Transcript
Cisco IOS Dial Technologies Command Reference
November 2009
Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883
Customer Order Number:
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco Nurse Connect, Cisco Pulse, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, and Flip Gift Card are service marks; and Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Fast Step, Follow Me Browsing, FormShare, GainMaker, GigaDrive, HomeLink, iLYNX, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, Laser Link, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerKEY, PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0908R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. Cisco IOS Dial Technologies Command Reference © 2001—2009 Cisco Systems, Inc. All rights reserved.
About Cisco IOS and Cisco IOS XE Software Documentation
Last Updated: March 5, 2009
This document describes the objectives, audience, conventions, and organization used in Cisco IOS and Cisco IOS XE software documentation, collectively referred to in this document as Cisco IOS documentation. Also included are resources for obtaining technical assistance, additional documentation, and other information from Cisco. This document is organized into the following sections:
• • • • •
Documentation Objectives, page iii Audience, page iii Documentation Conventions, page iv Documentation Organization, page v Additional Resources and Documentation Feedback, page xiii
Documentation Objectives
Cisco IOS documentation describes the tasks and commands available to configure and maintain Cisco networking devices.
Audience
The Cisco IOS documentation set is intended for users who configure and maintain Cisco networking devices (such as routers and switches) but who may not be familiar with the configuration and maintenance tasks, the relationship among tasks, or the Cisco IOS commands necessary to perform particular tasks. The Cisco IOS documentation set is also intended for those users experienced with Cisco IOS who need to know about new features, new configuration options, and new software characteristics in the current Cisco IOS release.
Cisco IOS Dial Technologies Command Reference November 2009
iii
Dial Commands Documentation Conventions
Documentation Conventions
In Cisco IOS documentation, the term router may be used to refer to various Cisco products; for example, routers, access servers, and switches. These and other networking devices that support Cisco IOS software are shown interchangeably in examples and are used only for illustrative purposes. An example that shows one product does not necessarily mean that other products are not supported. This section includes the following topics:
• • • •
Typographic Conventions, page iv Command Syntax Conventions, page iv Software Conventions, page v Reader Alert Conventions, page v
Typographic Conventions
Cisco IOS documentation uses the following typographic conventions: Convention ^ or Ctrl Description Both the ^ symbol and Ctrl represent the Control (Ctrl) key on a keyboard. For example, the key combination ^D or Ctrl-D means that you hold down the Control key while you press the D key. (Keys are indicated in capital letters but are not case sensitive.) A string is a nonquoted set of characters shown in italics. For example, when setting a Simple Network Management Protocol (SNMP) community string to public, do not use quotation marks around the string; otherwise, the string will include the quotation marks.
string
Command Syntax Conventions
Cisco IOS documentation uses the following command syntax conventions: Convention bold italic [x] ... | [x | y] {x | y} [x {y | z}] Description Bold text indicates commands and keywords that you enter as shown. Italic text indicates arguments for which you supply values. Square brackets enclose an optional keyword or argument. An ellipsis (three consecutive nonbolded periods without spaces) after a syntax element indicates that the element can be repeated. A vertical line, called a pipe, indicates a choice within a set of keywords or arguments. Square brackets enclosing keywords or arguments separated by a pipe indicate an optional choice. Braces enclosing keywords or arguments separated by a pipe indicate a required choice. Braces and a pipe within square brackets indicate a required choice within an optional element.
Cisco IOS Dial Technologies Command Reference
iv
November 2009
Dial Commands Documentation Organization
Software Conventions
Cisco IOS uses the following program code conventions: Convention
Courier font Bold Courier font
Description Courier font is used for information that is displayed on a PC or terminal screen. Bold Courier font indicates text that the user must enter. Angle brackets enclose text that is not displayed, such as a password. Angle brackets also are used in contexts in which the italic font style is not supported; for example, ASCII text. An exclamation point at the beginning of a line indicates that the text that follows is a comment, not a line of code. An exclamation point is also displayed by Cisco IOS software for certain processes.
<
>
!
[
]
Square brackets enclose default responses to system prompts.
Reader Alert Conventions
The Cisco IOS documentation set uses the following conventions for reader alerts:
Caution
Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.
Note
Means reader take note. Notes contain helpful suggestions or references to material not covered in the manual.
Timesaver
Means the described action saves time. You can save time by performing the action described in the paragraph.
Documentation Organization
This section describes the Cisco IOS documentation set, how it is organized, and how to access it on Cisco.com. Included are lists of configuration guides, command references, and supplementary references and resources that make up the documentation set. The following topics are included:
• • •
Cisco IOS Documentation Set, page vi Cisco IOS Documentation on Cisco.com, page vi Configuration Guides, Command References, and Supplementary Resources, page vii
Cisco IOS Dial Technologies Command Reference November 2009
v
Dial Commands Documentation Organization
Cisco IOS Documentation Set
Cisco IOS documentation consists of the following:
•
Release notes and caveats provide information about platform, technology, and feature support for a release and describe severity 1 (catastrophic), severity 2 (severe), and severity 3 (moderate) defects in released Cisco IOS code. Review release notes before other documents to learn whether or not updates have been made to a feature. Sets of configuration guides and command references organized by technology and published for each standard Cisco IOS release.
– Configuration guides—Compilations of documents that provide informational and
•
task-oriented descriptions of Cisco IOS features.
– Command references—Compilations of command pages that provide detailed information
about the commands used in the Cisco IOS features and processes that make up the related configuration guides. For each technology, there is a single command reference that covers all Cisco IOS releases and that is updated at each standard release.
• • •
Lists of all the commands in a specific release and all commands that are new, modified, removed, or replaced in the release. Command reference book for debug commands. Command pages are listed in alphabetical order. Reference book for system messages for all Cisco IOS releases.
Cisco IOS Documentation on Cisco.com
The following sections describe the documentation organization and how to access various document types. Use Cisco Feature Navigator to find information about platform support and Cisco IOS, Cisco IOS XE, and Catalyst OS software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
New Features List
The New Features List for each release provides a list of all features in the release with hyperlinks to the feature guides in which they are documented.
Feature Guides
Cisco IOS features are documented in feature guides. Feature guides describe one feature or a group of related features that are supported on many different software releases and platforms. Your Cisco IOS software release or platform may not support all the features documented in a feature guide. See the Feature Information table at the end of the feature guide for information about which features in that guide are supported in your software release.
Configuration Guides
Configuration guides are provided by technology and release and comprise a set of individual feature guides relevant to the release and technology.
Cisco IOS Dial Technologies Command Reference
vi
November 2009
Dial Commands Documentation Organization
Command References
Command reference books describe Cisco IOS commands that are supported in many different software releases and on many different platforms. The books are provided by technology. For information about all Cisco IOS commands, use the Command Lookup Tool at http://tools.cisco.com/Support/CLILookup or the Cisco IOS Master Command List, All Releases, at http://www.cisco.com/en/US/docs/ios/mcl/allreleasemcl/all_book.html.
Cisco IOS Supplementary Documents and Resources
Supplementary documents and resources are listed in Table 2 on page xiii.
Configuration Guides, Command References, and Supplementary Resources
Table 1 lists, in alphabetical order, Cisco IOS and Cisco IOS XE software configuration guides and command references, including brief descriptions of the contents of the documents. The Cisco IOS command references are comprehensive, meaning that they include commands for both Cisco IOS software and Cisco IOS XE software, for all releases. The configuration guides and command references support many different software releases and platforms. Your Cisco IOS software release or platform may not support all these technologies. For additional information about configuring and operating specific networking devices, go to the Product Support area of Cisco.com at http://www.cisco.com/web/psa/products/index.html. Table 2 lists documents and resources that supplement the Cisco IOS software configuration guides and command references. These supplementary resources include release notes and caveats; master command lists; new, modified, removed, and replaced command lists; system messages; and the debug command reference.
Table 1 Cisco IOS and Cisco IOS XE Configuration Guides and Command References
Configuration Guide and Command Reference Titles Cisco IOS AppleTalk Configuration Guide Cisco IOS XE AppleTalk Configuration Guide Cisco IOS AppleTalk Command Reference Cisco IOS Asynchronous Transfer Mode Configuration Guide Cisco IOS Asynchronous Transfer Mode Command Reference
Features/Protocols/Technologies AppleTalk protocol.
LAN ATM, multiprotocol over ATM (MPoA), and WAN ATM.
Cisco IOS Dial Technologies Command Reference November 2009
vii
Dial Commands Documentation Organization
Table 1
Cisco IOS and Cisco IOS XE Configuration Guides and Command References (continued)
Configuration Guide and Command Reference Titles Cisco IOS Bridging and IBM Networking Configuration Guide Cisco IOS Bridging Command Reference Cisco IOS IBM Networking Command Reference
Features/Protocols/Technologies
•
Transparent and source-route transparent (SRT) bridging, source-route bridging (SRB), Token Ring Inter-Switch Link (TRISL), and token ring route switch module (TRRSM). Data-link switching plus (DLSw+), serial tunnel (STUN), block serial tunnel (BSTUN); logical link control, type 2 (LLC2), synchronous data link control (SDLC); IBM Network Media Translation, including Synchronous Data Logical Link Control (SDLLC) and qualified LLC (QLLC); downstream physical unit (DSPU), Systems Network Architecture (SNA) service point, SNA frame relay access, advanced peer-to-peer networking (APPN), native client interface architecture (NCIA) client/server topologies, and IBM Channel Attach.
•
Cisco IOS Broadband and DSL Configuration Guide Cisco IOS XE Broadband and DSL Configuration Guide Cisco IOS Broadband and DSL Command Reference Cisco IOS Carrier Ethernet Configuration Guide Cisco IOS Carrier Ethernet Command Reference
Point-to-Point Protocol (PPP) over ATM (PPPoA) and PPP over Ethernet (PPPoE).
Connectivity fault management (CFM), Ethernet Local Management Interface (ELMI), IEEE 802.3ad link bundling, Link Layer Discovery Protocol (LLDP), media endpoint discovery (MED), and operations, administration, and maintenance (OAM). Autoinstall, Setup, Cisco IOS command-line interface (CLI), Cisco IOS file system (IFS), Cisco IOS web browser user interface (UI), basic file transfer services, and file management.
Cisco IOS Configuration Fundamentals Configuration Guide Cisco IOS XE Configuration Fundamentals Configuration Guide Cisco IOS Configuration Fundamentals Command Reference Cisco IOS DECnet Configuration Guide Cisco IOS XE DECnet Configuration Guide Cisco IOS DECnet Command Reference Cisco IOS Dial Technologies Configuration Guide Cisco IOS XE Dial Technologies Configuration Guide Cisco IOS Dial Technologies Command Reference Cisco IOS Flexible NetFlow Configuration Guide Cisco IOS Flexible NetFlow Command Reference
DECnet protocol.
Asynchronous communications, dial backup, dialer technology, dial-in terminal services and AppleTalk remote access (ARA), large scale dialout, dial-on-demand routing, dialout, modem and resource pooling, ISDN, multilink PPP (MLP), PPP, virtual private dialup network (VPDN). Flexible NetFlow.
Cisco IOS Dial Technologies Command Reference
viii
November 2009
Dial Commands Documentation Organization
Table 1
Cisco IOS and Cisco IOS XE Configuration Guides and Command References (continued)
Configuration Guide and Command Reference Titles Cisco IOS H.323 Configuration Guide
Features/Protocols/Technologies Gatekeeper enhancements for managed voice services, Gatekeeper Transaction Message Protocol, gateway codec order preservation and shutdown control, H.323 dual tone multifrequency relay, H.323 version 2 enhancements, Network Address Translation (NAT) support of H.323 v2 Registration, Admission, and Status (RAS) protocol, tokenless call authorization, and VoIP gateway trunk and carrier-based routing. A variety of High Availability (HA) features and technologies that are available for different network segments (from enterprise access to service provider core) to facilitate creation of end-to-end highly available networks. Cisco IOS HA features and technologies can be categorized in three key areas: system-level resiliency, network-level resiliency, and embedded management for resiliency. A VoIP-enabled device that is deployed at the edge of networks. An SBC is a toolkit of functions, such as signaling interworking, network hiding, security, and quality of service (QoS). Subscriber identification, service and policy determination, session creation, session policy enforcement, session life-cycle management, accounting for access and service usage, session state monitoring. LAN interfaces, logical interfaces, serial interfaces, virtual interfaces, and interface configuration.
Cisco IOS High Availability Configuration Guide Cisco IOS XE High Availability Configuration Guide Cisco IOS High Availability Command Reference
Cisco IOS Integrated Session Border Controller Command Reference Cisco IOS Intelligent Services Gateway Configuration Guide Cisco IOS Intelligent Services Gateway Command Reference Cisco IOS Interface and Hardware Component Configuration Guide Cisco IOS XE Interface and Hardware Component Configuration Guide Cisco IOS Interface and Hardware Component Command Reference Cisco IOS IP Addressing Services Configuration Guide Cisco IOS XE Addressing Services Configuration Guide Cisco IOS IP Addressing Services Command Reference Cisco IOS IP Application Services Configuration Guide Cisco IOS XE IP Application Services Configuration Guide Cisco IOS IP Application Services Command Reference Cisco IOS IP Mobility Configuration Guide Cisco IOS IP Mobility Command Reference Cisco IOS IP Multicast Configuration Guide Cisco IOS XE IP Multicast Configuration Guide Cisco IOS IP Multicast Command Reference
Address Resolution Protocol (ARP), Network Address Translation (NAT), Domain Name System (DNS), Dynamic Host Configuration Protocol (DHCP), and Next Hop Address Resolution Protocol (NHRP). Enhanced Object Tracking (EOT), Gateway Load Balancing Protocol (GLBP), Hot Standby Router Protocol (HSRP), IP Services, Server Load Balancing (SLB), Stream Control Transmission Protocol (SCTP), TCP, Web Cache Communication Protocol (WCCP), User Datagram Protocol (UDP), and Virtual Router Redundancy Protocol (VRRP). Mobile ad hoc networks (MANet) and Cisco mobile networks. Protocol Independent Multicast (PIM) sparse mode (PIM-SM), bidirectional PIM (bidir-PIM), Source Specific Multicast (SSM), Multicast Source Discovery Protocol (MSDP), Internet Group Management Protocol (IGMP), and Multicast VPN (MVPN).
Cisco IOS Dial Technologies Command Reference November 2009
ix
Dial Commands Documentation Organization
Table 1
Cisco IOS and Cisco IOS XE Configuration Guides and Command References (continued)
Configuration Guide and Command Reference Titles Cisco IOS IP Routing Protocols Configuration Guide Cisco IOS XE IP Routing Protocols Configuration Guide Cisco IOS IP Routing Protocols Command Reference
Features/Protocols/Technologies Border Gateway Protocol (BGP), multiprotocol BGP, multiprotocol BGP extensions for IP multicast, bidirectional forwarding detection (BFD), Enhanced Interior Gateway Routing Protocol (EIGRP), Interior Gateway Routing Protocol (IGRP), Intermediate System-to-Intermediate System (IS-IS), on-demand routing (ODR), Open Shortest Path First (OSPF), and Routing Information Protocol (RIP). Cisco IOS IP Service Level Agreements (IP SLAs).
Cisco IOS IP SLAs Configuration Guide Cisco IOS XE IP SLAs Configuration Guide Cisco IOS IP SLAs Command Reference Cisco IOS IP Switching Configuration Guide Cisco IOS XE IP Switching Configuration Guide Cisco IOS IP Switching Command Reference Cisco IOS IPv6 Configuration Guide Cisco IOS XE IPv6 Configuration Guide Cisco IOS IPv6 Command Reference Cisco IOS ISO CLNS Configuration Guide Cisco IOS XE ISO CLNS Configuration Guide Cisco IOS ISO CLNS Command Reference Cisco IOS LAN Switching Configuration Guide Cisco IOS XE LAN Switching Configuration Guide Cisco IOS LAN Switching Command Reference Cisco IOS Mobile Wireless Gateway GPRS Support Node Configuration Guide Cisco IOS Mobile Wireless Gateway GPRS Support Node Command Reference Cisco IOS Mobile Wireless Home Agent Configuration Guide Cisco IOS Mobile Wireless Home Agent Command Reference Cisco IOS Mobile Wireless Packet Data Serving Node Configuration Guide Cisco IOS Mobile Wireless Packet Data Serving Node Command Reference Cisco IOS Mobile Wireless Radio Access Networking Configuration Guide Cisco IOS Mobile Wireless Radio Access Networking Command Reference
Cisco Express Forwarding, fast switching, and Multicast Distributed Switching (MDS).
For IPv6 features, protocols, and technologies, go to the IPv6 “Start Here” document at the following URL: http://www.cisco.com/en/US/docs/ios/ipv6/configuration/ guide/ip6-roadmap.html ISO connectionless network service (CLNS).
VLANs, Inter-Switch Link (ISL) encapsulation, IEEE 802.10 encapsulation, IEEE 802.1Q encapsulation, and multilayer switching (MLS). Cisco IOS Gateway GPRS Support Node (GGSN) in a 2.5-generation general packet radio service (GPRS) and 3-generation universal mobile telecommunication system (UMTS) network. Cisco Mobile Wireless Home Agent, an anchor point for mobile terminals for which mobile IP or proxy mobile IP services are provided. Cisco Packet Data Serving Node (PDSN), a wireless gateway that is between the mobile infrastructure and standard IP networks and that enables packet data services in a code division multiple access (CDMA) environment. Cisco IOS radio access network products.
Cisco IOS Dial Technologies Command Reference
x
November 2009
Dial Commands Documentation Organization
Table 1
Cisco IOS and Cisco IOS XE Configuration Guides and Command References (continued)
Configuration Guide and Command Reference Titles Cisco IOS Multiprotocol Label Switching Configuration Guide Cisco IOS XE Multiprotocol Label Switching Configuration Guide Cisco IOS Multiprotocol Label Switching Command Reference Cisco IOS Multi-Topology Routing Configuration Guide Cisco IOS Multi-Topology Routing Command Reference Cisco IOS NetFlow Configuration Guide Cisco IOS XE NetFlow Configuration Guide Cisco IOS NetFlow Command Reference Cisco IOS Network Management Configuration Guide
Features/Protocols/Technologies MPLS Label Distribution Protocol (LDP), MPLS Layer 2 VPNs, MPLS Layer 3 VPNs, MPLS Traffic Engineering (TE), and MPLS Embedded Management (EM) and MIBs.
Unicast and multicast topology configurations, traffic classification, routing protocol support, and network management support. Network traffic data analysis, aggregation caches, export features.
Basic system management; system monitoring and logging; troubleshooting, logging, and fault management; Cisco IOS XE Network Management Configuration Guide Cisco Discovery Protocol; Cisco IOS Scripting with Tool Cisco IOS Network Management Command Reference Control Language (Tcl); Cisco networking services (CNS); DistributedDirector; Embedded Event Manager (EEM); Embedded Resource Manager (ERM); Embedded Syslog Manager (ESM); HTTP; Remote Monitoring (RMON); SNMP; and VPN Device Manager Client for Cisco IOS Software (XSM Configuration). Cisco IOS Novell IPX Configuration Guide Cisco IOS XE Novell IPX Configuration Guide Cisco IOS Novell IPX Command Reference Cisco IOS Optimized Edge Routing Configuration Guide Cisco IOS Optimized Edge Routing Command Reference Optimized edge routing (OER) monitoring, policy configuration, routing control, logging and reporting, and VPN IPsec/generic routing encapsulation (GRE) tunnel interface optimization. Class-based weighted fair queuing (CBWFQ), custom queuing, distributed traffic shaping (DTS), generic traffic shaping (GTS), IP- to-ATM class of service (CoS), low latency queuing (LLQ), modular QoS CLI (MQC), Network-Based Application Recognition (NBAR), priority queuing, Security Device Manager (SDM), Multilink PPP (MLPPP) for QoS, header compression, AutoQoS, QoS features for voice, Resource Reservation Protocol (RSVP), weighted fair queuing (WFQ), and weighted random early detection (WRED). Access control lists (ACLs), authentication, authorization, and accounting (AAA), firewalls, IP security and encryption, neighbor router authentication, network access security, network data encryption with router authentication, public key infrastructure (PKI), RADIUS, TACACS+, terminal access security, and traffic filters. Novell Internetwork Packet Exchange (IPX) protocol.
Cisco IOS Quality of Service Solutions Configuration Guide Cisco IOS XE Quality of Service Solutions Configuration Guide Cisco IOS Quality of Service Solutions Command Reference
Cisco IOS Security Configuration Guide Cisco IOS XE Security Configuration Guide Cisco IOS Security Command Reference
Cisco IOS Dial Technologies Command Reference November 2009
xi
Dial Commands Documentation Organization
Table 1
Cisco IOS and Cisco IOS XE Configuration Guides and Command References (continued)
Configuration Guide and Command Reference Titles Cisco IOS Service Selection Gateway Command Reference Cisco IOS Software Activation Configuration Guide Cisco IOS Software Activation Command Reference Cisco IOS Software Modularity Installation and Configuration Guide Cisco IOS Software Modularity Command Reference Cisco IOS Terminal Services Configuration Guide Cisco IOS Terminal Services Command Reference Cisco IOS XE Terminal Services Command Reference Cisco IOS Virtual Switch Command Reference
Features/Protocols/Technologies
Cisco IOS Service Selection Gateway Configuration Guide Subscriber authentication, service access, and accounting. An orchestrated collection of processes and components to activate Cisco IOS software feature sets by obtaining and validating Cisco software licenses. Installation and basic configuration of software modularity images, including installations on single and dual route processors, installation rollbacks, software modularity binding, software modularity processes and patches. DEC, local-area transport (LAT), and X.25 packet assembler/disassembler (PAD).
Virtual switch redundancy, high availability, and packet handling; converting between standalone and virtual switch modes; virtual switch link (VSL); Virtual Switch Link Protocol (VSLP).
Note
For information about virtual switch configuration, refer to the product-specific software configuration information for the Cisco Catalyst 6500 series switch or for the Metro Ethernet 6500 series switch.
Cisco IOS Voice Configuration Library Cisco IOS Voice Command Reference Cisco IOS VPDN Configuration Guide Cisco IOS XE VPDN Configuration Guide Cisco IOS VPDN Command Reference
Cisco IOS support for voice call control protocols, interoperability, physical and virtual interface management, and troubleshooting. The library includes documentation for IP telephony applications. Layer 2 Tunneling Protocol (L2TP) dial-out load balancing and redundancy, L2TP extended failover, L2TP security VPDN, multihop by Dialed Number Identification Service (DNIS), timer and retry enhancements for L2TP and Layer 2 Forwarding (L2F), RADIUS Attribute 82: tunnel assignment ID, shell-based authentication of VPDN users, tunnel authentication via RADIUS on tunnel terminator.
Cisco IOS Wide-Area Networking Configuration Guide
Frame Relay, Layer 2 Tunneling Protocol Version 3 (L2TPv3), Link Access Procedure, Balanced (LAPB), Switched Cisco IOS XE Wide-Area Networking Configuration Guide Multimegabit Data Service (SMDS), and X.25. Cisco IOS Wide-Area Networking Command Reference Cisco IOS Wireless LAN Configuration Guide Cisco IOS Wireless LAN Command Reference Broadcast key rotation, IEEE 802.11x support, IEEE 802.1x authenticator, IEEE 802.1x local authentication service for Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling (EAP-FAST), Multiple Basic Service Set ID (BSSID), Wi-Fi Multimedia (WMM) required elements, and Wi-Fi Protected Access (WPA).
Cisco IOS Dial Technologies Command Reference
xii
November 2009
Dial Commands Additional Resources and Documentation Feedback
Table 2
Cisco IOS Supplementary Documents and Resources
Document Title Cisco IOS Master Command List, All Releases Cisco IOS New, Modified, Removed, and Replaced Commands Cisco IOS Software System Messages
Description Alphabetical list of all the commands documented in all Cisco IOS releases. List of all the new, modified, removed, and replaced commands for a Cisco IOS release. List of Cisco IOS system messages and descriptions. System messages may indicate problems with your system; be informational only; or may help diagnose problems with communications lines, internal hardware, or the system software. Alphabetical list of debug commands including brief descriptions of use, command syntax, and usage guidelines. Information about new and changed features, system requirements, and other useful information about specific software releases; information about defects in specific Cisco IOS software releases. Files used for network monitoring. To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator at the following URL: http://www.cisco.com/go/mibs Standards documents maintained by the Internet Engineering Task Force (IETF) that Cisco IOS documentation references where applicable. The full text of referenced RFCs may be obtained at the following URL: http://www.rfc-editor.org/
Cisco IOS Debug Command Reference Release Notes and Caveats
MIBs
RFCs
Additional Resources and Documentation Feedback
What’s New in Cisco Product Documentation is published monthly and describes all new and revised Cisco technical documentation. The What’s New in Cisco Product Documentation publication also provides information about obtaining the following resources:
• • •
Technical documentation Cisco product security overview Product alerts and field notices
Cisco IOS Dial Technologies Command Reference November 2009
xiii
Dial Commands Additional Resources and Documentation Feedback
•
Technical assistance
Cisco IOS technical documentation includes embedded feedback forms where you can rate documents and provide suggestions for improvement. Your feedback helps us improve our documentation.
CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY, PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0910R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. © 2008–2009 Cisco Systems, Inc. All rights reserved.
Cisco IOS Dial Technologies Command Reference
xiv
November 2009
Using the Command-Line Interface in Cisco IOS and Cisco IOS XE Software
Last Updated: March 5, 2009
This document provides basic information about the command-line interface (CLI) in Cisco IOS and Cisco IOS XE software and how you can use some of the CLI features. This document contains the following sections:
• • • •
Initially Configuring a Device, page xv Using the CLI, page xvi Saving Changes to a Configuration, page xxvi Additional Information, page xxvi
For more information about using the CLI, see the “Using the Cisco IOS Command-Line Interface” section of the Cisco IOS Configuration Fundamentals Configuration Guide. For information about the software documentation set, see the “About Cisco IOS and Cisco IOS XE Software Documentation” document.
Initially Configuring a Device
Initially configuring a device varies by platform. For information about performing an initial configuration, see the hardware installation documentation that is provided with the original packaging of the product or go to the Product Support area of Cisco.com at http://www.cisco.com/web/psa/products/index.html. After you have performed the initial configuration and connected the device to your network, you can configure the device by using the console port or a remote access method, such as Telnet or Secure Shell (SSH), to access the CLI or by using the configuration method provided on the device, such as Security Device Manager.
Cisco IOS Dial Technologies Command Reference November 2009
xv
Dial Commands Using the CLI
Changing the Default Settings for a Console or AUX Port
There are only two changes that you can make to a console port and an AUX port:
• •
Change the port speed with the config-register 0x command. Changing the port speed is not recommended. The well-known default speed is 9600. Change the behavior of the port; for example, by adding a password or changing the timeout value.
Note
The AUX port on the Route Processor (RP) installed in a Cisco ASR1000 series router does not serve any useful customer purpose and should be accessed only under the advisement of a customer support representative.
Using the CLI
This section describes the following topics:
• • • • • • • • • • •
Understanding Command Modes, page xvi Using the Interactive Help Feature, page xix Understanding Command Syntax, page xx Understanding Enable and Enable Secret Passwords, page xxii Using the Command History Feature, page xxii Abbreviating Commands, page xxiii Using Aliases for CLI Commands, page xxiii Using the no and default Forms of Commands, page xxiv Using the debug Command, page xxiv Filtering Output Using Output Modifiers, page xxiv Understanding CLI Error Messages, page xxv
Understanding Command Modes
The CLI command mode structure is hierarchical, and each mode supports a set of specific commands. This section describes the most common of the many modes that exist. Table 3 lists common command modes with associated CLI prompts, access and exit methods, and a brief description of how each mode is used.
Cisco IOS Dial Technologies Command Reference
xvi
November 2009
Dial Commands Using the CLI
Table 3
CLI Command Modes
Command Mode User EXEC
Access Method Log in.
Prompt
Router>
Exit Method Issue the logout or exit command.
Mode Usage
• • •
Change terminal settings. Perform basic tests. Display device status. Issue show and debug commands. Copy images to the device. Reload the device. Manage device configuration files. Manage device file systems.
Privileged EXEC
From user EXEC mode, issue the enable command.
Router#
Issue the disable command or the exit command to return to user EXEC mode.
• • • • •
Global configuration
From privileged EXEC mode, issue the configure terminal command. From global configuration mode, issue the interface command.
Router(config)#
Issue the exit command Configure the device. or the end command to return to privileged EXEC mode. Issue the exit command Configure individual to return to global interfaces. configuration mode or the end command to return to privileged EXEC mode.
Interface configuration
Router(config-if)#
Line configuration
Router(config-line)# Issue the exit command Configure individual From global to return to global terminal lines. configuration mode, configuration mode or issue the line vty or line the end command to console command. return to privileged EXEC mode.
Cisco IOS Dial Technologies Command Reference November 2009
xvii
Dial Commands Using the CLI
Table 3
CLI Command Modes (continued)
Command Mode ROM monitor
Access Method From privileged EXEC mode, issue the reload command. Press the Break key during the first 60 seconds while the system is booting.
Prompt
rommon # >
Exit Method Issue the continue command.
Mode Usage
•
The # symbol represents the line number and increments at each prompt.
Run as the default operating mode when a valid image cannot be loaded. Access the fall-back procedure for loading an image when the device lacks a valid image and cannot be booted. Perform password recovery when a CTRL-Break sequence is issued within 60 seconds of a power-on or reload event. Inspect various states on the router, including the Cisco IOS state. Replace or roll back the configuration. Provide methods of restarting the Cisco IOS software or other processes. Reboot hardware, such as the entire router, an RP, an ESP, a SIP, a SPA, or possibly other hardware components. Transfer files into or off of the router using remote access methods such as FTP, TFTP, and SCP.
•
•
Diagnostic (available only on the Cisco ASR1000 series router)
Router(diag)# The router boots or enters diagnostic mode in the following scenarios. When a Cisco IOS process or processes fail, in most scenarios the router will reload.
If a Cisco IOS process failure is the reason for entering diagnostic mode, the failure must be resolved and the router must be rebooted to exit diagnostic mode. If the router is in diagnostic mode because of a transport-map configuration, access the router through another port or using a method that is configured to connect to the Cisco IOS CLI. If the RP auxiliary port was used to access the router, use another port for access. Accessing the router through the auxiliary port is not useful for customer purposes.
•
• •
•
A user-configured access policy was configured using the transport-map command, which directed the user into diagnostic mode. The router was accessed using an RP auxiliary port. A break signal (Ctrl-C, Ctrl-Shift-6, or the send break command) was entered, and the router was configured to enter diagnostic mode when the break signal was received.
•
•
•
•
Cisco IOS Dial Technologies Command Reference
xviii
November 2009
Dial Commands Using the CLI
EXEC commands are not saved when the software reboots. Commands that you issue in a configuration mode can be saved to the startup configuration. If you save the running configuration to the startup configuration, these commands will execute when the software is rebooted. Global configuration mode is the highest level of configuration mode. From global configuration mode, you can enter a variety of other configuration modes, including protocol-specific modes. ROM monitor mode is a separate mode that is used when the software cannot load properly. If a valid software image is not found when the software boots or if the configuration file is corrupted at startup, the software might enter ROM monitor mode. Use the question symbol (?) to view the commands that you can use while the device is in ROM monitor mode.
rommon 1 > ? alias boot confreg cont context cookie . . . rommon 2 > set and display aliases command boot up an external process configuration register utility continue executing a downloaded image display the context of a loaded image display contents of cookie PROM in hex
The following example shows how the command prompt changes to indicate a different command mode:
Router> enable Router# configure terminal Router(config)# interface ethernet 1/1 Router(config-if)# ethernet Router(config-line)# exit Router(config)# end Router#
Note
A keyboard alternative to the end command is Ctrl-Z.
Using the Interactive Help Feature
The CLI includes an interactive Help feature. Table 4 describes how to use the Help feature.
Table 4 CLI Interactive Help Commands
Command help ? partial command? partial command
command ? command keyword ?
Purpose Provides a brief description of the help feature in any command mode. Lists all commands available for a particular command mode. Provides a list of commands that begin with the character string (no space between the command and the question mark). Completes a partial command name (no space between the command and ). Lists the keywords, arguments, or both associated with the command (space between the command and the question mark). Lists the arguments that are associated with the keyword (space between the keyword and the question mark).
Cisco IOS Dial Technologies Command Reference November 2009
xix
Dial Commands Using the CLI
The following examples show how to use the help commands:
help
Router> help Help may be requested at any point in a command by entering a question mark '?'. If nothing matches, the help list will be empty and you must backup until entering a '?' shows the available options. Two styles of help are provided: 1. Full help is available when you are ready to enter a command argument (e.g. 'show ?') and describes each possible argument. 2. Partial help is provided when an abbreviated argument is entered and you want to know what arguments match the input (e.g. 'show pr?'.)
?
Router# ? Exec commands: access-enable access-profile access-template alps archive
Create a temporary access-List entry Apply user-profile to interface Create a temporary access-List entry ALPS exec commands manage archive files
partial command?
Router(config)# zo? zone zone-pair
partial command
Router(config)# we webvpn
command ?
Router(config-if)# pppoe ? enable Enable pppoe max-sessions Maximum PPPOE sessions
command keyword ?
Router(config-if)# pppoe enable ? group attach a BBA group
Understanding Command Syntax
Command syntax is the format in which a command should be entered in the CLI. Commands include the name of the command, keywords, and arguments. Keywords are alphanumeric strings that are used literally. Arguments are placeholders for values that a user must supply. Keywords and arguments may be required or optional. Specific conventions convey information about syntax and command elements. Table 5 describes these conventions.
Cisco IOS Dial Technologies Command Reference
xx
November 2009
Dial Commands Using the CLI
Table 5
CLI Syntax Conventions
Symbol/Text < > (angle brackets) A.B.C.D.
Function Indicate that the option is an argument. Indicates that you must enter a dotted decimal IP address. Indicates that you must enter one word. Indicates that you must enter more than one word.
Notes Sometimes arguments are displayed without angle brackets. Angle brackets (< >) are not always used to indicate that an IP address is an argument. Angle brackets (< >) are not always used to indicate that a WORD is an argument. Angle brackets (< >) are not always used to indicate that a LINE is an argument.
WORD (all capital letters)
LINE (all capital letters)
(carriage return)
Indicates the end of the list of — available keywords and arguments, and also indicates when keywords and arguments are optional. When is the only option, you have reached the end of the branch or the end of the command if the command has only one branch.
The following examples show syntax conventions:
Router(config)# ethernet cfm domain ? WORD domain name Router(config)# ethernet cfm domain dname ? level Router(config)# ethernet cfm domain dname level ? <0-7> maintenance level number Router(config)# ethernet cfm domain dname level 7 ? Router(config)# snmp-server file-transfer access-group 10 ? protocol protocol options Router(config)# logging host ? Hostname or A.B.C.D IP address of the syslog server ipv6 Configure IPv6 syslog server Router(config)# snmp-server file-transfer access-group 10 ? protocol protocol options
Cisco IOS Dial Technologies Command Reference November 2009
xxi
Dial Commands Using the CLI
Understanding Enable and Enable Secret Passwords
Some privileged EXEC commands are used for actions that impact the system, and it is recommended that you set a password for these commands to prevent unauthorized use. Two types of passwords, enable (not encrypted) and enable secret (encrypted), can be set. The following commands set these passwords and are issued in global configuration mode:
• •
enable password enable secret password
Using an enable secret password is recommended because it is encrypted and more secure than the enable password. When you use an enable secret password, text is encrypted (unreadable) before it is written to the config.text file. When you use an enable password, the text is written as entered (readable) to the config.text file. Each type of password is case sensitive, can contain from 1 to 25 uppercase and lowercase alphanumeric characters, and can start with a number. Spaces are also valid password characters; for example, “two words” is a valid password. Leading spaces are ignored, but trailing spaces are recognized.
Note
Both password commands have numeric keywords that are single integer values. If you choose a number for the first character of your password followed by a space, the system will read the number as if it were the numeric keyword and not as part of your password. When both passwords are set, the enable secret password takes precedence over the enable password. To remove a password, use the no form of the commands: no enable password or no enable secret password. For more information about password recovery procedures for Cisco products, see http://www.cisco.com/en/US/products/sw/iosswrel/ps1831/ products_tech_note09186a00801746e6.shtml.
Using the Command History Feature
The CLI command history feature saves the commands you enter during a session in a command history buffer. The default number of commands saved is 10, but the number is configurable within the range of 0 to 256. This command history feature is particularly useful for recalling long or complex commands. To change the number of commands saved in the history buffer for a terminal session, issue the terminal history size command:
Router# terminal history size num
A command history buffer is also available in line configuration mode with the same default and configuration options. To set the command history buffer size for a terminal session in line configuration mode, issue the history command:
Router(config-line)# history [size num]
To recall commands from the history buffer, use the following methods:
•
Press Ctrl-P or the up arrow key—Recalls commands beginning with the most recent command. Repeat the key sequence to recall successively older commands.
Cisco IOS Dial Technologies Command Reference
xxii
November 2009
Dial Commands Using the CLI
•
Press Ctrl-N or the down arrow key—Recalls the most recent commands in the history buffer after they have been recalled using Ctrl-P or the up arrow key. Repeat the key sequence to recall successively more recent commands.
Note •
The arrow keys function only on ANSI-compatible terminals such as the VT100.
Issue the show history command in user EXEC or privileged EXEC mode—Lists the most recent commands that you entered. The number of commands that are displayed is determined by the setting of the terminal history size and history commands. The CLI command history feature is enabled by default. To disable this feature for a terminal session, issue the terminal no history command in user EXEC or privileged EXEC mode or the no history command in line configuration mode.
Abbreviating Commands
Typing a complete command name is not always required for the command to execute. The CLI recognizes an abbreviated command when the abbreviation contains enough characters to uniquely identify the command. For example, the show version command can be abbreviated as sh ver. It cannot be abbreviated as s ver because s could mean show, set, or systat. The sh v abbreviation also is not valid because the show command has vrrp as a keyword in addition to version. (Command and keyword examples from Cisco IOS Release 12.4(13)T.)
Using Aliases for CLI Commands
To save time and the repetition of entering the same command multiple times, you can use a command alias. An alias can be configured to do anything that can be done at the command line, but an alias cannot move between modes, type in passwords, or perform any interactive functions. Table 6 shows the default command aliases.
Table 6 Default Command Aliases
Command Alias h lo p s u or un w
Original Command help logout ping show undebug where
To create a command alias, issue the alias command in global configuration mode. The syntax of the command is alias mode command-alias original-command. Following are some examples:
• • •
Router(config)# alias exec prt partition—privileged EXEC mode Router(config)# alias configure sb source-bridge—global configuration mode Router(config)# alias interface rl rate-limit—interface configuration mode
Cisco IOS Dial Technologies Command Reference November 2009
xxiii
Dial Commands Using the CLI
To view both default and user-created aliases, issue the show alias command. For more information about the alias command, see http://www.cisco.com/en/US/docs/ios/fundamentals/command/reference/cf_book.html.
Using the no and default Forms of Commands
Most configuration commands have a no form that is used to reset a command to its default value or disable a feature or function. For example, the ip routing command is enabled by default. To disable this command, you would issue the no ip routing command. To re-enable IP routing, you would issue the ip routing command. Configuration commands may also have a default form, which returns the command settings to their default values. For commands that are disabled by default, using the default form has the same effect as using the no form of the command. For commands that are enabled by default and have default settings, the default form enables the command and returns the settings to their default values. The no and default forms of commands are described in the command pages of command references.
Using the debug Command
A debug command produces extensive output that helps you troubleshoot problems in your network. These commands are available for many features and functions within Cisco IOS and Cisco IOS XE software. Some debug commands are debug all, debug aaa accounting, and debug mpls packets. To use debug commands during a Telnet session with a device, you must first enter the terminal monitor command. To turn off debugging completely, you must enter the undebug all command. For more information about debug commands, see the Cisco IOS Debug Command Reference at http://www.cisco.com/en/US/docs/ios/debug/command/reference/db_book.html.
Caution
Debugging is a high priority and high CPU utilization process that can render your device unusable. Use debug commands only to troubleshoot specific problems. The best times to run debugging are during periods of low network traffic and when few users are interacting with the network. Debugging during these periods decreases the likelihood that the debug command processing overhead will affect network performance or user access or response times.
Filtering Output Using Output Modifiers
Many commands produce lengthy output that may use several screens to display. Using output modifiers, you can filter this output to show only the information that you want to see. Three output modifiers are available and are described as follows:
• • •
begin regular expression—Displays the first line in which a match of the regular expression is found and all lines that follow. include regular expression—Displays all lines in which a match of the regular expression is found. exclude regular expression—Displays all lines except those in which a match of the regular expression is found.
Cisco IOS Dial Technologies Command Reference
xxiv
November 2009
Dial Commands Using the CLI
To use one of these output modifiers, type the command followed by the pipe symbol (|), the modifier, and the regular expression that you want to search for or filter. A regular expression is a case-sensitive alphanumeric pattern. It can be a single character or number, a phrase, or a more complex string. The following example illustrates how to filter output of the show interface command to display only lines that include the expression “protocol.”
Router# show interface | include protocol FastEthernet0/0 is up, line protocol is up Serial4/0 is up, line protocol is up Serial4/1 is up, line protocol is up Serial4/2 is administratively down, line protocol is down Serial4/3 is administratively down, line protocol is down
Understanding CLI Error Messages
You may encounter some error messages while using the CLI. Table 7 shows the common CLI error messages.
Table 7 Common CLI Error Messages
Error Message % Ambiguous command: “show con”
Meaning
How to Get Help
You did not enter enough Reenter the command followed by a characters for the command to space and a question mark (?). The be recognized. keywords that you are allowed to enter for the command appear. You did not enter all the keywords or values required by the command. Reenter the command followed by a space and a question mark (?). The keywords that you are allowed to enter for the command appear. Enter a question mark (?) to display all the commands that are available in this command mode. The keywords that you are allowed to enter for the command appear.
% Incomplete command.
% Invalid input detected at “^” You entered the command inmarker. correctly. The caret (^) marks the point of the error.
For more system error messages, see the following documents:
• • •
Cisco IOS Release 12.2SR System Message Guide Cisco IOS System Messages, Volume 1 of 2 (Cisco IOS Release 12.4) Cisco IOS System Messages, Volume 2 of 2 (Cisco IOS Release 12.4)
Cisco IOS Dial Technologies Command Reference November 2009
xxv
Dial Commands Saving Changes to a Configuration
Saving Changes to a Configuration
To save changes that you made to the configuration of a device, you must issue the copy running-config startup-config command or the copy system:running-config nvram:startup-config command. When you issue these commands, the configuration changes that you made are saved to the startup configuration and saved when the software reloads or power to the device is turned off or interrupted. The following example shows the syntax of the copy running-config startup-config command:
Router# copy running-config startup-config Destination filename [startup-config]?
You press Enter to accept the startup-config filename (the default), or type a new filename and then press Enter to accept that name. The following output is displayed indicating that the configuration was saved:
Building configuration... [OK] Router#
On most platforms, the configuration is saved to NVRAM. On platforms with a Class A flash file system, the configuration is saved to the location specified by the CONFIG_FILE environment variable. The CONFIG_FILE variable defaults to NVRAM.
Additional Information
•
“Using the Cisco IOS Command-Line Interface” section of the Cisco IOS Configuration Fundamentals Configuration Guide: http://www.cisco.com/en/US/docs/ios/fundamentals/configuration/guide/cf_cli-basics.html or “Using Cisco IOS XE Software” chapter of the Cisco ASR 1000 Series Aggregation Services Routers Software Configuration Guide: http://www.cisco.com/en/US/docs/routers/asr1000/configuration/guide/chassis/Using_CLI.html
•
Cisco Product Support Resources http://www.cisco.com/web/psa/products/index.html Support area on Cisco.com (also search for documentation by task or product) http://www.cisco.com/en/US/support/index.html Software Download Center (downloads; tools; licensing, registration, advisory, and general information) (requires Cisco.com User ID and password) http://www.cisco.com/kobayashi/sw-center/ Error Message Decoder, a tool to help you research and resolve error messages for Cisco IOS software http://www.cisco.com/pcgi-bin/Support/Errordecoder/index.cgi Command Lookup Tool, a tool to help you find detailed descriptions of Cisco IOS commands (requires Cisco.com user ID and password) http://tools.cisco.com/Support/CLILookup
•
•
•
•
Cisco IOS Dial Technologies Command Reference
xxvi
November 2009
Dial Commands Additional Information
•
Output Interpreter, a troubleshooting tool that analyzes command output of supported show commands https://www.cisco.com/pcgi-bin/Support/OutputInterpreter/home.pl
CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY, PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0910R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. © 2008—2009 Cisco Systems, Inc. All rights reserved.
Cisco IOS Dial Technologies Command Reference November 2009
xxvii
Dial Commands Additional Information
Cisco IOS Dial Technologies Command Reference
xxviii
November 2009
CONTENTS
About Cisco IOS and Cisco IOS XE Software Documentation Documentation Objectives Audience
iii iii
iii
Documentation Conventions iv Typographic Conventions iv Command Syntax Conventions Software Conventions v Reader Alert Conventions v
iv
Documentation Organization v Cisco IOS Documentation Set vi Cisco IOS Documentation on Cisco.com vi Configuration Guides, Command References, and Supplementary Resources Additional Resources and Documentation Feedback
xiii
vii
Using the Command-Line Interface in Cisco IOS and Cisco IOS XE Software Initially Configuring a Device
xv
xv
Using the CLI xvi Understanding Command Modes xvi Using the Interactive Help Feature xix Understanding Command Syntax xx Understanding Enable and Enable Secret Passwords xxii Using the Command History Feature xxii Abbreviating Commands xxiii Using Aliases for CLI Commands xxiii Using the no and default Forms of Commands xxiv Using the debug Command xxiv Filtering Output Using Output Modifiers xxiv Understanding CLI Error Messages xxv Saving Changes to a Configuration Additional Information
xxvi xxvi
Cisco IOS Dial Technologies Command Reference November 2009
xxix
Contents
Introduction
DIA-1 DIA-3 DIA-4
Dial Commands
aaa authorization configuration default aaa route download arap callback
DIA-7 DIA-8 DIA-9 DIA-10 DIA-12 DIA-13 DIA-14 DIA-5
async default routing async dynamic address async dynamic routing async mode dedicated async mode interactive
autodetect encapsulation autohangup autoselect backup delay
DIA-16 DIA-17 DIA-19 DIA-20
backup interface backup load busyout (port) busyout (spe)
backup interface dialer
DIA-24 DIA-26
DIA-22
busyout (privileged EXEC)
DIA-29
DIA-27
call progress tone country callback forced-wait callback nodsr-wait calltracker call-record calltracker enable
DIA-34
DIA-31
DIA-33
called-number (modem pool)
DIA-37 DIA-40
DIA-35
calltracker history max-size calltracker history retain-mins calltracker timestamp call-type cas-custom
DIA-46 DIA-47 DIA-48
DIA-42 DIA-43
DIA-44
call-type cas
cas-group (E1 controller) cas-group (T1 controller) channel-group
DIA-64
DIA-55 DIA-59
Cisco IOS Dial Technologies Command Reference
xxx
November 2009
Contents
chat-script
DIA-69 DIA-72 DIA-73 DIA-74
class (controller) clear cot summary clear counters line clear dialer
clear counters (async)
DIA-78
DIA-76
clear dialer dnis clear dsip tracing
DIA-79 DIA-81
clear dialer sessions
DIA-82 DIA-83
clear interface virtual-access clear ip route download clear line
DIA-85 DIA-86
DIA-84
clear line async-queue clear modem
DIA-87
clear modem counters clear modem log clear port
DIA-95 DIA-97
DIA-89
DIA-91 DIA-93
clear modempool-counters clear port log
clear resource-pool clear spe
DIA-101
DIA-99 DIA-100
clear snapshot quiet-time clear spe counters clear spe log clid group copy modem corlist outgoing
DIA-107 DIA-108 DIA-103
DIA-105
clock source line corlist incoming cpp authentication cpp callback accept debounce-time rai dialer
DIA-124
DIA-110 DIA-113 DIA-115 DIA-116 DIA-118 DIA-121 DIA-123
description (interface) dialer callback-secure
DIA-125
Cisco IOS Dial Technologies Command Reference November 2009
xxxi
Contents
dialer callback-server dialer called dialer caller
DIA-129 DIA-130
DIA-127
dialer clid group dialer dnis group dialer dns dialer dtr
DIA-132 DIA-133
dialer congestion-threshold
DIA-134 DIA-136 DIA-137
dialer enable-timeout
DIA-138 DIA-140 DIA-142
dialer fast-idle (interface) dialer fast-idle (map-class) dialer hold-queue
DIA-143
dialer idle-timeout (interface) dialer idle-timeout (template) dialer in-band dialer isdn
DIA-148 DIA-149 DIA-150 DIA-152
DIA-144 DIA-146
dialer isdn short-hold dialer load-threshold dialer map
DIA-154
dialer map snapshot dialer max-call dialer order dialer outgoing dialer persistent dialer pool
DIA-165
DIA-161
DIA-163
DIA-167 DIA-168
DIA-170 DIA-172 DIA-174
dialer pool-member dialer pre-classify dialer priority dialer redial
DIA-175 DIA-177 DIA-179 DIA-180 DIA-181
dialer remote-name dialer reserved-links dialer rotary-group dialer rotor dialer string
DIA-183 DIA-185
dialer string (dialer profiles)
DIA-187
Cisco IOS Dial Technologies Command Reference
xxxii
November 2009
Contents
dialer string (legacy DDR) dialer string trunkgroup dialer voice-call dialer vpdn
DIA-192 DIA-193
DIA-188 DIA-190
dialer wait-for-carrier-time (interface) dialer wait-for-carrier-time (map-class) dialer wait-for-line-protocol dialer watch-disable dialer watch-group dialer watch-list dialer-group
DIA-198 DIA-199 DIA-200 DIA-204 DIA-196
DIA-194 DIA-195
dialer watch-list delay
DIA-206
dialer-group (template) dialer-list protocol (Dial) dial-peer cor custom dial-peer cor list
DIA-207 DIA-209
DIA-212
DIA-213 DIA-214
dial-shelf split backplane-ds0 dial-shelf split slots
DIA-216
dial-shelf split slots none dial-shelf split slots remove dial-tdm-clock disconnect dnis group
DIA-220 DIA-222 DIA-223
DIA-218 DIA-219
ds0 busyout (channel) ds0 busyout-threshold ds0-group (controller e1) encap-sequence encapsulation cpp firmware location firmware upgrade flowcontrol group-range interface bri
DIA-224 DIA-226 DIA-228
DIA-232 DIA-234 DIA-236
failover group-number
DIA-238 DIA-241
DIA-244 DIA-246 DIA-247 DIA-250
interface dialer
Cisco IOS Dial Technologies Command Reference November 2009
xxxiii
Contents
interface multilink interface serial interface virtual-ppp
DIA-251
DIA-253 DIA-255 DIA-256
interface virtual-template ip address negotiated ip address-pool
DIA-260
DIA-259
ip dhcp-client network-discovery ip dhcp client route ip dhcp-server ip idle-group ip local pool ip route
DIA-264 DIA-265 DIA-267 DIA-268
DIA-262
DIA-272 DIA-276
ip route (large-scale dial-out) ip rtp reserve
DIA-278
ip tcp async-mobility server ip telnet comport ip telnet hidden ip telnet quiet ip telnet tos ipx ppp-client
DIA-280 DIA-282 DIA-284
DIA-279
ip telnet timeout retransmit
DIA-287
DIA-286
ipx compression cipx
DIA-289
DIA-288
isdn all-incoming-calls-v120 isdn answer1, isdn answer2 isdn autodetect
DIA-294
DIA-291 DIA-292
isdn bcac service audit
DIA-295 DIA-297 DIA-299 DIA-301
isdn bcac service audit interface isdn bcac service audit trigger isdn bcac service retry max isdn bcac service timer
isdn bcac service retry in-serv-on-fail
DIA-303 DIA-305
isdn bcac service update linkup isdn bchan-number-order isdn busy
DIA-313
DIA-307 DIA-309
isdn bcac service update provision
DIA-311
Cisco IOS Dial Technologies Command Reference
xxxiv
November 2009
Contents
isdn call interface isdn caller
DIA-316
DIA-315
isdn calling-number isdn calling-party-num isdn conference-code isdn disconnect-cause
DIA-318 DIA-320 DIA-322
isdn channel-id invert extended-bit
DIA-323 DIA-324 DIA-325 DIA-326
isdn disconnect interface isdn fast-rollover-delay isdn flip-chan-flag isdn guard-timer isdn incoming ie
DIA-328 DIA-329 DIA-330
isdn incoming alerting add-PI
DIA-333 DIA-335 DIA-337
isdn incoming-voice isdn layer1-emulate isdn layer2-flap isdn logging isdn map isdn leased-line bri
DIA-343
DIA-338 DIA-340
DIA-342
isdn modem-busy-cause isdn negotiate-bchan isdn not-end-to-end isdn nsf-service isdn number isdn outgoing ie
DIA-351 DIA-352
DIA-346
DIA-347 DIA-349
DIA-350
isdn outgoing ie redirecting-number isdn outgoing-voice isdn overlap-receiving isdn piafs-enabled
DIA-359 DIA-360
DIA-357
isdn overlap-receiving calltypes all
DIA-363 DIA-364 DIA-365
DIA-362
isdn point-to-point-setup isdn protocol-emulate isdn reject
DIA-367
isdn send-alerting
DIA-369 DIA-371
isdn sending-complete
Cisco IOS Dial Technologies Command Reference November 2009
xxxv
Contents
isdn service
DIA-373 DIA-376 DIA-377
isdn silent-boot
isdn snmp busyout b-channel isdn spid1, isdn spid2 isdn spoofing isdn static-tei
DIA-380 DIA-382 DIA-383 DIA-386 DIA-378
isdn switch-type (BRI) isdn switch-type (PRI) isdn t306 isdn t310
DIA-389 DIA-391
isdn tei-negotiation (global) isdn tei-negotiation (interface) isdn test call interface isdn timer
DIA-399 DIA-402 DIA-404 DIA-406 DIA-407 DIA-408
DIA-393 DIA-394
DIA-397 DIA-398
isdn test disconnect interface isdn timer t309 isdn timer t321 isdn transfer-code isdn transparent isdn twait-disable isdn v110 only isdn v110 padding isdn voice-priority isdn x25 dchannel isdn x25 static-tei limit base-size line-power
DIA-409 DIA-411 DIA-412 DIA-414 DIA-416 DIA-417
l2tp tunnel retransmit initial retries
DIA-419 DIA-420
limit overflow-size
DIA-421
logging event nfas-status loopback (controller el) loopback local (controller) loopback local (interface) loopback remote (controller) map-class dialer
DIA-427
DIA-422 DIA-423 DIA-424 DIA-425 DIA-426
Cisco IOS Dial Technologies Command Reference
xxxvi
November 2009
Contents
member
DIA-430 DIA-431
member (dial peer cor list) modem always-on modem at-mode
DIA-432
modem answer-timeout
DIA-434
DIA-433
modem at-mode-permit
DIA-436 DIA-437
modem autoconfigure discovery modem autoconfigure type modem autotest modem bad modem buffer-size modem busyout modem callin modem callout
DIA-439 DIA-440 DIA-442 DIA-443
DIA-438
modem busyout-threshold
DIA-447 DIA-448 DIA-449
DIA-445
modem call-record modem country mica
DIA-453 DIA-455
modem country microcom_hdms modem country smart_acf modem cts-required modem dialin
DIA-462 DIA-464 DIA-461
DIA-458
modem dialout controller modem dtr-active modem enable modem host modem inout modem hold-reset
DIA-465 DIA-466
DIA-468
DIA-469 DIA-470 DIA-471 DIA-472
modem cts-alarm modem log
modem link-info poll time
DIA-474
modem min-speed max-speed modem poll retry modem poll time modem printer
DIA-476 DIA-477 DIA-478
DIA-475
modem recovery action
DIA-480
Cisco IOS Dial Technologies Command Reference November 2009
xxxvii
Contents
modem recovery maintenance modem recovery threshold modem recovery-time modem ri-is-cd modem shutdown modem startup-test modem status-poll modemcap edit modemcap entry modem-pool modemui multilink
DIA-497 DIA-501 DIA-488 DIA-489 DIA-490 DIA-491 DIA-486
DIA-482
DIA-485
DIA-492 DIA-493
DIA-495
modemui-version
DIA-502
multilink bundle-name multilink max-fragments multilink virtual-template multilink-group netbios nbf number
DIA-507
DIA-504 DIA-505 DIA-506
name (dial peer cor custom)
DIA-509
DIA-508
network-clock-priority
DIA-512
DIA-510
peer default ip address peer ip address forced peer match aaa-pools peer pool backup peer pool static pool-range port (global) ppp
DIA-534 DIA-535 DIA-537
DIA-515 DIA-518 DIA-520
DIA-522 DIA-524 DIA-526
permission (dial peer voice)
DIA-528 DIA-530
port modem autotest ppp accm
DIA-532
ppp acfc local ppp acfc remote ppp bap call
DIA-539
DIA-541
Cisco IOS Dial Technologies Command Reference
xxxviii
November 2009
Contents
ppp bap callback ppp bap drop ppp bap max ppp bap link types
DIA-542
DIA-543 DIA-544
DIA-545 DIA-547
ppp bap monitor load ppp bap number ppp bap timeout ppp bridge ip ppp bridge ipx
DIA-548 DIA-551 DIA-553
ppp bridge appletalk
DIA-554
DIA-555 DIA-557 DIA-558
ppp callback (DDR) ppp caller name ppp direction ppp dnis
DIA-563
ppp callback (PPP client)
DIA-560 DIA-561
ppp encrypt mppe ppp hold-queue ppp ipcp
DIA-568
DIA-565 DIA-567
ppp ipcp default route ppp ipcp predictive ppp iphc max-header ppp lcp delay
DIA-576
DIA-571 DIA-572 DIA-574
ppp iphc max-period ppp iphc max-time ppp lcp delay ppp lcp fast-start ppp lcp predictive ppp link reorders ppp max-bad-auth ppp max-configure ppp max-failure ppp microcode ppp mru match ppp max-terminate ppp loopback ignore
DIA-579 DIA-581
DIA-583 DIA-585 DIA-586 DIA-588 DIA-589 DIA-591 DIA-592 DIA-594 DIA-596
DIA-598 DIA-599
Cisco IOS Dial Technologies Command Reference November 2009
xxxix
Contents
ppp ms-chap refuse ppp ms-chap-v2 refuse ppp mtu adaptive ppp multilink
DIA-600 DIA-602
DIA-604
DIA-606 DIA-609 DIA-611 DIA-613 DIA-615
ppp multilink endpoint
ppp multilink fragment delay ppp multilink fragment disable
ppp multilink fragment maximum ppp multilink fragment size ppp multilink fragmentation ppp multilink group ppp multilink idle-link ppp multilink interleave
DIA-619 DIA-621 DIA-623
DIA-616 DIA-618
ppp multilink links maximum ppp multilink links minimum ppp multilink load-threshold ppp multilink mrru
DIA-634
DIA-628 DIA-630 DIA-632
ppp multilink multiclass
DIA-637 DIA-641 DIA-644 DIA-647
ppp multilink multiclass local ppp multilink multiclass remote ppp multilink ncp sequenced ppp multilink slippage ppp pap wait ppp pfc local ppp pfc remote ppp quality ppp reliable-link ppp timeout aaa ppp timeout idle
DIA-651 DIA-652 DIA-654
DIA-649
DIA-656 DIA-657 DIA-659 DIA-660
ppp timeout authentication
DIA-661
ppp timeout idle (template) ppp timeout multilink link add
DIA-662 DIA-664 DIA-666 DIA-668
ppp timeout multilink link remove ppp timeout multilink lost-fragment ppp timeout ncp
DIA-669
Cisco IOS Dial Technologies Command Reference
xl
November 2009
Contents
ppp timeout retry pri-group timeslots profile incoming range
DIA-677
DIA-670 DIA-672 DIA-676
rcapi number rcapi server redundancy resource
DIA-679 DIA-680 DIA-681 DIA-684
reload components
DIA-686
resource-pool
DIA-688 DIA-689
resource-pool aaa accounting ppp resource-pool aaa protocol resource-pool call treatment resource-pool group resource resource-pool profile customer resource-pool profile service resource-pool profile vpdn retry keepalive rotary
DIA-704 DIA-707 DIA-709 DIA-711 DIA-702
DIA-691 DIA-692 DIA-693
resource-pool call treatment discriminator
DIA-694 DIA-696 DIA-698
resource-pool profile discriminator
DIA-700
DIA-699
rotary-group
script activation script callback show caller script dialer script reset script startup sgbp dial-bids sgbp group sgbp member script connection
script arap-callback
DIA-715
DIA-713
DIA-718
DIA-720 DIA-722 DIA-724 DIA-726
set ip next-hop dynamic dhcp
DIA-727 DIA-728 DIA-729 DIA-730
sgbp ppp-forward
Cisco IOS Dial Technologies Command Reference November 2009
xli
Contents
sgbp protocol sgbp seed-bid shelf-id
DIA-731 DIA-733
DIA-735 DIA-737
show async status show backup show busyout
DIA-739 DIA-740 DIA-743 DIA-747 DIA-748 DIA-754
show call calltracker active show call calltracker handle show call calltracker history
show call calltracker summary show call progress tone show caller
DIA-759
DIA-756
show interfaces virtual-access show controllers bri
DIA-767
DIA-761
show controllers e1 call-counters show controllers e1 cas-data show controllers t1 cas-data show controllers t1 clock show controllers t1 call-counters
DIA-782
DIA-774
DIA-776 DIA-778
DIA-780
show controllers t1 firmware-status show controllers t1 timeslots show cot dsp
DIA-786 DIA-788 DIA-790
DIA-783
DIA-784
show cot request show cot summary show dhcp show dialer
DIA-792 DIA-794 DIA-798 DIA-800
show dialer dnis show dialer map show dial-shelf show dsc clock show dsi show dsip
show dialer interface bri
DIA-803
show dialer sessions show dial-shelf split
DIA-812 DIA-819
DIA-805
DIA-806 DIA-809
DIA-810
Cisco IOS Dial Technologies Command Reference
xlii
November 2009
Contents
show dsip clients show dsip nodes show dsip ports show dsip queue show dsip tracing show dsip transport show dsip version show interfaces bri
DIA-822 DIA-824 DIA-826 DIA-829 DIA-830 DIA-832 DIA-835 DIA-837 DIA-842 DIA-843 DIA-849
show interfaces serial bchannel show interfaces virtual-access show ip interface virtual-access show ip local pool
DIA-851 DIA-854 DIA-855 DIA-856
show ip route track-table show ipx compression show ipx spx-protocol show isdn
DIA-858
show isdn nfas group show line async-queue show modem
DIA-876
DIA-872 DIA-875
show modem at-mode show modem call-stats show modem calltracker
DIA-885 DIA-886
show modem bundled-firmware
DIA-887 DIA-893
show modem configuration show modem connect-speeds show modem cookie show modem csm show modem log show modem mica
DIA-895 DIA-901
DIA-907 DIA-908
DIA-910 DIA-921
show modem mapping
DIA-924 DIA-928
show modem operational-status show modem summary show modem test show modemcap show modem version
DIA-944 DIA-945 DIA-947
DIA-953
Cisco IOS Dial Technologies Command Reference November 2009
xliii
Contents
show modem-pool show nbf cache show nbf sessions show port config show port log show port digital log
DIA-956 DIA-958 DIA-961 DIA-963 DIA-968
DIA-971 DIA-979
show port modem calltracker show port modem log show port modem test show ppp bap
DIA-1003 DIA-1006 DIA-982
DIA-990 DIA-993
show port operational-status show ppp multilink show rcapi status
show queuing virtual-access
DIA-1013
DIA-1011
show resource-pool call
DIA-1014 DIA-1015 DIA-1017
show resource-pool customer show resource-pool resource show resource-pool vpdn show sessions show sgbp
DIA-1024 DIA-1025 DIA-1026
show resource-pool discriminator
DIA-1021
DIA-1019
show sgbp queries show snapshot show spe show spe digital
DIA-1029
DIA-1027
DIA-1033 DIA-1035
show spe digital active show spe digital csr
DIA-1037 DIA-1039
show spe digital disconnect-reason show spe digital summary show spe log
DIA-1043 DIA-1045 DIA-1048 DIA-1050 DIA-1041
show spe modem
show spe modem active show spe modem csr
show spe modem disconnect-reason show spe modem high speed
DIA-1052
DIA-1054
Cisco IOS Dial Technologies Command Reference
xliv
November 2009
Contents
show spe modem high standard show spe modem low speed show spe modem low standard show spe modem summary show spe recovery show spe version
DIA-1068 DIA-1071
DIA-1058
DIA-1060 DIA-1062
DIA-1065
show tech-support modem show tech-support spe show tgrm
DIA-1083 DIA-1085 DIA-1088 DIA-1091 DIA-1093
DIA-1078
DIA-1080
show trunk group show vtemplate shutdown (port) shutdown (spe) snapshot client snapshot server source template spe
DIA-1099
signaling-class cas
DIA-1094
DIA-1095 DIA-1097 DIA-1098
spe call-record modem spe country spe log-size spe recovery start-character start-chat stop-character tdm clock priority template
DIA-1117 DIA-1103
DIA-1101
spe download maintenance
DIA-1108 DIA-1109 DIA-1111
DIA-1106
DIA-1112 DIA-1114 DIA-1115
test modem back-to-back timeout absolute timer
DIA-1123 DIA-1122
DIA-1119 DIA-1120
test port modem back-to-back
trunk group (global) tunnel
DIA-1131
DIA-1125 DIA-1127
trunk-group (timeslots)
Cisco IOS Dial Technologies Command Reference November 2009
xlv
Contents
virtual-profile if-needed vty-async
DIA-1134
DIA-1132 DIA-1133
virtual-profile virtual-template vty-async dynamic-routing
DIA-1136 DIA-1137 DIA-1138
vty-async header-compression vty-async ipx ppp-client loopback vty-async keepalive vty-async mtu
DIA-1139 DIA-1140
vty-async ppp authentication vty-async ppp use-tacacs vty-async virtual-template x25 aodi
DIA-1145 DIA-1146
DIA-1141
DIA-1142 DIA-1143
x25 map ppp
Cisco IOS Dial Technologies Command Reference
xlvi
November 2009
Introduction
This book contains the commands to configure and maintain Cisco IOS dial and access applications. These applications are documented in the following parts of the Cisco IOS Dial Technologies Configuration Guide:
• • • • • • • • • • • •
Dial Interfaces, Controllers, and Lines Modem Configuration and Management ISDN Configuration Signaling Configuration Dial-on-Demand Routing Configuration Dial-Backup Configuration Dial-Related Addressing Services Configuring Virtual Templates and Profiles PPP Configuration Callback and Bandwidth Allocation Configuration Dial Access Specialized Features Dial Access Scenarios
Cisco IOS Dial Technologies Command Reference November 2009
DIA-1
Dial Commands
Cisco IOS Dial Technologies Command Reference
DIA-2
November 2009
Dial Commands
Cisco IOS Dial Technologies Command Reference November 2009
DIA-3
Dial Commands aaa authorization configuration default
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
radius tacacs+
RADIUS static route download. TACACS+ static route download.
Command Default
No configuration authorization is defined.
Command Modes
Global configuration
Command History
Release 12.0(3)T
Modification This command was introduced.
Examples
The following example downloads static route information using a TACACS+ server:
aaa authorization configuration default tacacs+
Related Commands
Command aaa new-model aaa route download clear ip route download show ip route
Description Enables the AAA access control model. Enables the download static route feature and sets the amount of time between downloads. Clears static routes downloaded from a AAA server. Displays all static IP routes, or those installed using the AAA route download function.
Cisco IOS Dial Technologies Command Reference
DIA-4
November 2009
Dial Commands aaa route download
aaa route download
To enable the static route download 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] [authorization method-list] no aaa route download
Syntax Description
time authorization method-list
(Optional) Time between downloads, in minutes. The range is from 1 to 1440 minutes. (Optional) Specify a named method list to which RADIUS authorization requests for static route downloads are sent. If these attributes are not set, all RADIUS authorization requests will be sent to the servers that are specified by the default method list.
Command Default
The default period between downloads (updates) is 720 minutes.
Command Modes
Global configuration
Command History
Release 12.0(3)T 12.1 12.2(8)T 12.2(28)SB
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.1. The authorization keyword was added; the method-list argument was added. This command was integrated into Cisco IOS Release 12.2(28)SB.
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 100
The following example sets the AAA route update period to 10 minutes and sends static route download requests to the servers specified by the method list name “list1”:
aaa route download 10 authorization list1
Cisco IOS Dial Technologies Command Reference November 2009
DIA-5
Dial Commands aaa route download
Related Commands
Command aaa authorization configuration default clear ip route download show ip route
Description Downloads static route configuration information from the AAA server using TACACS+ or RADIUS. Clears static routes downloaded from a AAA server. Displays all static IP routes, or those installed using the AAA route download function.
Cisco IOS Dial Technologies Command Reference
DIA-6
November 2009
Dial Commands arap callback
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.
Command Default
Callback requests are not accepted on lines configured for ARA.
Command Modes
Global configuration
Command History
Release 11.1
Modification This command was introduced.
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 callback
Related Commands
Command arap callback autoselect ppp bap call ppp callback (DDR)
Description Enables an ARA client to request a callback from an ARA client. Configures a line to start an ARA, PPP, or SLIP session. Sets PPP BACP call parameters. Enables a dialer interface that is not a DTR interface to function either as a callback client that requests callback or as a callback server that accepts callback requests. Enables the Cisco IOS software to call back clients that request a callback from the EXEC level. Enables virtual profiles by AAA configuration.
server (RLM) virtual-profile aaa
Cisco IOS Dial Technologies Command Reference November 2009
DIA-7
Dial Commands async default routing
async default routing
Note
Beginning in Cisco IOS Release 12.3(11)T, the async default routing command is replaced by the routing dynamic command. See the routing dynamic command for more information. To enable the router to pass routing updates to other routers over 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.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 10.0 12.3(11)T
Modification This command was introduced. This command was replaced by the routing dynamic command.
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 0 async default routing
Related Commands
Command async dynamic routing
Description Enables manually configured routing on an asynchronous interface.
Cisco IOS Dial Technologies Command Reference
DIA-8
November 2009
Dial Commands async dynamic address
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.
Command Default
Dynamic addressing is disabled.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
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 0 ip address 10.0.0.1 255.0.0.0 interface async 6 async dynamic address
Related Commands
Command peer default ip address
Description Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-9
Dial Commands async dynamic routing
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.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
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 1 async dynamic routing async dynamic address async default ip address 10.1.1.2 ip tcp header-compression passive
A 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.
Cisco IOS Dial Technologies Command Reference
DIA-10
November 2009
Dial Commands async dynamic routing
Related Commands
Command async default routing async dynamic address
Description Enables the router to pass routing updates to other routers over the AUX port configured as an asynchronous interface. Specifies dynamic asynchronous addressing versus default addressing.
ip tcp header-compression Enables TCP header compression.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-11
Dial Commands async mode dedicated
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.
Command Default
Asynchronous mode is disabled.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
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 4 async default ip address 172.31.7.51 async mode dedicated encapsulation slip line 20 location remote computer stopbits 1 speed 115200
Related Commands
Command async dynamic address async mode interactive
Description Specifies dynamic asynchronous addressing. Returns a line that has been placed into dedicated asynchronous network mode to interactive mode, thereby enabling the slip and ppp EXEC commands.
Cisco IOS Dial Technologies Command Reference
DIA-12
November 2009
Dial Commands async mode interactive
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.
Command Default
Asynchronous mode is disabled.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
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 6 async default ip address 172.31.7.51 async mode interactive ip unnumbered ethernet 0
Related Commands
Command
Description
async mode dedicated Places a line into dedicated asynchronous mode using SLIP or PPP encapsulation. ppp slip Starts an asynchronous connection using PPP. Starts a serial connection to a remote host by using SLIP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-13
Dial Commands autodetect encapsulation
autodetect encapsulation
To enable automatic detection of the encapsulation types operating over a point-to-point link to a specified serial or ISDN interface or dialer interface under Media Gateway Control Protocol (MGCP) network access server (NAS) packages, 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 ppp v120
Link Access Procedure, Balanced (LAPB) for an ISDN terminal adapter. PPP encapsulation on the interface. V.120 encapsulation on B channels.
Command Default
No default behavior or values.
Command Modes
Interface configuration
Command History
Release 11.2 12.0(4)T 12.3(7)YB 12.4(6)T
Modification This command was introduced. The lapb-ta keyword was added. Support was added for MGCP NAS packages. Support for MGCP NAS packages was integrated into Cisco IOS Release 12.4(6)T.
Usage Guidelines
At least one encapsulation type must be specified, but you can specify multiple encapsulation types. Encapsulation types can be specified in any order. Use this command to enable the specified serial or ISDN interface or dialer interface under an MGCP NAS package 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 possible by issuing the lapb-ta keyword. This allows recognition of incoming LAPB-terminal adapter (TA) calls. Automatic detection is attempted for 10 seconds after the link is established or the first five packets exchanged over the link, whichever is first.
Cisco IOS Dial Technologies Command Reference
DIA-14
November 2009
Dial Commands autodetect encapsulation
Examples
The following example configures BRI 0 to call and receive calls from two sites, use 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 0 encapsulation ppp autodetect encapsulation v120 no keepalive dialer map ip 172.17.36.10 name EB1 234 dialer map ip 172.17.36.9 name EB2 456 dialer-group 1 isdn spid1 0146334600 isdn spid2 0146334610 isdn T200 1000 ppp authentication chap
The 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-async interface serial0:23 autodetect encapsulation lapb-ta v120
The following example enables PPP encapsulation and LAPB-TA and V.120 protocols for autodetection on the dialer interface under an MGCP NAS package:
interface Dialer1 ip unnumbered Loopback1 encapsulation ppp dialer in-band dialer idle-timeout 240 dialer extsig dialer-group 1 autodetect encapsulation ppp v120 lapb-ta ppp authentication chap !
Related Commands
Command encapsulation
Description Sets the encapsulation method used by the interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-15
Dial Commands autohangup
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.
Command Default
Disabled
Command Modes
Line configuration
Command History
Release 10.0
Modification This command was introduced.
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 10 autohangup
Related Commands
Command exit (EXEC)
Description Closes an active terminal session by logging off the router.
Cisco IOS Dial Technologies Command Reference
DIA-16
November 2009
Dial Commands autoselect
autoselect
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
arap ppp slip during-login timeout seconds
ARA session. PPP session. SLIP session. Displays the username or password prompt without the user pressing the Return key. After the user logs in, the autoselect function begins. Timeout period from 1 to 120 seconds for the autoselect process. This argument applies only when the arap, ppp, or slip keyword functions are enabled and has no effect when the during-login keyword function is enabled.
Command Default
ARA session No timeout default
Command Modes
Line configuration
Command History
Release 10.3 11.3
Modification This command was introduced. The following keywords were added:
• • •
during-login no autoselect timeout seconds
Usage Guidelines
This command eliminates the need for users to enter an EXEC command to start an ARA, PPP, or SLIP session.
Note
SLIP does not support authentication. For PPP and ARAP, you must enable authentication. 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
Cisco IOS Dial Technologies Command Reference November 2009
DIA-17
Dial Commands autoselect
starts a PPP or SLIP session, respectively. This command is used on lines making different types of connections. You should configure autoselect ppp when the gateway is configured for interactive PPP authentication. You do not need to configure autoselect ppp for dedicated PPP configurations.
Note
If you configure autoselect ppp, you should not configure a no exec under the same line; these processes are mutally exclusive. 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
After the modem connection is established, a Return is required to evoke a response, such as to get the username prompt. You might need to update your scripts to include this requirement. Additionally, the activation character should be set to the default and the exec-character-bits set to 7. If you change these defaults, the application cannot recognize the activation request.
Examples
The following example enables ARA on a line:
line 3 arap enable autoselect arap
The following example enables a timeout of 30 seconds on a PPP-enabled line:
line 7 autoselect ppp autoselect timeout 30
The 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 3 arap enable autoselect arap autoselect during-login arap noguest if-needed
Related Commands
Command arap use-tacacs arap warning time exec ppp authentication chap ppp authentication pap ppp bap call ppp use-tacacs
Description Enables TACACS for ARA authentication. Sets when a disconnect warning message is displayed. Allows an EXEC process on a line, use the exec command in line configuration mode. Enables CHAP or PAP or both and specifies the order in which CHAP and PAP authentication are selected on the interface. Enables CHAP or PAP or both and specifies the order in which CHAP and PAP authentication are selected on the interface. Sets PPP BACP call parameters. Enables TACACS for PPP authentication.
Cisco IOS Dial Technologies Command Reference
DIA-18
November 2009
Dial Commands backup delay
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
enable-delay-period disable-delay-period never
Number of seconds that elapse after the primary line goes down before the Cisco IOS software activates the secondary line. Number of seconds that elapse after the primary line comes up before the Cisco IOS software deactivates the secondary line. Secondary line is never activated or deactivated.
Command Default
0 second delay
Command Modes
Interface configuration
Command History
Release 10.0 12.2(33)SRB1
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(33)SRB1.
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. For the Cisco 7600 Backup Interface for Flexible UNI feature to work correctly, the enable and disable backup delay must be 0.
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 0 backup delay 0 10
Cisco IOS Dial Technologies Command Reference November 2009
DIA-19
Dial Commands backup interface
backup interface
To configure an interface as a secondary or dial backup, use the backup interface command in interface configuration mode. To disable the interface from serving as a backup, 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 type number no backup interface type number
Syntax Description
slot/port-adapter/port
The chassis slot, port adapter, and port number of the interface to configure as a backup. Include a slash (/) between slot, port-adapter, and port (for example, 1/1/1). See your hardware installation manual for the specific slot, port adapter, and port numbers. Type and port number of the interface being configured as a backup.
type number
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 11.0 12.2(33)SRB1
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(33)SRB1.
Usage Guidelines
The interface you define with this command can back up only one other interface. Routers support only serial and ISDN backup interfaces. Access servers support both asynchronous and serial backup interfaces. In Cisco IOS Release 12.2(33)SRB1 and later releases, you can configure a backup interface for Gigabit Ethernet on the Cisco 7600 router. The configurations on the primary and backup interfaces must match or the backup interface does not work. Note, however, that if the interface configuration includes the xconnect command, you must specify a different virtual circuit ID (VCID) on the primary and backup interfaces.
Cisco IOS Dial Technologies Command Reference
DIA-20
November 2009
Dial Commands backup interface
Examples
The following example sets serial 1 as the backup line to serial 0:
interface serial 0 backup interface serial 1
The following example sets gigabitEthernet4/0/1 as the backup interface for gigabitEthernet3/0/1 on the Cisco 7600 router:
interface gigabitEthernet 3/0/1 backup interface gigabitEthernet 4/0/1
Related Commands
Command xconnect
Description Configures a pseudowire for transporting data over the network.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-21
Dial Commands backup interface dialer
backup 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
number
Dialer interface number to use as the backup interface.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
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 dialer0 ip unnumbered loopback0 encapsulation ppp dialer remote-name Remote0 dialer pool 1 dialer string 5550112 dialer-group 1 interface dialer1 ip unnumbered loopback0 encapsulation ppp dialer remote-name Remote1 dialer pool 1 dialer string 5550134 dialer-group 1 interface bri 0 encapsulation PPP dialer pool-member 1 ppp authentication chap
Cisco IOS Dial Technologies Command Reference
DIA-22
November 2009
Dial Commands backup interface dialer
interface serial 0 ip unnumbered loopback0 backup interface dialer 0 backup delay 5 10 interface serial 1 ip unnumbered loopback0 backup interface dialer 1 backup delay 5 10
Cisco IOS Dial Technologies Command Reference November 2009
DIA-23
Dial Commands backup load
backup 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
enable-threshold disable-load
Percentage of the primary line’s available bandwidth that the traffic load must exceed to enable dial backup. Percentage of the available bandwidth that the traffic load must be less than to disable dial backup. The transmitted or received load on the primary line plus the transmitted or received load on the secondary line is less than the value entered for the disable-load argument to disable dial backup. The secondary line is never activated or deactivated because of the traffic load.
never
Command Default
No threshold is defined.
Command Modes
Interface configuration
Command History
Release 10.0 12.2(33)SRB1
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(33)SRB1.
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:
• •
The transmitted load on the primary line plus the transmitted load on the secondary line is less than the value entered for the disable-load argument. The received load on the primary line plus the received load on the secondary line is less than the value entered for the disable-load argument.
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.
Cisco IOS Dial Technologies Command Reference
DIA-24
November 2009
Dial Commands backup 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 0 backup load 60 5 backup interface serial 1
Cisco IOS Dial Technologies Command Reference November 2009
DIA-25
Dial Commands busyout (port)
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 reenable the ports, use the no form of this command. busyout no busyout
Syntax Description
This command has no arguments or keywords.
Command Default
Busyout is not enabled.
Command Modes
Port configuration
Command History
Release 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5400. This command was implemented on the Cisco AS5800. This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
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 reenable the ports.
Examples
The following example will disable service processing element (SPE) ports 1 to 10 on slot 1 once active services have terminated:
Router(config)# port 1/1 1/10 Router(config-port)# busyout
Related Commands
Command clear port clear spe shutdown (port) show spe
Description Resets the NextPort port and clears any active call. Reboots all specified SPEs. Disables a port. Displays SPE status.
Cisco IOS Dial Technologies Command Reference
DIA-26
November 2009
Dial Commands busyout (privileged EXEC)
busyout (privileged EXEC)
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 (privileged EXEC) 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 include the slash marks.
Command Default
Busyout is disabled.
Command Modes
Privileged EXEC
Command History
Release 11.3(2)AA 12.0
Modification This command was introduced and supported T1 and T3 only. 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 signaling, there is a limit on the amount of traffic that the exchange can accept on the signaling channel. The restrictions are as follows:
• •
A busyout can take 1 or 2 minutes to complete for a T1 or T2 trunk card. The no busyout command cannot be used within 3 minutes of the busyout command and vice versa; otherwise, the command will be rejected.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-27
Dial Commands busyout (privileged EXEC)
Examples
The following example enables busyout on the card in dial shelf 5, slot 4, port 1:
busyout 5/4/1
Related Commands
Command ds0 busyout (channel) modem busyout
Description Forces a DS0 timeslot on a controller into the busyout state. Disables a modem from dialing or answering calls whereby the disabling action is not executed until the active modem returns to an idle state. Abruptly shuts down an active or idle modem installed in an access server or router. Displays information about the dial shelf, including clocking information.
modem busyout-threshold Maintains a balance between the number of DS0s and modems. modem shutdown show dial-shelf
Cisco IOS Dial Technologies Command Reference
DIA-28
November 2009
Dial Commands busyout (spe)
busyout (spe)
To disable active calls on the specified service processing elements (SPEs), use the busyout command in SPE configuration mode. To reenable the SPEs, use the no form of this command. busyout no busyout
Syntax Description
This command has no arguments or keywords.
Command Default
Busyout is not enabled.
Command Modes
SPE configuration
Command History
Release 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5400. This command was implemented on the Cisco AS5800. This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
You can perform autodiagnostic 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 display the state of the range of SPEs. Use the shutdown command to override the busyout command. Use the no busyout command to reenable the SPEs.
Examples
The following example shows all active ports on SPE 1 to 10 on slot 1 being busied out:
spe 1/1 1/10 busyout
Related Commands
Command clear port clear spe shutdown (port) show spe
Description Resets the NextPort port and clears any active call. Reboots all specified SPEs. Disables a port. Displays SPE status.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-29
Dial Commands busyout (spe)
Cisco IOS Dial Technologies Command Reference
DIA-30
November 2009
Dial Commands call progress tone country
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
country-name
Selects default call progress tones (ring and cadence settings) for the specified country. Valid entries are: argentina, australia, austria, belgium, brazil, canada, china, colombia, cyprus, czech-republic, denmark, finland, france, germany, greece, hongkong, hungary, iceland, india, indonesia, ireland, israel, italy, japan, korea, luxembourg, malaysia, mexico, netherlands, peru, philippines, poland, portugal, russia, singapore, slovakia, slovenia, south-africa, spain, sweden, switzerland, taiwan, thailand, turkey, unitedkingdom, usa, and venezuela.
Command Default
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
Release 12.0(3)XG 12.0(4)XI
Modification This command was introduced. 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.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-31
Dial Commands call progress tone country
Examples
The following example shows the call progress tone set for Japan tone parameters:
call progress tone country japan
Related Commands
Command show call progress tone
Description Displays the contents of the internal CP tone database for a specific country.
Cisco IOS Dial Technologies Command Reference
DIA-32
November 2009
Dial Commands callback forced-wait
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.
Command Default
The forced waiting period is not set.
Command Modes
Global configuration
Command History
Release 11.1
Modification This command was introduced.
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-wait
Related Commands
Command arap callback chat-script debug callback ppp callback (DDR)
Description Enables an ARA client to request a callback from an ARA client. Places calls over a modem and logs in to remote systems. Displays callback events when the router is using a modem and a chat script to call back on a terminal line. Enables a dialer interface that is not a DTR interface to function either as a callback client that requests callback or as a callback server that accepts callback requests. Defines the IP addresses of the server. Enables virtual profiles by AAA configuration.
server (RLM) virtual-profile aaa
Cisco IOS Dial Technologies Command Reference November 2009
DIA-33
Dial Commands callback nodsr-wait
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
Release 11.2(6.1)P
Modification This command was introduced.
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/107 callback nodsr-wait 10000
Related Commands
Command callback forced-wait debug callback
Description Sets a waiting period when DSR signals decrease after a callback, before the router attempts another callback. Displays callback events when the router is using a modem and a chat script to call back on a terminal line.
Cisco IOS Dial Technologies Command Reference
DIA-34
November 2009
Dial Commands called-number (modem pool)
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 max-conn number
Called number for a modem pool. (Optional) Maximum number of simultaneous connections allowed for the called party number.
Command Default
Disabled
Command Modes
Modem pool configuration
Command History
Release 11.2P
Modification This command was introduced.
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
Modem pools using MICA technologies or Microcom modems support incoming analog calls over ISDN PRI. However, only MICA modems support modem pooling for CT1 and CE1 configurations with channel associated signaling.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-35
Dial Commands called-number (modem pool)
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 5550112 max-conn 55 command assigns the DNIS number 5550112 to the v90service modem pool. The total number of simultaneous connections is limited to 55. The called-number 5550132 max-conn 55 command assigns the DNIS number 5550132, 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 v90service pool-range 1-110 called-number 5550112 max-conn 55 called-number 4440132 max-conn 55
The 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 30
Related Commands
Command
Description
clear modempool-counters Clears active or running counters associated with one or more modem pools. modem-pool Creates a new modem pool or specifies an existing modem pool, which allows you to physically or virtually partition your access server for dial-in and dial-out access. Assigns a range of modems to a modem pool. Displays the configuration and connection status for one or more modem pools.
pool-range show modem-pool
Cisco IOS Dial Technologies Command Reference
DIA-36
November 2009
Dial Commands calltracker call-record
calltracker call-record
To enable call record system logging (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
terse verbose quiet
Generates a brief set of call records containing a subset of the data stored within Call Tracker used primarily to manage calls. Generates a complete set of call records containing all of the data stored within Call Tracker used primarily to debug calls. (Optional) Call record will be sent only to the configured syslog server and not to the console.
Command Default
Call Tracker call record logging is disabled.
Command Modes
Global configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
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.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-37
Dial Commands calltracker call-record
The following informational logs are available:
• • •
CALL_RECORD provides generic data information shared for all call categories. This record is generated for both terse and verbose configuration options. MODEM_CALL_RECORD provides overall modem call information for modem calls only. This record is generated for both terse and verbose configuration options. MODEM_LINE_CALL_REC provides modem transport physical layer information used to debug modem connection problems for modem calls only. This record is generated for the verbose configuration option only. MODEM_INFO_CALL_REC provides modem status information used to debug modem problems for modem calls only. This record is generated for the verbose configuration option only. MODEM_NEG_CALL_REC provides client-host negotiation information used to debug modem negotiation problems for modem calls only. This record is generated for the verbose configuration option only.
• •
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 AE0301FFFFE1C07A707A70D650D6500
Cisco IOS Dial Technologies Command Reference
DIA-38
November 2009
Dial Commands calltracker call-record
Related Commands
Command calltracker history max-size calltracker history retain-mins show call calltracker history show call calltracker summary
Description Sets the maximum calls saved in the history table. Sets the number of minutes to save calls in the history table. Displays all information stored within the Call Tracker history database table for the most recent disconnected calls. Displays Call Tracker activity and configuration information such as the number of active calls and the history table attributes.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-39
Dial Commands calltracker enable
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.
Command Default
Call Tracker is not enabled.
Command Modes
Global configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
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 example shows how to enable the Call Tracker feature:
calltracker calltracker calltracker calltracker snmp-server snmp-server snmp-server snmp-server enable history max-size number history retain-mins minutes call-record terse packetsize byte-count queue-length length enable traps calltracker host host community-string calltracker
Related Commands
Command calltracker history max-size calltracker history retain-mins debug calltracker dnis modem link-info poll time show call calltracker active
Description Sets the maximum calls saved in the history table. Sets the number of minutes to save calls in the history table. Displays debug messages tracing the Call Tracker processing flow. Enables Call Tracker SYSLOG support for generating detailed Call Records. Sets the polling interval at which link statistics are retrieved from the MICA modem. Displays all information stored within the Call Tracker active database for all active calls.
Cisco IOS Dial Technologies Command Reference
DIA-40
November 2009
Dial Commands calltracker enable
show call calltracker history show call calltracker summary snmp-server host
Displays all information stored within the Call Tracker history database table for the most recent disconnected calls. Displays Call Tracker activity and configuration information such as the number of active calls and the history table attributes. Specifies the host to receive Call Tracker traps.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-41
Dial Commands calltracker history max-size
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
number
Maximum call entries to store in the Call Tracker history table. The valid range is from 0 through 10 times the maximum DS0 supported on a platform. A value of 0 prevents any history from being saved.
Command Default
The default maximum is dynamically calculated to be 1 times the maximum DS0 supported on a platform.
Command Modes
Global configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
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 50
Related Commands
Command calltracker history retain-mins show call calltracker history show call calltracker summary
Description Sets the number of minutes to save calls in the history table. Displays all information stored within the Call Tracker history database table for the most recent disconnected calls. Displays Call Tracker activity and configuration information such as the number of active calls and the history table attributes.
Cisco IOS Dial Technologies Command Reference
DIA-42
November 2009
Dial Commands calltracker history retain-mins
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
Release 12.1(3)T
Modification This command was introduced.
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 5000
Related Commands
Command calltracker history max-size show call calltracker history show call calltracker summary
Description Sets the maximum calls saved in the history table. Displays all information stored within the Call Tracker history database table for the most recent disconnected calls. Displays Call Tracker activity and configuration information such as the number of active calls and the history table attributes.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-43
Dial Commands calltracker timestamp
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.
Command Default
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
Release 12.1(3)T 12.2 12.3 12.3T 12.4T 12.4
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2. This command was integrated into Cisco IOS Release 12.3. This command was integrated into Cisco IOS Release 12.3.T. This command was integrated into Cisco IOS Release 12.4T. This command was integrated into Cisco IOS Release 12.4.
Usage Guidelines
This AS5400 command is used to add a milliseconds time stamp (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 time stamp:
u5400# configure terminal Enter configuration commands, one per line. End with CNTL/Z. u5400(config)# calltracker ? call-record Generate a SYSLOG Call Record at end of call enable start calltracker history Aspects of the CT History Table timestamp CDR timestamp config
Cisco IOS Dial Technologies Command Reference
DIA-44
November 2009
Dial Commands calltracker timestamp
u5400(config)# calltracker timestamp ? msec Shows millisecond value in timestamp u5400(config)# calltracker timestamp msec ? u5400# show call calltracker active -------------------------- call handle = 206 ------------------------------status-Active, service=PPP, origin=Anser, category-Modem DSO 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.2 setup=08/05/2003 192.04.41.645, conn=0.01,phys=23.73,service=16.33,authen=26.33 init rx/tx b-rate=28800/28800,rx/tx chars=0/0 resource slot/port=4/97, mp bundle=0,charged units=0,accontid=198 ibd handle=0x0,tty handle=0x63B4F010,tcb handle=0x0
Related Commands
Command calltracker enable calltracker history retain-mins show call calltracker history show call calltracker summary
Description Enables Call Tracker on the access server. Sets the number of minutes to save calls in the history table. Displays all information stored within the Call Tracker history database table for the most recent disconnected calls. Displays Call Tracker activity and configuration information such as the number of active calls and the history table attributes.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-45
Dial Commands call-type
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
all digital speech v110 v120
All calls. Digital calls. Speech calls. V.110 calls. V.120 calls.
Command Default
All calls are accepted by the network access server.
Command Modes
Call discriminator profile configuration
Command History
Release 12.0(4)XI
Modification This command was introduced.
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 userd3 call-type speech
Cisco IOS Dial Technologies Command Reference
DIA-46
November 2009
Dial Commands call-type cas
call-type cas
To statically set the call-type override for incoming channel-associated signaling (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
digital speech
Override call type to digital. The incoming call with the DNIS in the called group is treated as a digital call type. Override call-type to speech. The incoming call with the DNIS in the called group is treated as a speech call type.
Command Default
No default behavior or values.
Command Modes
DNIS group configuration
Command History
Release 12.0(4)XI
Modification This command was introduced.
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-group1 call-type cas speech
Cisco IOS Dial Technologies Command Reference November 2009
DIA-47
Dial Commands cas-custom
cas-custom
To customize signaling 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 signaling customization, use the no form of this command. cas-custom channel no cas-custom channel
Syntax Description
channel
For E1, specifies a single channel group number, which can be from 0 to 30. This channel group number must match the channel number specified in the cas-group command. For T1, specifies a single channel group number, which can be between 0 and 23.
Command Default
No customized signaling parameters are set. If you do not specify a country name using the country name command, which is described in Table 8, ITU is the selected default signal.
Command Modes
Controller configuration
Command History
Release 11.2P 11.3(2)T 12.0(1)T 12.1(5)T
Modification This command was introduced to support E1 channel groups. This command was implemented on additional Cisco access server and router platforms. This command was implemented on the Cisco 3600 series, and support for T1 channel groups was added. This command was implemented on the Cisco 3600 series, and support for T1 channel groups was added.
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 signaling customization will not take effect. See Example 1 (T1), page 52. 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 8. 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 2 (E1 on AS5800), page 52.
Cisco IOS Dial Technologies Command Reference
DIA-48
November 2009
Dial Commands cas-custom
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 8: 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), page 53 and Example 6 (E1 R2 Country Defaults), page 54. Beginning in Cisco IOS Release 12.3(11)YK and Cisco IOS Release 12.4(2)T, you can block incoming collect calls for in-line signaling with the double-answer feature, which is activated by entering the double-answer keyword. The double-answer feature sends the incoming collect call through a series of answer functions that can last up to two seconds and which causes the switch to drop the collect call while the normal calls stay connected. See Example 7 (E1 Collect Call Blocking).
Note
Incoming collect calls in Brazil send a II-8 response and to block such calls, a category B-7 response must be sent instead of the usual answer signal. This is known as category based blocking. Brazil is the only country that supports category based call blocking. If the double-answer feature is configured for Brazil, it will overwrite the category blocking and will not send the category B7 response.
Note
Only integrated Cisco MICA technologies modems support E1 R2 signaling on Cisco 5000 series access servers and Cisco 3600 series routers. Table 8 shows a list of command options in cas-custom mode, which is used to customize R2 signaling settings.
Table 8 Available Commands in cas-custom Mode
CAS Options ani-digits min number max number
Purpose Expected number of ANI digits. The minimum number of collected digits is set by min number. Replace number with a value between 0 and 64. The maximum number of collected digits is set by max number. Replace number with a value between 3 and 64. The default is 0 digits, which is the ITU default. Answer signal to be used. You can specify the group A signal or the group B signal. The signal number can be 1 to 15. Default is group-b 6, which is the ITU default. Specifies the number of digits the access server needs to collect before it requests ANI or CallerID information. The digits can be from 1 to 10. Default is 1, which is the ITU default. Specifies the type of incoming call, which is mapped to a group signal number. Signal numbers from 1 to 15 are available. Default is 1, which is the ITU default.
answer-signal {group-a | group-b} number caller-digits number
category number
Cisco IOS Dial Technologies Command Reference November 2009
DIA-49
Dial Commands cas-custom
Table 8
Available Commands in cas-custom Mode (continued)
CAS Options country name
Purpose Specifies local country settings to use with R2 signaling. Replace the name variable with one of the following supported country names. Cisco strongly recommends that you include the use-defaults option, which enables the default settings for a specific country. Default country setting is ITU.
• • • • • • •
argentina [use-defaults] australia [use-defaults] brazil [use-defaults] china [use-defaults] columbia [use-defaults] costarica [use-defaults] easteurope [use-defaults] The easteurope option supports Croatia, Russia, and the Slovak Republic.
• • • • •
ecuador-itu [use-defaults] ecuador-lme [use-defaults] greece [use-defaults] guatemala [use-defaults] hongkong-china [use-defaults] The Hong Kong options uses the China variant. indonesia [use-defaults] israel [use-defaults] itu ITU is the signaling default. ITU provides support for the following list of countries: Denmark, Finland, Germany, Russia (ITU variant), Hong Kong (ITU variant), and South Africa (ITU variant). The expression “ITU variant” means that there are multiple R2 signaling types deployed in the specified country, but Cisco supports the ITU variant.
• • •
• • •
korea [use-defaults] malaysia [use-defaults] newzealand [use-defaults]
Cisco IOS Dial Technologies Command Reference
DIA-50
November 2009
Dial Commands cas-custom
Table 8
Available Commands in cas-custom Mode (continued)
CAS Options
Purpose
• • • • • •
paraguay [use-defaults] peru [use-defaults] philippines [use-defaults] saudiarabia [use-defaults] singapore [use-defaults] southafrica-panaftel [use-defaults] The South Africa option uses the Panaftel variant. telmex [use-defaults] telnor [use-defaults] The telemex and telnor options are used in Mexico. thailand [use-defaults] uruguay [use-defaults] venezuela [use-defaults] vietnam [use-defaults]
• •
• • • •
default
Sets a command to its default setting.
dnis-digits min number Expected number of DNIS digits. The minimum number of collected digits max number is set by min number. Replace number with a value between 3 and 64. The maximum number of collected digits is set by max number. Replace number with a value between 3 and 64. The default is 0 digits, which is the ITU default. double-answer exit invert-abcd ka number kd number metering nc-congestion Enables collect call blocking on E1 with R2 digital signaling. Default is that the double-answer feature is turned off. Takes you out of cas custom mode. Inverts the ABCD bits before tx and after rx. This feature is disabled by default, which is the ITU default. Specifies the KA signal code. You can choose 1 to 15. Default is 0, which is the ITU default. Specifies the KD signal code. You can choose 1 to 15. Default is 0, which is the ITU default. Specifies sending a metering pulse when the access server is making an outgoing call. Metering is turned off by default, which is the ITU default. Specifies the noncompelled congestion signal. This signal is sent to the central office when the access server is congested and cannot accept the call. The default is B4, which is the ITU default. Negates a command or sets its defaults. Specifies a range of 1 to 64, but using this command you either turn on the request-category or turn it off by eliminating the line in your configuration. Specifies unused ABCD bit values, which can have a 0 or 1 bit value. This feature is disabled by default, which is the ITU default.
no request-category unused-abcd value
Cisco IOS Dial Technologies Command Reference November 2009
DIA-51
Dial Commands cas-custom
Examples
Example 1 (T1)
The following example enables this feature on channel 1:
Router(config)# controller T1 1/0/1 Router(config-controller)# cas-custom 1
Example 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 terminal Enter configuration commands, one per line. End with CNTL/Z Router(config)# controller e1 1/0/1 Router(config-controller)# ds0-group 1 timeslots 1-31 type r2-digital r2-compelled Router(config-controller)# cas-custom 1 Router(config-ctrl-cas)# ? CAS custom commands: ani-digits Expected number of ANI digits answer-signal Answer signal to be used caller-digits Digits to be collected before requesting CallerID category Category signal country Country Name default Set a command to its defaults dnis-digits Expected number of DNIS digits exit Exit from cas custom mode invert-abcd invert the ABCD bits before tx and after rx ka KA Signal kd KD Signal metering R2 network is sending metering signal nc-congestion Non Compelled Congestion signal no Negate a command or set its defaults unused-abcd Unused ABCD bit values
Example 3 (E1)
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 cas-group command and the cas-custom command.
Router(config)# controller e1 1 Router(config-controller)# cas-group 1 timeslots 1-31 type r2-digital r2-compelled Router(config-controller)# cas-custom 1 Router(config-ctrl-cas)# ? CAS custom commands: ani-digits Expected number of ANI digits answer-signal Answer signal to be used caller-digits Digits to be collected before requesting CallerID category Category signal country Country Name default Set a command to its defaults dnis-digits Expected number of DNIS digits exit Exit from cas custom mode invert-abcd invert the ABCD bits before tx and after rx ka KA Signal kd KD Signal metering R2 network is sending metering signal nc-congestion Non Compelled Congestion signal no Negate a command or set its defaults unused-abcd Unused ABCD bit values
Cisco IOS Dial Technologies Command Reference
DIA-52
November 2009
Dial Commands cas-custom
Example 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 8. For example, use the country argentina use-defaults command for a R2 scenario in Argentina.
Router(config-ctrl-cas)# country ? argentina australia bolivia brazil bulgaria china colombia costarica croatia easteurope ecuador-itu ecuador-lme greece guatemala hongkong-china india indonesia israel itu korea laos malaysia malta newzealand paraguay peru philippines saudiarabia singapore southafrica-panaftel telmex telnor thailand uruguay venezuela vietnam Argentina Australia Bolivia Brazil Bulgaria China Colombia Costa Rica Croatia East Europe Ecuador ITU Ecuador LME Greece Guatemala Hong Kong (China variant) India Indonesia Israel ITU Korea LAOS Network (Thailand Variant) Malaysia Malta New Zealand Paraguay Peru Philippines Saudi Arabia Singapore South Africa Panaftel Telmex Telnor Thailand Uruguay Venezuela Vietnam
Router(config-ctrl-cas)# country argentina ? use-defaults Use Country defaults
Router(config-ctrl-cas)# country argentina use-defaults
Example 5 (Collect ANI Digits)
The following example customizes the signaling 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 1 Router(config-ctrl-cas)# country argentina use-defaults Router(config-ctrl-cas)# caller-digits 3 Router(config-ctrl-cas)# ^z
Cisco IOS Dial Technologies Command Reference November 2009
DIA-53
Dial Commands cas-custom
Example 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)# Router(config-ctrl-cas)# Router(config-ctrl-cas)# Router(config-ctrl-cas)# Router(config-ctrl-cas)# country argentina use-defaults caller-digits 3 unused-abcd 1 metering country argentina use-defaults
Example 7 (E1 Collect Call Blocking)
The following example configures the double-answer feature for incoming collect call blocking on the Cisco 2801 with R2 digital signaling with DTMF. The call blocking feature is for all countries.
Router(config)# controller Router(config-controller)# Router(config-controller)# Router(config-controller)# e1 4/0 ds0-group 1 timeslot 1 type r2-digital compelled cas-custom 1 double-answer
To disable call blocking, use the no form of this command:
Router(config-controller)# no double-answer
Related Commands
Command profile incoming signaling-class cas
Description Defines a template formed by directives guiding the CSM to process the digit sequence for a signaling class. Defines a signaling class which specifies the template that processes the ANI/DNIS delimiter.
cas-group (E1 controller) Configures CAS on an E1 controller.
Cisco IOS Dial Technologies Command Reference
DIA-54
November 2009
Dial Commands cas-group (E1 controller)
cas-group (E1 controller)
To configure channel-associated signaling (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
channel timeslots range
Single channel group number from 0 to 30. Time slot or time slot range, which can be from 1 to 31. You can specify a time slot range (for example, 1-29), individual time slots separated by commas (for example 1, 3, 5), or a combination of the two (for example 1-14, 15, 17-31). The 16th time slot is reserved for out-of-band signaling. Type of CAS. Configure the signal type that your central office uses. For Cisco 5800 series access servers, replace the signal keyword with one of the following signal types:
•
type signal
e&m-fgb [dtmf [dnis] | mf [dnis]]—Specifies ear and mouth channel signaling with feature group B support, which includes the wink-start protocol. The optional signal tones are DTMF and MF with the option of provisioning DNIS. e&m-fgd—Specifies ear and mouth channel signaling with feature group D support, which includes the wink-start protocol. e&m-immediate-start—Specifies ear and mouth channel signaling with immediate-start support. fxs-ground-start—Specifies Foreign Exchange Station ground-start signaling support. fxs-loop-start—Specifies Foreign Exchange Station loop-start signaling support. p7—Specifies the P7 switch type. r2-analog [dtmf | r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]] r2-digital [dtmf | r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]] r2-pulse [dtmf | r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]] sas-ground-start—Specifies Special Access Station ground-start signaling support. sas-loop-start—Specifies Special Access Station loop-start signaling support.
• • • • • • • • • •
Cisco IOS Dial Technologies Command Reference November 2009
DIA-55
Dial Commands cas-group (E1 controller)
type signal (continued)
For the Cisco 3600 series access servers, replace the signal variable with one of the following signal types:
• • •
r2-analog {r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]} r2-digital {r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]} r2-pulse {r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]}
The following descriptions are provided for the previous R2 syntax bullets:
•
r2-analog—Specifies R2 ITU Q411 analog line signaling, which reflects the on/off switching of a tone in frequency-division multiplexing circuits (before TDM circuits were created). The tone is used for line signaling. r2-digital—Specifies R2 ITU Q421 digital line signaling, which is the most common signaling configuration. The A and B bits are used for line signaling. r2-pulse—Specifies R2 ITU supplement 7 pulse line signaling, which is a transmitted pulse that indicates a change in the line state. dtmf—Specifies the DTMF tone signaling (Cisco 5800 series access server only). r2-compelled [ani]—Specifies R2 compelled register signaling. You can also specify provisioning the ANI address option. r2-non-compelled [ani]—Specifies R2 noncompelled register signaling. r2-semi-compelled [ani]—Specifies R2 semicompelled register signaling.
•
• • • • •
Command Default
No CAS is configured on the controller. All R2 signaling types have DNIS turned on by default.
Command Modes
Controller configuration
Command History
Release 11.2P 12.0(1)T
Modification This command was introduced. This command was implemented on the Cisco 3600 series.
Cisco IOS Dial Technologies Command Reference
DIA-56
November 2009
Dial Commands cas-group (E1 controller)
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 signaling. The signaling you configure on the access server must match the signaling used by the central office. For example if the central office switch is forwarding R2 analog signaling to a Cisco AS5800, then the access server’s E1 controller must also be configured for R2 analog signaling (r2-analog). All R2 signaling 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 signaling 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 signaling parameters.
Note
Only integrated MICA modems support E1 R2 signaling on Cisco access servers. DNIS is automatically collected for modem pools and R2 tone signaling. You do not need to specify the collection of DNIS information with the cas-group command. However, if you are using non-R2 tone signaling, the system must be manually configured to collect DNIS information. For non-R2 cas signaling, DNIS collection is done only for E&M-fgb.
Examples
In most cases, you will configure the same channel-associated signaling on each E1 controller. The following examples configure signaling 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
The actual channel associated signaling is configured on the 16th time slot, which is the reason why this time slot does not come up in the following output.
Router(config-controller)# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config-controller)# controller e1 2/1/0 Router(config-controller)# cas-group 1 timeslots 1-31 type r2-digital r2-compelled ani %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: RBS RBS RBS RBS RBS RBS of of of of of of controller controller controller controller controller controller 0 0 0 0 0 0 timeslot timeslot timeslot timeslot timeslot timeslot 1 2 3 4 5 6 is is is is is is up up up up up up
Cisco IOS Dial Technologies Command Reference November 2009
DIA-57
Dial Commands cas-group (E1 controller)
%DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP:
RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS
of of of of of of of of of of of of of of of of of of of of of of of of
controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot
7 is up 8 is up 9 is up 10 is up 11 is up 12 is up 13 is up 14 is up 15 is up 17 is up 18 is up 19 is up 20 is up 21 is up 22 is up 23 is up 24 is up 25 is up 26 is up 27 is up 28 is up 29 is up 30 is up 31 is up
The following example shows all the supported E1 signaling types on a Cisco AS5800:
Router(config-controller)# cas-group 1 timeslots 1-31 type ? e&m-fgb e&m-fgd e&m-immediate-start fxs-ground-start fxs-loop-start p7 r2-analog r2-digital r2-pulse sas-ground-start sas-loop-start E & M Type II FGB E & M Type II FGD E & M Immediate Start FXS Ground Start FXS Loop Start P7 Switch R2 ITU Q411 R2 ITU Q421 R2 ITU Supplement 7 SAS Ground Start SAS Loop Start
Router(config-controller)# cas-group 1 timeslots 1-31 type r2-analog ? dtmf r2-compelled r2-non-compelled r2-semi-compelled DTMF tone signaling R2 Compelled Register signaling R2 Non Compelled Register signaling R2 Semi Compelled Register signaling
R2 signaling 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 CallerID category Category signal country Country Name default Set a command to its defaults exit Exit from cas custom mode invert-abcd invert the ABCD bits before tx and after rx metering R2 network is sending metering signal nc-congestion Non Compelled Congestion signal no Negate a command or set its defaults
Cisco IOS Dial Technologies Command Reference
DIA-58
November 2009
Dial Commands cas-group (T1 controller)
cas-group (T1 controller)
To configure channelized T1 time slots with robbed-bit signaling, and R1 channel-associated signaling, use the cas-group command in controller configuration mode. To disable signaling 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 Signaling
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
channel timeslots range
Single channel group number from 0 to 30. Time slot or time slot range, which can be from 1 to 24 for T1, and from 1 to 31 for E1. You can specify a time slot range (for example, 1-31), individual time slots separated by commas (for example 1, 3, 5), or a combination of the two (for example 1-7, 8, 17-31). The 16th time slot is reserved for out-of-band signaling. Type of robbed-bit signaling. Replace the signal variable with one of the following signal types. The keywords service, data, and voice are used for switched 56K configuration. These keywords are described at the end of this syntax description table.
•
type signal
e&m-fgb [dtmf [dnis] | [service {data | voice}]] | [service {data | voice}] | [mf [dnis] | [service {data | voice}]]—Specifies ear and mouth channel signaling with feature group B support, which includes the wink-start protocol. Use the options dtmf [dnis] to configure dual tone multifrequency (DTMF) tone signaling with optional dialed number information server (DNIS) provisioning. Use the options mf [dnis] to configure MF tone signaling with optional DNIS provisioning. Use the options service {data | voice} for switched 56K configurations. (See the end of this syntax description table for more information about these switched 56K keywords.) e&m-fgd [service {data | voice}]—Specifies ear and mouth channel signaling with feature group D support, which includes the wink-start protocol. Use the options service {data | voice} for switched 56K configurations. (See the end of this syntax description table for more information.) e&m-immediate-start [service {data | voice}]—Specifies ear and mouth channel signaling with immediate-start support. Use the options service {data | voice} for switched 56K configurations. (See the end of this syntax description table for more information.)fxs-ground-start [service {data | voice}]—Specifies Foreign Exchange Station ground-start signaling support. Use the options [service {data | voice} for switched 56K configurations. (See the end of this syntax description table for more information.)
•
•
Cisco IOS Dial Technologies Command Reference November 2009
DIA-59
Dial Commands cas-group (T1 controller)
type signal (continued)
•
fxs-loop-start [service {data | voice}]—Specifies Foreign Exchange Station loop-start signaling support. Use the options service {data | voice} for switched 56K configurations. (See the end of this syntax description table for more information.) r1-modified ani-dnis—Indicates R1 signaling will collect ani and dnis information. r1-modified dnis—Indicates R1 signaling will collect only dnis information. sas-ground-start [service {data | voice}]—Specifies Special Access Station ground-start signaling support. Use the options service {data | voice} for switched 56K configurations. (See the end of this syntax description table for more information.) sas-loop-start [service {data | voice}]—Specifies Special Access Station loop-start signaling support. Use the options service {data | voice} for switched 56K configurations. service—(Optional) Specifies the type of services provided for scenarios involving switched 56K connections. Do not include this option in the cas-group command statement if you are not using the access server to provide switched 56K connections. data—Enables switched 56K digital data services on the specified range of time slots. The data is directly read from the time slot or channel. Time slots configured with this option will not accept analog modem calls. voice—Enables analog modem services on the specified range of time slots. The call is forwarded to the modems for demodulation. Time slots configured with this option will not accept switched 56K digital calls.
• • •
•
•
•
•
Command Default
For ISDN PRI, the cas-group command is disabled. If the channelized T1 is not configured as a PRI, the default value for line signaling is e&m-fgb and the default value for tone signaling is DTMF. The R1 signaling default value is ani-dnis.
Command Modes
Controller configuration
Command History
Release 11.2 11.3T
Modification This command was introduced. The following signaling keywords were added:
• • •
service data voice
The R1 keyword was added.
Cisco IOS Dial Technologies Command Reference
DIA-60
November 2009
Dial Commands cas-group (T1 controller)
Usage Guidelines
Use the cas-group command to configure T1 controllers with different types of robbed-bit signaling, 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 signaling with feature group B support:
Router(config-controller)# controller T1 0 Router(config-controller)# cas-group 1 timeslots 1-24 type e&m-fgb %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS of of of of of of of of of of of of of of of of of of of of of of of of controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot 1 is up 2 is up 3 is up 4 is up 5 is up 6 is up 7 is up 8 is up 9 is up 10 is up 11 is up 12 is up 13 is up 14 is up 15 is up 16 is up 17 is up 18 is up 19 is up 20 is up 21 is up 22 is up 23 is up 24 is up
The following example configures the required signaling to support modem pooling and the digital number identification service (DNIS) over channelized T1 lines on a Cisco AS5300. The only supported signaling 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
Make sure that your switch provides inband address information for incoming analog calls before you enable this feature.
controller t1 0 cas-group 0 timeslots 1-24 type e&m-fgb dtmf dnis exit
Cisco IOS Dial Technologies Command Reference November 2009
DIA-61
Dial Commands cas-group (T1 controller)
modem-pool accounts1 pool-range 30-50 called-number 2000 max-conn 21 exit
The following example configures a Cisco AS5200 to accept switched 56K digital calls on both of its T1 controllers:
copy running-config startup-config
The following 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 0 cas-group 0 timeslots 1-15 type e&m-fgb service data cas-group 1 timeslots 16-24 type e&m-fgb service voice framing esf clock source line secondary linecode b8zs exit
The following example configures R1 signaling 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-dnis
The following example configures R1 modified signaling 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-dnis Router(config-controller)# ^Z Router(config-controller)# debug csm Call Switching Module debugging is on 1d16h:%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) *Dec 17 11:27:47.961:CSM v(4/2) *Dec 17 11:27:49.413:CSM v(4/2) ev_IC_DNIS_INFO_COLLECTED. *Dec 17 11:27:50.265:CSM v(4/2) ev_IC_ADDR_INFO_COLLECTED. *Dec 17 11:27:50.265:CSM v(4/2) ev_DSX0_CONNECTED. Router# show modem csm 1/4/2 VDEV_INFO:slot 4, port 2 vdev_status(0x00000001):VDEV_STATUS_ACTIVE_CALL. csm_state(0x00000205)=CSM_IC5_CONNECTED, csm_event_proc=0x60665CB0, current call thru Channelize line invalid_event_count=0, wdt_timeout_count=0 watchdog timer is not activated wait_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=0 The calling party phone number = The called party phone number = 6789 ring_no_answer=0, ic_failure=0, ic_complete=1 dial_failure=0, oc_failure=0, oc_complete=0 c(E1 1/1/0:0):CSM_PROC_IDLE: ev_DSX0_CALL. c(E1 1/1/0:0):CSM_PROC_IC1_RING: ev_MODEM_OFFHOOK. c(E1 1/1/0:0):CSM_PROC_IC2_COLLECT_ADDR_INFO: c(E1 1/1/0:0):CSM_PROC_IC2_COLLECT_ADDR_INFO: c(E1 1/1/0:0):CSM_PROC_IC4_WAIT_FOR_CARRIER:
Cisco IOS Dial Technologies Command Reference
DIA-62
November 2009
Dial Commands cas-group (T1 controller)
oc_busy=0, oc_no_dial_tone=0, oc_dial_timeout=0 remote_link_disc=0, busyout=0, modem_reset=0 call_duration_started=1d16h, call_duration_ended=00:00:00, total_call_duration=00:00:00 Router# debug mica msm MICA modems state machine debugging is on DA-Slot4# 1d16h:Msm2:MSM_IN_SERVICE:n_ring_ind:cc0x200 si5 dc3 ms0 cr56000,75 1d16h:Msm2:MSM_PREPARE:m_state_trans:newst MODEM_STATE_SETUP 1d16h: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_CONNECT 1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_LINK 1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_TRAINUP 1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_EC_NEGOTIATING 1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_STEADY_STATE
Cisco IOS Dial Technologies Command Reference November 2009
DIA-63
Dial Commands channel-group
channel-group
To configure serial WAN on a T1 or E1 interface, use the channel-group command in controller configuration mode. To clear a channel group, use the no form of this command.
Cisco 2600 Series
channel-group channel-group-number timeslots range [speed {56 | 64}] [aim aim-slot-number] no channel-group channel-group-number
Cisco 2611 (Cisco Signaling Link Terminal [SLT])
channel-group channel-number no channel-group channel-number
Cisco 2600XM Series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, and Cisco 3745
channel-group channel-group-number {timeslots range [speed {56 | 64}] | unframed} [aim aim-slot-number] no channel-group [channel-group-number timeslots range]
Cisco AS5350 and Cisco AS5400 Series
channel-group channel-group-number no channel-group channel-group-number
Cisco MC3810
channel-group channel-number timeslots range [speed {56 | 64}] no channel-group [channel-number timeslots range]
Syntax Description
channel-group-number
Channel-group number on the Cisco 2600 series, Cisco 2600XM, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, and Cisco 3745 routers. When a T1 data line is configured, channel-group numbers can be values from 0 to 23. When an E1 data line is configured, channel-group numbers can be values from 0 to 30. Valid values can be 0 or 1 on the Cisco AS5350 and Cisco AS5400.
Cisco IOS Dial Technologies Command Reference
DIA-64
November 2009
Dial Commands channel-group
timeslots range
Specifies one or more time slots separated by commas, and spaces or ranges of time slots belonging to the channel group separated by a dash. The first time slot is numbered 1.
• •
For a T1 controller, the time slots range from 1 to 24. For an E1 controller, the time slots range from 1 to 31.
You can specify a time slot range (for example, 1-29), individual time slots separated by commas (for example 1, 3, 5), or a combination of the two (for example 1-14, 15, 17-31). See the “Examples” section for samples of different timeslot ranges. speed {56 | 64} (Optional) Specifies the speed of the underlying DS0s in kilobits per second. Valid values are 56 and 64. The default line speed when configuring a T1 controller is 56 kbps on the Cisco 2600 series, Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, Cisco 3745, and Cisco MC3810. The default line speed when configuring an E1 controller is 64 kbps on the Cisco 2600 series, Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, Cisco 3745, and Cisco MC3810. The line speed controls real-time (VBR-RT) traffic shaping, and the maximum burst size (MBS) is 255 cells. aim aim-slot-number (Optional) Directs HDLC traffic from the T1/E1 interface to the AIM-ATM-VOICE-30 digital signaling processor (DSP) card on the Cisco 2600 series, Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, and Cisco 3745. Number of the channel. Valid values can be 0 or 1 on the Cisco SLT (Cisco 2611). Specifies the use of all 32 time slots for data. None of the 32 time slots is used for framing signals on the Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, and Cisco 3745. This keyword is applicable to E1 only.
channel-number unframed
Command Default
The T1/E1 line is connected to the Motorola MPC-860x processor serial communication controller (SCC) or network module with two voice or WAN interface card (VIC or WIC) slots and 0/1/2 FastEthernet ports DSCC4 by default on Cisco 2600 series, Cisco 2600XM, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, and Cisco 3745 routers. There is no default behavior or values on the Cisco SLT (Cisco 2611). The serial interface object encapsulation is set to HDLC on a network access server (NAS) (Cisco AS5350 and Cisco AS5400 series routers). The default line speed is 56 kbps when a T1 controller is configured on the Cisco 2600 series, Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, Cisco 3745, and the Cisco MC3810. The default line speed is 64 kbps when an E1 controller is configured on the Cisco 2600 series, Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, Cisco 3745, and the Cisco MC3810.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-65
Dial Commands channel-group
Command Modes
Controller configuration
Command History
Release 11.3MA 12.0 12.0(7)XE 12.1(1)E 12.1(1)T
Modification This command was introduced on the Cisco MC3810. This command was integrated into Cisco IOS Release 12.0 on the Cisco MC3810. This command was implemented on the Catalyst 6000 family switches. This command was integrated into Cisco IOS Release 12.1(1)E. This command was modified to accommodate two channel groups on a port on 1- and 2-port T1/E1 multiflex voice or WAN interface cards on the Cisco 2600 and Cisco 3600 series routers. The number of valid values for the kbps argument was changed on the Cisco MC3810; see the “Usage Guidelines” section for valid values. This command was implemented on the Cisco AS5350 and Cisco AS5400. The aim keyword was added for use on the Cisco 2600 series (including the Cisco 2691), Cisco 2600XM, Cisco 3660, Cisco 3725, and Cisco 3745. The unframed keyword was added for use on the Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, and Cisco 3745. This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.
12.1(3a)E3 12.2(11)T 12.2(15)T 12.3(1) 12.2SX
Usage Guidelines
Use this command to direct HDLC traffic from the T1/E1 interface to the AIM-ATM-VOICE-30 DSP card. A channel group is created using Advanced Integration Module (AIM) HDLC resources when a channel-group command with the aim keyword is parsed during system initialization or when the command is entered during configuration. You must specify the aim keyword under a T1/E1 controller port to direct HDLC traffic from the T1/E1 interface to the AIM-ATM-VOICE-30 DSP card on the Cisco 2600 series, Cisco 2600XM series, Cisco 2691, Cisco 3631, Cisco 3660, Cisco 3725, and Cisco 3745.
Note
Neither the Cisco AS5400 series NAS nor the Cisco MC3810 is supported with the integrated voice and data WAN on T1/E1 interfaces using the AIM-ATM-VOICE-30 module. If previous channel-group commands are configured with the aim keyword, subsequent channel-group commands without the aim keyword are rejected. Similarly, if a regular channel-group command is followed by another channel-group command with the aim keyword implemented, the second command is rejected on the Cisco 2600 and Cisco 2600XM. A channel group using AIM HDLC resources is deleted only when a no channel-group command is entered. By default, the channel-group command on a NAS sets the serial interface object encapsulation to HDLC. You must override the default by entering the encapsulation ss7 command for that serial interface object. Once you override the default, encapsulation cannot be changed again for that object. The SS7 encapsulation option is new to the Integrated Signaling Link Terminal feature and is available only for interface serial objects created by the channel-group command. The Integrated Signaling Link Terminal feature added SLT functionality on Cisco AS5350 and Cisco AS5400 platforms.
Cisco IOS Dial Technologies Command Reference
DIA-66
November 2009
Dial Commands channel-group
A digital SS7 link can be deleted by entering the no channel-group channel-group-number command on the associated T1/E1 controller. The link must first be stopped using the no shutdown command. It is not necessary to remove the channel ID association first. Use the channel-group command in configurations where the router or access server must communicate with a T1 or E1 fractional data line. The channel group number may be arbitrarily assigned and must be unique for the controller. The time-slot range must match the time slots assigned to the channel group. The service provider defines the time slots that comprise a channel group.
Note
Channel groups, channel-associated signaling (CAS) voice groups, DS0 groups, and time-division multiplexing (TDM) groups all use group numbers. All group numbers configured for channel groups, CAS voice groups, and TDM groups must be unique on the local Cisco MC3810 concentrator. For example, you cannot use the same group number for a channel group and for a TDM group. Furthermore, on the Cisco MC3810, only one channel group can be configured on a controller. The channel group number can be 0 or 1 on the Cisco SLT (Cisco 2611). The channel-group command also applies to Voice over Frame Relay, Voice over ATM, and Voice over HDLC on the Cisco MC3810.
Examples
The following example shows basic configuration directing HDLC traffic from the T1/E1 interface to the AIM-ATM-VOICE-30 DSP card, starting in global configuration mode:
Router(config)# controller e1 1/0 Router(config-controller)# clock source internal Router(config-controller)# channel-group 0 timeslots 1-31 aim 0
The following example explicitly sets the encapsulation type to PPP to override the HDLC default:
Router# configure terminal Router(config)# controller t1 6/0 Router(config-controller)# channel-group 2 timeslots 3 aim 0 Router(config-controller)# exit Router(config)# interface serial 6/0:2 Router(config-if)# encapsulation ppp Router(config-if)# ip address 10.0.0.1 255.0.0.0 Router(config-if)# no shutdown Router(config-if)# end
The following example shows how to explicitly set the encapsulation type to SS7 to override the HDLC default using the Integrated Signaling Link Terminal feature. This example uses an 8PRI DFC card inserted into slot 7, and DS0-timeslot 3 on trunk 5 of that card is used as an SS7 link:
Router# configure terminal Router(config)# controller t1 7/5 Router(config-controller)# channel-group 2 timeslots 3 Router(config-controller)# exit Router(config)# interface serial 7/5:2 Router(config-if)# encapsulation ss7 Router(config-if)# channel-id 0 Router(config-if)# no shutdown Router(config-if)# end
Cisco IOS Dial Technologies Command Reference November 2009
DIA-67
Dial Commands channel-group
The following example defines three channel groups. Channel-group 0 consists of a single time slot, channel-group 8 consists of seven time slots and runs at a speed of 64 kbps per time slot, and channel-group 12 consists of two time slots.
Router(config-controller)# channel-group 0 timeslots 1 Router(config-controller)# channel-group 8 timeslots 5,7,12-15,20 speed 64 Router(config-controller)# channel-group 12 timeslots 2
The following example configures a channel group on controller T1 0 on a Cisco MC3810:
Router(config)# controller T1 0 Router(config-controller)# channel-group 10 timeslots 10-64
The following example configures a channel group on controller E1 1 and specifies that all time slots are used for data:
controller e1 1 channel-group 1 unframed
Note
SS7 digital F-link support for the 8PRI line card requires use of a third onboard TDM stream to route trunk DS0 messages to the onboard MGCs.
Related Commands
Command framing invert data linecode voice-card encapsulation
Description Specifies the frame type for the T1 or E1 data line. Enables channel inversion. Specifies the line code type for the T1 or E1 line. Configures a card with voice processing resources and enters voice card configuration mode. Sets the encapsulation type.
Cisco IOS Dial Technologies Command Reference
DIA-68
November 2009
Dial Commands chat-script
chat-script
To create a script that will place a call over a modem, use the chat-script command in global configuration mode. To disable the specified chat script, use the no form of this command. chat-script script-name expect-send no chat-script script-name expect-send
Syntax Description
script-name expect-send
Name of the chat script. Pairs of information elements: an item to expect and an item to send in response.
Command Default
No chat scripts are defined.
Command Modes
Global configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
Chat scripts are used in dial-on-demand routing (DDR) to give commands to dial a modem and commands to log on to remote systems. The defined script will be used to place a call over a modem. Some characteristics of chat scripts are as follows:
• • • •
Chat scripts are case sensitive. You can have any number of ABORT sequences active at once. When a chat script starts, the default timeout is 5 seconds. Changes to the timeout persist until the next time you change them in the script. A string within quotation marks is treated as a single entity.
We recommend that one chat script (a “modem” chat script) be written for placing a call and another chat script (a “system” or “login” chat script) be written to log on to remote systems, where required.
Suggested Chat Script Naming Conventions
A suggested chat script naming convention is vendor-type-modulation. If you follow this convention, the syntax of the chat-script command becomes chat-script vendor-type-modulation expect-send. For example, if you have a Telebit T3000 modem that uses V.32bis modulation, you would name your chat script telebit-t3000-v32bis. The chat-script command could be written as follows:
chat-script telebit-t3000-v32bis ABORT ERROR ABORT BUSY ABORT "NO ANSWER" "" "AT H" OK "AT DT \T" DIALING \c TIMEOUT 30 CONNECT \c
Cisco IOS Dial Technologies Command Reference November 2009
DIA-69
Dial Commands chat-script
Adhering to this naming convention allows you to use partial chat script names with regular expressions to specify a range of chat scripts that can be used. This capability is particularly useful for dialer rotary groups and is explained further in the next section. Chat scripts are in the form expect-send, where the send string following the hyphen (-) is executed if the preceding expect string fails. Each send string is followed by a return unless it ends with the escape sequence \c. The sequence ^x is translated into the appropriate control character, and the sequence \x is translated into x if \x is not one of the special sequences listed in Table 9. See the book titled Managing uucp and Usenet by Tim O’Reilly and Grace Todino for more information about chat scripts.
Escape Sequences
The escape sequences used in chat scripts are listed in Table 9.
Table 9 Chat Script Send String Escape Sequences
Escape Sequence \ \\ \” \c \d \K \n \N \p \q \r \s \t \T “” BREAK EOT
Expect-Send Pairs
Description Sends the ASCII character with its octal value. Sends a backslash (\) character. Sends a double-quote (“) character (does not work within double quotes). Suppresses a new line at the end of the send string. Delays for 2 seconds. Inserts a BREAK. Sends a newline or linefeed character. Sends a null character. Pauses for 0.25 second. Reserved, not yet used. Sends a return. Sends a space character. Sends a tab character. Replaced by phone number. Expects a null string. Causes a BREAK. This sequence is sometimes simulated with line speed changes and null characters. May not work on all systems. Sends an end-of-transmission character.
Sample supported expect-send pairs are described in Table 10.
Cisco IOS Dial Technologies Command Reference
DIA-70
November 2009
Dial Commands chat-script
Table 10
Sample Supported Expect-Send Pairs
Expect and Send Pair ABORT string TIMEOUT time
Function Designates a string whose presence in the input indicates that the chat script has failed. Sets the time to wait for input, in seconds. The default is 5 seconds and a timeout of 60 seconds is recommended for V.90 modems.
For example, if a modem reports BUSY when the number dialed is busy, you can indicate that you want the attempt stopped at this point by including ABORT BUSY in your chat script.
Alternate Handlers
If you use the expect-send pair ABORT SINK instead of ABORT ERROR, the system terminates abnormally when it encounters SINK instead of ERROR.
Missed Characters
After the connection is established and you press the Return key, you must often press Return a second time before the prompt appears. For example, you might include the following as part of your chat script:
ssword:-/r-ssword
This part of the script specifies that, after the connection is established, you want ssword to be displayed. If it is not displayed, you must press Return again after the timeout passes.
Examples
The following example shows the chat-script command being used to create a chat script named t3000:
chat-script t3000 ABORT ERROR ABORT BUSY ABORT "NO ANSWER" "" "AT H" OK "AT DT \T" DIALING \c TIMEOUT 60 CONNECT \c
Related Commands
Command dialer map script dialer
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Specifies a default modem chat script.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-71
Dial Commands class (controller)
class (controller)
To create a signaling class structure that can be referred to by its name, use the class command in controller configuration mode. To remove the structure, use the no form of this command. class name no class name
Syntax Description
name
The signaling class name which specifies the template that processes the automatic number identification/dialed number identification service (ANI/DNIS) delimiter.
Command Default
No signaling class structures are defined.
Command Modes
Controller configuration
Command History
Release 12.1(1)T
Modification This command was introduced.
Usage Guidelines
A signaling class allows the Cisco AS5300 and Cisco AS5800 universal access servers to provide the ANI/DNIS delimiter on incoming T1/CAS trunk lines. The digit collection logic in the call switching module (CSM) for incoming T1 CAS calls in dual tone multifrequency (DTMF) is modified to process the delimiters, the ANI digits, and the DNIS digits. For this feature to work, a CAS signaling class with the template to process ANI/DNIS delimiters has to be defined. This creates a signaling class structure which can be referred to by its name. The name argument must match the name configured in the signaling-class cas command.
Examples
The following example defines a CAS signaling class with the template to process ANI/DNIS delimiters on channel 1:
Router(config)# signaling-class cas test Router(config-sig-class)# profile incoming S<*a<*d<*n Router(config)# controller T1 1/0/1 Router(config-controller)# class test
Related Commands
Commands profile incoming signaling-class cas
Descriptions Defines a template formed by directives guiding the CSM to process the digit sequence for a signaling class. Defines a signaling class which specifies the template that processes the ANI/DNIS delimiter.
Cisco IOS Dial Technologies Command Reference
DIA-72
November 2009
Dial Commands clear cot summary
clear cot summary
To reset the counters, use the clear cot summary command in privileged EXEC mode. clear cot summary
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
Release 11.3(7)
Modification This command was introduced.
Examples
There is no display generated, but the counters in the show cot summary command would be all zeros.
Related Commands
Command show cot dsp show cot request show cot summary
Description Displays information about the COT DSP configuration or current status. Displays COT request information. Displays information about the COT activity.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-73
Dial Commands clear counters (async)
clear counters (async)
To clear the counters of a specified asynchronous interface or specified asynchronous interface group, as displayed by the show interface async command, use the clear counters command in EXEC mode. clear counters {async async-interface-number | group-async group-async-interface-number}
Syntax Description
async async-interface-number
Counters in a specified asynchronous interface. Required async interface number of the asynchronous interface that has been previously created with this number specification. The range is from 1 through 49. Counters in a specified asynchronous interface group. Required group-async interface number that has been previously created with this number specification. The range is from 0 through 49.
group-async group-async-interface-number
Command Modes
EXEC
Command History
Release 12.0
Modification This command was introduced.
Usage Guidelines
Before using this command, use the show interface async command to display the asynchronous related counters on the specified asynchronous interface.
Examples
The following example uses the show interface async command to display the asynchronous related counters on the asynchronous interface named 1. The example then uses the clear counters group-async command to clear the counters. After the counters are cleared, the configuration file for the interface is displayed.
Router# show interface async 1 Async1 is down, line protocol is down modem(slot/port)=1/0, state=IDLE dsx1(slot/unit/channel)=NONE, status=VDEV_STATUS_UNLOCKED Hardware is Async Serial Interface is unnumbered. Using address of Ethernet0 (1.18.31.9) MTU 1500 bytes, BW 115 Kbit, DLY 100000 usec, rely 255/255, load 1/255 Encapsulation PPP, loopback not set, keepalive not set DTR is pulsed for 5 seconds on reset LCP Closed Closed: IPCP, CDPCP Last input never, output never, output hang never Last clearing of "show interface" counters 00:03:46 Input queue: 0/10/0 (size/max/drops); Total output drops: 0///// Queueing strategy: weighted fair
Cisco IOS Dial Technologies Command Reference
DIA-74
November 2009
Dial Commands clear counters (async)
Output queue: 0/1000/64/0 (size/max total/threshold/drops) Conversations 0/0/256 (active/max active/max total) Reserved Conversations 0/0 (allocated/max allocated) 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 packets input, 0 bytes, 0 no buffer Received 0 broadcasts, 0 runts, 0 giants, 0 throttles 0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored, 0 abort 0 packets output, 0 bytes, 0 underruns 0 output errors, 0 collisions, 0 interface resets 0 output buffer failures, 0 output buffers swapped out 0 carrier transitions Router# Router# clear counters group-async 1 Clear "show interface" counters on this interface [confirm] Router# *Oct 17 00:42:27.083: %CLEAR-5-COUNTERS: Clear counter on interface Group-Asynce
Related Commands
Command
Description
clear modem counters Clears the statistical counters on one or more manageable modems on access servers or routers. show interface async Displays the asynchronous related counters on the specified asynchronous interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-75
Dial Commands clear counters line
clear counters line
To clear line counters, use the clear counters line command in EXEC mode. clear counters line {type | number}
Syntax Description
type number
Line type: aux, console, tty, or vty. First line number to clear, which can be between 0 and 54.
Command Modes
EXEC
Command History
Release 11.2P
Modification This command was introduced.
Usage Guidelines
This command clears the line counters shown by the show line command.
Examples
The following example shows the available options under the clear counters line command. When you issue this command, the counters (for example, Uses and Noise) displayed by the show line command are cleared.
Router# clear counters line ? <0-54> aux console tty vty First Line number Auxiliary line Primary terminal line Terminal controller Virtual terminal
Router# exit Router> show line Tty 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 Typ CTY TTY TTY TTY TTY TTY TTY TTY TTY TTY TTY TTY TTY TTY TTY TTY TTY Tx/Rx 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 115200/115200 A Modem inout inout inout inout inout inout inout inout inout inout inout inout inout inout inout inout Roty AccO AccI Uses 0 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 1 Noise 4 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Overruns 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0 0/0
* A A A * * * * * * * * * * * * A
Cisco IOS Dial Technologies Command Reference
DIA-76
November 2009
Dial Commands clear counters line
A A A A A
17 18 19 20 21
TTY TTY TTY TTY TTY
115200/115200 115200/115200 115200/115200 115200/115200 115200/115200
-
inout inout inout inout inout
-
-
-
1 1 1 1 1
0 0 0 0 0
0/0 0/0 0/0 0/0 0/0
Related Commands
Command show line
Description Displays the parameters of a terminal line.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-77
Dial Commands clear dialer
clear dialer
To clear the values of dialer statistics for one or more serial interfaces or BRIs configured for dial-on-demand routing (DDR), use the clear dialer privileged EXEC mode command clear dialer [interface type number]
Cisco 7500 Series Routers Only
clear dialer [interface serial slot/port]
Syntax Description
interface type number slot/port
(Optional) Indicates that one interface will be specified. (Optional) Interface type: async, serial, or bri. (Optional) Interface number. (Optional) Backplane slot number and port number on the interface. See your hardware installation manual for the specific slot and port numbers.
Command Modes
Privileged EXEC
Command History
Release 11.0
Modification This command was introduced.
Usage Guidelines
If the interface keyword and the arguments are not used, dialer statistics are cleared on all interfaces.
Examples
The following example clears the dialer statistics on serial interface 1:
Router# clear dialer interface serial 1
Cisco IOS Dial Technologies Command Reference
DIA-78
November 2009
Dial Commands clear dialer dnis
clear dialer dnis
To reset the counter statistics associated with a specific dialed number identification service (DNIS) group or number, use the clear dialer dnis command in privileged EXEC mode. clear dialer dnis {group name | number number}
Syntax Description
group name number number
Dialer DNIS group statistics. Dialer DNIS number statistics.
Command Modes
Privileged EXEC
Command History
Release 12.0(4)XI
Modification This command was introduced.
Usage Guidelines
Use the clear dialer dnis EXEC command to reset the counter statistics associated with a specific DNIS group or number. This command clears the counters for a DNIS group to reset the counter statistics associated with a specific DNIS group or number. If an ISP is charging a customer for the number of calls to a DNIS, it can clear the number after a week or month by using this command.
Examples
The following example shows the result of using the clear dialer dnis command for the DNIS group named “dg1”. Note that the counters have been cleared after the clear dialer dnis command has been entered.
Router# show dialer dnis group dg1 DNIS Number:71028 4 total connections 3 peak connections 1 calltype mismatches DNIS Number:4156266541 8 total connections 5 peak connections 0 calltype mismatches DNIS Number:4085541628 3 total connections 2 peak connections 0 calltype mismatches DNIS Number:71017 2 total connections 1 peak connections 0 calltype mismatches Router# clear dialer dnis group dg1 Router# show dialer dnis group dg1 DNIS Number:71028 0 total connections
Cisco IOS Dial Technologies Command Reference November 2009
DIA-79
Dial Commands clear dialer dnis
0 peak connections 0 calltype mismatches DNIS Number:4156266541 0 total connections 0 peak connections 0 calltype mismatches DNIS Number:4085541628 0 total connections 0 peak connections 0 calltype mismatches DNIS Number:71017 0 total connections 0 peak connections 0 calltype mismatches
Related Commands
Command show dialer dnis
Description Displays the number of calls DNIS groups have had.
Cisco IOS Dial Technologies Command Reference
DIA-80
November 2009
Dial Commands clear dialer sessions
clear dialer sessions
To remove all dialer sessions and disconnect links when connected, use the clear dialer sessions command in EXEC mode. clear dialer sessions
Syntax Description
This command has no arguments or keywords.
Command Modes
EXEC
Command History
Release 12.0(3)T
Modification This command was introduced.
Examples
The following example shows how to use the clear dialer sessions command:
Router# clear dialer sessions
Related Commands
Command show dialer sessions
Description Displays all dialer sessions.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-81
Dial Commands clear dsip tracing
clear dsip tracing
To clear Distributed System Interconnect Protocol (DSIP) tracing statistics (trace logging), use the clear dsip tracing command in privileged EXEC mode. clear dsip tracing {counters | tracing} [control | data | ipc]
Syntax Description
counters tracing control data ipc
DSIP counters. DSIP tracing buffers. (Optional) Control counters or tracing buffers. (Optional) Data counters or tracing buffers. (Optional) Inter-process communication counters or tracing buffers.
Command Default
If no option is specified, all control, data, and inter-process communication counters or tracing buffers are cleared.
Command Modes
Privileged EXEC
Command History
Release 11.3(2)AA 12.2(33)SRA 12.2SX
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(33)SRA. This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.
Usage Guidelines
Use this command to clear the counters displayed with the show dsip tracing EXEC command.
Examples
In the following example, the DSIP counters are cleared (including data, control, and ipc counters):
Router# clear dsip tracing
Related Commands
Command show dsip tracing show dsip version
Description Displays DSIP tracing buffer information. Displays DSIP version information.
Cisco IOS Dial Technologies Command Reference
DIA-82
November 2009
Dial Commands clear interface virtual-access
clear interface virtual-access
To tear down the virtual access interface and free the memory for other dial-in uses, use the clear interface virtual-access command in privileged EXEC mode. clear interface virtual-access number
Syntax Description
number
Virtual access interface number.
Command Modes
Privileged EXEC (#)
Command History
Release 11.2F 12.2(33)SRE 15.0(1)M
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(33)SRE. This command was integrated into Cisco IOS Release 15.0(1)M.
Usage Guidelines
This command does not free the memory for uses unrelated to dial-in access.
Examples
The following example clears a specified virtual access interface. You can use the show interfaces virtual-access command to display the interface numbers before you clear any specific one.
Router# clear interface virtual-access 2.1
Related Commands
Command
Description
interface virtual-template Creates a virtual template interface that can be configured and applied dynamically in creating virtual access interfaces. show interfaces Displays statistics for the interfaces configured on a router or access server.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-83
Dial Commands clear ip route download
clear ip route download
To clear static routes downloaded from an authentication, authorization, and accounting (AAA) server, use the clear ip route download command in EXEC mode. clear ip route download {* | network-number network-mask | reload}
Syntax Description
* network-number network-mask reload
All routes. Destination network route and mask in standard IP address notation. For example, 10.1.1.1 255.255.255.255. Delete all routes, then reload static routes from the AAA server and reset the timer configured by the aaa route download command.
Command Modes
EXEC
Command History
Release 12.0(3)T
Modification This command was introduced.
Usage Guidelines
This command forces the router to reload static routes from the AAA server before the update timer expires.
Examples
The following example shows how to clear all routes:
Router# clear ip route download *
Related Commands
Command aaa authorization configuration default aaa route download show ip route
Description Downloads static route configuration information from the AAA server using TACACS+ or RADIUS. Enables the download static route feature and sets the amount of time between downloads. Displays all static IP routes, or those installed using the AAA route download function.
Cisco IOS Dial Technologies Command Reference
DIA-84
November 2009
Dial Commands clear line
clear line
To return a terminal line to idle state, use the clear line command in EXEC mode. clear line line-number
Syntax Description
line-number
Absolute line number.
Command Modes
EXEC
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
Use this command to log out of a specific session running on another line. If the line uses a modem, the modem will be disconnected.
Examples
The following example resets line 3 to idle state:
Router# clear line 3
Cisco IOS Dial Technologies Command Reference November 2009
DIA-85
Dial Commands clear line async-queue
clear line async-queue
To reset the connections currently waiting to use a rotary line in the queue, use the clear line async-queue command in EXEC mode. clear line async-queue [rotary-group]
Syntax Description
rotary-group
(Optional) Rotary group.
Command Modes
EXEC
Command History
Release 12.1(1)T
Modification This command was introduced.
Usage Guidelines
Use this command without any argument to remove all rotary line queues and terminate the asynchronous queue manager. Use the clear line async-queue command with the rotary-group argument to reset only the specified rotary group.
Examples
The following example clears all the rotary queues and shows the resulting output:
Router# clear line async-queue Clearing queued Clearing rotary Clearing line Clearing line Clearing rotary Clearing line Clearing line Clearing line connections for ALL rotary groups ! [confirm] group 1 69 70 group 2 66 67 68
Cisco IOS Dial Technologies Command Reference
DIA-86
November 2009
Dial Commands clear modem
clear modem
To reset the hardware for one or more manageable modems on an access server or router, use the clear modem command in EXEC mode. clear modem {slot/port | all | group group-number | at-mode slot/port | test}
Syntax Description
slot/port all group group-number at-mode slot/port
Slot and modem port number. (Include the slash mark when entering this variable, for example: 1/1.) All modems. This command disconnects any active calls. Group of modems. The modem group number is the number of the group you have previously created. AT directly connected session. The variable, slot/port, is required. This EXEC command clears an attention (AT) directly connected session to a manageable Microcom modem from a second Telnet session. Log or test report that is displayed by the show modem test command. If you do not clear the test regularly, eventually the oldest test report will replace the current test report.
test
Command Modes
EXEC
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
The modem hardware is reset for modems that are idle or busied out for long periods of time. An AT directly connected session is usually initiated and closed from the same Telnet session when you enter the modem at-mode command and press Ctrl-C. However, you can clear an AT directly connected session that was mistakenly left open by enabling the clear modem at-mode command from a second Telnet session in to the access server.
Examples
The following example of the clear modem slot/port command resets the hardware for manageable modem 1/1:
Router# clear modem 1/1
The following is an example of using the clear modem all command:
Router# clear modem all This command will disconnect any active calls. Clear (reset) all modems? [confirm] Clearing modems................................................ Done Router#
Cisco IOS Dial Technologies Command Reference November 2009
DIA-87
Dial Commands clear modem
The following examples of the clear modem group command clear the manageable modems in group 1:
Router# clear modem group 1 Router# clear modem group1
The following example executes the clear modem at-mode command from a Telnet session:
modem at-mode 1/1
The following example executes the clear modem at-mode command from a second Telnet session while the first Telnet session is connected to the modem:
Router# clear modem at-mode 1/1 clear "modem at-mode" for modem 1/1 [confirm] Router#
The following output is displayed in the first Telnet session after the modem is cleared by the second Telnet session:
Direct connect session cleared by vty0 (172.19.1.164)
Related Commands
Command
Description
clear modem counters Clears the statistical counters on one or more manageable modems on access servers or routers. interface group-async Creates a group interface that will serve as master, to which asynchronous interfaces can be associated as members. show modem at-mode Opens a directly connected session and enters AT command mode, which is used for sending AT commands to Microcom manageable modems. show modem test Displays the modem test log.
Cisco IOS Dial Technologies Command Reference
DIA-88
November 2009
Dial Commands clear modem counters
clear modem counters
To clear the statistical counters on one or more manageable modems installed in an access server, use the clear modem counters command in EXEC mode. clear modem counters [slot/port-number | group [group-number]]
Syntax Description
slot/port-number
(Optional) Slot and modem port number. (Include the slash mark when entering this variable, for example: 1/1.)
group [group-number] (Optional) One or all groups of modems. The optional modem group number is the number of a group-async interface. The group number range is from 1 to 1002.
Command Default
Disabled
Command Modes
EXEC
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
Entering the clear modem counters command without specifying an optional keyword or argument resets the modem statistics on each modem and the summary statistics displayed in the show modem summary command. The subcommand clear modem counters group without the group number clears counters in all modem groups. The optional modem group number is the number of a group you have previously created.
Examples
The following example of the clear modem counters slot/port command clears the statistical counters on manageable modem 1/1:
Router# clear modem counters 1/1
The following example of the clear modem counters group command clears the statistical counters on all manageable modem groups:
Router# clear modem counters group Clear "show modem" counters for all modem groups [confirm] Router# *Oct 17 20:20:24.974: %CLEAR-5-COUNTERS: Clear counter on modems in all groups e Router#
Cisco IOS Dial Technologies Command Reference November 2009
DIA-89
Dial Commands clear modem counters
Related Commands
Command clear cot summary
Description Clears the counters of a specified asynchronous interface or specified asynchronous interface group.
show modem summary Displays a high-level report for all manageable modems dialing into and out of the network.
Cisco IOS Dial Technologies Command Reference
DIA-90
November 2009
Dial Commands clear modem log
clear modem log
To reset the log for one or more manageable modems installed in a Cisco AS5800 series access server, use the clear modem log command in EXEC mode. clear modem log [shelf/slot/port [shelf/slot/port ...] | group [group-number]]
Syntax Description
shelf/slot/port [shelf/slot/port ...]
(Optional) One or several modem shelves listed in the order shelf, slot, and port. (Include the slash mark when entering the values.) The shelf value is the shelf ID of the dial shelf. The slot values range from 2 to 11 and the port values range from 0 to 323 on the UP324 modem card, and from 0 to 143 on the Double Density Modem Module (DMM) card.
group [group-number] (Optional) One or all groups of modems. The optional modem group number is the number of a group-async interface. The group number range is from 1 to 1002.
Command Default
Reset logs for all modems.
Command Modes
EXEC
Command History
Release 12.1T
Modification This command was introduced.
Usage Guidelines
Entering the clear modem log command without specifying an optional keyword or argument resets the log for all modems. Entering the clear modem log command and the group keyword without an argument clears the log for all modem groups. Use the optional shelf/slot/port or group-number argument to clear the log of a specific modem or modem group. The group-number argument is the number of a group you have previously created using the interface group-async global configuration and group range interface configuration commands. These commands create a group of asynchronous interfaces that are associated with a group asynchronous interface on the same device.
Examples
The following example clears the modem log for shelf 1, slot 4, port 0:
Router# clear modem log 1/4/0 Clear Modem log for modem 1/4/00 [confirm]y
Use the show modem log command to verify that the modem log for shelf 1, slot 4, port 0 is cleared:
Router# show modem log 1/4/0 Modem 1/4/00 Events Log:
Cisco IOS Dial Technologies Command Reference November 2009
DIA-91
Dial Commands clear modem log
The following example clears the modem logs for shelf 1, slot 4, port 0 and shelf 1, slot 4, port 2:
Router# clear modem log 1/4/1 1/4/2 Clear modem log for modems 1/4/01 to 1/4/02 [confirm]y
Use the show modem log command to verify the modem logs for shelf 1, slot 4, port 0 and shelf 1, slot 4, port 2 are cleared:
Router# show modem log 1/4/1 1/4/2 Modem 1/4/01 Events Log: Modem 1/4/02 Events Log:
The following example clears the log for all modems:
Router# clear modem log Clear modem log for all modems [confirm]y
The following example clears the log for all modem groups:
Router# clear modem log group Clear modem log for modems in all groups [confirm]y
The following example clears the log for modem group 0:
Router# clear modem log group 0 Clear modem log for modems in group 0 [confirm]y
Related Commands
Command group range interface group-async show modem log
Description Creates a list of member asynchronous interfaces (associated with a group interface). Creates a group interface that will serve as master, to which asynchronous interfaces can be associated as members. Displays the modem history event status performed on a manageable modem or group of modems.
Cisco IOS Dial Technologies Command Reference
DIA-92
November 2009
Dial Commands clear modempool-counters
clear modempool-counters
To clear the active or running counters associated with one or more modem pools, use the clear modempool-counters command in EXEC mode. clear modempool-counters [name]
Syntax Description
name
(Optional) Modem pool name. If you do not include this option, all counters for all modem pools will be cleared.
Command Modes
EXEC
Command History
Release 11.2P
Modification This command was introduced.
Usage Guidelines
The clear modempool-counters command clears the counters that are displayed in the show modem-pool command. This command is used only with MICA technologies digital modems.
Examples
The following examples show three modem pools set up on the access server: System-def-Mpool, v90service, and v34service:
Router# show modem-pool modem-pool: System-def-Mpool modems in pool: 20 active conn: 15 0 no free modems in pool modem-pool: v90service modems in pool: 50 active conn: 43 3 no free modems in pool called_party_number: 4441000 max conn allowed: 50, active conn: 43 3 max-conn exceeded, 3 no free modems in pool modem-pool: v34service modems in pool: 50 active conn: 30 1 no free modems in pool called_party_number: 4443000 max conn allowed: 50, active conn: 30 0 max-conn exceeded, 0 no free modems in pool
In the following example, the clear modempool-counters v90service command clears the running counters for the v90services modem pool:
Router# clear modempool-counters v90service Router# show modem-pool modem-pool: System-def-Mpool modems in pool: 20 active conn: 15 0 no free modems in pool
Cisco IOS Dial Technologies Command Reference November 2009
DIA-93
Dial Commands clear modempool-counters
modem-pool: v90service modems in pool: 50 active conn: 0 0 no free modems in pool called_party_number: 4441000 max conn allowed: 50, active conn: 0 0 max-conn exceeded, 0 no free modems in pool modem-pool: v34service modems in pool: 50 active conn: 30 1 no free modems in pool called_party_number: 4443000 max conn allowed: 50, active conn: 30 0 max-conn exceeded, 0 no free modems in pool
Related Commands
Command called-number (modem pool) modem-pool
Description Assigns a called party number to a pool of modems. Creates a new modem pool or specifies an existing modem pool, which allows you to physically or virtually partition your access server for dial-in and dial-out access. Assigns a range of modems to a modem pool. Displays the configuration and connection status for one or more modem pools.
pool-member show modem-pool
Cisco IOS Dial Technologies Command Reference
DIA-94
November 2009
Dial Commands clear port
clear port
To reset the NextPort port and clear any active call to the port, use the clear port command in EXEC mode.
Cisco AS5400 with the NextPort Dial Feature Card (DFC)
clear port [slot | slot/port]
Cisco AS5800 with the Universal Port Card (UPC)
clear port [shelf/slot | shelf/slot/port]
Syntax Description
slot slot/port
(Optional) The slot number to be cleared. All ports on the specified slot will be cleared. For the Cisco AS5400, slot values range from 1 to 7. (Optional) The slot and port number to be cleared. For the Cisco AS5400, slot values range from 1 to 7 and port values range from 0 to one less than the number of ports supported by the card. You must type in the slash mark. (Optional) The shelf and slot number to be cleared. All ports on the specified shelf and slot will be cleared. For the Cisco AS5800, shelf values range from 0 to 1 and UPC slot values range from 2 to 11. You must type in the slash mark. (Optional) The shelf, slot, and port number to be cleared. For the Cisco AS5800, shelf values range from 0 to 1, slot values range from 2 to 11, and port values range from 0 to 323. You must type in the slash mark.
shelf/slot
shelf/slot/port
Command Modes
EXEC
Command History
Release 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5400. This command was implemented on the Cisco AS5800. This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
If you specify the shelf, slot, and port, you clear that port on that SPE. If you specify only the shelf and slot, you clear all active ports on that particular shelf and slot. If you do not specify a shelf, slot, or port, you clear all the ports on the access server. This command also clears the Bad state on a port and resets it. However, the port is not cleared if the SPE was previously in a Bad state due to an SPE firmware download.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-95
Dial Commands clear port
Examples
The following example shows output from the clear port command on the Cisco AS5400 with the NextPort DFC. This example clears slot 1, port 1:
Router# clear port 1/1 This will clear port 1/01[confirm]y
The following example shows output from the clear port command on the Cisco AS5800 with the UPC. This example clears shelf 1, slot 3, port 0:
Router# clear port 1/3/0 This will clear port 1/03/00[confirm]y
Related Commands
Command busyout clear line clear spe show port digital log show port modem log show spe shutdown (port)
Description Informs the central-office switch that a channel is out of service. Returns a terminal line to idle state. Reboots all specified SPEs. Displays the data event log for digital modems. Displays the events generated by the modem sessions Displays SPE status. Disables a port.
Cisco IOS Dial Technologies Command Reference
DIA-96
November 2009
Dial Commands clear port log
clear port log
To clear all event entries in the port level history event log, use the clear port log command in EXEC mode.
Cisco AS5400 with NextPort DFC
clear port log [slot | slot/port]
Cisco AS5800 with Universal Port Card
clear port log [shelf/slot | shelf/slot/port]
Syntax Description
slot slot/port
(Optional) All ports on the specified slot. For the AS5400, slot values range from 0 to 7. (Optional) All ports on the specified slot and SPE. For the AS5400, slot values range from 0 to 7 and port values range from 0 to 107. Be sure to include the slash mark. (Optional) All ports on the specified shelf and slot. For the AS5800, shelf values range from 0 to 1 and UPC slot values range from 2 to 11. Be sure to include the slash mark. (Optional) All ports on the specified SPE. For the AS5800, shelf values range from 0 to 1, slot values range from 2 to 11, and port values range from 0 to 323. Be sure to include the slash mark.
shelf/slot
shelf/slot/port
Command Modes
EXEC
Command History
Release 12.1(1)XD 12.1(3)T
Modification This command was introduced on the Cisco AS5400. This command was implemented on the Cisco AS5800.
Usage Guidelines
The clear port log command clears the entire port log. You cannot remove individual service events from the port log. On the Cisco AS5400 only, you can use show port modem log or the show port digital log to display specific service events, but you must use clear port log to clear the entire port event log.
Examples
The following example shows output from the clear port log command on the Cisco AS5400 with NextPort DFC. This example clears slot 1, port 1:
Router# clear port log 1/1 This will clear log event history for port(s)1/01 - 1/01[confirm]y
Cisco IOS Dial Technologies Command Reference November 2009
DIA-97
Dial Commands clear port log
The following example shows output from the clear port log command on the Cisco AS5800 with universal port card. This example clears shelf 1, slot 3, port 0:
Router# clear port log 01/03/00 This will clear port 1/03/00[confirm]y
Related Commands
Command show port digital log show port modem log
Description Displays the data event log for digital modems. Displays the events generated by the modem sessions.
Cisco IOS Dial Technologies Command Reference
DIA-98
November 2009
Dial Commands clear resource-pool
clear resource-pool
To reset the counter statistics associated with a specific customer profile, call discriminator, or physical resource, use the clear resource-pool command in privileged EXEC mode. clear resource-pool {customer | discriminator | resource} {name | all}
Syntax Description
customer resource name all
Customer profile. Physical resource. Checks the counters maintained for resource groups. Specific customer profile, discriminator, or physical resource in the access server. All customer profiles, discriminators, or physical resources in the access server.
discriminator Call discriminator.
Command Modes
Privileged EXEC
Command History
Release 12.0(4)XI
Modification This command was introduced.
Usage Guidelines
Use the clear resource-pool privileged EXEC command to reset the counter statistics associated with a specific customer profile, call discriminator, or physical resource.
Examples
The following example shows the use of the clear resource-pool command for the specific customer named “customer-isp”:
Router# clear resource-pool customer ? WORD all Customer profile name Clear all customer profiles
Router# clear resource-pool customer customer-isp
Related Commands
Command show resource-pool call show resource-pool customer show resource-pool resource
Description Displays all active call information for all customer profiles and resource groups. Displays the contents of one or more customer profiles. Displays the resource groups configured in the NAS.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-99
Dial Commands clear snapshot quiet-time
clear snapshot quiet-time
To end the quiet period on a client router within two minutes, use the clear snapshot quiet-time command in EXEC mode. clear snapshot quiet-time interface-type interface-number
Syntax Description
interface-type interface-number
Interface type and number.
Command Modes
EXEC
Command History
Release 10.3
Modification This command was introduced.
Usage Guidelines
The clear snapshot quiet-time command places the client router in a state to reenter the active period within two minutes. The two-minute hold period ensures a quiet period of at least two minutes between active periods.
Examples
The following example ends the quiet period on dialer interface 1:
Router# clear snapshot quiet-time dialer 1
Related Commands
Command show snapshot snapshot client
Description Displays snapshot routing parameters associated with an interface. Configures a client router for snapshot routing.
Cisco IOS Dial Technologies Command Reference
DIA-100
November 2009
Dial Commands clear spe
clear spe
To reboot all specified service processing elements (SPEs), use the clear spe command in EXEC mode.
Cisco AS5400 with the NextPort Dial Feature Card (DFC)
clear spe [slot | slot/spe]
Cisco AS5800 with the Universal Port Card (UPC)
clear spe [shelf/slot | shelf/slot/spe]
Syntax Description
slot slot/spe
(Optional) The slot number to be cleared. All ports on the specified slot will be cleared. For the Cisco AS5400, slot values range from 1 to 7. (Optional) The slot and service processing element (SPE) number to be cleared. All ports on the specified slot and SPE will be cleared. For the Cisco AS5400, slot values range from 1to 7 and SPE values range from 1 to 17. You must type in the slash mark. (Optional) The shelf and slot number to be cleared. All ports on the specified shelf and slot will be cleared. For the Cisco AS5800, shelf values range from 0 to 1 and UPC slot values range from 2 to 11. You must type in the slash mark. (Optional) The shelf, slot and SPE number to be cleared. All ports on the specified SPE will be cleared. For the Cisco AS5800, shelf values range from 0 to 1, slot values range from 2 to 11, and SPE values range from 0 to 53. You must type in the slash marks.
shelf/slot
shelf/slot/spe
Command Modes
EXEC
Command History
Release 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5400. This command was implemented on the Cisco AS5800. This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
Execution of the clear spe command causes the configured firmware to be downloaded to the specified SPE or the range of SPEs and causes the power-on self-test (POST) to be executed. This command can be executed regardless of the state of the SPEs.
Note
All active ports running on the SPE are prematurely terminated and messages are logged into the appropriate log.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-101
Dial Commands clear spe
This command downloads configured SPEs with firmware as configured. Unconfigured SPEs download with the default firmware, which is the bundled version. To configure and manage the downloading of firmware without abruptly terminating SPEs, use the firmware location or firmware upgrade commands as appropriate.
Examples
The following example clears SPEs when the clear spe command is entered on the Cisco AS5400 with the NextPort DFC. This example performs a coldstart on slot 1, SPE 1.
Router# clear spe 1/1 Router# This will tear all active calls on the SPE(s), if any.[confirm]y
The following example clears SPEs when the clear spe command is entered on the Cisco AS5800 with the UPC. This example performs a coldstart on shelf 1, slot 8, SPE 0.
Router# clear spe 1/8/0 Router# This will tear all active calls on the SPE(s), if any.[confirm]y
Related Commands
Command busyout clear line clear port show spe shutdown (port)
Description Disables a port by waiting for the active services on the specified port to terminate. Returns a line to its idle state. Resets the NextPort port and clears any active call. Displays SPE status. Disables a port.
Cisco IOS Dial Technologies Command Reference
DIA-102
November 2009
Dial Commands clear spe counters
clear spe counters
To clear all statistics, use the clear spe counters command in EXEC mode.
Cisco AS5350 and Cisco AS5400 with the NextPort Dial Feature Card (DFC)
clear spe counters [slot | slot/spe] [slot | slot/spe]
Cisco AS5800 with the Universal Port Card (UPC)
clear spe counters [slot/spe | shelf/slot | shelf/slot/spe] [slot/spe | shelf/slot | shelf/slot/spe]
Syntax Description
slot
(Optional) The slot number to be cleared. All ports on the specified slot will be cleared. For the Cisco AS5350 slot values range from 1 to 3. For the Cisco AS5400, slot values range from 1 to 7. A range of slots can be cleared by entering a second value for the slot argument. (Optional) The slot and service processing element (SPE) number to be cleared. All ports on the specified slot and SPE will be cleared. For the Cisco AS5350 slot values range from 1 to 3. For the Cisco AS5400, slot values range from 1 to 7. The SPE values range from 0 to 17.You must type in the slash mark. A range of SPEs can be cleared by entering by entering a second value for the slot/spe argument. (Optional) The shelf and slot number to be cleared. All ports on the specified shelf and slot will be cleared. For the Cisco AS5800, shelf values range from 0 to 1 and UPC slot values range from 2 to 11. You must type in the slash mark. A range of slots can be cleared by entering by entering a second value for the shelf/slot argument. (Optional) The shelf, slot and SPE number to be cleared. All ports on the specified SPE will be cleared. For the Cisco AS5800, shelf values range from 0 to 1, slot values range from 2 to 11, and SPE values range from 0 to 53. You must type in the slash marks. A range of SPEs can be cleared by entering by entering a second value for the shelf/slot/spe argument.
slot/spe
shelf/slot
shelf/slot/spe
Command Modes
EXEC
Command History
Release 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5400. This command was implemented on the Cisco AS5800. This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
The clear spe counters command clears statistical counters of all service types for the specified SPE, range of SPEs, or all the SPEs. If you do not set a parameter, you clear all SPE statistical counters.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-103
Dial Commands clear spe counters
Examples
The following example shows how to clear all statistics by entering the clear spe counters command on the Cisco AS5350 with the NextPort DFC:
Router# clear spe counters 1/3 1/7 This will clear statistic counters for SPEs 1/03 - 1/07 [confirm]y
The following example shows how to clear all statistics by entering the clear spe counters command on the Cisco AS5800 with the UPC. This example clears shelf 1, slot 3, ports 0 to 11.
Router# clear spe counters 1/3/0 1/3/11 This will clear statistic counters for SPEs 1/03/00 - 1/03/11[confirm]y
Cisco IOS Dial Technologies Command Reference
DIA-104
November 2009
Dial Commands clear spe log
clear spe log
To clear event entries in the slot history event log, use the clear spe log command in EXEC mode.
Cisco AS5400 with the NextPort Dial Feature Card (DFC)
clear spe log [slot] [slot]
Cisco AS5800 with the Universal Port Card (UPC)
clear spe log [shelf/slot] [shelf/slot]
Syntax Description
slot
(Optional) The slot number to be cleared. All ports on the specified slot will be cleared. For the Cisco AS5400, slot values range from 1 to 7. A range of slots can be cleared by entering a second value for the slot argument. (Optional) The shelf and slot number to be cleared. All ports on the specified shelf and slot will be cleared. For the Cisco AS5800, shelf values range from 0 to 1 and UPC slot values range from 2 to 11. You must type in the slash mark. A range of slots can be cleared by entering a second value for the shelf/slot argument.
shelf/slot
Command Modes
EXEC
Command History
Release 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5400. This command was implemented on the Cisco AS5800. This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
The clear spe log command clears event entries in the slot history event log. If you do not specify the shelf/slot range, all service processing element (SPE) event entries clear. If you specify the shelf/slot, only the event entries for that slot clear.
Examples
The following example shows output from the clear spe log command on the Cisco AS5400 with the NextPort DFC. This example clears the SPE log from shelf 1, 2 and 3:
Router# clear spe log 1 3 This will clear slot event history for slot(s) 1 - 3[confirm]y
The following example shows output from the clear spe log command on the Cisco AS5800 with the UPC. This example clears shelf 1, slot 8:
Router# clear spe log 1/8 This will clear slot event history for slot(s) 8 - 8[confirm]y
Cisco IOS Dial Technologies Command Reference November 2009
DIA-105
Dial Commands clear spe log
Related Commands
Command show spe log
Description Displays the SPE system log.
Cisco IOS Dial Technologies Command Reference
DIA-106
November 2009
Dial Commands clid group
clid group
To add a calling line identifier (CLID) group to a discriminator, use the clid group command in CLID configuration mode. To remove a CLID group from a discriminator, use the no form of this command. clid group {clid-group-name | default} no clid group {clid-group-name | default}
Syntax Description
clid-group-name
Name of the CLID group added to the discriminator. You can add an existing CLID group or one that is to be defined. Discrimination does not happen until the CLID group is defined. Default discrimination profile. Any CLID number coming in on a call is in its respective default group unless it is specifically assigned a CLID group name.
default
Command Default
CLID screening is not used.
Command Modes
CLID configuration
Command History
Release 12.1(5)T
Modification This command was introduced.
Usage Guidelines
Use the clid group command to add a CLID group (which specifies the calls to reject) to the discriminator. If you use the default option, CLID call screening is not used.
Examples
The following example shows a call discriminator named “clidElim” created and configured to block digital calls from the CLID group named “group1”:
resource-pool profile discriminator clidElim call-type digital clid group group1
Related Commands
Command call-type resource-pool profile discriminator
Description Specifies the type of calls you want to block. Creates a call discrimination profile and assigns it a name.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-107
Dial Commands clock source line
clock source line
To set the E1 line clock source for the Cisco AS5200 access server, use the clock source line command in controller configuration mode. To change or remove the clocking source, use the no form of this command. clock source line {primary | secondary} no clock source line {primary | secondary}
Syntax Description
primary secondary
Primary TDM clock source. Secondary TDM clock source.
Command Default
Primary TDM clock source is taken from the E1 controller 0 on the Cisco AS5200. Secondary TDM clock source is taken from the E1 controller 1 on the Cisco AS5200.
Command Modes
Controller configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
Configure the clock source line primary command on the controller that takes the most reliable clocking from an E1 line. Configure the clock source line secondary command on the controller that has the next best known clocking. With this configuration, the primary line clocking is backed up to the secondary line if the primary clocking shuts down.
Examples
The following example configures the Cisco AS5200 to use E1 controller 0 as the primary clocking source and the E1 controller 1 as the secondary clocking source:
controller e1 0 framing esf linecode hdb3 pri-group timeslots 1-23 clock source line primary ! controller e1 1 framing esf linecode hdb3 pri-group timeslots 1-23 clock source line secondary
Cisco IOS Dial Technologies Command Reference
DIA-108
November 2009
Dial Commands clock source line
Related Commands
Command clear controller controller linecode show controllers e1
Description Resets the T1 or E1 controller. Configures a T1 or E1 controller and enters controller configuration mode. Selects the linecode type for T1 or E1 line. Displays information about the E1 links supported by the NPM (Cisco 4000) or MIP (Cisco 7500 series).
Cisco IOS Dial Technologies Command Reference November 2009
DIA-109
Dial Commands copy modem
copy modem
To copy modem firmware to integrated modems in an access server, use the copy modem command in EXEC mode. copy {flash | tftp | rcp} modem
Syntax Description
flash tftp rcp
Flash memory. Local TFTP server. Local rcp server.
Command Modes
EXEC
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
Note
The copy modem command is no longer available for MICA portware and 56K Microcom modems on Cisco AS5200 and AS5300 access servers. Use the spe command instead. The Microcom V.34 modems and Cisco AS5200 V.110 terminal adapter will continue to use the copy modem command. On bootup, because these modems do not require download, the command displays the location of the firmware as "feature_card_flash." After you enable this command, you are asked to provide the download destination (a slot/port or all), the remote host name, and the path leading to the source modem firmware. If a modem that you want to upgrade is busy with a call when the copy modem command is enabled, the upgrade for that modem yields until the active call is dropped. All other idle modems in the upgrade range proceed with the downloading operation.
Examples
The following example copies the modem firmware file called modem_upgrade from the TFTP server called Modem_Server to modem 2/0, which is installed in a Cisco AS5200 access server:
Router# copy tftp modem Modem Numbers (/[-/] | group | all)? 2/0 Address or name of remote host [UNKNOWN]? Modem_Server Source file name? file1/elem/modem_upgrade Accessing file 'file1/elem/modem_upgrade on Modem_Server... Loading file1/elem/modem_upgrade .from 192.168.254.254 (via Ethernet0): ! [OK] Loading file1/elem/modem_upgrade from 192.168.254.254 (via Ethernet0): !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! [OK - 237503/278528 bytes]
Cisco IOS Dial Technologies Command Reference
DIA-110
November 2009
Dial Commands copy modem
Router# %MODEM-5-DL_START: Modem (2/0) started firmware download %MODEM-5-DL_GOOD: Modem (2/0) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85
As shown in this example, you might want to upgrade and test one modem’s firmware before upgrading the firmware of all the modems on the access server, as shown in the next example. The following example downloads the same modem firmware file from the TFTP server to all the modems in the Cisco AS5200 access server:
Router# copy tftp modem Modem Numbers (/[-/] | group | all)? all Address or name of remote host [UNKNOWN]? Modem_Server Source file name? file1/elem/modem_upgrade Accessing file 'file1/elem/modem_upgrade on Modem_Server... Loading file1/elem/modem_upgrade .from 192.168.254.254 (via Ethernet0): ! [OK] Loading file1/elem/modem_upgrade from 192.168.254.254 (via Ethernet0): !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! [OK - 237503/278528 bytes] Router# %MODEM-5-DL_START: Modem (2/0) started firmware download %MODEM-5-DL_START: Modem (2/1) started firmware download %MODEM-5-DL_START: Modem (2/2) started firmware download %MODEM-5-DL_START: Modem (2/3) started firmware download %MODEM-5-DL_START: Modem (2/4) started firmware download %MODEM-5-DL_START: Modem (2/5) started firmware download %MODEM-5-DL_START: Modem (2/6) started firmware download %MODEM-5-DL_START: Modem (2/7) started firmware download %MODEM-5-DL_START: Modem (2/8) started firmware download %MODEM-5-DL_START: Modem (2/9) started firmware download %MODEM-5-DL_START: Modem (2/10) started firmware download %MODEM-5-DL_START: Modem (2/11) started firmware download %MODEM-5-DL_START: Modem (2/12) started firmware download %MODEM-5-DL_START: Modem (2/13) started firmware download %MODEM-5-DL_START: Modem (2/14) started firmware download %MODEM-5-DL_START: Modem (2/15) started firmware download %MODEM-5-DL_START: Modem (2/16) started firmware download %MODEM-5-DL_START: Modem (2/17) started firmware download %MODEM-5-DL_START: Modem (2/18) started firmware download %MODEM-5-DL_START: Modem (2/19) started firmware download %MODEM-5-DL_START: Modem (2/20) started firmware download %MODEM-5-DL_START: Modem (2/21) started firmware download %MODEM-5-DL_START: Modem (2/22) started firmware download %MODEM-5-DL_START: Modem (2/23) started firmware download %MODEM-5-DL_GOOD: Modem (2/2) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/10) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/4) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/6) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/7) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/12) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/11) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85
Cisco IOS Dial Technologies Command Reference November 2009
DIA-111
Dial Commands copy modem
%MODEM-5-DL_GOOD: Modem (2/13) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/1) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/14) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/19) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/22) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/5) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/8) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/9) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/17) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/0) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/3) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/21) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/16) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/15) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/18) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/20) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 %MODEM-5-DL_GOOD: Modem (2/23) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85
The following example copies the modem firmware file called STAR.M from Flash memory to the integrated modem 1/2:
Router# copy flash modem Modem Numbers (/ | group | all)? 1/2 System flash directory: File Length Name/status 1 3539820 as5200-i-m.allcookies 2 239203 STAR.M 3 23072 BOOT.105 [3802288 bytes used, 4586320 available, 8388608 total] Source file name? STAR.M Router# %MODEM-5-DL_START: Modem (1/2) started firmware download %MODEM-5-DL_GOOD: Modem (1/2) completed firmware download: MNPClass10V.34/V.FCModemRev1.0.23/85.23/85 Router
Related Commands
Command copy spe
Description Copies any file from a source to a destination. Enters SPE configuration mode and sets the range of SPEs.
Cisco IOS Dial Technologies Command Reference
DIA-112
November 2009
Dial Commands corlist incoming
corlist incoming
To specify the class of restrictions (COR) list to be used when a specified dial peer acts as the incoming dial peer, use the corlist incoming command in dial peer configuration mode. To clear the previously defined incoming COR list in preparation for redefining the incoming COR list, use the no form of this command. corlist incoming cor-list-name no corlist incoming cor-list-name
Syntax Description
cor-list-name
Name of the dial peer COR list that defines the capabilities that the specified dial peer has when it is used as an incoming dial peer.
Command Default
No default behavior or values.
Command Modes
Dial peer configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
The dial-peer cor list and member commands define a set of capabilities (a COR list). These lists are used in dial peers to indicate the capability set that a dial peer has when it is used as an incoming dial peer (the corlist incoming command) or to indicate the capability set that is required for an incoming dial peer to make an outgoing call through the dial peer (the corlist outgoing command). For example, if dial peer 100 is the incoming dial peer and its incoming COR list name is list100, dial peer 200 has list200 as the outgoing COR list name. If list100 does not include all the members of list200 (that is, if list100 is not a superset of list200), it is not possible to have a call from dial peer 100 that uses dial peer 200 as the outgoing dial peer.
Examples
In the following example, incoming calls from 526.... are blocked from being switched to outgoing calls to 1900.... because the COR list for the incoming dial peer (list2) is not a superset of the COR list for the outgoing dial peer (list1):
dial-peer list list1 member 900call dial-peer list list2 member 800call member othercall dial-peer voice 526 pots answer-address 408555.... corlist incoming list2 direct-inward-dial
Cisco IOS Dial Technologies Command Reference November 2009
DIA-113
Dial Commands corlist incoming
dial-peer voice 900 pots destination pattern 1900....... direct-inward-dial trunkgroup 101 prefix 333 corlist outgoing list1
Related Commands
Command corlist outgoing dial-peer cor list member
Description Specifies the COR list to be used by outgoing dial peers. Defines a COR list name. Adds a member to a dial peer COR list.
Cisco IOS Dial Technologies Command Reference
DIA-114
November 2009
Dial Commands corlist outgoing
corlist outgoing
To specify the class of restrictions (COR) list to be used by outgoing dial peers, use the corlist outgoing command in dial peer configuration mode. To clear the previously defined outgoing COR list in preparation for redefining the outgoing COR list, use the no form of this command. corlist outgoing cor-list-name no corlist outgoing cor-list-name
Syntax Description
cor-list-name
Required name of the dial peer COR list for outgoing calls to the configured number using this dial peer.
Command Default
No default behavior or values.
Command Modes
Dial peer configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
If the COR list for the incoming dial peer is not a superset of the COR list for the outgoing dial peer, calls from the incoming dial peer cannot use that outgoing dial peer.
Examples
In the following example, incoming calls from 526.... are blocked from being switched to outgoing calls to 1900.... because the COR list for the incoming dial peer (list2) is not a superset of the COR list for the outgoing dial peer (list1):
dial-peer list list1 member 900call dial-peer list list2 member 800call member othercall dial-peer voice 526 pots answer-address 408555.... corlist incoming list2 direct-inward-dial dial-peer voice 900 pots destination pattern 1900....... direct-inward-dial trunk group 101 prefix 333 corlist outgoing list1
Cisco IOS Dial Technologies Command Reference November 2009
DIA-115
Dial Commands cpp authentication
cpp authentication
Note
Effective with Cisco IOS Release 12.3(4)T, the cpp authentication command is no longer available in Cisco IOS software. To enable negotiation of authentication with a router or bridge that supports the Combinet Proprietary Protocol (CPP) and that is calling in to this router, use the cpp authentication command in interface configuration mode. To disable negotiation of CPP authentication, use the no form of this command. cpp authentication no cpp authentication
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 11.2 12.3(4)T
Modification This command was introduced. This command was removed and is no longer available in Cisco IOS software.
Usage Guidelines
Use this command for authenticating the device that is calling in to this router. Use this command to communicate over an ISDN interface with Cisco 700 and 800 series (formerly Combinet) routers that do not support PPP but do support the CPP. Since most Cisco routers support PPP, Cisco routers can communicate over ISDN with CPP devices by using PPP encapsulation, which supports both routing and fast switching. This command is supported on ISDN and dialer interfaces. This command uses names and passwords from the username password command. It does not support TACACS.
Examples
The following example configures a PRI to communicate with a bridge that does not support PPP:
controller t1 1/1 framing esf linecode b8zs pri-group timeslots 1-23 isdn switchtype primary-4ess
Cisco IOS Dial Technologies Command Reference
DIA-116
November 2009
Dial Commands cpp authentication
interface Serial1/1:23 encapsulation cpp cpp callback accept cpp authentication
The following example configures a BRI to communicate with a bridge that does not support PPP:
interface bri 0 encapsulation cpp cpp callback accept cpp authentication
Related Commands
Command cpp callback accept encapsulation cpp virtual-profile aaa
Description Enables the router to accept callback from a router or bridge that supports the CPP. Enables encapsulation for communication with routers or bridges using the CPP. Enables virtual profiles by AAA configuration.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-117
Dial Commands cpp callback accept
cpp callback accept
Note
Effective with Cisco IOS Release 12.3(4)T, the cpp callback accept command is no longer available in Cisco IOS software. To enable the router to accept callback from a router or bridge that supports the Combinet Proprietary Protocol (CPP), use the cpp callback accept command in interface configuration mode. To disable callback acceptance, use the no form of this command. cpp callback accept no cpp callback accept
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Interface configuration
Command History
Release 11.2 12.3(4)T
Modification This command was introduced. This command was removed and is no longer available in Cisco IOS software.
Usage Guidelines
Use this command to communicate over an ISDN interface with Cisco 700 and 800 series (formerly Combinet) routers that do not support PPP but do support CPP. Currently, most Cisco routers do support PPP. Cisco routers can communicate over ISDN with these devices by using PPP encapsulation, which supports both routing and fast switching. This command is supported on ISDN and dialer interfaces.
Examples
The following example configures the PRI serial interface 1/1:23 to communicate with a router or bridge that does not support PPP:
controller t1 1/1 framing esf linecode b8zs pri-group timeslots 1-23 isdn switchtype primary-4ess ! interface Serial1/1:23 encapsulation cpp cpp callback accept cpp authentication
Cisco IOS Dial Technologies Command Reference
DIA-118
November 2009
Dial Commands cpp callback accept
The following example configures BRI 0 to communicate with a router or bridge that does not support PPP:
interface bri 0 encapsulation cpp cpp callback accept cpp authentication
Related Commands
Command cpp authentication encapsulation cpp
Description Enables negotiation of authentication with a router or bridge that supports the CPP and that is calling in to this router. Enables encapsulation for communication with routers or bridges using the CPP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-119
Dial Commands cpp callback accept
Cisco IOS Dial Technologies Command Reference
DIA-120
November 2009
Dial Commands debounce-time rai
debounce-time rai
To configure a timer that prevents E1 or STM-1 trunk lines from being torn down in response to brief line outages, use the debounce-time rai command in controller configuration mode. To restore the default timer value, use the no form of this command. debounce-time rai milliseconds no debounce-time rai milliseconds
Syntax Description
milliseconds
Time, in milliseconds (ms), to wait before tearing down an E1 or STM-1 line after receiving a Receive Alarm Indication (RAI) signal.
AS5800
•
E1 lines—Valid values range from 500 to 7000 ms. The value entered must be a multiple of 50. The default value is 500 ms.
AS5850
• •
E1 lines—Valid values range from 1000 to 7000 ms. The value entered must be a multiple of 50. The default value is 1000 ms. STM-1 lines—Valid values range from 2000 to 7000 ms. The value entered must be a multiple of 50. The default value is 2000 ms.
Command Default
The default value for the timer is used:
• • •
E1 lines on the AS5800—500 ms E1 lines on the AS5850—1000 ms STM-1 lines on the AS5850—2000 ms
Command Modes
Controller configuration
Command History
Release 12.2(2)XB5 12.2(11)T 12.3(7)XI 12.3(4)T
Modification This command was introduced on the Cisco AS5800 and the route switch controller (RSC) Cisco AS5850. Support for this command on the Cisco AS5800 and the RSC Cisco AS5850 was integrated into Cisco IOS Release 12.2(11)T. Support for this command was added for the enhanced RSC (ERSC) Cisco AS5850. Support for the ERSC Cisco AS5850 was integrated into Cisco IOS Release 12.3(4)T.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-121
Dial Commands debounce-time rai
Usage Guidelines
Use the debounce-time rai command to configure a timer that allows Awaiting Info (I) calls to ignore brief trunk outages. When a Receive Alarm Indication (RAI) signal is received, the access server will wait the configured interval before tearing down the line.
Examples
The following example configures an E1 controller to wait for 5250 ms before tearing down an E1 trunk line:
Router(config)# controller e1 1/0/0 Router(config-controller)# debounce-time rai 5250
Related Commands
Command controller
Description Configures a T1, E1, or J1 controller and enters controller configuration mode.
Cisco IOS Dial Technologies Command Reference
DIA-122
November 2009
Dial Commands description (interface)
description (interface)
To add a description to an interface configuration, use the description command in interface configuration mode. To remove the description, use the no form of this command. description string no description
Syntax Description
string
Comment or a description to help you remember what is attached to this interface. This string is limited to 238 characters.
Command Default
No description is added.
Command Modes
Interface configuration
Command History
Release 9.21
Modification This command was introduced.
Usage Guidelines
The description command is meant solely as a comment to be put in the configuration to help you remember what certain interfaces are used for. The description appears in the output of the following EXEC commands: more nvram:startup-config, show interfaces, and more system:running-config.
Examples
The following example shows how to add a description for a T1 interface:
interface serial 0 description Fractional T1 line to remote office -- 128 kbps
Related Commands
Command more nvram:startup-config more system:running-config show interfaces
Description Displays the startup configuration file contained in NVRAM or specified by the CONFIG_FILE environment variable. Displays the running configuration. Displays statistics for all interfaces configured on the router or access server.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-123
Dial Commands dialer
dialer
To specify the dialer interface that an accept-dialout virtual private dialup network (VPDN) subgroup will use to dial out calls, use the dialer command in accept-dialout configuration mode. To remove the dialer interface from the accept-dialout VPDN subgroup, use the no form of this command. dialer dialer-interface no dialer
Syntax Description
dialer-interface
Number of the dialer interface.
Command Default
Disabled
Command Modes
Accept-dialout configuration
Command History
Release 12.0(5)T
Modification This command was introduced.
Usage Guidelines
You must first enable Layer 2 Tunneling Protocol (L2TP) on the accept-dialout VPDN subgroup by using the protocol l2tp command before you can enable the dialer command. Removing the protocol command will remove the dialer command from the accept-dialout subgroup. You can only specify one dialer per accept dialout group. Configuring a second dialer command will replace the first dialer command.
Examples
The following example creates an accept-dialout VPDN subgroup that uses dialer interface 2:
VPDN-group 1 accept dialout protocol l2tp dialer 2 terminate-from hostname yourhost
Related Commands
Command accept-dialout protocol (VPDN) terminate-from
Description Accepts requests to tunnel L2TP dial-out calls and creates an accept-dialout VPDN subgroup. Specifies the L2TP that the VPDN subgroup will use. Specifies the host name of the remote LAC or LNS that will be required when accepting a VPDN tunnel.
Cisco IOS Dial Technologies Command Reference
DIA-124
November 2009
Dial Commands dialer callback-secure
dialer callback-secure
To enable callback security, use the dialer callback-secure command in interface configuration mode. To disable callback security, use the no form of this command. dialer callback-secure no dialer callback-secure
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 11.0
Modification This command was introduced.
Usage Guidelines
This command affects those users that are not authorized to be called back through configuration of the dialer callback-server command. If the username (the host-name argument in the dialer map command) is not authorized for callback, the call will be disconnected if the dialer callback-secure command is configured.
Examples
The following partial example configures BRI0 with the commands required to make it function as the callback server on the shared network. Callback security is enabled on BRI0, such that any user other than user1 will be disconnected and not called back.
interface BRI0 ip address 172.19.1.9 255.255.255.0 encapsulation ppp dialer callback-secure dialer enable-timeout 2 dialer map ip 172.19.1.8 name user1 class dial1 81012345678901 dialer-group 1 ppp callback accept ppp authentication chap ! map-class dialer dial1 dialer callback-server username
Cisco IOS Dial Technologies Command Reference November 2009
DIA-125
Dial Commands dialer callback-secure
Related Commands
Command
Description
dialer callback-server Enables an interface to make return calls when callback is successfully negotiated. dialer map map-class dialer Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback. Enables a dialer interface that is not a DTR interface to function either as a callback client that requests callback or as a callback server that accepts callback requests.
ppp callback (DDR)
Cisco IOS Dial Technologies Command Reference
DIA-126
November 2009
Dial Commands dialer callback-server
dialer callback-server
To enable an interface to make return calls when callback is successfully negotiated, use the dialer callback-server command in interface configuration mode. To disable return calls, use the no form of this command. dialer callback-server [username | dialstring] no dialer callback-server
Syntax Description
username dialstring
(Optional) Looks up the authenticated host name in a dialer map command. This is the default. (Optional) Identifies the return call during callback negotiation.
Command Default
Disabled. The default keyword is username.
Command Modes
Interface configuration
Command History
Release 11.0
Modification This command was introduced.
Examples
The following partial example configures BRI 0 to function as the callback server on the shared network:
interface BRI0 ip address 172.19.1.9 255.255.255.0 encapsulation ppp dialer callback-secure dialer enable-timeout 2 dialer map ip 172.19.1.8 name mymap class dial1 81012345678901 dialer-group 1 ppp callback accept ppp authentication chap ! map-class dialer dial1 dialer callback-server username
Related Commands
Command dialer enable-timeout dialer hold-queue dialer map
Description Sets the length of time an interface stays down after a call has completed or failed and before the interface is available to dial again. Allows interesting outgoing packets to be queued until a modem connection is established. Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites.
dialer callback-secure Enables callback security.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-127
Dial Commands dialer callback-server
Command map-class dialer
Description Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback. Enables a dialer interface that is not a DTR interface to function either as a callback client that requests callback or as a callback server that accepts callback requests.
ppp callback (DDR)
Cisco IOS Dial Technologies Command Reference
DIA-128
November 2009
Dial Commands dialer called
dialer called
To configure dial-on-demand routing (DDR) to perform DNIS-plus-ISDN-subaddress binding for dialer profile interfaces, use the dialer called command in dial-on-demand routing configuration mode. To disable DNIS-plus-ISDN-subaddress binding, use the no form of this command. dialer called DNIS:subaddress no dialer called DNIS:subaddress
Syntax Description
DNIS:subaddress
Dialed Number Identification Service or the called party number, a colon, and the ISDN subaddress.
Command Default
No default behavior or values.
Command Modes
Dial-on-demand routing configuration
Command History
Release 12.0(4)T
Modification This command was introduced.
Usage Guidelines
If you have more than one DNIS-plus-ISDN-subaddress number to configure under the same dialer profile interface, you can configure multiple dialer called commands. The parser accepts a dialer called command with a DNIS and without the subaddress; however, the call will fail. For a successful call, enter the DNIS, a colon, and the ISDN subaddress after the dialer called command.
Examples
The following example configures a dialer profile for a receiver with DNIS 12345 and ISDN subaddress 6789:
dialer called 12345:6789
Related Commands
Command dialer caller
Description Configures caller ID screening and, optionally, enables ISDN caller ID callback for legacy DDR or the dialer profiles DDR feature.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-129
Dial Commands dialer caller
dialer caller
To configure caller ID screening for a dialer rotary group interface or to bind an incoming call to a particular dialer profile, and, optionally, to enable ISDN caller ID callback, use the dialer caller command in interface configuration mode. To disable this feature, use the no form of this command. dialer caller number [callback] no dialer caller number [callback]
Syntax Description
number
Remote telephone number for which to screen. Use a lower case letter x to represent a single “don’t care” digit. The maximum length of each number is 25 characters. (Optional) Enables callback.
callback
Command Default
Caller ID screening, call binding, and ISDN caller ID callback are disabled.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
On a dialer rotary group interface, this command configures the Cisco IOS software to accept calls from the specified number or, used with the callback keyword, to reject incoming calls from the specified number but to initiate callback to the number. When the optional callback keyword is used, the initial call is rejected (hence, not subject to tolls) and callback is initiated to the calling number. When x’s are used in the callback number, dialer caller screening is based on a best match system that uses the number of x’s as a criterion. To make callback calls only to specified numbers or ranges of numbers but to accept any other incoming calls, make sure that the number of x’s in any configuration line that uses the callback keyword is less than the number of x’s in any configuration line that does not use the keyword. For example, if you use at most four x’s in the configuration lines with the callback keyword, then to accept calls from other numbers use at least five x’s in a configuration line that does not use the callback keyword.
Note
Caller ID screening requires a local switch that is capable of delivering the caller ID to the router or access server. If you enable caller ID screening but do not have such a switch, no calls will be allowed in. For dialer profiles, this command helps bind a dialer profile to—and thus configure—the interface used for a call. The dialer command acts as a binding command by associating an incoming call with a specified dialer profile if the caller ID presented by the call matches the dialer caller value.
Cisco IOS Dial Technologies Command Reference
DIA-130
November 2009
Dial Commands dialer caller
Note
Incoming calls also can be bound to a dialer profile based on PPP name authentication, so in this instance the incoming call can be bound to the dialer profile even if the presented caller ID does not match the dialer caller value. To configure caller ID screening with dialer profiles, use the legacy isdn caller command.
Examples
In the following example, callback calls will be made only to numbers in the 555 and 556 exchanges, but any other number can call in:
dialer caller 408555xxxx callback dialer caller 408556xxxx callback dialer caller xxxxx
Related Commands
Command isdn caller show dialer
Description Configures ISDN caller ID screening and, optionally, enables ISDN caller ID callback for legacy DDR. Displays general diagnostic information for interfaces configured for DDR.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-131
Dial Commands dialer clid group
dialer clid group
To create a Calling Line Identification (CLID) group in the resource pool and assign it a name, use the dialer clid group command in global configuration mode. To remove a CLID group from the resource pool, use the no form of this command. dialer clid group clid-group-name no dialer clid group clid-group-name
Syntax Description
clid-group-name
Name of the CLID group created in the resource pool.
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Release 12.1(5)T
Modification This command was introduced.
Usage Guidelines
Use the dialer clid group command to create a CLID group and assign it a name. The CLID group name must be the same as the name used when configuring the customer profile. Customer profiles are configured with a DNIS and/or CLID group and call type. The DNIS and/or CLID and call type of the incoming call is used to find the appropriate customer profile.
Examples
The following example shows the command to configure a CLID group named “group1.” After you enter this command, the router prompt changes to the CLID configuration mode, Router(config-clid-group)#.
Router(config)# dialer clid group group1
Related Commands
Command number
Description Adds a DNIS number to a dialer DNIS group.
resource-pool call treatment discriminator Configures a CLID group in a discriminator.
Cisco IOS Dial Technologies Command Reference
DIA-132
November 2009
Dial Commands dialer congestion-threshold
dialer congestion-threshold
To specify congestion threshold in connected links, use the dialer congestion-threshold command in interface configuration mode. To disable this function, use the no form of this command. dialer congestion-threshold links no dialer congestion-threshold
Syntax Description
links
Number of connected links for congestion threshold in the range from 0 to 64,000.
Command Default
The default number of connected links is 64,000.
Command Modes
Interface configuration
Command History
Release 12.0(3)T
Modification This command was introduced.
Usage Guidelines
This command is used to force the dialer to search for another uncongested system (the alternate network access server) in a stack group to dial out using Stack Group Bidding Protocol (SGBP).
Examples
The following example sets the congestion threshold to five connected links on the Dialer interface 0:
interface Dialer0 dialer aaa dialer congestion-threshold 5
Related Commands
Command dialer reserved-links sgbp dial-bids
Description Reserves links for dial-in and dial-out. Allows the stack group to bid for dial-out connection.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-133
Dial Commands dialer dnis group
dialer dnis group
To create a DNIS group, use the dialer dnis group command in global configuration mode. To remove a specific Dialed Number Identification Service (DNIS) group from the running configuration, use the no form of this command. dialer dnis group name no dialer dnis group name
Syntax Description
name
Name to assign to the DNIS group number.
Command Default
A dialer DNIS group named default.
Command Modes
Global configuration
Command History
Release 12.0(4)XI
Modification This command was introduced.
Usage Guidelines
Use the dialer dnis group global configuration command to create a DNIS group. This command enables you to create and populate a DNIS group, which is then added to a profile (customer or discriminator) by using the dnis group command within that profile’s configuration mode.
Examples
The following example shows a specific DNIS group named modem-group1 being created with the options available for further configuration:
dialer dnis group modem-group1 Dialer Called Configuration Commands: call-type set call-type override default Set a command to its defaults exit Exit from dialer configuration mode help Description of the interactive help system no Negate a command or set its defaults number Enter number in dnis group
In the following example, a customer profile called isp-1 is created, a DNIS group called dnis-isp-1 is associated with the customer profile, and DNIS numbers 1234 and 5678 are assigned to the DNIS group. Only DNIS numbers 1234 and 5678 are allocated physical resources by the isp-1 customer profile, which counts and manages the resources for these two DNIS numbers and ignores all other DNIS numbers:
resource-pool profile customer isp-1 dnis group dnis-isp-1 exit dialer dnis group dnis-isp-1 number 1234 number 5678
Cisco IOS Dial Technologies Command Reference
DIA-134
November 2009
Dial Commands dialer dnis group
Related Commands
Command dnis group resource-pool profile
Description Includes a group of DNIS numbers in a customer profile. Creates a resource group for RPM.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-135
Dial Commands dialer dns
dialer dns
To obtain a user profile name on a remote network using reverse Domain Name System (DNS), use the dialer dns command in interface configuration mode. To disable this function, use the no form of this command. dialer dns no dialer dns
Syntax Description
This command has no arguments or keywords.
Command Default
The reverse DNS function is disabled by default.
Command Modes
Interface configuration of a dialer rotary group leader
Command History
Release 12.0(3)T
Modification This command was introduced.
Usage Guidelines
This command allows the dialer to use reverse DNS to get a profile name for accessing the authentication, authorization, and accounting (AAA) server. This command is not required when using named static routes.
Examples
The following example shows how to allow the dialer to use reverse DNS for name lookup:
interface dialer 0 dialer aaa dialer dns
Related Commands
Command dialer aaa
Description Allows a dialer to access the AAA server for dialing information.
Cisco IOS Dial Technologies Command Reference
DIA-136
November 2009
Dial Commands dialer dtr
dialer dtr
To enable dial-on-demand routing (DDR) on an interface and specify that the serial line is connected by non-V.25bis modems using Electronic Industries Association (EIA) signaling only—specifically, the data terminal ready (DTR) signal—use the dialer dtr command in interface configuration mode. To disable DDR for the interface, use the no form of this command. dialer dtr no dialer dtr
Syntax Description
This command has no arguments or keywords.
Command Default
DTR dialing is disabled.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
A serial interface configured for DTR dialing can place calls only; it cannot accept them. When a local interface is configured for DTR dialing, the remote interface (that will be receiving the calls) can be configured for in-band dialing or not configured for anything but encapsulation, depending on the desired behavior. If the remote interface is expected to terminate a call when no traffic is transmitted for some time, it must be configured for in-band dialing (along with access lists and a dummy dialer string). If the remote interface is purely passive, no configuration is necessary. Rotary groups cannot be configured for DTR dialing. The dialer map and dialer string commands have no effect on DTR dialers.
Examples
The following example enables DDR and specifies DTR dialing on an interface:
Router(config-if)# dialer dtr
Related Commands
Command dialer in-band dialer map dialer string (legacy DDR)
Description Specifies that DDR is to be supported. Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Specifies the destination string (telephone number) to be called for interfaces calling a single site.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-137
Dial Commands dialer enable-timeout
dialer enable-timeout
To set the length of time an interface stays down after a call has completed or failed and before it is available to dial again, use the dialer enable-timeout command in interface configuration mode. To return to the default value, use the no form of this command. dialer enable-timeout seconds no dialer enable-timeout
Syntax Description
seconds
Time in seconds that the Cisco IOS software waits before the next call can occur on the specific interface. Acceptable values are positive, nonzero integers in the range from 1 through 2147483. This value must be greater than the serial pulse interval for this interface, set via the pulse-time command.
Command Default
15 seconds
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
The dialer enable-timeout command can be configured as a line down timer, to keep asynchronous interface lines down for a certain period of time, and as a callback timer for both synchronous and asynchronous interfaces. If your phone lines are often busy or down, you may need to enforce a certain period of time before the system repeats an attempt to make a connection with a remote site. Configuring this timeout can prevent outgoing lines and switching equipment from being needlessly overloaded. In this application, the dialer enable-timeout command applies to both inbound and outbound calls on asynchronous interfaces only. When the dialer enable-timeout command is configured on an ISDN interface, its only effect is to set a callback timer, because it is not possible (nor advisable) to keep an ISDN interface disconnected.
Examples
The following example shows how to specify a timeout period of 30 seconds on asynchronous interface 1 before attempting another connection:
interface async 1 dialer enable-timeout 30
The following example shows how to configure a BRI interface for legacy dial-on-demand routing (DDR) and ISDN caller ID callback:
interface bri 0 description Connected to NTT 81012345678901 ip address 10.1.1.7 255.255.255.0
Cisco IOS Dial Technologies Command Reference
DIA-138
November 2009
Dial Commands dialer enable-timeout
no ip mroute-cache encapsulation ppp isdn caller 81012345678902 callback dialer enable-timeout 2 dialer map ip 10.1.1.8 name spanky 81012345678902 dialer-group 1 ppp authentication chap
The following examples show how to configure a PPP callback server and client.
PPP Callback Server
The PPP callback server is configured on an ISDN BRI interface and requires an enable timeout period and a map class to be defined.
interface bri 0 ip address 10.1.1.7 255.255.255.0 encapsulation ppp dialer callback-secure dialer enable-timeout 2 dialer map ip 10.1.1.8 name mymap class dial1 81012345678901 dialer-group 1 ppp callback accept ppp authentication chap
PPP Callback Client
The PPP callback client is also configured on an ISDN BRI interface, but does not require an enable timeout period or a map class to be defined.
map-class dialer dial1 dialer callback-server username interface bri 0 ip address 10.1.1.8 255.255.255.0 encapsulation ppp dialer map ip 10.1.1.7 name yourmap 81012345678902 dialer-group 1 ppp callback request ppp authentication chap
Cisco IOS Dial Technologies Command Reference November 2009
DIA-139
Dial Commands dialer fast-idle (interface)
dialer fast-idle (interface)
To specify the amount of time that a line for which there is contention will stay idle before it is disconnected and the competing call is placed, use the dialer fast-idle command in interface configuration mode. To return to the default value, use the no form of this command. dialer fast-idle seconds no dialer fast-idle
Syntax Description
seconds
Idle time, in seconds, that must occur on an interface before the line is disconnected. Acceptable values are positive, nonzero integers.
Command Default
20 seconds
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
The dialer fast idle timer is activated if there is contention for a line. The dialer fast idle timer is activated if a line is busy, a packet for a different next hop address is received, and the busy line is required to send the competing packet. If the line becomes idle for configured length of time, the current call is disconnected immediately and the new call is placed. If the line has not yet been idle as long as the fast idle timeout period, the packet is dropped because there is no way to get through to the destination. After the packet is dropped, the fast idle timer remains active and the current call is disconnected as soon as it has been idle for as long as the fast idle timeout. The fast idle timer will be restarted if, in the meanwhile, another packet is transmitted to the currently connected destination and it is classified as interesting. This command applies to inbound and outbound calls. Combining this command with the dialer idle-timeout command allows you to configure lines to stay up for a longer period of time when there is no contention, but to be reused more quickly when there are not enough lines for the current demand.
Examples
The following example specifies a fast idle timeout of 35 seconds on asynchronous interface 1:
interface async 1 dialer fast-idle 35
Cisco IOS Dial Technologies Command Reference
DIA-140
November 2009
Dial Commands dialer fast-idle (interface)
Related Commands
Command dialer map
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites.
dialer idle-timeout (interface) Specifies the idle time before the line is disconnected.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-141
Dial Commands dialer fast-idle (map-class)
dialer fast-idle (map-class)
To specify the fast idle timer value to use when placing a call to any telephone number associated with a specified class, use the dialer fast-idle command in map-class dialer configuration mode. To reset the dialer fast-idle timer to the default, use the no form of this command. dialer fast-idle seconds no dialer fast-idle
Syntax Description
seconds
Number of seconds to wait before placing a different call.
Command Default
Defaults to the fast idle timer value that is set for the interface.
Command Modes
Map-class dialer configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
This fast idle timer is associated only with the map class, not the entire interface.
Examples
The following example specifies a dialer fast idle time of 10 seconds:
dialer string 4156884540 class Eng ! This map-class ensures that these calls use an ISDN speed of 56 kbps and a ! fast-idle time of 10 seconds. map-class dialer Eng isdn speed 56 dialer fast-idle 10 dialer wait-for-carrier-time 30
Related Commands
Command
Description
dialer idle-timeout (interface) Specifies the amount of time that a line for which there is contention will stay idle before it is disconnected and the competing call is placed. dialer wait-for-carrier-time (map-class) map-class dialer Specifies the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class. Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback.
Cisco IOS Dial Technologies Command Reference
DIA-142
November 2009
Dial Commands dialer hold-queue
dialer hold-queue
To allow interesting outgoing packets to be queued until a modem connection is established, use the dialer hold-queue command in interface configuration mode. To disable the hold queue, use the no form of this command. dialer hold-queue packets timeout seconds no dialer hold-queue [packets]
Syntax Description
packets timeout seconds
Number of packets, in the range from 1 to 100 packets, to hold in the queue. This argument is optional with the no form of this command. Amount of time, in seconds, to queue the packets.
Command Default
The outgoing packet queue is disabled.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
A dialer hold queue can be configured on any type of dialer, including in-band synchronous, asynchronous, data terminal ready (DTR), and ISDN dialers. Rotary groups can be configured with a dialer hold queue. If a rotary group is configured with a hold queue, all members of the group will be configured with a dialer hold queue and no individual member’s hold queue can be altered. If no hold queue is configured, packets are dropped during the time required to establish a connection. Setting packets to 0 using the dialer hold-queue command is equivalent to using the no dialer hold-queue command.
Examples
The following command configures a dialer hold queue to hold 10 packets:
Router(config-if)# dialer hold-queue 10 timeout 60
Related Commands
Command dialer-group
Description Controls access by configuring an interface to belong to a specific dialing group.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-143
Dial Commands dialer idle-timeout (interface)
dialer idle-timeout (interface)
To specify the duration of idle time before a line is disconnected, use the dialer idle-timeout command in interface configuration mode. To reset the idle timeout to the default, use the no form of this command. dialer idle-timeout seconds [inbound | either] no dialer idle-timeout
Syntax Description
seconds inbound either
Idle time, in seconds, that must occur on the interface before the line is disconnected. Acceptable values are positive, nonzero integers. (Optional) Only inbound traffic will reset the idle timeout. (Optional) Both inbound and outbound traffic will reset the idle timeout.
Command Default
Direction: outbound Idle time: 120 seconds
Command Modes
Interface configuration
Command History
Release 10.0 12.1(1)T
Modification This command was introduced. The following keywords were added:
• •
inbound either
Usage Guidelines
This command is used on lines for which there is no contention. When contention occurs, the dialer fast-idle command is activated. For example, when a busy line is requested to send another packet to a different destination than it is currently connected to, line contention occurs and the dialer fast-idle command is activated. By default, this command applies to inbound and outbound calls. For example, if a receiving system needs to make outgoing calls, you might configure it with a short idle timeout. Only packets that match the dialer group reset the idle timer. Use the dialer idle-timeout command to set a very high idle timer when Multilink PPP is configured and you want a multilink bundle to be connected indefinitely. (The dialer-load threshold 1 command no longer keeps a multilink bundle of n links connected indefinitely and the dialer-load threshold command no longer keeps a multilink bundle of two links connected indefinitely.)
Cisco IOS Dial Technologies Command Reference
DIA-144
November 2009
Dial Commands dialer idle-timeout (interface)
Examples
The following example specifies an idle timeout of 3 minutes (180 seconds) on asynchronous interface 1. Because the inbound keyword is included, only inbound traffic that matches the dialer group will reset the idle timer.
interface async 1 dialer idle-timeout 180 inbound
Related Commands
Command dialer fast-idle (interface)
Description Specifies the amount of time that a line for which there is contention will stay idle before it is disconnected and the competing call is placed. Controls access by configuring an interface to belong to a specific dialing group.
dialer-group
Cisco IOS Dial Technologies Command Reference November 2009
DIA-145
Dial Commands dialer idle-timeout (template)
dialer idle-timeout (template)
To set the dialer idle timeout period in a virtual template interface, use the dialer idle-timeout command in template configuration mode. To change the dialer idle timeout, use the no form of this command. dialer idle-timeout seconds [inbound | either] no dialer idle-timeout seconds [inbound | either]
Syntax Description
seconds inbound either
Resets the idle timer after the period specified, in seconds. (Optional) Resets the idle timer after the period specified based only on inbound traffic. (Optional) Resets the idle timer after the period specified based on either inbound or outbound traffic.
Command Default
No default behavior or values.
Command Modes
Template configuration
Command History
Release 12.2(4)T 12.2(11)T
Modification This command was introduced for Resource Pool Manager (RPM) template configuration. This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5300, Cisco AS5400, and Cisco AS5800.
Usage Guidelines
The dialer idle-timeout command allows the dialer idle timeout period to be specified in an RPM customer profile and applied on a per-dialed number identification service (DNIS) basis. The dialer idle timer configuration set in this command will override dialer idle timer configurations for dialer, group asynchronous, and virtual template interfaces, unless a per-user configuration is received from an authentication, authorization, and accounting (AAA) per-user interface configuration. In this case, the settings from the AAA per-user interface configuration take precedence over the local interface configuration. The dialer idle-timeout command works well with Multilink PPP (MLP) and Multichassis Multilink PPP (MMP) when the master bundle interface is not a virtual access (projected) interface. For virtual access interfaces where the dialer idle timer cannot be used, you can classify traffic that resets the PPP idle timer using the ip idle-group commands.
Examples
The following example sets the idle timeout period in an RPM customer profile template to 45 seconds:
template template 1 dialer idle-timeout 45
Cisco IOS Dial Technologies Command Reference
DIA-146
November 2009
Dial Commands dialer idle-timeout (template)
The following example sets the idle timeout period in an RPM customer profile template to 60 seconds and resets the idle timer based on either inbound or outbound traffic:
template template 1 dialer idle-timeout 60 either
The following example sets the idle timeout period in an RPM customer profile template to 100 seconds and resets the idle timer based only on inbound traffic:
template template 1 dialer idle-timeout 100 inbound
Related Commands
Command
Description
dialer-group (template) Controls access by configuring a virtual template interface to belong to a specific dialing group. ip idle-group template Configures interesting traffic on an interface for the PPP idle timer. Accesses the template configuration mode for configuring a particular customer profile template.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-147
Dial Commands dialer in-band
dialer in-band
To specify that dial-on-demand routing (DDR) is to be supported, use the dialer in-band command in interface configuration mode. To disable DDR for the interface, use the no form of this command. dialer in-band [no-parity | odd-parity] no dialer in-band
Syntax Description
no-parity odd-parity
(Optional) No parity is to be applied to the dialer string that is sent out to the modem on synchronous interfaces. (Optional) Dialed number has odd parity (7-bit ASCII characters with the eighth bit as the parity bit) on synchronous interfaces.
Command Default
Disabled. By default, no parity is applied to the dialer string.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
The dialer in-band command specifies that chat scripts will be used on asynchronous interfaces and V.25bis will be used on synchronous interfaces. The parity keywords do not apply to asynchronous interfaces. The parity setting applies to the dialer string that is sent out to the modem. If you do not specify a parity, or if you specify no parity, no parity is applied to the output number. If odd parity is configured, the dialed number will have odd parity (7-bit ASCII characters with the eighth bit as the parity bit.) If an interface only accepts calls and does not place calls, the dialer in-band interface configuration command is the only command needed to configure it. If an interface is configured in this manner, with no dialer rotary groups, the idle timer never disconnects the line. It is up to the remote end (the end that placed the call) to disconnect the line based on idle time.
Examples
The following example specifies DDR for asynchronous interface 1:
interface async 1 dialer in-band
Related Commands
Command dialer map
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites.
dialer string (legacy DDR) Specifies the string (telephone number) to be called for interfaces calling a single site.
Cisco IOS Dial Technologies Command Reference
DIA-148
November 2009
Dial Commands dialer isdn
dialer isdn
To specify the bit rate used on the B channel associated with a specified map class and to specify whether to set up semipermanent connections for this map class, use the dialer isdn command in map-class dialer configuration mode. To remove the speed and connection settings, use the no form of this command. dialer isdn [speed speed] [spc] no dialer isdn [speed speed] [spc]
Syntax Description
speed speed spc
(Optional) Bit rate, in kilobytes per second (Kbps), used on the ISDN B channel. Values are 56 and 64. Default is 64. (Optional) ISDN semipermanent connection is used for calls associated with this map class.
Command Default
Bit rate is 64 Kbps. Semipermanent connections are not set up.
Command Modes
Map-class dialer configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
This command is valid for ISDN interfaces only.
Examples
The following example configures a speed of 56 Kbps and no semipermanent connections for the Eng map class:
dialer string 4155550140 class Eng ! This map-class ensures that these calls use an ISDN speed of 56 kbps and that ! no semipermanent connection is set up. map-class dialer Eng dialer isdn speed 56
Related Commands
Command dialer wait-for-carrier-time (map-class)
Description Specifies the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-149
Dial Commands dialer isdn short-hold
dialer isdn short-hold
To configure the router to disconnect a call at the end of the current charging period if the line has been idle for at least the specified minimum period, use the dialer isdn short-hold command in map-class dialer configuration mode. To reset the ISDN short-hold timer to the default period, use the no form of this command. dialer isdn short-hold seconds no dialer isdn short-hold
Syntax Description
seconds
Minimum number of seconds of idle time on the line. Default is 120 seconds.
Command Default
Disabled; the router uses a static idle timeout. When this command is enabled, the default short-hold timeout is 120 seconds.
Command Modes
Map-class dialer configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
This command is used for configuring ISDN Advice of Charge (AOC) on Cisco routers. Use the dialer isdn short-hold command if you subscribe to an ISDN AOC during-call service provided by the local ISDN network and want to use this option. The router uses the frequency at which the network sends the AOC-D message to determine the charging period. If the line has been idle for the short-hold timeout, the call disconnects at the end of the charging period. If the line has not been idle for at least that long, the call is maintained into the next charging period.
Examples
The following partial example configures the dialer map class Deutschland with a static idle timeout for outgoing calls. The static idle timer is to be used if for any reason the network does not provide charging information. It also configures a short-hold timeout to allow the router to determine dynamically whether to disconnect or continue the call at the end of the charging period.
dialer map-class myclass dialer idle-timeout 150 dialer isdn short-hold 120
Cisco IOS Dial Technologies Command Reference
DIA-150
November 2009
Dial Commands dialer isdn short-hold
Related Commands
Command dialer map dialer string (dialer profiles) dialer wait-for-carrier-time (map-class) map-class dialer
Description Configures a serial interface or ISDN interface to call one or multiple sites, or to receive calls from multiple sites. Specifies the string (telephone number) to be used when placing a call from an interface. Specifies the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class. Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-151
Dial Commands dialer load-threshold
dialer load-threshold
To configure bandwidth on demand by setting the maximum load before the dialer places another call to a destination, use the dialer load-threshold command in interface configuration mode. To disable the setting, use the no form of this command. dialer load-threshold load [outbound | inbound | either] no dialer load-threshold
Syntax Description
load
Interface load used to determine whether to initiate another call or to drop a link to the destination. This argument represents a utilization percentage; it is a number between 1 and 255, where 255 is 100 percent. (Optional) Calculates the actual load using outbound data only. (Optional) Calculates the actual load using inbound data only. (Optional) Sets the maximum calculated load as the larger of the outbound and inbound loads.
outbound inbound either
Command Default
No maximum load is predefined.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
When the cumulative load of all UP links (a number n) exceeds the load threshold the dialer adds an extra link and when the cumulative load of all UP links minus one (n - 1) is at or below load threshold then the dialer can bring down that one link. The dialer will make additional calls or drop links as necessary but will never interrupt an existing call to another destination. The load argument is the calculated weighted average load value for the interface; 1 is unloaded and 255 is fully loaded. The load is calculated by the system dynamically, based on bandwidth. You can set the bandwidth for an interface in kilobits per second, using the bandwidth command. The load calculation determines how much of the total bandwidth you are using. A load value of 255 means that you are using one hundred percent of the bandwidth. The load number is required. See the description of the bandwidth command earlier in this guide for more information. When multilink PPP is configured, the dialer load-threshold 1 command no longer keeps a multilink bundle of n links connected indefinitely and the dialer-load threshold 2 command no longer keeps a multilink bundle of 2 links connected indefinitely. If you want a multilink bundle to be connected indefinitely, you must set a high idle timer or make all traffic interesting. When two connected routers are configured to dial out, only one router should have the dialer max-call or dialer pool-member max-links command configured. Otherwise, if both routers dial simultaneously, each will reject the incoming call when it exceeds the setting for the max-links argument. If the
Cisco IOS Dial Technologies Command Reference
DIA-152
November 2009
Dial Commands dialer load-threshold
maximum number of calls configured is one and dialing out is synchronized, no connection will come up or it will take many retries before the connection stays up. To prevent this problem, one of the following configurations is recommended:
•
Use the dialer max-call command to restrict the number of connections, rather than the dialer pool-member max-links command. The result is the same and the dialer max-call command is easier to understand and configure. When two systems will dial each other and a maximum of one link is desired, configure the dialer max-calls command on only one side of the connection, not on both sides. Configure the dialer load-threshold command on only one side of the connection, either the local or remote router, and configure the dialer max-call command on the interface where the dialer load-threshold command is configured.
• •
Note
Dial-on-demand (DDR) load balancing does not forward packets correctly when the system dials out via the dialer load-threshold command and more than one remote device is connected by either dial-out or dial-in. This problem typically occurs on a PRI with dialer load-threshold configured, but it may also occur on BRI or multiple DDR interfaces in a dialer rotary group when more than one remote device is connected. As a workaround, remove the dialer load-threshold command.
Examples
In the following example, if the load to a particular destination on an interface in dialer rotary group 5 exceeds interface load 200, the dialer will initiate another call to the destination:
interface dialer 5 dialer load-threshold 200
Related Commands
Command bandwidth busyout dialer max-call dialer pool-member max-links dialer reserved-links interface dialer
Description Specifies the maximum aggregate bandwidth for H.323 traffic. Creates a “host-failed” message that displays when a connection fails. Specifies the maximum number of calls to a remote destination that can be up at any one time for a dialer profile. Configures a physical interface to be a member of a dialer profile dialing pool. Includes a specified interface in a dialer rotary group. Defines a dialer rotary group.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-153
Dial Commands dialer map
dialer map
To configure a serial or ISDN interface to call multiple sites or to receive calls from multiple sites, use the dialer map command in interface configuration mode. Several options for using this command are possible; see the following description and the “Examples” section. To delete a particular dialer map entry, use the no form of this command.
Complete Syntax
dialer map protocol-keyword protocol-next-hop-address [broadcast | class dialer-map-class-name | modem-script modem-regular-expression | vrf vrf-name | name host-name | spc | speed 56 | speed 64 | system-script system-regular-expression | dial-string[:isdn-subaddress]] no dialer map protocol-keyword protocol-next-hop-address [broadcast | class dialer-map-class-name | modem-script modem-regular-expression | vrf vrf-name | name host-name | spc | speed 56 | speed 64 | system-script system-regular-expression | dial-string[:isdn-subaddress]]
Dialer Map for an Asynchronous Interface
To configure an asynchronous interface to place a call to a single site that requires a system script or that has no assigned modem script, or to multiple sites on a single line, on multiple lines, or on a dialer rotary group, use the following form of the dialer map interface configuration command: dialer map protocol-keyword protocol-next-hop-address [name host-name] [broadcast] [modem-script modem-regular-expression] [system-script system-regular-expression] [dial-string] no dialer map protocol-keyword protocol-next-hop-address [name host-name] [broadcast] [modem-script modem-regular-expression] [system-script system-regular-expression] [dial-string]
Dialer Map for ISDN Interface and ISDN AOC Short-Hold Idle Timeout
To configure an ISDN interface to place a call to multiple sites, to authenticate calls from multiple sites, and to identify the class name that configures the ISDN Advice of Charge (AOC) short-hold idle timeout, use the following form of the dialer map interface configuration command: dialer map protocol-keyword protocol-next-hop-address [name host-name] [speed 56 | speed 64] [broadcast] class dialer-map-class-name [dial-string[:isdn-subaddress]] no dialer map protocol-keyword protocol-next-hop-address [name host-name] [speed 56 | speed 64] [broadcast] class dialer-map-class-name [dial-string[:isdn-subaddress]]
Dialer Map for German and Australian SPC
The following command syntax is used only in Germany for circuits between an ISDN BRI and a 1TR6 ISDN switch, and in Australia for circuits between an ISDN PRI and a TS-014 switch. To set up network addressing on an ISDN BRI interface to support semipermanent connection between customer equipment and the exchange, use the following form of the dialer map interface configuration command: dialer map protocol-keyword protocol-next-hop-address [name host-name] [spc] [speed 56 | speed 64] [broadcast] dial-string[:isdn-subaddress]
Cisco IOS Dial Technologies Command Reference
DIA-154
November 2009
Dial Commands dialer map
no dialer map protocol-keyword protocol-next-hop-address [name host-name] [spc] [speed 56 | speed 64] [broadcast] dial-string[:isdn-subaddress]]
Dialer Map for MPLS VPN
To configure a serial or ISDN interface to support an IP-based VPN routing and forwarding instance (VFR)-aware dialer map for a Multiprotocol Label Switching (MPLS) VPN, use the following form of the dialer map interface configuration command: dialer map ip protocol-next-hop-address vrf vrf-name name host-name dial-string no dialer map ip protocol-next-hop-address vrf vrf-name name host-name dial-string
Dialer Map for Bridging
To configure a serial or ISDN interface to support bridging, use the following form of the dialer map interface configuration command: dialer map bridge [name host-name] [broadcast] [dial-string[:isdn-subaddress]] no dialer map bridge [name host-name] [broadcast] [dial-string[:isdn-subaddress]]
Syntax Description
protocol-keyword protocol-next-hop-address
Enter one of the protocol keywords listed followed by an appropriate address (for example, the clns keyword is followed by a network service access point, or NSAP, address):
• • • • • • • • • • •
appletalk—AppleTalk bridge—Bridging (no address is required) clns—Cisco IOS Connectionless Network Service (CLNS) decnet—DECnet hpr—High Performance Routing ip—IP ipx—Internetwork Packet Exchange llc2—Logical Link Control, type 2 netbios—NetBIOS pppoe—PPP over Ethernet snapshot—Snapshot routing protocol; refer to the dialer map snapshot command description for use of this keyword
broadcast class dialer-map-class-name modem-script modem-regular-expression vrf vrf-name
(Optional) Forwards broadcasts to the address specified with the protocol-next-hop-address argument. (Optional) Dialer map class name. (Optional) Modem script name to be used for the connection (asynchronous interfaces only). (Optional) VPN routing/forwarding instance (VRF) for use with a VRF-aware dialer map in an MPLS VPN. Provide a dial string after the VRF name.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-155
Dial Commands dialer map
name host-name
(Optional) The remote system with which the local router or access server communicates. Used for authenticating the remote system on incoming calls. The host-name argument is a case-sensitive name or ID of the remote device. For routers with ISDN interfaces, if calling line identification—sometimes called CLI, but also known as caller ID and automatic number identification (ANI)—is provided, the host-name argument can contain the number that the calling line ID provides. (Optional) Semipermanent connection between customer equipment and the exchange; used only in Germany for circuits between an ISDN BRI and a 1TR6 ISDN switch and in Australia for circuits between an ISDN PRI and a TS-014 switch. (Optional) Keyword and value indicating the line speed in kbps to use. Used for ISDN only. The default speed is speed 64 (64 kbps). (Optional) System script name to be used for the connection (asynchronous interfaces only).
spc
speed 56 | speed 64 system-script system-regular-expression
dial-string[:isdn-subaddress] (Optional) Dial string (telephone number) sent to the dialing device when it recognizes packets with the specified address that matches the configured access lists, and the optional subaddress number used for ISDN multipoint connections (colon required for separating numbers). The dial string and ISDN subaddress, when used, must be the last item in the command line.
Command Default
For all forms of the command, no dialer map is configured. The default speed is 64 kbps. No scripts are defined for placing calls.
Command Modes
Interface configuration
Command History
Release 9.1 10.0 11.3 12.2(8)T 12.2(13)T
Modification This command was introduced for synchronous serial interfaces using V.25bis dialing. This command was enhanced to support asynchronous and ISDN interfaces. This command was enhanced to support ISDN AOC. The vrf vrf-name keyword and argument were added. The vines and xns arguments were removed because Banyan Systems’ Virtual Integrated Network Service (VINES) and the Xerox Network System (XNS) are no longer available in Cisco IOS software.
Cisco IOS Dial Technologies Command Reference
DIA-156
November 2009
Dial Commands dialer map
Usage Guidelines
Usage Guidelines for Asynchronous Interfaces
Configure a dialer map command for each remote destination for an asynchronous interface. Specify chat scripts for a physical interface that is not part of a dialer rotary group when no chat script is specified for the line, or when a system chat script is required to log in to the remote system. However, you need not specify a system script under the following conditions:
• •
The modem script can be used to dial in and log in to the remote system. You are calling a system that does not require a login script—that is, a system that answers and immediately goes into protocol mode.
If you adhere to the chat script naming convention suggested in the description of the chat-script command, use the form modem-script *modulation-type in the dialer map command; for example, *-v32bis. This form allows you to specify the modulation type that is best for the system you are calling, and allows the modem type for the line to be specified by the script dialer command. The period (.) is a wildcard that matches any character, and the asterisk (*) indicates that the preceding character can be duplicated multiple times. For more information about regular expressions, refer to the “Regular Expressions” appendix in the Cisco IOS Dial Technologies Configuration Guide. If a modem script is specified in the dialer map interface configuration command and a modem script is specified in the script dialer line configuration command, the first chat script that matches both is used. If no script matches both, an error message is logged and the connection is not established. If there is no modem chat script specified for the line, the first chat script (that is, the one specified in the chat-script global configuration command) that matches the regular expression of the modem script is used. If there is a system script specified in the dialer map interface configuration command, the first chat script to match the regular expression is used. The modem-script and system-script keywords and corresponding arguments are optional. They are ignored on synchronous interfaces. If you have named your chat script according to the type of modem and modulation (for example, codex-v32 or telebit v32), your regular expression could be codex-.* in the script dialer line configuration command, and *-v32bis in the modem script specified in the dialer map command for a system to which you want to connect using V.32bis modulation. The modem lines (specified by the regular-expression argument in the script dialer line configuration command) would be set to one of the following regular expressions to match patterns, depending on the kind of modem you have:
• • •
codex-.* telebit-.* usr-.*
Usage Guidelines for Synchronous Interfaces
Use the dialer map command with the name keyword but without the dial string in configurations in which remote sites are calling a central site, but the central site is not calling the remote site. With this command, the local device will authenticate the remote site using Challenge Handshake Authentication Protocol (CHAP) or Password Authentication Protocol (PAP), which will send the remote site’s host name to the central site. The central site will then use this name to authenticate the caller, and will use the next hop address to send packets to the remote site. Because no dialer string is specified, the central site cannot call the remote router.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-157
Dial Commands dialer map
Usage Guidelines for ISDN Interfaces and ISDN AOC
Use the dialer map command with the name keyword in configurations in which remote sites are calling a central site, but the central site is not calling the remote site. With this command, the local device will authenticate the remote site using CHAP or PAP, which will send the remote site host name to the central site. The central site will then use this name to authenticate the caller, and will use the next hop address to send packets to the remote site. Because no dialer string is specified, the central site cannot call the remote router. For ISDN interfaces only, you can specify an optional speed parameter for dialer map commands if you also specify a dial string. This option informs the ISDN software whether it should place a call at 56 or 64 kbps. If you omit the ISDN speed parameter, the default is 64 kbps. For routers with ISDN interfaces, if CLI is provided, the host-name field may contain the number that calling line ID provides. When the network provides ISDN AOC information, use the dialer map command with the class keyword for outgoing calls. Use the map-class dialer global command to identify the class name, the dialer idle-timeout command to define a static idle timeout period for outgoing calls to the class, and the dialer isdn short-hold command to define the minimum idle time to wait before disconnecting calls at the end of the charging period.
Usage Guidelines for MPLS VPN
Beginning with Cisco IOS Release 12.2(8)T, dialer software became capable of being “VRF-aware for MPLS VPN,” meaning that it can distinguish between two destinations with the same IP address using information stored in a VRF. When the dialer map command is configured with the vrf keyword in an MPLS VPN, the dialer software looks up a map for the next hop address using the next hop address and the VRF name configured. Once dial-out takes place and authentication is complete, a virtual profile interface is created. The VRF is installed on the virtual profile interface using the following per-user authentication, authorization, and accounting (AAA) interface command: cisco-avpair “lcp:interface-config=ip vrf forwarding vrf-name” Data transfer occurs as defined by the virtual profile dialer. When an IP route for a particular VRF points to the dialer (configured using the ip route global configuration command), the dialer uses the VFR-aware dialer map to get the dial string and IP address, and to bring up the connection. Once the user is authenticated, a virtual access interface is created and the user details are downloaded from the AAA server, and finally, the appropriate IP VRF command is applied on the virtual access interface.
Examples
Asynchronous Interface Examples
The following example sets the dialer speed at 56 kbps to call a remote site at 172.19.2.5:
interface async 1 encapsulation ppp ppp authentication chap dialer map ip 172.19.2.5 speed 56
The following example shows a dialing chat script and a login chat script. The dialer in-band command enables dial-on-demand routing (DDR) on asynchronous interface 10, and the dialer map command looks for the specified dialing and the login scripts, then uses those scripts to dial the string 95550190.
chat-script dial ABORT ERROR "" "AT Z" OK "ATDT \T" TIMEOUT 30 CONNECT \c chat-script login ABORT invalid TIMEOUT 15 name: billw word: wewpass ">" "slip default" interface async 10 dialer in-band dialer map ip 10.55.0.1 modem-script dial system-script login 95550190
Cisco IOS Dial Technologies Command Reference
DIA-158
November 2009
Dial Commands dialer map
In the following example, the remote site is calling the central site, and the central site is calling the remote site. The central router uses the name ZZZ to authenticate the remote router when connection is made, and uses the dialer string 14155550134 to call the remote router if it is not currently connected.
interface async 1 dialer map ip 172.19.2.5 name ZZZ 14155550134
In the following example, a remote site is calling a central site, but the central site is not calling the remote site. The local device will authenticate the site that is calling in using CHAP. CHAP causes the remote site name, YYY, to be sent to the site it is calling. The central site will then use this name to authenticate the remote site.
interface async 1 encapsulation ppp ppp authentication chap dialer map ip 172.19.2.5 name YYY
ISDN AOC Short-Hold Idle Timeout Example
In the following legacy DDR example, a BRI interface is configured with dialer map classes to use for outgoing calls, and a dialer idle timeout period to use for all incoming calls. All of the map classes are configured with dialer idle timeout periods that override the interface static dialer idle timeout for outgoing calls. Two map classes are also configured for an ISDN AOC short-hold idle timeout.
hostname A ! username IA password 7 1533121F0725 username IB password 7 110A1016262D29 username IC password 7 1533121F072508 isdn switch-type basic-net3 ! interface bri 0 ip address 10.0.0.35 255.0.0.0 encapsulation ppp dialer idle-timeout 150 dialer map ip 10.0.0.33 name IA class One 06966600050 dialer map ip 10.0.0.40 name IB class Two 778578 dialer map ip 10.0.0.45 name IC class Three 778579 ppp authentication chap ! map-class dialer Three dialer idle-timeout 300 dialer isdn short-hold 10 ! map-class dialer One dialer idle-timeout 300 ! map-class dialer Two dialer idle-timeout 300 dialer isdn short-hold 10
SPC Example
The following example configures the interface for semipermanent connections in Germany; the IP address and the phone number are provided:
dialer map ip 192.168.48.2 spc 49305550155:3789
Cisco IOS Dial Technologies Command Reference November 2009
DIA-159
Dial Commands dialer map
MPLS VPN Example
In the following partial example, the number to be dialed is based on the VRF name and destination IP address configured. The VRF is identified based on the incoming interface of the packet, and is used with the destination IP address to determine the number to be dialed, as defined in the dialer map command.
virtual-profile virtual-template 1 virtual-profile aaa ! interface virtual-template 1 ip unnumbered loopback0 ppp authentication chap ppp multilink . . . interface dialer 1 dialer map ip 10.9.9.9 vrf new_vrf name new_name 5550145 dialer map ip 10.9.9.9 vrf branch_vrf name branch_name 5550156 ppp authentication chap ppp multilink . . . ip route vrf vrfgreen_vrf 10.9.9.9 255.255.255.255 dialer1 ip route vrf vrfyellow_vrf 10.9.9.9 255.255.255.255 dialer1
Related Commands
Command chat-script dialer idle-timeout (map-class)
Description Places calls over a modem and logs in to remote systems. Specifies the fast idle timer value to use when placing a call to any telephone number associated with a specified class.
dialer isdn short-hold Configures the router to disconnect a call at the end of the current charging period if the line has been idle for at least the specified minimum period. dialer map snapshot ip route map-class dialer Defines a dialer map for the snapshot routing protocol on a client router connected to a DDR interface. Establishes static IP routes, and pairs an IP address with a VRF-aware dialer map. Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback. Sets PPP BACP call parameters. Enables virtual profiles by AAA configuration.
ppp bap call virtual-profile aaa
Cisco IOS Dial Technologies Command Reference
DIA-160
November 2009
Dial Commands dialer map snapshot
dialer map snapshot
To define a dialer map for Cisco’s snapshot routing protocol on a client router connected to a dial-on-demand routing (DDR) interface, use the dialer map snapshot command in interface configuration mode. To delete one or more previously defined snapshot routing dialer maps, use the no form of this command. dialer map snapshot sequence-number dial-string no dialer map snapshot [sequence-number]
Syntax Description
sequence-number dial-string
A number in the range from 1 to 254, inclusive, that uniquely identifies a dialer map. (Optional for the no form.) Telephone number of a remote snapshot server to be called during an active period.
Command Default
No snapshot routing dialer map is defined.
Command Modes
Interface configuration
Command History
Release 10.3
Modification This command was introduced.
Usage Guidelines
Enter a command for each remote snapshot server router the client router should call during an active period. Use the no dialer map snapshot form of this command to remove all previously defined snapshot dialer maps on the client router; use the no dialer map snapshot sequence-number form of this command to delete a specified dialer map.
Examples
The following examples define snapshot dialer maps on a client router:
dialer map snapshot 12 4155550134 dialer map snapshot 13 4155550145
The following example removes one of the previously defined snapshot routing dialer maps on the client router:
no dialer map snapshot 13
Cisco IOS Dial Technologies Command Reference November 2009
DIA-161
Dial Commands dialer map snapshot
Related Commands
Command dialer reserved-links interface dialer snapshot client
Description Includes a specified interface in a dialer rotary group. Defines a dialer rotary group. Configures a client router for snapshot routing.
Cisco IOS Dial Technologies Command Reference
DIA-162
November 2009
Dial Commands dialer max-call
dialer max-call
To specify the maximum number of calls to a remote destination that can be up at any one time for a dialer profile, use the dialer max-call command in interface configuration mode. dialer max-call number
Syntax Description
number
Maximum number of calls, ranging from 1 to 4096.
Command Default
No maximum number of calls is specified.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
The dialer max-call command is used to specify the maximum number of calls for the dialer interface. This command applies to dialer interfaces only. This command can be configured only if a dialer profile is enabled using the dialer pool command. The dialer max-call command cannot be used with legacy dial-on-demand routing (DDR). When two connected routers are configured to dial out, only one router should have the dialer max-call or dialer pool-member max-links command configured. Otherwise, if both routers dial simultaneously, each will reject the incoming call when it exceeds the setting for the max-links argument. If the maximum number of calls configured is one and dialing out is synchronized, no connection will come up or it will take many retries before the connection stays up. To prevent this problem, one of the following configurations is recommended:
•
Use the dialer max-call command to restrict the number of connections, rather than the dialer pool-member max-links command. The result is the same and the dialer max-call command is easier to understand and configure. When two systems will dial each other and a maximum of one link is desired, configure the dialer max-calls command on only one side of the connection, not on both sides. Configure the dialer load-threshold command on only one side of the connection, either the local or remote router, and configure the dialer max-call command on the interface where the dialer load-threshold command is configured.
• •
Examples
The following example sets a maximum of six calls:
dialer max-call 6
Cisco IOS Dial Technologies Command Reference November 2009
DIA-163
Dial Commands dialer max-call
Related Commands
Command dialer isdn
Description Specifies the bit rate used on the B channel associated with a specified map class and specifies whether to set up semipermanent connections for this map class. Configures bandwidth on demand by setting the maximum load before the dialer places another call to a destination. Specifies, for a dialer interface, which dialing pool to use to connect to a specific destination subnetwork. Configures a physical interface to be a member of a dialer profile dialing pool. Specifies the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class.
dialer load-threshold dialer pool dialer pool-member max-links dialer wait-for-carrier-time (map-class)
Cisco IOS Dial Technologies Command Reference
DIA-164
November 2009
Dial Commands dialer order
dialer order
To specify the dialing order when multiple dial strings are configured, use the dialer order command in interface configuration mode. To change or remove the dialing order, use the no form of this command. dialer order [sequential | round-robin | last-successful] no dialer order [sequential | round-robin | last-successful]
Syntax Description
sequential
(Optional) Always starts dialing the first dial string configured in a list of multiple strings, and continues to the next dial string when a call fails. This keyword allows dial string order to be prioritized, and is the default. (Optional) Always starts dialing using the dial string that follows the most recently used dial string. If no calls have previously been made, the dialer uses the first dial string. When a call fails, the dialer tries the next dial string until all dial strings have been tried. This keyword allows calls to be shared equally among the configured dial strings. However, if the dial strings are associated with multiple ISDN B channels on the same remote device, a call may be placed to bring up a second B channel without trying to call the number associated with the first B channel.
round-robin
last-successful (Optional) Always starts dialing using the most recently successful dial string, and continues to the next dial string in a list when a call fails. This keyword reduces the time needed to find a dial string that successfully completes a call when the dial strings are not likely to be equally successful.
Command Default
Dial order is sequential.
Command Modes
Interface configuration
Command History
Release 12.2(8)T
Modification This command was introduced.
Usage Guidelines
The dialer order command keywords can be configured on a per-interface basis. The configuration rules are as follows:
• •
The keyword you configure applies to dial strings configured on an interface by the dialer map and dialer string configuration commands. The keyword you configure for a dialer interface is effective for all destinations defined by that interface.
You can use the dialer order command in configurations that apply to both legacy dialers and dialer profiles. The command is also compatible with the following dialer features and protocols:
• •
Dialer redial Dialer Watch feature
Cisco IOS Dial Technologies Command Reference November 2009
DIA-165
Dial Commands dialer order
• • • •
Dialer Persistent feature Bandwidth Allocation Control Protocol (BACP) Bandwidth on demand Multilink PPP
Examples
The following legacy dialer configuration shows how to set the dialing software to try the telephone number of the last successful call when starting a new call, rather than the first telephone number in the list (555-0104):
interface Serial0/0 ip address 10.2.1.130 255.255.255.0 encapsulation ppp dialer in-band dialer map ip 10.2.1.131 name mymap1 modem-script scr-3 5550104 dialer map ip 10.2.1.131 name mymap1 modem-script scr-3 5550105 dialer map ip 10.2.1.131 name mymap1 modem-script scr-3 5550106 dialer-group 1 dialer order last-successful
If in a previous attempt to dial network 10.2.1.131 the telephone number 555-0106 was successful, because the dial order is set to last-successful, the next attempt to dial network 10.2.1.131 will start again with the 555-0106 telephone number. The following dialer profile configuration shows how to set the dialing software to try the telephone number that occurs after the most recently used dial string when starting a new call, rather than the first telephone number in the list (0104):
interface Dialer0 ip address 10.1.1.130 255.255.255.0 encapsulation ppp dialer pool 1 dialer string 0104 dialer string 0105 dialer string 0106 dialer string 0107 dialer-group 1 dialer order round-robin
If in a previous attempt to dial network 10.1.1.130 the telephone number 0106 was successful, because the dial order is set to round-robin, the next attempt to dial network 10.1.1.130 will start with the 0107 telephone number.
Related Commands
Command dialer map dialer string
Description Configures a serial interface or ISDN interface to call one or multiple sites, or to receive calls from multiple sites. Specifies the string (telephone number) to be used when placing a call from an interface.
Cisco IOS Dial Technologies Command Reference
DIA-166
November 2009
Dial Commands dialer outgoing
dialer outgoing
To configure the dialer map class for a Network Specific Facilities (NSF) dialing plan to support outgoing calls, use the dialer outgoing command in map-class dialer configuration mode. dialer outgoing class-name
Syntax Description
class-name
Keyword for a specified AT&T Primary-4ESS NSF dialing plan. The following keywords are supported: sdn, megacomm, and accunet.
Command Default
This command is disabled; no class name is provided.
Command Modes
Map-class dialer configuration
Command History
Release 11.0
Modification This command was introduced.
Usage Guidelines
Use this command only to define a dialer map class for an NSF call-by-call service offered by AT&T on Primary-4ESS ISDN switches. This command is not used for other vendors and switch types.
Examples
The following partial example shows a class called sdn to support the Software Defined Network (SDN) dialing plan. For a more complete example using all the related commands, see the map-class dialer command.
dialer outgoing sdn
Related Commands
Command dialer map dialer voice-call isdn nsf-service map-class dialer
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Configures the dialer map class for an NSF dialing plan to support outgoing voice calls. Configures NSF on an ISDN PRI for outgoing calls configured as voice calls. Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-167
Dial Commands dialer persistent
dialer persistent
To force a dialer interface to be connected at all times, even in the absence of interesting traffic, use the dialer persistent command in interface configuration mode. To disable this option, use the no form of this command. dialer persistent [delay [initial] seconds | max-attempts number] no dialer persistent
Syntax Description
delay initial seconds max-attempts number
(Optional) Sets the delay before an attempt to reestablish a persistent connection after a network error has disrupted it. (Optional) Sets the delay before a persistent connection is established, after configuration or boot-up, in the absence of interesting traffic. (Optional) Sets the time, in seconds, for the delay or initial delay set by the delay and initial keywords. Default is 1 second. (Optional) Maximum number of attempts for reconnecting after a network error has disrupted the persistent connection. There is no default or limit to the number of attempts.
Command Default
No persistent connections are established. The default delay and initial delay interval is 1 second. There is no default or limit to the number of reconnection attempts.
Command Modes
Interface configuration
Command History
Release 12.2(4)T 12.2(11)T
Modification This command was introduced. This feature was implemented on Cisco access server platforms.
Usage Guidelines
Do not use the dialer redial command when a dialer profile has been configured with the dialer persistent command. Both these configuration commands prompt the router to dial out, so it is desirable to configure only one of them. Do not use the dialer idle-timeout interface configuration command when a dialer profile has been configured with the dialer persistent command. Doing so has no effect on the idle timer, which is overridden by the dialer idle-timeout command as dialer idle-timeout 0. You can use the clear interface EXEC command on the dialer interface to clear unsuccessful dial attempts on a line without interesting traffic; the dialer software continues attempting to bring up the connection as persistent. To disconnect a persistent connection and prevent the software from attempting more dialing, use the shutdown interface configuration command. Once a connection has been brought up as persistent, it cannot be torn down due to a fast-idle timeout.
Cisco IOS Dial Technologies Command Reference
DIA-168
November 2009
Dial Commands dialer persistent
Examples
The following example shows how to configure a dialer interface for dialer persistent:
! interface dialer 0 ip address 10.1.1.2 255.255.255.0 encapsulation ppp dialer string 5550189 dialer pool 1 dialer-group 1 dialer persistent delay initial 20 ! access-list 101 permit icmp any any access-list 101 deny ip any any dialer-list 1 protocol ip list 101
Related Commands
Command dialer-group dialer-list protocol dialer pool dialer redial
Description Controls access by configuring an interface to belong to a specific dialing group. Defines a DDR dialer list to control dialing by protocol or by a combination of a protocol and a previously defined access list. Specifies for a dialer interface which dialing pool to use to connect to a specific destination subnetwork. Configures redial after failed outbound dial attempts.
dialer string (dialer profiles) Specifies the string (telephone number) to be used when placing a call from an interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-169
Dial Commands dialer pool
dialer pool
To specify, for a dialer interface, which dialing pool to use to connect to a specific destination subnetwork, use the dialer pool command in interface configuration mode. To remove the dialing pool assignment, use the no form of this command. dialer pool number no dialer pool number
Syntax Description
number
Dialing pool number, in the range 1 through 255.
Command Default
Disabled; no default number is specified.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
This command applies to dialer interfaces only.
Examples
The following example shows a dialer interface configuration that is linked to the physical interface configuration shown for BRI 1 in the dialer pool-member command section. Dialer interface 1 uses dialer pool 3, of which BRI 1 is a member.
! This is a dialer profile for reaching remote subnetwork 10.1.1.1. interface Dialer1 ip address 10.1.1.1 255.255.255.0 encapsulation ppp dialer remote-name Smalluser dialer string 4540 dialer pool 3 dialer-group 1
The following example might accompany the previous dialer profile configuration example. Physical interface BRI 1 has a reserved channel in dialer pool 3. That channel is inactive until BRI 1 uses it to place calls.
interface BRI1 encapsulation ppp dialer pool-member 1 priority dialer pool-member 2 priority ! BRI 1 has a reserved channel ! until BRI 1 uses it to place dialer pool-member 3 min-link ppp authentication chap
50 50 in dialer pool 3; the channel remains inactive calls. 1
Cisco IOS Dial Technologies Command Reference
DIA-170
November 2009
Dial Commands dialer pool
Related Commands
Command dialer pool-member dialer wait-for-carrier-time (map-class)
Description Configures a physical interface to be a member of a dialer profiles dialing pool. Specifies the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-171
Dial Commands dialer pool-member
dialer pool-member
To configure a physical interface to be a member of a dialer profile dialing pool, use the dialer pool-member command in interface configuration mode. To remove the configuration, use the no form of this command. dialer pool-member number [priority priority] [min-link minimum] [max-link maximum] no dialer pool-member number
Syntax Description
number priority priority
Dialing pool number, in the range 1 through 255. (Optional) Priority of this interface within the dialing pool. Valid values for the priority argument range from 1 (lowest) to 255 (highest). The default priority is 1. Interfaces with the highest priority are selected first for dialing out. (Optional) Minimum number of B channels on this interface that are reserved for this dialing pool. Valid values for the minimum argument range from 1 to 255. The default minimum is 1. A reserved channel is inactive until the specified interface uses it to place calls. This option applies to ISDN outgoing interfaces only. (Optional) Maximum number of B channels on this interface that can be used by this dialing pool. Valid values for the minimum argument range from 1 to 255. The default maximum is 255. This option applies to ISDN interfaces only, and can be configured on both incoming and outgoing calls.
min-link minimum
max-link maximum
Command Default
The interface is not a member of a dialer profile dialing pool.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
This command applies to asynchronous serial, synchronous serial, BRI, and PRI physical interfaces only. It does not apply to dialer interfaces. The common number used in the dialer pool command and in the dialer pool-member command links the physical interface and dialer interface configurations. The min-link keyword and value are used primarily for dial backup. The Cisco IOS software provides the dialer max-links interface configuration command and the max-link keyword with the dialer pool-member command to specify a maximum number of links. When two linked systems are configured to dial out, only one system needs to have the maximum number of links configured. Otherwise, if both systems dial simultaneously, each will reject the incoming call
Cisco IOS Dial Technologies Command Reference
DIA-172
November 2009
Dial Commands dialer pool-member
when it exceeds the specified maximum links. If maximum links is configured to 1 and the dialing out is synchronized, no connection will come up or it will take many retries before a connection stays up. Some suggestions for correcting this behavior follow:
• • •
Use only the dialer max-links command to restrict the number of connections. The result is the same as configuring the dialer pool-member command with the max-link keyword. If two systems will dial each other and only one link is desired, configure the dialer max-links command on just one system. Configure the dialer load-threshold interface configuration command on only one side, either local or remote, and configure the dialer max-links command on the interface where the dialer load-threshold command was configured.
Examples
The following example for a 23-channel ISDN PRI T1 interface shows that only one channel is available for incoming calls and 22 channels are reserved for outgoing calls:
dialer pool-member 1 min-link 22 max-link 23
The following sample report from the debug dialer EXEC command indicates that once one incoming call has been received, the next incoming call is denied:
Incoming call id 0x3 rejected, exceeded max calls . . . Incoming call id 0x3 rejected, exceeded
The following example reserves 19 channels for an incoming call on a 23-channel ISDN PRI T1 interface:
dialer pool-member 1 min-link 5 max-link 24
The following example shows the configuration of one ISDN BRI interface to be a member of dialer pool 2 with priority 100:
interface BRI2 encapsulation ppp dialer pool-member 2 priority 100 ppp authentication chap
In the following example, BRI physical interface configuration BRI 1 has one reserved channel in dialer pool 3. That channel is inactive until BRI 1 uses it to place calls.
interface BRI1 encapsulation ppp dialer pool-member 1 priority dialer pool-member 2 priority !BRI 1 has a reserved channel !until BRI 1 uses it to place dialer pool-member 3 min-link ppp authentication chap
50 50 in dialer pool 3; the channel remains inactive calls. 1
Related Commands
Command dialer pool
Description Specifies for a dialer interface, which dialing pool to use to connect to a specific destination subnetwork.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-173
Dial Commands dialer pre-classify
dialer pre-classify
To force IP Security (IPSec) to check an interesting packet against a dialer-list before enabling a dialer interface, use the dialer pre-classify command in crypto-map configuration mode. dialer pre-classify
Syntax Description
This command has no arguments or keywords.
Command Modes
Crypto-map configuration mode (config-crypto-map)
Command History
Release 12.3(15)T
Modification This command was introduced.
Usage Guidelines
Use the crypto map isakmp-profile command to enter crypto-map configuration mode and create an Internet Security Association and Key Management Protocol (ISAKMP) profile on a crypto map, prior to using the dialer pre-classify command.
Examples
The following example shows how to check a dialer-list prior to enabling a dialer interface, by using the dialer pre-classify command:
Router> enable Router# configure terminal Router(config)# crypto map map-name ipsec-isakmp profile isakmp-profile-name Router(config-crypto-map)# dialer pre-classify
Related Commands
Command crypto map isakmp-profile
Description Configures an ISAKMP profile on a crypto map.
Cisco IOS Dial Technologies Command Reference
DIA-174
November 2009
Dial Commands dialer priority
dialer priority
To set the priority of an interface in a dialer rotary group, use the dialer priority command in interface configuration mode. To revert to the default setting, use the no form of this command. dialer priority number no dialer priority
Syntax Description
number
Priority of an interface in a dialer rotary group; the highest number indicates the highest priority. This is a number from 0 through 255. The default value is 0, the lowest priority.
Command Default
No priority is predefined. When priority is defined, the default value is 0.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
This command is meaningful only for interfaces that are part of dialer rotary groups. The value 0 indicates the lowest priority, and 255 indicates the highest priority. The dialer priority command controls which interfaces within a dialer rotary group will be used first. Higher priority interfaces (configured with higher n value) are used first. The dialer priority command gives you the ability to tell the dialer rotary group which free interface (and, by extension for asynchronous interfaces, which modem) to use first. This command applies to outgoing calls only. For example, a router or access server might have a selection of many modems, some of which are better performers than others. You might have a 19.2-kbps, two 4800-bps, three 1200-bps, and one 300-bps modem on interfaces in one dialer rotary group. You do not want the router or access server to make the call on the 300-baud modem if any of the faster modems are free. You want to use the highest-performance modems first, and the slowest modems last.
Examples
In the following example, asynchronous interface 3 will be used after interfaces with higher priority and before interfaces with lower priority:
interface async 3 dialer priority 5
Cisco IOS Dial Technologies Command Reference November 2009
DIA-175
Dial Commands dialer priority
Related Commands
Command dialer reserved-links interface dialer
Description Includes a specified interface in a dialer rotary group. Defines a dialer rotary group.
Cisco IOS Dial Technologies Command Reference
DIA-176
November 2009
Dial Commands dialer redial
dialer redial
To configure redial after failed outbound dial attempts, use the dialer redial command in interface configuration mode. To disable redial, use the no form of this command. dialer redial interval interval-time attempts redials [re-enable disable-time] no dialer redial
Syntax Description
interval interval-time attempts redials re-enable disable-time
Time, in seconds, between redial attempts. The time can range from 5 to 2147483 seconds. The maximum number of redial attempts to be performed. The number can range from 0 to 2147483. (Optional) Time, in seconds, for which the interface will be disabled if all redial attempts fail. The time can range from 5 to 2147483 seconds.
Command Default
Redial timer disabled.
Command Modes
Interface configuration
Command History
Release 12.1(2) 12.2(4)T
Modification This command was introduced. This command was modified to allow the following:
• • • •
A disable time can be applied to a dialer profile interface and to a serial dialer. The dialer can be configured to apply a disable timer without performing any redial attempts. The dialer may select a different physical dialer on each redial attempt. The dialer will cycle through all dialer strings or matching dialer maps on each redial attempt before applying the redial interval.
Usage Guidelines
Use this command to customize the number of redial attempts to be made, the interval between redial attempts, and the amount of time the interface will be disabled if all redial attempts fail. Setting attempts 0 prevents redial attempts without inactivating the re-enable option. The re-enable option can be applied to both serial dialers and dialer profile interfaces. When a logical dialer interface such as a dialer profile or a dialer rotary group is used, redial attempts may occur on a different physical dialer on each attempt. The physical dialer selection algorithm may be customized using the dialer rotor interface configuration command. Do not use the dialer redial command when a dialer profile has been configured with the dialer persistent command. Both these configuration commands prompt the router to dial out, so it is desirable to configure only one of them.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-177
Dial Commands dialer redial
Examples
The following example configures the dialer to make five redial attempts with an interval of 10 seconds between attempts. If all redial attempts fail, the interface will be disabled for 50 minutes.
dialer redial interval 10 attempts 5 re-enable 3000
Related Commands
Command debug dialer events dialer persistent dialer rotor
Description Displays debugging information about the packets received on a dialer interface. Forces a dialer interface to be connected at all times, even in the absence of interesting traffic. Specifies the method for identifying the outbound line to be used for ISDN or asynchronous DDR calls.
Cisco IOS Dial Technologies Command Reference
DIA-178
November 2009
Dial Commands dialer remote-name
dialer remote-name
To specify the authentication name of the remote router on the destination subnetwork for a dialer interface, use the dialer remote-name command in interface configuration mode. To remove the specified name, use the no form of this command. dialer remote-name user-name no dialer remote-name
Syntax Description
user-name
Case-sensitive character string identifying the remote device; maximum length is 255 characters.
Command Default
No remote name is specified.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
This command applies only to dialer interfaces. Only one remote name can be associated with a dialer interface at a time. You may change the name associated with the dialer interface by reissuing the dialer remote-name command. Issuing the no dialer remote-name command removes the remote name configuration. When using Challenge Handshake Authentication Protocol (CHAP) or Password Authentication Protocol (PAP) authentication, user-name is the name of the remote device that is authenticating.
Examples
The following partial example sets the name of the remote host to yourhost:
interface dialer 1 dialer remote-name yourhost
Related Commands
Command ppp bap call
Description Sets PPP BACP call parameters.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-179
Dial Commands dialer reserved-links
dialer reserved-links
To reserve links for dial-in and dial-out, use the dialer reserved-links command in interface configuration mode. To clear the link, use the no form of this command. dialer reserved-links {dialin-link | dialout-link} no dialer reserved-links
Syntax Description
dialin-link dialout-link
Link reserved for dial-in. Link reserved for dial-out.
Command Default
By default, no links are reserved.
Command Modes
Interface configuration
Command History
Release 12.0(3)T
Modification This command was introduced.
Examples
The following example sets dial in reserved links to 1 and dialout reserved links to 0 on the Dialer0 interface:
interface Dialer0 dialer aaa dialer reserved-links 1 0
Related Commands
Command dialer congestion-threshold sgbp dial-bids
Description Specifies congestion threshold in connected links. Allows the stack group to bid for dialout connection.
Cisco IOS Dial Technologies Command Reference
DIA-180
November 2009
Dial Commands dialer rotary-group
dialer rotary-group
To include a specified interface in a dialer rotary group, use the dialer rotary-group command in interface configuration mode. To remove the specified interface, use the no form of this command. dialer rotary-group interface-number no dialer rotary-group interface-number
Syntax Description
interface-number
Number of the previously defined dialer interface in whose rotary group this interface is to be included. This is a number from 0 to 255. The dialer interface is defined by the interface dialer command.
Command Default
No interfaces are included in a dialer rotary group.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Examples
The following example places asynchronous interfaces 1 and 2 into dialer rotary group 1, defined by the interface dialer 1 command:
hostname central-site ! PPP encapsulation is enabled for interface dialer 1. interface dialer 1 encapsulation ppp dialer in-band ip address 172.18.2.1 255.255.255.0 ip address 172.16.4.1 255.255.255.0 secondary ! ! The first dialer map command allows the central site and remote site YYY ! to call each other and allows the central site to authenticate site YYY ! when it calls in. The second dialer map command, with no dialer string, ! allows the central site to authenticate remote site ZZZ when it calls in, but ! the central site cannot call remote site ZZZ (no phone number). dialer map ip 172.18.2.5 name YYY 14155550134 dialer map ip 172.16.4.5 name ZZZ ! ! The DTR pulse signals for three seconds on the interfaces in dialer ! group 1. This holds the DTR low so the modem can recognize that DTR has been ! dropped. pulse-time 3 ! ! Interfaces async 1 and async 2 are placed in dialer rotary group 1. ! All of the interface configuration commands (the encapsulation and dialer ! map commands shown earlier in this example) applied to interface ! dialer 1 apply to the physical interfaces assigned to the dialer group. !
Cisco IOS Dial Technologies Command Reference November 2009
DIA-181
Dial Commands dialer rotary-group
interface async 1 dialer rotary-group 1 interface async 2 dialer rotary-group 1
Related Commands
Command interface dialer
Description Defines a dialer rotary group.
Cisco IOS Dial Technologies Command Reference
DIA-182
November 2009
Dial Commands dialer rotor
dialer rotor
To specify the method for identifying the outbound line to be used for ISDN or asynchronous dial-on-demand routing (DDR) calls, use the dialer rotor command in interface configuration mode. To remove the specified method, use the no form of this command. dialer rotor {priority | best} no dialer rotor {priority | best}
Syntax Description
priority best
Selects the first outbound line with the highest priority; this is the selection criterion that was previously used. Selects the outbound line with the most recent success. If that line also has the most recent failure, then it will try the line with the least recent failure. If that line also has the most recent failure, it will then try an as-of-yet untried outbound line.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
This command allows the router to skip outbound ISDN BRI and asynchronous lines that have problems. This command would not be useful for ISDN PRI, unless your local telephone service provider has problems keeping your lines properly configured.
Examples
The following example configures a dialer interface to select the outbound line that most recently placed a successful call:
dialer rotor best
Related Commands
Command dialer priority
Description Sets the priority of an interface in a dialer rotary group.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-183
Dial Commands dialer rotor
Cisco IOS Dial Technologies Command Reference
DIA-184
November 2009
Dial Commands dialer string
dialer string
To specify the string (telephone number) to be called for interfaces calling a single site, use the dialer string command in interface configuration mode. To delete the dialer string specified for the interface, use the no form of this command. dialer string dial-string[:isdn-subaddress] no dialer string
Syntax Description
dial-string :isdn-subaddress
String of characters to be sent to a DCE device. (Optional) ISDN subaddress.
Command Default
No strings are predefined.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
To use this command on an asynchronous interface, you must define a modem chat script for the associated line by using the script dialer command. A script must be used to implement dialing. Dialers configured as in-band pass the string to the external dialing device. Specify one dialer string command per interface. To specify multiple strings, use the dialer map command. In general, you include a dialer string or dialer map command if you intend to use a specific interface to initiate a dial-on-demand routing (DDR) call.
Note
If a dialer string command is specified without a dialer-group command with access lists defined, dialing is never initiated. If the debug dialer command is enabled, an error message is displayed indicating that dialing never will occur. The string of characters specified for the dial-string argument is the default number used under the following conditions:
• •
A dialer map command is not included in the interface configuration. The next hop address specified in a packet is not included in any of the dialer map interface configuration commands recorded—assuming that the destination address passes any access lists specified for DDR with the dialer-list command.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-185
Dial Commands dialer string
ITU-T V.25bis Options
On synchronous interfaces, depending on the type of modem you are using, International Telecommunication Union Telecommunication (ITU-T) Standardization Sector V.25bis options might be supported as dial-string parameters of the dialer string command. Supported options are listed in Table 11. The functions of the parameters are nation specific, and they may have different implementations in your country. These options apply only if you have enabled DDR with the dialer in-band command. Refer to the operation manual for your modem for a list of supported options.
Note
The ITU-T carries out the functions of the former Consultative Committee for International Telegraph and Telephone (CCITT).
Table 11 ITU-T V.25bis Options
Option : < = > P T &
Description Wait tone. Pause. Usage and duration of this parameter vary by country. Separator 3. For national use. Separator 4. For national use. Dialing to be continued in pulse mode. Optionally accepted parameter. Tone. Dialing to be continued in Dual Tone Multifrequency (DTMF) mode. Optionally accepted parameter. Flash. (The flash duration varies by country.) Optionally accepted parameter.
Examples
The following example specifies a dial-on-demand routing (DDR) telephone number to be tone-dialed on interface async 1 using the dialer string command:
interface async 1 dialer string T14085550134
Related Commands
Command dialer-group dialer in-band dialer-list protocol (Dial) dialer map script dialer
Description Controls access by configuring an interface to belong to a specific dialing group. Specifies that DDR is to be supported. Defines a DDR dialer list to control dialing by protocol or by a combination of a protocol and a previously defined access list. Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Specifies a default modem chat script.
Cisco IOS Dial Technologies Command Reference
DIA-186
November 2009
Dial Commands dialer string (dialer profiles)
dialer string (dialer profiles)
To specify the string (telephone number) to be used when placing a call from an interface, use the dialer string command in interface configuration mode. To delete the telephone number specified for the interface, use the no form of this command. dialer string dial-string [class class-name] no dialer string
Syntax Description
dial-string class class-name
Telephone number to be sent to a DCE device. (Optional) Dialer map class associated with this telephone number.
Command Default
No telephone numbers and class names are predefined.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
When you use dialer profiles for DDR, use the dialer string class form of this command to define a map class for a specific dialer profile. Dialer profiles make it unnecessary to use dialer maps to configure DDR.
Note
If a dialer string command is specified without a dialer-group command with access lists defined, dialing is never initiated. If the debug dialer command is enabled, an error message is displayed indicating that dialing never will occur.
Examples
The following example specifies that the dial string 4155550134 be used in calls to destinations defined by the map class myclass:
dialer string 4155550134 class myclass
Related Commands
Command dialer-group dialer wait-for-carrier-time (map-class) interface dialer
Description Controls access by configuring an interface to belong to a specific dialing group. Specifies the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class. Defines a dialer rotary group.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-187
Dial Commands dialer string (legacy DDR)
dialer string (legacy DDR)
To specify the destination string (telephone number) to be called for interfaces calling a single site, use the dialer string command in interface configuration mode. To delete the dialer string specified for the interface, use the no form of this command. dialer string dial-string[:isdn-subaddress] no dialer string
Syntax Description
dial-string :isdn-subaddress
String of characters to be sent to a DCE device. (Optional) ISDN subaddress preceded by a colon.
Command Default
No strings are predefined.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
To use this command on an asynchronous interface, you must define a modem chat script for the associated line by using the script dialer command. A script must be used to implement dialing. Dialers configured as in-band pass the string to the external dialing device. Specify one dialer string command per interface. In general, you include a dialer string command if you intend to use a specific interface to initiate a dial-on-demand routing (DDR) call.
Note
If a dialer string command is specified without a dialer-group command with access lists defined, dialing is never initiated. If the debug dialer command is enabled, an error message is displayed indicating that dialing never will occur. The string of characters specified for the dial-string argument is the default number used under the following conditions:
• •
A dialer map command is not included in the interface configuration. The next hop address specified in a packet is not included in any of the dialer map command in interface configuration modes recorded—assuming that the destination address passes any access lists specified for DDR with the dialer-list command.
Cisco IOS Dial Technologies Command Reference
DIA-188
November 2009
Dial Commands dialer string (legacy DDR)
ITU-T V.25bis Options
On synchronous interfaces, depending on the type of modem you are using, International Telecommunication Union Telecommunication (ITU-T) Standardization Sector V.25bis options might be supported as dial-string parameters of the dialer string command. Supported options are listed in Table 11. The functions of the parameters are nation specific, and they may have different implementations in your country. These options apply only if you have enabled DDR with the dialer in-band command. Refer to the operation manual for your modem for a list of supported options.
Note
The ITU-T carries out the functions of the former Consultative Committee for International Telegraph and Telephone (CCITT).
Examples
The following example specifies a DDR telephone number to be tone-dialed on asynchronous interface 1 using the dialer string command:
interface async 1 dialer string T14085550134
Related Commands
Command dialer-group dialer in-band dialer-list protocol (Dial) dialer map script dialer
Description Controls access by configuring an interface to belong to a specific dialing group. Specifies that DDR is to be supported. Defines a DDR dialer list to control dialing by protocol or by a combination of a protocol and a previously defined access list. Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Specifies a default modem chat script.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-189
Dial Commands dialer string trunkgroup
dialer string trunkgroup
To specify a dial-out telephone number and dial-out trunk group name for a static configuration on a network access server (NAS), use the dialer string trunkgoup command in interface configuration mode. To delete the static, dial-out trunk group configuration, use the no form of this command. dialer string dial-string trunkgroup trunkgroup-label no dialer string dial-string trunkgroup trunkgroup-label
Syntax Description
dial-string trunkgroup-label
String of characters to be dialed. A predefined dial-out trunk group name.
Command Default
No trunk groups are defined.
Command Modes
Interface configuration
Command History
Release 12.3(11)T
Modification This command was introduced.
Usage Guidelines
A dialer string command, in general, enables a specific interface for initiating a dial-on-demand routing (DDR) call. The dialer string trunkgroup command enables use of a dial-out trunk group, which directs an outbound synchronous or asynchronous call to be initiated by DDR on a specific channel of an ISDN circuit. The channel (also called a digital service 0 or DS0 link), is a member of a defined dial-out trunk group. Individual DS0s from various signaling circuits can be aggregated into a dial-out trunk group. The dial-out trunk group configured by the dialer string trunkgroup command must be part of a static configuration on an NAS. See the “Related Commands” section for commands that allow other nonstatic configurations of dial-out trunk groups.
Examples
The following example enables use of dial-out trunk group TG1 on dialer interface 0 as part of a static NAS configuration:
interface dialer 0 dialer string 5550112 trunkgroup TG1
Related Commands
Command cas-custom ds0-group
Description Customizes signaling parameters for a particular E1 or T1 channel group on a channelized line. Defines E1 channels for the CAS method by which the router connects to the PSTN.
Cisco IOS Dial Technologies Command Reference
DIA-190
November 2009
Dial Commands dialer string trunkgroup
Command pri-group timeslots show trunk group
Description Specifies an ISDN PRI group on a channelized T1 or E1 controller. Displays one or more trunk groups.
trunk-group timeslots Directs an outbound synchronous or asynchronous call initiated by DDR to use specific DS0 channels of an ISDN circuit.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-191
Dial Commands dialer voice-call
dialer voice-call
To configure the dialer map class for a Network Specific Facilities (NSF) dialing plan to support outgoing voice calls, use the dialer voice-call command in map-class dialer configuration mode. dialer voice-call
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Map-class dialer configuration
Command History
Release 11.0
Modification This command was introduced.
Examples
The following partial example defines a dialer map class to support the SDN dialing plan and to support outgoing voice calls. For a more complete example using all the related commands, see the map-class dialer command.
map-class dialer sdnplan dialer voice-call dialer outgoing sdn
Related Commands
Command dialer map dialer outgoing map-class dialer
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Configures the dialer map class for a NSF dialing plan to support outgoing calls. Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback.
Cisco IOS Dial Technologies Command Reference
DIA-192
November 2009
Dial Commands dialer vpdn
dialer vpdn
To enable a dialer profile or dial-on-demand routing (DDR) dialer to use Layer 2 Tunnel Protocol (L2TP) dialout, use the dialer vpdn command in interface configuration mode. To disable L2TP dialout on a dialer profile or DDR dialer, use the no form of this command. dialer vpdn no dialer vpdn
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 12.0(5)T
Modification This command was introduced.
Usage Guidelines
The dialer vpdn command must be configured on the LNSs dialer interface to enable L2TP dialout. This command enables the dialer to place a VPDN call.
Examples
The following example shows how to configure the dialer interface and VPDN group on an LNS for L2TP dialout:
interface Dialer2 ip address 172.16.2.3 255.255.255.128 encapsulation ppp dialer remote-name myname dialer string 5550134 dialer vpdn dialer pool 1 dialer-group 1 ppp authentication chap vpdn-group 1 request-dialout protocol l2tp pool-member 1 initiate-to ip 172.21.9.4
Related Commands
Command dialer aaa request-dialout
Description Allows a dialer to access the AAA server for dialing information. Enables an LNS to request VPDN dial-out calls by using L2TP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-193
Dial Commands dialer wait-for-carrier-time (interface)
dialer wait-for-carrier-time (interface)
To specify the length of time the interface waits for a carrier, use the dialer wait-for-carrier-time command in interface configuration mode. To reset the carrier wait time value to the default, use the no form of this command. dialer wait-for-carrier-time seconds no dialer wait-for-carrier-time
Syntax Description
seconds
Number of seconds that the interface waits for the carrier to come up when a call is placed. Acceptable values are positive, nonzero integers.
Command Default
30 seconds
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
On asynchronous interfaces, the dialer wait-for-carrier-time command sets the total time allowed for the chat script to run. If a carrier signal is not detected in this amount of time, the interface is disabled until the enable timeout occurs (configured with the dialer enable-timeout command). Do not use this command for BRI and leased-line interfaces.
Examples
The following example specifies a carrier wait time of 45 seconds on asynchronous interface 1:
interface async 1 dialer wait-for-carrier-time 45
Related Commands
Command
Description
dialer enable-timeout Sets the length of time an interface stays down after a call has completed or failed and before the interface is available to dial again.
Cisco IOS Dial Technologies Command Reference
DIA-194
November 2009
Dial Commands dialer wait-for-carrier-time (map-class)
dialer wait-for-carrier-time (map-class)
To specify the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class, use the dialer wait-for-carrier-time command in map-class dialer configuration mode. To reset the carrier wait time value to the default, use the no form of this command. dialer wait-for-carrier-time seconds no dialer wait-for-carrier-time
Syntax Description
seconds
Number of seconds that the interface waits for the carrier to come up when a call is placed. Acceptable values are positive, nonzero integers. The default is 30 seconds.
Command Default
30 seconds
Command Modes
Map-class dialer configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
You can define different dialer map classes with different wait-for-carrier times to suit the different types of lines and interfaces. For example, you must define a longer wait time for a map class used by serial interfaces than for one used by ISDN interfaces. Do not use this command for BRI and leased-line interfaces.
Examples
The following example specifies a carrier wait time of 20 seconds for the class “Eng” on interface Dialer2:
interface Dialer2 ip address 10.2.2.2 255.255.255.0 encapsulation ppp dialer remote-name Mediumuser dialer string 5264540 class Eng dialer wait-for-carrier-time 20 dialer load-threshold 50 either dialer pool 1 dialer-group 2
Cisco IOS Dial Technologies Command Reference November 2009
DIA-195
Dial Commands dialer wait-for-line-protocol
dialer wait-for-line-protocol
To set a maximum time the dialer will wait for a line protocol after establishing a physical connection before considering the call unsuccessful, use the dialer wait-for-line-protocol command in interface configuration mode. To disable this function, use the no form of this command. dialer wait-for-line-protocol wait-time no dialer wait-for-line-protocol
Syntax Description
wait-time
Time, in seconds, that the dialer will wait for the line protocol to come up after the physical layer connection has been established. The time can range from 1 to 2147483 seconds.
Command Default
Timer is disabled.
Command Modes
Interface configuration
Command History
Release 12.2(4)T
Modification This command was introduced.
Usage Guidelines
This command is supported only with encapsulation PPP. By default the Cisco IOS software considers a dial-out attempt successful if a connection is established to the physical layer (Layer 1 of the Open System Interconnection reference model). The dialer wait-for-line-protocol command can be used to configure a router to wait a specific amount of time for a line protocol to come up once a physical layer connection has been established. If the call is dropped before the timer has elapsed, the call will be considered a failure. Redial will be triggered if the redial options have been configured with the dialer redial interface configuration command. The dialer failure statistics for the physical interface will be updated, which may influence the selection of a physical dialer for the next dial attempt. The physical dialer selection algorithm may be customized using the dialer rotor interface configuration command.
Note
This command is not useful in conjunction with Cisco High-Level Data Link Control (HDLC) encapsulation. Cisco HDLC encapsulation is the default line protocol and will always come up regardless of line conditions.
Examples
The following example configures the dialer to wait 10 seconds for a line protocol after making a physical connection:
dialer wait-for-line-protocol 10
Cisco IOS Dial Technologies Command Reference
DIA-196
November 2009
Dial Commands dialer wait-for-line-protocol
Related Commands
Command debug dialer events dialer redial
Description Displays debugging information about the packets received on a dialer interface. Configures the number of redial attempts to be made, the interval between redial attempts, and the amount of time the interface will be disabled if all redial attempts fail. Specifies the method for identifying the outbound line to be used for ISDN or asynchronous DDR calls.
dialer rotor
Cisco IOS Dial Technologies Command Reference November 2009
DIA-197
Dial Commands dialer watch-disable
dialer watch-disable
Note
Effective with Cisco IOS Release 12.3(11)T, this command is replaced by the dialer watch-list delay command. See the dialer watch-list delay command page for more information. To set a delay time to the backup interface, use the dialer watch-disable command in interface configuration mode. To disable this feature, use the no form of this command. dialer watch-disable timeout no dialer watch-disable
Syntax Description
timeout
The timeout value in seconds.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 11.3 12.3(11)T
Modification This command was introduced. This command was replaced by the dialer watch-list delay command.
Usage Guidelines
This command is used to add a delay time to the backup interface. The delay time delays the time it takes for the backup interface to disconnect after the primary interface recovers.
Examples
The following example forces a 6-second delay to the backup interface once the primary interface recovers:
interface bri0 ip address 10.1.1.2 255.255.255.0 encapsulation ppp dialer map ip 10.3.1.1 255.255.255.0 name mymap 5550134 dialer-group 1 dialer watch-group 1 dialer watch-disable 6
Related Commands
Command show dialer dnis
Description Displays general diagnostic information for ISDN BRI interfaces configured for DDR.
Cisco IOS Dial Technologies Command Reference
DIA-198
November 2009
Dial Commands dialer watch-group
dialer watch-group
To enable dial-on-demand routing (DDR) backup on an interface using Dialer Watch, configure the interface using the dialer watch-group command in interface configuration mode. To disable this feature, use the no form of this command. dialer watch-group group-number no dialer watch-group group-number
Syntax Description
group-number
Group number assigned that will point to a globally defined list of IP addresses to watch. The valid range is 1 to 255.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 11.3T
Modification This command was introduced.
Usage Guidelines
Use the dialer watch-group command on the secondary interface you want to enable DDR backup. The dialer watch group number points to a globally defined list (the dialer watch-list command) that contains the IP addresses to be watched. If you use the dialer watch-group command you must also use the dialer watch-list command. You must configure the standard commands required to enable the router to perform DDR in addition to the Dialer Watch commands. Refer to the Cisco IOS Dial Technologies Configuration Guide and the Cisco IOS Dial Technologies Command Reference for additional information. The dialer watch-group and dialer watch-list commands can be added in any order.
Examples
The following example configures BRI interface 0 as the backup interface:
interface bri0 ip address 10.1.1.2 255.255.255.0 encapsulation ppp dialer watch-group 1
Related Commands
Command dialer watch-list
Description Adds the list of IP addresses to be monitored for Dialer Watch.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-199
Dial Commands dialer watch-list
dialer watch-list
To specify a list of watched routes of IP addresses or optionally, IP address and VPN routing and forwarding (VRF) instance pairs to be monitored by Dialer Watch, or to configure the router to dial the backup link if the primary link fails during initial startup, use the dialer watch-list command in global configuration mode. To disable these features, use the no form of this command. dialer watch-list group-number {ip ip-address address-mask [vrf vrf-name] | delay route-check initial seconds} no dialer watch-list group-number {ip ip-address address-mask [vrf vrf-name] | delay route-check initial seconds}
Syntax Description
group-number
Group number assigned to the list. Valid group numbers are from 1 to 255. The value of this argument must match the group number set with the dialer watch-group command. Specifies the IP address or address range and address mask to be applied to the list. IP is the only routed protocol supported for Dialer Watch. (Optional) Specifies a watched route using the VRF instance table named in the vrf-name argument.
ip ip-address address-mask vrf vrf-name
delay route-check Number of seconds after which the router ensures that the primary route is up once initial seconds initial startup is complete.
Command Default
The dialer watch-list command is disabled.
Command Modes
Global configuration
Command History
Release 11.3 12.1(3)T 12.3(7)T
Modification This command was introduced. The delay route-check initial seconds keywords and argument were introduced. The vrf vrf-name keyword and argument were introduced.
Usage Guidelines
Use this command to add all IP addresses or networks that you want monitored. There is no software limit to the number of IP addresses that can be added to a group. Use this command with the dialer watch-group interface configuration command. The group-number value must match the group number set in the dialer watch-group interface configuration command. For example, if you use dialer watch-group 1, you must also use dialer watch-list 1. The dialer watch-list and dialer watch-group commands can be added in any order. Address matching is exact; therefore, you must apply the specific IP address and mask range for the networks that you want monitored. Use the show ip route command to verify that the route you are watching exists in the routing table. The route configured for the dialer watch-list command must match the one in the routing table exactly. This matching includes verifying that both the network and the masks
Cisco IOS Dial Technologies Command Reference
DIA-200
November 2009
Dial Commands dialer watch-list
are identical. You must configure the standard commands required to enable the router to perform dial-on-demand routing (DDR) in addition to configuring the Dialer Watch commands. Refer to the Cisco IOS Dial Technologies Configuration Guide and the Cisco IOS Dial Technologies Command Reference for additional information. Enabling the delay route-check initial keywords enables the router to check whether the primary route is up after the initial startup of the router is complete and the timer (in seconds) expires. Without this command, the Dialer Watch feature is triggered only when the primary route is removed from the routing table. If the primary link fails to come up during initial startup of the router, the route is never added to the routing table and hence cannot be watched. Therefore, using the delay route-check initial keywords enables the Dialer Watch feature to dial the backup link in the event of a primary link failure during the initial startup of the router. Enabling the vrf vrf-name keyword and argument configures the corresponding VRF table to be used to detect when the watched route for the VRF has gone down. A VRF is a per-VPN routing information repository that defines the virtual private network (VPN) membership of a customer site attached to a network access server. A VRF consists of an IP routing table, a derived Cisco Express Forwarding (CEF) table, a set of interfaces that use the forwarding table, and a set of rules and routing protocol parameters that control the information that is included in the routing table. A separate set of routing and CEF tables is maintained for each VPN customer. It is important to note that the VRF might have overlapping address space, as follows: At the provider edge (PE) router, each customer edge (CE) router will have a corresponding VRF associated with it. Further, two CE routers might be using the same address space, so that the corresponding VRFs at the PE router will have overlapping address space. For this reason, when using the vrf vrf-name keyword and argument, configure the watched route as an IP address-VRF name pair, where the IP address is the watched IP address and the VRF name is the routing and forwarding instance to which the IP address belongs. Configuring the Dialer Watch feature with only the IP address does not ensure that the correct CE route will be dialed when a watched route goes down. Configuring Dialer Watch with an IP address and VRF name pair ensures that the VRF table corresponding to the routing and forwarding instance to which the IP address belongs is found and the correct CE is dialed. You can define one watch route that watches the same IP address, but belongs to a different VRF, in a single watch list.
Examples
The following example specifies a pair of watched routes in a legacy dialer configuration. In this configuration, watch lists 1 and 2 are both watching the same IP address, but belong to different VRFs.
interface BRI3/0 ip address 10.0.2.2 255.255.255.0 encapsulation ppp dialer map 10.1.2.0 vrf v1 3xxxxxx dialer map 10.1.2.0 vrf v2 4xxxxxx dialer-group 1 dialer watch-group 1 dialer watch-group 2 isdn switch-type ntt ppp authentication chap ! dialer watch-list 1 ip 10.2.1.0 255.255.255.0 vrf v1 dialer watch-list 2 ip 10.2.1.0 255.255.255.0 vrf v2
Cisco IOS Dial Technologies Command Reference November 2009
DIA-201
Dial Commands dialer watch-list
The following example specifies a pair of watched routes in a dialer rotary group configuration. In this configuration, watch lists 1 and 2 are both watching the same IP address, but belong to different VRFs.
interface BRI3/0 no ip address encapsulation ppp dialer rotary-group 1 isdn switch-type ntt ppp authentication chap ! interface Dialer1 ip address 10.0.2.2 255.255.255.0 encapsulation ppp dialer remote-name c3640-B dialer map 10.1.2.0 vrf v1 3xxxxxx dialer map 10.1.2.0 vrf v2 4xxxxxx dialer watch-group 1 dialer watch-group 2 dialer-group 1 ppp authentication chap ! dialer watch-list 1 ip 10.2.1.0 255.255.255.0 vrf v1 dialer watch-list 2 ip 10.2.1.0 255.255.255.0 vrf v2 dialer watch-list 1 delay disconnect 30
The following example specifies a pair of watched routes in a dialer profile configuration. In this configuration, watch lists 1 and 2 are both watching the same IP address, but belong to different VRFs.
interface BRI3/0 no ip address encapsulation ppp dialer pool-member 1 isdn switch-type ntt ppp authentication chap ! interface Dialer1 ip vrf forwarding v1 ip address 10.0.2.2 255.255.255.0 encapsulation ppp dialer pool 1 dialer remote-name c3640-B dialer watch-disable 30 dialer string 03xxxxxxx1 dialer caller 03xxxxxxx1 callback dialer watch-group 1 dialer-group 1 ppp authentication chap ! interface Dialer2 ip vrf forwarding v2 ip address 10.0.2.2 255.255.255.0 encapsulation ppp dialer pool 1 dialer remote-name c3640-B dialer string 04xxxxxxx1 dialer caller 04xxxxxxx1 callback dialer watch-group 2 dialer-group 1 ppp authentication chap ! dialer watch-list 1 ip 10.2.1.0 255.255.255.0 vrf v1 dialer watch-list 2 ip 10.2.1.0 255.255.255.0 vrf v2 dialer watch-list 1 delay disconnect 30 dialer watch-list 2 delay disconnect 30
Cisco IOS Dial Technologies Command Reference
DIA-202
November 2009
Dial Commands dialer watch-list
The following example lists IP addresses to be watched and forms a group of networks to monitor:
dialer watch-list 1 ip 10.1.1.0 255.255.255.0 dialer watch-list 1 ip 10.31.1.0 255.255.255.0 dialer watch-list 1 ip 10.12.1.0 255.255.255.0
The following partial example shows how to ensure that the router will check that the primary route is up after initial startup of the router is complete:
! Create backup link and enable process switching interface BRI0/0 ip address 10.13.1.1 255.255.255.0 encapsulation ppp no ip route-cache . . . ! Enable dialer watch on this backup interface. ! Watch the route specified with the dialer watch-list 1 command. ! Apply interesting traffic defined in dialer list 1. ! Apply crypto map on backup interface. dialer watch-group 1 dialer-group 1 isdn switch-type basic-ts013 no peer neighbor-route no cdp enable ppp authentication chap crypto map cisco . . . ! Access control list (ACL) 101 is the IPSec traffic used in match address. ! ACL 110 is for the dialer list to mark all IP traffic uninteresting. ! The dialer watch will trigger the ISDN backup when the route is lost. access-list 101 permit ip host 10.11.11.11 host 10.11.22.22 access-list 110 deny ip any any dialer watch-list 1 ip 192.168.0.222 255.255.255.255 ! These commands define the routes to be watched ! and check whether the primary route is up after the initial startup of the ! router is complete. ! The exact route (including subnet mask) must exist in the routing table. ! The dialer watch-group 1 command applies this list to the backup interface. dialer watch-list 1 delay route-check initial 10 dialer-list 1 protocol ip list 110 ! Interesting traffic is defined by ACL 110. ! The ACL is applied to BRI0/0 using dialer group 1.
Related Commands
Command dialer watch-group show ip route
Description Enables DDR backup on an interface using Dialer Watch. Displays all static IP routes, or those installed using the AAA route download function.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-203
Dial Commands dialer watch-list delay
dialer watch-list delay
To configure the router to delay before connecting or disconnecting a secondary link for a route monitored by Dialer Watch, use the dialer watch-list delay command in global configuration mode. To disable these delays, use the no form of this command. dialer watch-list group-number delay {connect connect-time | disconnect disconnect-time} no dialer watch-list group-number delay {connect connect-time | disconnect disconnect-time}
Syntax Description
group-number connect connect-time
Group number assigned to the list. Valid group numbers are from 1 to 255. Specifies that the router will delay dialing the secondary link when the primary link becomes unavailable. Time, in seconds, after which the router rechecks for availability of the primary link. If the primary link is still unavailable, the secondary link is then dialed. Valid times range from 1 to 2147483. Specifies that the disconnect timer is started when the secondary link is up and after the idle timeout period has expired, and only when software has determined that the primary route has come up. Time, in seconds. Valid times range from 1 to 2147483.
disconnect
disconnect-time
Command Default
No delay is configured.
Command Modes
Global configuration
Command History
Release 12.2(8)T
Modification This command was introduced.
Usage Guidelines
Use this command to configure a delay before connecting or disconnecting a secondary link for a route monitored by Dialer Watch. This command will not work unless dial-on-demand routing (DDR) is configured and Dialer Watch has been enabled.
Examples
The following example configures the router to wait 10 seconds before verifying that the primary link is still down and dialing a secondary link:
dialer watch-list 1 ip 10.1.1.0 255.255.255.0 dialer watch-list 1 delay connect 10
The following example configures the router to wait 10 seconds to disconnect a secondary link once the primary link has been reestablished:
dialer watch-list 1 ip 10.1.1.0 255.255.255.0 dialer watch-list 1 delay disconnect 10
Cisco IOS Dial Technologies Command Reference
DIA-204
November 2009
Dial Commands dialer watch-list delay
Related Commands
Command dialer watch-group dialer watch-list
Description Enables DDR backup on an interface using Dialer Watch. Adds the list of IP addresses to be monitored for Dialer Watch.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-205
Dial Commands dialer-group
dialer-group
To control access by configuring an interface to belong to a specific dialing group, use the dialer-group command in interface configuration mode. To remove an interface from the specified dialer access group, use the no form of this command. dialer-group group-number no dialer-group
Syntax Description
group-number
Number of the dialer access group to which the specific interface belongs. This access group is defined with the dialer-list command. Acceptable values are nonzero, positive integers between 1 and 10.
Command Default
No access is predefined.
Command Modes
Interface configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
An interface can be associated with a single dialer access group only; multiple dialer-group assignment is not allowed. A second dialer access group assignment will override the first. A dialer access group is defined with the dialer-group command. The dialer-list command associates an access list with a dialer access group. Packets that match the dialer group specified trigger a connection request.
Examples
The following example specifies dialer access group number 1. The destination address of the packet is evaluated against the access list specified in the associated dialer-list command. If it passes, either a call is initiated (if no connection has already been established) or the idle timer is reset (if a call is currently connected).
interface async 1 dialer-group 1 access-list 101 deny igrp 0.0.0.0 255.255.255.255 255.255.255.255 0.0.0.0 access-list 101 permit ip 0.0.0.0 255.255.255.255 0.0.0.0 255.255.255.255 dialer-list 1 protocol ip list 101
Related Commands
Command dialer-list protocol (Dial)
Description Defines a DDR dialer list to control dialing by protocol or by a combination of protocol and an access list.
Cisco IOS Dial Technologies Command Reference
DIA-206
November 2009
Dial Commands dialer-group (template)
dialer-group (template)
To control access by configuring a virtual access interface to belong to a specific dialing group, use the dialer-group command in template configuration mode. To remove an interface from the specified dialer access group, use the no form of this command. dialer-group dialer-list-number no dialer-group
Syntax Description
dialer-list-number
Number of the dialer access group to which the specific interface belongs. This access group is defined with the dialer-list command. Acceptable values are positive numbers from 1 to 128.
Command Default
No access is predefined.
Command Modes
Template configuration
Command History
Release 12.2(4)T 12.2(11)T
Modification This command was introduced for Resource Pool Manager (RPM) template configuration. This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5300, Cisco AS5400, and Cisco AS5800.
Usage Guidelines
An interface can be associated with only a single dialer access group; multiple dialer-group assignment is not allowed. A second dialer access group assignment will override the first. A dialer access group is defined with the dialer-group template configuration command. The dialer-list command associates an access list with a dialer access group. For Cisco IOS Release 12.2(4)T, the number of dialer groups that can be configured was increased from 10 to 128. Packets that match the dialer group specified trigger a connection request.
Examples
The following example specifies dialer access group number 1. The destination address of the packet is evaluated against the access list specified in the associated dialer-list command. If it passes, either a call is initiated (if no connection has already been established) or the idle timer is reset (if a call is currently connected).
template template1 dialer-group 1
Cisco IOS Dial Technologies Command Reference November 2009
DIA-207
Dial Commands dialer-group (template)
Related Commands
Command dialer-list protocol
Description Defines a dialer list to control dialing by protocol or by a combination of protocol and an access list.
Cisco IOS Dial Technologies Command Reference
DIA-208
November 2009
Dial Commands dialer-list protocol (Dial)
dialer-list protocol (Dial)
To define a dial-on-demand routing (DDR) dialer list for dialing by protocol or by a combination of a protocol and a previously defined access list, use the dialer-list protocol command in global configuration mode. To delete a dialer list, use the no form of this command. dialer-list dialer-group protocol protocol-name {permit | deny | list access-list-number | access-group} no dialer-list dialer-group [protocol protocol-name [list access-list-number | access-group]]
Syntax Description
dialer-group protocol-name
Number of a dialer access group identified in any dialer-group interface or template configuration command. Up to 128 dialer groups can be configured. One of the following protocol keywords: appletalk, bridge, clns, clns_es, clns_is, decnet, decnet_router-L1, decnet_router-L2, decnet_node, ip, ipx, or ipv6. Permits access to an entire protocol. Denies access to an entire protocol. Specifies that an access list will be used for defining a granularity finer than an entire protocol.
permit deny list
access-list-number Access list numbers specified in any DECnet, IP, or Novell IPX standard or extended access lists, including Novell IPX extended service access point (SAP) access lists and bridging types. See Table 12 for the supported access list types and numbers. access-group Filter list name used in the clns filter-set and clns access-group commands.
Command Default
No dialer lists are defined.
Command Modes
Global configuration
Command History
Release 10.0 10.3 12.2(2)T 12.2(4)T 12.2(11)T 12.2(13)T
Modification This command was introduced. The list keyword and the access-list-number and access-group arguments were added. The ipv6 protocol keyword was added. The number of dialer groups that can be configured was increased to 128. This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5300, Cisco AS5400, and Cisco AS5800. The igrp, vines, and xns arguments were removed because the Interior Gateway Routing Protocol (IGRP), Banyan Systems Virtual Integrated Network Service (VINES), and the Xerox Network System (XNS) are no longer available in Cisco IOS software.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-209
Dial Commands dialer-list protocol (Dial)
Usage Guidelines
The various no forms of this command have the following effects:
• • •
The no dialer-list dialer-group command deletes all lists configured for the specified dialer access group, regardless of the keyword previously used (permit, deny, protocol, or list). The no dialer-list dialer-group protocol protocol-name command deletes all lists configured for the specified dialer access group and protocol protocol-name. The no dialer-list dialer-group protocol protocol-name list access-list-number command deletes the specified list.
The dialer-list protocol command permits or denies access to an entire protocol. The dialer-list protocol command with the optional list keyword provides finer permission granularity and also supports protocols that were not previously supported. This command also applies protocol access lists to dialer access groups to control dialing using DDR. The dialer access groups are defined with the dialer-group command. Table 12 lists the access list types and numbers that the dialer-list protocol command supports. The table does not include International Organization for Standardization Connectionless Network Service (ISO CLNS) because that protocol uses filter names instead of predefined access list numbers.
Table 12 dialer-list protocol Command Supported Access List Types and Numbers
Access List Type AppleTalk DECnet IP (standard) IP (extended) Novell IPX (standard) Novell IPX (extended) Transparent Bridging
Access List Number Range (Decimal) 600–699 300–399 1–99 100–199 800–899 900–999 200–299
Examples
Dialing occurs when an interesting packet (one that matches access list specifications) needs to be output on an interface. Using the standard access list method, packets can be classified as interesting or uninteresting. The following example classifies all other IP packets as interesting and permits them to initiate calls:
access-list 101 permit ip 10.0.0.0 255.255.255.255 10.0.0.0 255.255.255.255
Then the following command places list 101 into dialer access group 1:
dialer-list 1 protocol ip list 101
In the following example, DECnet access lists allow any DECnet packets with source area 10 and destination area 20 to trigger calls:
access-list 301 permit 10.0 0.1023 10.0 0.1023 access-list 301 permit 10.0 0.1023 20.0 0.1023
Then the following command places access list 301 into dialer access group 1:
dialer-list 1 protocol decnet list 301
Cisco IOS Dial Technologies Command Reference
DIA-210
November 2009
Dial Commands dialer-list protocol (Dial)
In the following example, a CLNS filter is defined and then the filter is placed in dialer access group 1:
clns filter-set ddrline permit 47.0004.0001.... ! dialer-list 1 protocol clns list ddrline
The following example configures an IPv6 access list named list2 and places the access list in dialer access group 1:
ipv6 access-list list2 deny fec0:0:0:2::/64 any ipv6 access-list list2 permit any any ! dialer-list 1 protocol ipv6 list list2
Related Commands
Command access-list clns filter-set
Description Configures the access list mechanism for filtering frames by protocol type or vendor code. Builds a list of CLNS address templates with associated permit and deny conditions for use in CLNS filter expressions.
dialer-group (template) Controls access by configuring a virtual template interface to belong to a specific dialing group. ipv6 access-list Defines an IPv6 access list and sets deny or permit conditions for the defined access list.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-211
Dial Commands dial-peer cor custom
dial-peer cor custom
To specify that named class of restrictions (COR) apply to dial peers, use the dial-peer cor custom command in global configuration mode. dial-peer cor custom
Syntax Description
This command has no arguments or keywords.
Command Default
No default behavior or keywords.
Command Modes
Global configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
You must use the dial-peer cor custom command and the name command to define the names of capabilities before you can specify COR rules and apply them to specific dial peers. Examples of possible names might include the following: call1900, call527, call9, and call911.
Note
You can define a maximum of 64 COR names.
Examples
The following example defines two COR names:
dial-peer cor custom name group32 name CatchAll
Related Commands
Command
Description
name (dial peer cor custom) Provides a name for a custom COR.
Cisco IOS Dial Technologies Command Reference
DIA-212
November 2009
Dial Commands dial-peer cor list
dial-peer cor list
To define a class of restrictions (COR) list name, use the dial-peer cor list command in global configuration mode. To remove a previously defined COR list name, use the no form of this command. dial-peer cor list list-name no dial-peer cor list list-name
Syntax Description
list-name
List name that is applied to incoming or outgoing calls to specific numbers or exchanges.
Command Default
No default behavior or keywords.
Command Modes
Global configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
A COR list defines a capability set that is used in the COR checking between incoming and outgoing dial peers.
Examples
The following example adds two members to the COR list named list1:
dial-peer cor list list1 member 900block member 800_call
Related Commands
Command dial-peer cor custom member (dial peer cor list) name (dial peer cor custom)
Description Specifies that named COR apply to dial peers. Adds a member to a dial peer COR list. Provides a name for a custom COR.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-213
Dial Commands dial-shelf split backplane-ds0
dial-shelf split backplane-ds0
To connect two router shelves to a dial shelf, use the dial-shelf split backplane-ds0 command in global configuration mode. To remove the connection, use the no form of this command. dial-shelf split backplane-ds0 {predefined-option | userdefined option} no dial-shelf split backplane-ds0
Syntax Description
predefined-option
Predefined backplane DS0 pairs. See Table 13 for a list of these options.
userdefined option Number of backplane DS0 interfaces used by the router shelf that you define, in the range 128 to 2048.
Command Default
Option pair 6
Command Modes
Global configuration
Command History
Release 12.1(5)T
Modification This command was introduced.
Usage Guidelines
The options for this command come in pairs and vary according to the desired configuration. You will need to log in to each router shelf and separately configure the routers for the intended load. In most circumstances, it is recommended that the predefined options remain selected. These options are designed to be matched pairs, as seen in Table 13. You can select the userdefined keyword and define your own split, if needed. Table 13 lists the predefined options.
dial-shelf split backplane ds-0 Predefined Options
Table 13
Router Shelf 1 Option Pair 1 2 3 4 5 6 7
1
Router Shelf 2 Maximum Calls 1344 1152 1288 1150 960 Unused T1 — 4 — 2 — Option
1ct3cas part1ct1ct3cas part1ct1ct3isdn_b part1ct1ct3isdn 3ce1
Total Calls Maximum Calls 672 888 644 897 960 Unused T1 — 3 7 1 — 2016 2040 1932 2047 1920 — 2048
Option
2ct3cas part2ct1ct3cas 2ct3isdn part2ct1ct3isdn 3ce1
Default (no option entered)
no dial-shelf backplane-ds0
1/2 of current — input 1024 —
Default (no option entered)
no dial-shelf backplane-ds0
1/2 of current — input 1024 —
1. This option is used to revert to the default for an environment that uses six E1 lines.
Cisco IOS Dial Technologies Command Reference
DIA-214
November 2009
Dial Commands dial-shelf split backplane-ds0
The dial-shelf split slot command must be defined for the dial-shelf split backplane-ds0 command to be active. Even if your system is already using a split dial shelf configuration, configuring one router shelf to handle two T3 trunks and the other router to handle the third trunk requires you to take the entire access server out of service. Busyout all connections before attempting to reconfigure. The configuration must be changed to set up one pool of TDM resources that can be used by either DMM cards or UPC and a second pool of two streams that contains TDM resources that can be used only by UPCs. You may have more trunk capacity than 2048 calls. It is your decision how to provision the trunks so the backplane capacity is not exceeded. If more calls come in than backplane DS0 capacity for that half of the split, the call will be rejected and an error message printed for each call. This cannot be detected while a new configuration is being built because the router cannot tell which T1 trunks are provisioned and which are not. The user may want some trunks in hot standby. The DMM, HMM, and VoIP cards can use only 1792 DS0 of the available 2048 backplane DS0. The UPC and trunk cards can use the full 2048 backplane DS0. The show tdm splitbackplane command shows the resources in two groups, the first 1792 accessible to all cards, and the remaining 256 accessible only to UPC and trunk cards.
Examples
The following example shows how to configure two router shelves. Refer to Table 13 to interpret the options specified. Configure router shelf 1 to run two CT3 interfaces with channel-associated signaling (CAS) and the ability to answer 1344 calls:
dial-shelf split backplane-ds0 2ct3cas
Configure router shelf 2 to run one CT3 interface with CAS on the second router shelf and the ability to answer 672 calls:
dial-shelf split backplane-ds0 1ct3cas
The total calls configured for the system are 2036 (1344 plus 672).
Related Commands
Command dial-shelf split slots show tdm splitbackplane
Description Configures split dial shelves. Displays modem and PRI channel assignments with streams and channels on the modem side as assigned to the unit and channels on the PRI side of the TDM assignment.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-215
Dial Commands dial-shelf split slots
dial-shelf split slots
To configure split dial shelves, use the dial-shelf split slots command in global configuration mode. To change the router shelf to normal mode, if a router is in split mode and the other router shelf has already relinquished control of all dial shelf slots or is switched off, use the no form of this command. dial-shelf split slots slot-numbers no dial-shelf split slots
Syntax Description
slot-numbers
List of the dial shelf slot numbers that the router owns in the range 0 to 11, separated by spaces. Slot ownership for each of the two router shelves is configured individually using the dial-shelf split slots command.
Command Default
No default behavior or keywords.
Command Modes
Global configuration
Command History
Release 11.3(8)AA
Modification This command was introduced.
Usage Guidelines
You allocate the slots in the dial shelf between the two router shelves to achieve the desired configuration. The two router shelves are both configured to run in split mode by means of the dial-shelf split slots command. While a router is in split mode, additional slots can be added to the set that the router owns by re-entering the dial-shelf split slots command listing the new slots. The effect of entering two or more dial-shelf split slots commands with different slot numbers is cumulative. Slots must be explicitly removed from the list of router-owned slots with the dial-shelf split slots remove command. A single router can also be configured in split mode, but with no slots owned, by using the dial-shelf split slots none command. When you configure a Cisco AS5800 system to operate in split mode, it is the same as having two Cisco AS5800 systems with each having a separate set of feature boards assigned to its router; they just happen to be sharing a single dial shelf. Modem pooling, for example, is the same as if you had two separate Cisco AS5800 systems. Router shelf 1 has a modem pool that consists of all the modem cards that reside in slots owned by router shelf 1. The same situation applies to router shelf 2.
Examples
The following example would configure the router shelf to own slots 0 through 2 and 6 through 8.
dial-shelf split slots 0 1 2 6 7 8
In this example, the other router shelf could be configured to own the other slots: 3, 4, 5, 9, 10, and 11.
Cisco IOS Dial Technologies Command Reference
DIA-216
November 2009
Dial Commands dial-shelf split slots
Related Commands
Command dial-shelf split slots none dial-shelf split slots remove
Description Configures the router in dial shelf split mode but with no slots owned. Removes slots configured in split mode.
dial-shelf split backplane-ds0 Connects two router shelves to a dial shelf.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-217
Dial Commands dial-shelf split slots none
dial-shelf split slots none
To configure the router in dial shelf split mode but with no slots owned, use the dial-shelf split slots none command in global configuration mode. dial-shelf split slots none
Syntax Description
This command has no arguments or keywords.
Command Default
No default behavior or keywords.
Command Modes
Global configuration
Command History
Release 11.3(8)AA
Modification This command was introduced.
Usage Guidelines
The dial-shelf split slots none command is useful for configuring a single router in split mode, but with no slots owned.
Examples
The following example changes dial shelf slot ownership. The router will no longer have ownership of any dial shelf slots.
dial-shelf split slots none
Related Commands
Command dial-shelf split slots remove
Description Removes slots configured in split mode.
Cisco IOS Dial Technologies Command Reference
DIA-218
November 2009
Dial Commands dial-shelf split slots remove
dial-shelf split slots remove
To remove slots configured in split mode, use the dial-shelf split slots remove command in global configuration mode. dial-shelf split slots remove slot-numbers
Syntax Description
slot-numbers
List of the dial shelf slot numbers to be removed ,separated by spaces, in the range 0 to 11.
Command Default
No default behavior or keywords.
Command Modes
Global configuration
Command History
Release 11.3(8)AA
Modification This command was introduced.
Usage Guidelines
To move a slot from the control of one router shelf to the others, the router releasing the slot should be modified first by entering the dial-shelf split slots remove command, specifying the slot numbers to be released. The released slots can then be added to the slot set of the other router by re-entering the dial-shelf split slots command including the new slot numbers. The router shelf that is losing the slot frees any resources and clears any state associated with the card in the slot it is relinquishing. The dial shelf controller (DSC) reconfigures its hub to ignore traffic from that slot, and if there is a card in the slot it will be reset. This ensures that the card frees up any TDM resource it might be using and allows it to restart under control of the router shelf that is subsequently configured to own the slot.
Examples
The following example removes dial shelf slot 8 from the list of owned dial shelf slots:
dial-shelf split slots remove 8
The effect of multiple commands is cumulative.
Related Commands
Command dial-shelf split slots none
Description Configures the router in dial shelf split mode but with no slots owned.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-219
Dial Commands dial-tdm-clock
dial-tdm-clock
To configure the clock source and priority of the clock source used by the time-division multiplexing (TDM) bus on the dial shelf of the Cisco AS5800, use the dial-tdm-clock command in global configuration mode. To return the clock source and priority to the default values, use the no form of this command. dial-tdm-clock priority number {external {e1 | t1} [120ohm] | freerun | trunk-slot slot port port} [line {0 | 1}] no dial-tdm-clock priority number {external {e1 | t1} [120ohm] | freerun | trunk-slot slot port port} [line {0 | 1}]
Syntax Description
priority number external {e1 | t1} [120ohm]
Specifies the priority of the clock source. The range is from 1 to 50. Priority 1 is the highest priority, and 50 is the lowest. Specifies the priority of an external clock source. The external clock source is connected to the front panel of the Dial Shelf Controller (DSC) card. Specifies priority of the E1 (2.048 MHz) or T1 (1.54 MHz) external clock source. The default value of the external coaxial cable impedance is 75 ohm. Specify the 120ohm option if a 120 ohm coaxial cable is connected. Specifies the priority of the local oscillator clock source. Specifies the priority of the trunk card to provide the clock source. The slot number is from 0 to 5 (these are the only slots capable of providing clock sources). Specifies the controller number on the trunk used to provide the clock source. The port number is from 0 to 28. The T1 and E1 trunk cards each have 12 ports. The T3 trunk card has 28 ports. (Optional) Specifies the optical port. If the physical optical port is 0, the line value is also 0.
freerun trunk-slot slot
port port
line {0 | 1}
Command Default
If no clock sources are specified, the software selects the first available good clock source on a trunk port.
Command Modes
Global configuration
Command History
Release 11.3(2)AA 12.2(15)T 12.2(33)SRA 12.2SX
Modification This command was introduced. The line keyword was added. This command was integrated into Cisco IOS Release 12.2(33)SRA. This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.
Cisco IOS Dial Technologies Command Reference
DIA-220
November 2009
Dial Commands dial-tdm-clock
Usage Guidelines
The TDM bus in the backplane on the dial shelf must be synchronized to the T1/E1 clocks on the trunk cards. The DSC card on the dial shelf provides hardware logic to accept multiple clock sources as input and use one of them as the primary source to generate a stable, PPL synchronized output clock. The input clock can be any of the following sources:
• • •
Trunk port in slots 0 through 5 (up to 12 can be selected (two per slot) An external T1 or E1 clock source fed directly through a connector on the DSC card A free running clock from an oscillator in the clocking hardware on the DSC card
The clock commands are listed in the configuration file with the highest priority listed first. If the current primary clock source is good, specifying another clock source of higher priority does not cause the clock source to switch to the higher priority clock source. The new higher priority clock source is used as a backup clock source. This prevents switching of the clock source as you enter multiple dial-tdm-clock priority configuration commands in random order. Also, it is important not to disturb the existing clock source as long as it is good. To force the new higher priority clock source to take over from a currently good primary clock source, configure the new clock source and use the no dial-tdm-clock priority command to remove the current primary clock source. To display the current primary and backup clocks along with their priorities, use the show dial-shelf clocks EXEC command.
Examples
In the following example, an external clock source is set at priority 1 and the trunk card in slot 4, port 1 is set at priority 5:
Router(config)# dial-tdm-clock priority 1 external t1 Router(config)# dial-tdm-clock priority 5 trunk-slot 4 port 1 Router(config)# exit
Related Commands
Command show dial-shelf
Description Displays information about the dial shelf, including clocking information.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-221
Dial Commands disconnect
disconnect
To disconnect a line, use the disconnect command in EXEC mode. disconnect [connection]
Syntax Description
connection
(Optional) Number of the line or name of the active network connection to be disconnected.
Command Modes
EXEC
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
Do not disconnect a line to end a session. Instead, log off the host, so that the Cisco IOS software can clear the connection. Then end the session. If you cannot log out of an active session, disconnect the line.
Examples
In the following example, the user disconnects from the device Remote to return to the router:
Remote% disconnect Connection closed by remote host
Related Commands
Command
Description
login (EXEC) Enables or changes a login user name.
Cisco IOS Dial Technologies Command Reference
DIA-222
November 2009
Dial Commands dnis group
dnis group
To include a group of Dialed Number Identification Service (DNIS) numbers in a customer profile, use the dnis group command in customer profile configuration mode. To remove a DNIS group from a customer profile, use the no form of this command. dnis group {default | name dnis-group-name} no dnis group {default | name dnis-group-name}
Syntax Description
default
Allows a specified customer profile to accept all DNIS numbers coming into the access server. For example, a stray DNIS number not listed in any customer profile passes through this default DNIS group. Most customer profiles do not have this option configured. Assigns a name to a DNIS group. DNIS group name. It can have up to 23 characters.
name dnis-group-name
Command Default
No DNIS groups are associated with a customer profile.
Command Modes
Customer profile configuration
Command History
Release 12.0(4)XI
Modification This command was introduced.
Usage Guidelines
Use the dnis group customer profile configuration command to include a group of DNIS numbers in a customer profile or discriminator.
Examples
The following example includes the DNIS group called customer1dnis in the customer1 customer profile:
resource-pool profile customer customer1 dnis group name customer1dnis
Related Commands
Command dialer dnis group resource-pool profile customer
Description Creates a DNIS group. Creates a customer profile.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-223
Dial Commands ds0 busyout (channel)
ds0 busyout (channel)
To busyout one or more digital signal level 0s (DS0s), use the ds0 busyout command in controller configuration mode. To cancel busyout on a DS0, use the no form of this command. ds0 busyout ds0 no ds0 busyout ds0
Syntax Description
ds0
DS0 number listed as a single channel, or listed as a channel range with the starting channel number and the ending channel number seperated by a hyphen. The range of numbers can be from 1 to 24 for T1. For example, from 1 to 10, or from 10 to 24.
Command Default
Disabled
Command Modes
Controller configuration
Command History
Release 11.3(2)AA 12.0
Modification This command was introduced, and supported T1 and T3 only. This command was integrated into Cisco IOS Release 12.0, and supported the E1and DMM HMM (Double Modem Module [12] Hex Modem Module [6]).
Usage Guidelines
Use the ds0 busyout command when you to busyout a one or more DS0s (channels). If there is an active call, the software waits until the call terminates by a disconnection; then the DS0 is busied out. First you must specify the T1 line (port) containing the 24 DS0s, using the controller T1 command. To busyout all DS0s on a trunk card or all modems on a modem card, use the busyout privileged EXEC command. To display the busyout information, use the show busyout privileged EXEC command.
Note
The ds0 busyout command only applies to cas-group command configurations for channel-associated signaling. This command has no effect on pri-group command configurations.
Examples
In this example, the controller T1 is configured with cas-group (channel-associated signaling). The following example removes DS0s 1 through 10 from dialup services. These DS0s are assigned to the T1 port (line) in shelf 6, slot 0, port 0:
controller t1 6/0/0 ds0 busyout 1-10 exit
Cisco IOS Dial Technologies Command Reference
DIA-224
November 2009
Dial Commands ds0 busyout (channel)
Related Commands
Command busyout modem busyout
Description Informs the central-office switch that a channel is out of service. Disables a modem from dialing or answering calls whereby the disabling action is not executed until the active modem returns to an idle state. Abruptly shuts down an active or idle modem installed in an access server or router. Displays the busyout status for a card on the dial shelf. Displays information about the dial shelf, including clocking information.
modem busyout-threshold Maintains a balance between the number of DS0s and modems. modem shutdown show busyout show dial-shelf
Cisco IOS Dial Technologies Command Reference November 2009
DIA-225
Dial Commands ds0 busyout-threshold
ds0 busyout-threshold
To define a threshold to maintain a balance between the number of DS0s and modems, use the ds0 busyout-threshold command in global configuration mode. To remove the threshold, use the no form of this command.
Cisco AS5300 and AS5800 Access Servers Only
ds0 busyout-threshold threshold-number no ds0 busyout-threshold threshold-number
Note
This command is the same as the modem busyout-threshold command for the Cisco AS5350 and AS5400 access servers.
Syntax Description
threshold-number
Number of modems that are free when the router should enforce the stipulation that the number of free DS0 lines is less than or equal to the number of modems.
Command Default
No threshold is defined.
Command Modes
Global configuration
Command History
Release 11.3(2)AA 12.2
Modification This command was introduced as modem busyout-threshold. This command was changed to ds0 busyout-threshold for the Cisco AS5300 and AS5800 access servers.
Usage Guidelines
The ds0 busyout-threshold command functionality is also often termed autobusyout. This command applies to all DS0 lines coming into the router and counts all free modems in all pools. The ds0 busyout-threshold command periodically checks to see if the number of free modems is less that the user specified threshold and if it is it ensures the number of free DS0 channels is less than or equal to the number of modems. This command should only be used where excess calls to one router are forwarded by the exchange to an additional router on the same exchange group number. Since the ds0 busyout-threshold command checks only periodically, the threshold should be greater than the number of calls the user expects to receive in 1 minute plus a safety margin. For example, if the user receives an average of 10 calls per minute, then a threshold of 20 would be advised. Very small thresholds should be avoided since they do not allow sufficient time for the exchange to respond to out-of-service notifications from the router, and callers may receive busy signals when free modems are all used.
Cisco IOS Dial Technologies Command Reference
DIA-226
November 2009
Dial Commands ds0 busyout-threshold
Caution
The number of DS0 lines in normal operating conditions should be approximately equal to the number of modems (for example, within 30). If it is not, this will cause a lot of messaging traffic to the exchange and may cause active calls to be dropped. This is not a concern for short periods, that is, when modem cards are replaced. On T3 controllers, any contained T1 controllers that are not in use should be undeclared to remove them from the autobusyout list.
Examples
The following example shows how you might configure the ds0 busyout-threshold command:
ds0 busyout-threshold 30
Related Commands
Command busyout modem busyout modem shutdown
Description Informs the central-office switch that a channel is out-of-service. Disables a modem from dialing or answering calls whereby the disabling action is not executed until the active modem returns to an idle state. Abruptly shuts down an active or idle modem installed in an access server or router.
ds0 busyout (channel) Forces a DS0 time slot on a controller into the busyout state.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-227
Dial Commands ds0-group (controller e1)
ds0-group (controller e1)
To define E1 channels for compressed voice calls and the channel-associated signaling (CAS) method by which the router connects to the PBX or PSTN, enter the ds0-group command in controller configuration mode. To remove the group and signaling setting, use the no form of this command. ds0-group channel timeslots range type signal no ds0-group channel timeslots range type signal
Syntax Description
channel timeslots range
Specifies a single channel group number. Replace the channel variable with a number from 0 through 30. Specifies a time-slot range, which can be from 1 through 31. You can specify a time-slot range (for example, 1-31), individual time-slots separated by commas (for example 1, 3, 5), or a combination of the two (for example 1-14, 15, 17-31). The sixteenth time slot is reserved for out-of-band signaling. Specifies the type of channel-associated signaling. Configure the signal type that your central office uses. Replace the signal argument with one of the following signal types:
• • •
type signal
r2-analog [r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]] r2-digital [r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]] r2-pulse [r2-compelled [ani] | r2-non-compelled [ani] | r2-semi-compelled [ani]]
The following descriptions are provided for the previous three R2 syntax bullets:
•
r2-analog—Specifies R2 ITU Q411 analog line signaling, which reflects the on/off switching of a tone in frequency-division multiplexing circuits (before TDM circuits were created). The tone is used for line signaling. r2-digital—Specifies R2 ITU Q421 digital line signaling, which is the most common signaling configuration. The A and B bits are used for line signaling. r2-pulse—Specifies R2 ITU supplement 7 pulse line signaling, which is a transmitted pulse that indicates a change in the line state. r2-compelled [ani]—Specifies R2 compelled register signaling. You can also specify provisioning the ANI address option. r2-non-compelled [ani]—Specifies R2 noncompelled register signaling. r2-semi-compelled [ani]—Specifies R2 semicompelled register signaling.
•
• • • •
Command Default
No channel-associated signaling is configured on the controller. All R2 signaling types have DNIS turned on by default.
Cisco IOS Dial Technologies Command Reference
DIA-228
November 2009
Dial Commands ds0-group (controller e1)
Command Modes
Controller configuration
Command History
Release 11.3MA 12.0(5)XK 12.0(7)T 12.1(2)XH 12.1(3)T 12.2
Modification The command was introduced as the voice-group command on the Cisco MC3810 concentrator. The command was implemented on the Cisco 2600 and Cisco 3600 series with a different name and some keyword modifications. The command was implemented on the Cisco 2600 and Cisco 3600 series with a different name and some keyword modifications. The command was modified for E1 R2 signaling. The command was modified for E1 R2 signaling. The command was modified to exclude sas keywords. The Single Attachment Station (SAS) CAS options of sas-loop-start and sas-ground-start are not supported as a type of signaling for the DS0 group.
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 sixteenth time slot to transmit the channel-associated signaling. The signaling you configure on the access server must match the signaling used by the central office. For example, if the central office switch is forwarding R2 analog signaling to a Cisco 2600 or 3600 series router, the E1 controller on the router must also be configured for R2 analog signaling (r2-analog). All R2 signaling 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, the DNIS number is router B and the ANI number is router A. ANI is very similar to Caller ID. To customize the R2 signaling parameters, refer to the cas-custom controller configuration command. When you enable the ds0-group command, the cas-custom command is automatically set up to be polled for configuration information. However, unless you enable or turn on specific features with the ds0-custom command, the cas-custom feature has an empty set of signaling parameters. DNIS is automatically collected for modem pools and R2 tone signaling. You do not need to specify the collection of DNIS information with the ds0-group command. However, if you are using non-R2 tone signaling, the system must be manually configured to collect DNIS information. For non-R2 CAS signaling, DNIS collection is done only for E&M-fgb.
Examples
In most cases, you will configure the same channel-associated signaling on each E1 controller. The following examples configure signaling and customized parameters on controller E1 2 using the ds0-group and cas-custom controller configuration commands. The actual channel-associated signaling is configured on the sixteenth time slot, which is the reason why this time slot does not come up in the following output.
Router(config)# controller e1 2 Router(config-controller)# ds0-group 1 timeslots 1-31 type r2-digital r2-compelled ani
Cisco IOS Dial Technologies Command Reference November 2009
DIA-229
Dial Commands ds0-group (controller e1)
Router(config-controller)# %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: %DSX0-5-RBSLINEUP: RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS RBS of of of of of of of of of of of of of of of of of of of of of of of of of of of of of of controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller controller 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot timeslot 1 is up 2 is up 3 is up 4 is up 5 is up 6 is up 7 is up 8 is up 9 is up 10 is up 11 is up 12 is up 13 is up 14 is up 15 is up 17 is up 18 is up 19 is up 20 is up 21 is up 22 is up 23 is up 24 is up 25 is up 26 is up 27 is up 28 is up 29 is up 30 is up 31 is up
The following example shows all the supported E1 signaling types on a Cisco 2600 or 3600 series router.
Router(config-controller)# ds0-group 1 timeslots 1-31 type ? e&m-fgb e&m-fgd e&m-immediate-start fxs-ground-start fxs-loop-start p7 r2-analog r2-digital r2-pulse sas-ground-start sas-loop-start E & M Type II FGB E & M Type II FGD E & M Immediate Start FXS Ground Start FXS Loop Start P7 Switch R2 ITU Q411 R2 ITU Q421 R2 ITU Supplement 7 SAS Ground Start SAS Loop Start
Note
Cisco IOS Releases later than 12.2 do not support the Single Attachment Station (SAS) CAS options of sas-loop-start and sas-ground-start.
Router(config-controller)# cas-group 1 timeslots 1-31 type r2-analog ? r2-compelled r2-non-compelled r2-semi-compelled R2 Compelled Register Signalling R2 Non Compelled Register Signalling R2 Semi Compelled Register Signalling
R2 signaling parameters can be customized with the cas-custom controller configuration command:
Router(config-controller)# cas-custom 1 Router(config-ctrl-cas)# ?
Cisco IOS Dial Technologies Command Reference
DIA-230
November 2009
Dial Commands ds0-group (controller e1)
CAS custom commands: caller-digits Digits to be collected before requesting CallerID category Category signal country Country Name default Set a command to its defaults exit Exit from cas custom mode invert-abcd invert the ABCD bits before tx and after rx metering R2 network is sending metering signal nc-congestion Non Compelled Congestion signal no Negate a command or set its defaults
Cisco IOS Dial Technologies Command Reference November 2009
DIA-231
Dial Commands encap-sequence
encap-sequence
To assign an encapsulation sequence number to a priority class in a multiclass multilink PPP bundle, use the encap-sequence command in policy-map class configuration mode. To reset the default value, use the no form of this command. encap-sequence [sequence-id | none] no encap-sequence sequence-id
Syntax Description
sequence-id none
Assigns a unique encapsulation sequence number to priority class in a multiclass multilink PPP bundle. Valid range is from 0 to 3. Specifies that a certain priority class is classified as or is assigned the highest priority, and packets are not encapsulated with a sequence number for multiclass multilink PPP.
Command Default
Sequence numbers are not assigned to priority classes.
Command Modes
Policy-map class configuration
Command History
Release 12.2(31)SB2
Modification This command was introduced and implemented on the Cisco 10000 series router for the PRE2.
Usage Guidelines
The encap-sequence command allows you to assign sequence numbers to priority classes in a policy map for multiclass multilink PPP encapsulation. This command is only supported on the PRE2. A class with a multiclass multilink PPP sequence number must have an associated queue action such as bandwidth and shape. The sequence number assigned to each priority class must be unique. The default sequence number for class-default is 0 and it is not configurable. If you do not assign a sequence number to a priority class, the priority queue packets use PPP encapsulation. Interleaving is allowed for priority traffic regardless of the encapsulated sequence number configuration.
Examples
The following example shows that class voice has the highest priority and that packets are not encapsulated with a sequence number for multiclass multilink PPP.
Router(config)# policy-map prec1 Router(config-pmap)# class voice Router(config-pmap-c)# priority Router(config-pmap-c)# police 128 Router(config-pmap-c)# encap-sequence none Router(config-pmap-c)# exit Router(config-pmap)# class video
Cisco IOS Dial Technologies Command Reference
DIA-232
November 2009
Dial Commands encap-sequence
Router(config-pmap-c)# bandwidth 1000 Router(config-pmap-c)# police 1000 Router(config-pmap-c)# encap-sequence 1 Router(config-pmap-c)# exit Router(config-pmap)# class game Router(config-pmap-c)# bandwidth 1000 Router(config-pmap-c)# encap-sequence 2 Router(config-pmap-c)# exit Router(config-pmap)# class class-default
Related Commands
Command show ppp multilink
Description Displays information for multilink PPP bundles.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-233
Dial Commands encapsulation cpp
encapsulation cpp
Note
Effective with Cisco IOS Release 12.3(4)T, the encapsulation cpp command is no longer available in Cisco IOS software. To enable encapsulation for communication with routers or bridges using the Combinet Proprietary Protocol (CPP), use the encapsulation cpp command in interface configuration mode. To disable CPP encapsulation, use the no form of this command. encapsulation cpp no encapsulation cpp
Syntax Description
This command has no arguments or keywords.
Command Default
CPP encapsulation disabled.
Command Modes
Interface configuration
Command History
Release 11.2 12.3(4)T
Modification This command was introduced. This command was removed and is no longer available in Cisco IOS software.
Usage Guidelines
Use this command to communicate over an ISDN interface with Cisco 700 and 800 series (formerly Combinet) routers that do not support PPP but do support CPP. Most Cisco routers support PPP. Cisco routers can communicate over ISDN with these devices by using PPP encapsulation, which supports both routing and fast switching. The Cisco 700 and 800 series routers support only IP, IPX, and bridging. For AppleTalk, these Cisco routers automatically perform half-bridging. This command is supported on ISDN BRIs and PRIs only.
Examples
The following example configures BRI interface 0 to communicate with a router or bridge that does not support PPP:
interface bri 0 encapsulation cpp cpp callback accept cpp authentication
Cisco IOS Dial Technologies Command Reference
DIA-234
November 2009
Dial Commands encapsulation cpp
The following example configures PRI serial interface 1/1:23 to communicate with a router or bridge that does not support PPP:
controller t1 1/1 framing esf linecode b8zs pri-group timeslots 1-23 isdn switchtype primary-4ess ! interface Serial1/1:23 encapsulation cpp cpp callback accept cpp authentication
Related Commands
Command cpp authentication cpp callback accept
Description Enables negotiation of authentication with a router or bridge that supports the CPP and that is calling in to this router. Enables the router to accept callback from a router or bridge that supports the CPP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-235
Dial Commands failover group-number
failover group-number
To configure shelf redundancy for Cisco AS5800 universal access servers, use the failover group-number command in redundancy configuration mode. To disable redundancy, use the no form of this command. failover group-number group-code no failover group-number group-code
Syntax Description
group-code
The failover group code. An integer that identifies a redundant pair of router shelves. Each member of the pair must be configured with the same group code. When failover mode is enabled, this group code is sent in place of the router MAC address.
Command Default
Redundancy is not enabled.
Command Modes
Redundancy configuration
Command History
Release 12.1(5)XV1 12.2(11)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
This command must be configured on both router shelves. The group-code argument is used by the system controller and must be the same for both router shelves forming the redundant pair. For successful failover to occur, both router-shelf configurations must be synchronized. Configure each router shelf separately, as active and backup respectively, with the same configuration except for the IP address on egress interfaces.
Note
Test the backup router shelf configuration before deployment in a production environment.
Examples
The following example assigns the configured router shelf to the redundancy pair designated as 25. These commands must be issued on both router shelves in the redundant router-shelf pair:
Router(config)# redundancy Router(config-red)# failover group-number 25
Cisco IOS Dial Technologies Command Reference
DIA-236
November 2009
Dial Commands failover group-number
Related Commands
Command redundancy show redundancy
Purpose Enters redundancy mode for further configuration. Displays current or historical status and related information and displays shelf-redundancy status.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-237
Dial Commands firmware location
firmware location
To download firmware into the modems, use the firmware location command in Service Processing Element (SPE) configuration mode. To revert the router to the system embedded image default, use the no form of this command. firmware location [IFS]filename no firmware location
Syntax Description
IFS:
(Optional) IOS file specification (IFS), which can be any valid IFS on any local file system. Examples of legal specifications include:
• • •
bootflash:—Loads the firmware from a separate Flash memory device. flash:—Loads the firmware from the Flash NVRAM located within the router. system:/—Loads the firmware from a built-in file within the Cisco IOS image. The optional forward slash (/) and system path must be entered with this specification.
Use the dir all-filesystems EXEC command to display legal IFSs. filename The firmware filename. When filename is entered without an IFS specification, this name defaults to the file in Flash memory.
Command Default
Downloads SPE firmware in Flash memory.
Command Modes
SPE configuration
Command History
Release 12.0(4)XI1 12.0(6)T 12.0(7)T 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5200, Cisco AS5300, and Cisco AS5800. This command was integrated into Cisco IOS Release 12.0(6)T. This command was implemented on the Cisco AS5300 and Cisco AS5800 for MICA technologies modems. This command was implemented on the Cisco AS5400 for the NextPort dial feature card (DFC). This command was implemented on the Cisco AS5400 for the NextPort DFC and on the Cisco AS5800 for the universal port card (UPC). This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
Cisco IOS Dial Technologies Command Reference
DIA-238
November 2009
Dial Commands firmware location
Usage Guidelines
Use the firmware location SPE configuration command to download firmware into your modems. This command specifies the location of the firmware file and downloads the firmware in the range of SPEs specified, depending on the states configured by the firmware upgrade command. Use the firmware location command with the firmware upgrade command. The entire SPE is affected by the firmware location command. The latest SPE firmware image can usually be retrieved from Cisco.com. You must first copy the SPE image from a TFTP server to Flash memory using the copy tftp flash command. The firmware location command is a configuration command and must be saved into the system configuration using the write memory command; otherwise, at the next reboot downloading of the specified firmware will not occur. The firmware location command was first supported in Cisco IOS Release 12.0(4)XI1. For earlier images, use the copy command. For the Cisco IOS Release 12.0(4)XI1 images, the copy flash modem command is disabled for MICA technologies modems and newer versions of the 56-kbps Microcom modems. The older V.34 Microcom modems still use the copy command for downloading in Cisco IOS Release 12.0(4)XI1 images.
Note
This command should be used when traffic is low because the firmware location download will not begin until the modems have no active calls. Otherwise, use the firmware upgrade command to customize the scheduling of modem downloads for your needs. You cannot use the firmware location command on SPEs that are in the Bad state.
Examples
The following example shows how to display all legal IFSs:
Router# dir all-filesystems Directory of nvram:/ 121 122 -rw---1543 5 startup-config private-config
126968 bytes total (125368 bytes free) Directory of system:/ 6 1 2 17 dr-x -rwdr-x dr-x 0 2929 0 0 date> date> date> memory running-config ucode vfiles
No space information available Directory of flash:/ 1 -rw12575032 c5300-js-mz.122-11.T
16777216 bytes total (4202120 bytes free) Directory of bootflash:/ 1 -rw1155864 2 -rw381540 3 -rw384056 8388608 bytes total (5682340 bytes free) c5300-boot-mz.113-10.T.bin mica-modem-pw.2.6.2.0.bin pw2621.ios
Cisco IOS Dial Technologies Command Reference November 2009
DIA-239
Dial Commands firmware location
Directory of lex:/ No files in directory No space information available
The following example shows how to enter the SPE configuration mode, set the range of SPEs, specify the firmware file location in Flash memory, download the file to the SPEs, and display a status report using the show spe EXEC command:
Router# configure terminal Router(config)# spe 7/0 7/17 Router(config-spe)# firmware location flash:np-6-75 Router(config-spe)# firmware upgrade busyout Started downloading firmware flash:np-6-75.spe Router(config-spe)# exit Router# show spe 7 . . . SPE SPE SPE SPE SPE# Port # State Busyout Shut Crash 7/00 0000-0005 ACTIVE 1 0 0 7/01 0006-0011 DOWNLOAD 1 0 0 7/02 0012-0017 DOWNLOAD 1 0 0 7/03 0018-0023 DOWNLOAD 1 0 0 . . .
Port State BBBBBB bbbbbb bbbbbb bbbbbb
Call Type ______ ______ ______ ______
The following configuration example specifies a firmware file located in Flash memory:
spe 1/0 1/8 firmware location np-spe-upw-1.0.1.2.bin
The following configuration example shows how to download firmware that is not bundled with the Cisco IOS image:
spe 1/2 1/4 firmware location flash:portware.2620.ios
The following configuration example shows how to download firmware that is bundled with the Cisco IOS image:
spe 2/9 2/9 firmware location system:/ucode/microcom_firmware
Related Commands
Command clear port clear spe copy copy tftp flash firmware upgrade show spe version spe download maintenance spe recovery
Description Resets the NextPort port and clears any active call. Reboots all specified SPEs. Copies any file from a source to a destination. Copies the SPE image from a TFTP server to the Flash memory. Specifies the method in which the SPE will be downloaded. Displays the firmware version on an SPE. Performs download maintenance on SPEs that are marked for recovery. Sets an SPE port for recovery.
Cisco IOS Dial Technologies Command Reference
DIA-240
November 2009
Dial Commands firmware upgrade
firmware upgrade
To modify the way in which the service processing element (SPE) will be downloaded, use the firmware upgrade command in SPE configuration mode. To revert to the default SPE firmware upgrade option, busyout, use the no form of this command. firmware upgrade {busyout | recovery | reboot} no firmware upgrade
Cisco AS5350, Cisco AS5400, and Cisco AS5800
firmware upgrade [busyout | download-maintenance | reboot]
Syntax Description
busyout recovery reboot download-maintenance
Upgrades when all calls are terminated on the SPE. Upgrades during download maintenance time. Upgrades at the next reboot. Upgrades during download maintenance time.
Command Default
An upgrade occurs when all calls are terminated on the SPE (busyout). For the Cisco AS5350, Cisco AS5400, and Cisco AS5800 there is no default.
Command Modes
SPE configuration
Command History
Release 12.0(4)XI1 12.0(6)T 12.0(7)T 12.1(1)XD 12.1(3)T 12.1(5)XM1 12.2(11)T
Modification This command was introduced on the Cisco AS5200, Cisco AS5300, and Cisco AS5800. This command was integrated into Cisco IOS Release 12.0(6)T. This command was implemented on the Cisco AS5300 and Cisco AS5800 for MICA technologies modems. This command was implemented on the Cisco AS5400 for the NextPort dial feature card (DFC). This command was implemented on the Cisco AS5400 for the NextPort DFC and Cisco AS5800 for the universal port card (UPC). This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
Three methods of upgrade are available: busyout, reboot, and download-maintenance or recovery. The reboot keyword requests the Cisco access servers to upgrade SPE firmware at the next reboot. The busyout keyword upgrades SPE firmware after waiting for all calls to be terminated on an SPE.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-241
Dial Commands firmware upgrade
The download-maintenance or recovery keyword requests SPE firmware download during maintenance time. Use this command in conjunction with the firmware location command and the spe download maintenance command. The SPE firmware location command is designed to integrate all continuous ranges of SPEs containing the same firmware location. However, the firmware upgrade command does not affect the ranges of SPEs. As such, all SPEs within the ranges of SPEs must have the same firmware upgrade mode or the router uses the default upgrade mode to busyout state. If you want to upgrade a single SPE within an existing range of SPEs with a different upgrade mode than is currently configured, you must first change the upgrade mode for the entire range of SPEs and then change the firmware location for the specific SPE being upgraded. Furthermore, each time you merge ranges of SPEs due to configuration changes, verify that the configuration of the SPE firmware upgrade remains effective to what is desired.
Examples
The following example sets the SPEs and specifies the firmware upgrade to take place once all calls are terminated on the SPE:
Router(config)# spe 1/03 Router(config-spe)# firmware location np-spe-upw-1.0.1.2.bin Router(config-spe)# firmware upgrade busyout
If the busyout upgrade command is specified, or if no upgrade mode is specified, the SPE modems are set into a “pending download” state when you use the firmware location command on the specified SPE. The pending download state prevents any modem in that state to be allocated for new calls until the state is cleared. Modems with active calls remain active for their call durations, but enter the pending download state when they terminate. This pending download state can be cleared only when the SPE is finally downloaded. When all modems within the SPE are in the pending download state and no active calls remain on the SPE, the SPE is reloaded. The busyout option is the fastest way to upgrade modems on an active router but can severely impact the capacity of the router during the upgrade. The following example sets the default option for the firmware upgrade process:
Router(config-spe)# firmware upgrade busyout
If reboot upgrade is specified, the SPE modems are not reloaded to the new firmware location until the router is rebooted. The reboot upgrade option is useful for routers that need to have their SPE upgraded and that also will be rebooted for maintenance. When the new firmware is configured, the configuration takes effect after the reboot takes place. The following example sets the firmware upgrade reboot:
Router(config-spe)# firmware upgrade reboot
If recovery upgrade is specified, the SPE modems are reloaded based on the modem recovery algorithm. Only when no active calls exist on the SPE does the firmware download take place. Furthermore, at the time configured with the modem recovery maintenance command, the modem recovery maintenance process attempts, in a controller fashion, to reload the modems by busying out the modems for a window duration of time to make the download take place. Refer to the modem recovery documentation for more information. The recovery upgrade option upgrades modems on an active router with the least impact. Capacity is kept at a maximum. However, this option may take a few days for all modems to be reloaded to the new firmware location. The following example sets the system for a firmware upgrade recovery:
Router(config-spe)# firmware upgrade recovery
For the Cisco AS5350, Cisco AS5400, or Cisco AS5800, use the following syntax to set the system for a firmware upgrade recovery:
Router(config-spe)# firmware upgrade download-maintenance
Cisco IOS Dial Technologies Command Reference
DIA-242
November 2009
Dial Commands firmware upgrade
Related Commands
Command firmware location show spe version spe download maintenance spe recovery
Description Downloads firmware into the modems from this file location. Displays the firmware version on an SPE. Performs download maintenance on SPEs that are marked for recovery. Sets an SPE port for recovery.
modem recovery maintenance Specifies the scheduled modem maintenance recovery behavior.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-243
Dial Commands flowcontrol
flowcontrol
To set the method of data flow control between the terminal or other serial device and the router, use the flowcontrol command in line configuration mode. To disable flow control, use the no form of this command. flowcontrol {none | software [lock] [in | out] | hardware [in | out]} no flowcontrol {none | software [lock] [in | out] | hardware [in | out]}
Syntax Description
none software lock
Turns off flow control. Sets software flow control. (Optional) Makes it impossible to turn off flow control from the remote host when the connected device needs software flow control. This option applies to connections using the Telnet or rlogin protocols. (Optional) Specifies the direction of software or hardware flow control: the keyword in causes the Cisco IOS software to listen to flow control from the attached device, and the out keyword causes the software to send flow control information to the attached device. If you do not specify a direction, both directions are assumed. Sets hardware flow control. For more information about hardware flow control, see the hardware manual that was shipped with your router.
[in | out]
hardware
Command Default
Flow control is disabled.
Command Modes
Line configuration
Command History
Release 10.0 12.2(31)SB2
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(31)SB2.
Usage Guidelines
When software flow control is set, the default stop and start characters are Ctrl-S and Ctrl-Q (XOFF and XON). You can change them using the stop-character and start-character commands. If a remote Telnet device requires software flow control, the remote system should not be able to turn it off. Using the lock option makes it possible to refuse “dangerous” Telnet negotiations if they are inappropriate.
Examples
The following example sets hardware flow control on line 7:
line 7 flowcontrol hardware
Cisco IOS Dial Technologies Command Reference
DIA-244
November 2009
Dial Commands flowcontrol
Related Commands
Command start-character stop-character
Description Sets the flow control start character. Sets the flow control stop character.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-245
Dial Commands group-range
group-range
To create a list of member asynchronous interfaces (associated with a group interface), use the group-range command in interface configuration mode. To remove an interface from the member list, use the no form of this command. group-range low-end-of-interfacerange high-end-of-interfacerange no group-range interface
Syntax Description
low-end-ofinterfacerange high-end-ofinterfacerange interface
Beginning interface number to be made a member of the group interface. Ending interface number to be made a member of the group interface. Interface number to be removed from the group interface.
Command Default
No interfaces are designated as members of a group.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
Using the group-range command, you create a group of asynchronous interfaces that are associated with a group asynchronous interface on the same device. This group interface is configured by using the interface group-async command. This one-to-many structure allows you to configure all associated member interfaces by entering one command on the group interface, rather than entering this command on each interface. You can customize the configuration on a specific interface by using the member command. Interface numbers can be removed from the interface group using the no group-range command.
Examples
The following example defines interfaces 2, 3, 4, 5, 6, and 7 as members of asynchronous group interface 0:
interface group-async 0 group-range 2 7
Related Commands
Command interface group-async member
Description Creates a group interface that will serve as master, to which asynchronous interfaces can be associated as members. Alters the configuration of an asynchronous interface that is a member of a group.
Cisco IOS Dial Technologies Command Reference
DIA-246
November 2009
Dial Commands interface bri
interface bri
To configure a BRI interface and enter interface configuration mode, use the interface bri command in global configuration mode.
Cisco 7200 Series and 7500 Series Routers
interface bri number interface bri slot/port
Cisco 7200 Series and 7500 Series Routers with BRI Subinterfaces Only
interface bri number.subinterface-number [multipoint | point-to-point] interface bri slot/port.subinterface-number [multipoint | point-to-point]
X.25 on an ISDN BRI Interface
interface bri number:0 interface bri slot/port:0
Syntax Description
number
Port, connector, or interface card number. The numbers are assigned at the factory at the time of installation or when added to a system, and can be displayed with the show interfaces command. On the Cisco 7200 series, slot location and port number of the interface. The slash mark is required. Subinterface number in the range from 1 to 4,294,967,293. The number that precedes the period (.) must match the number this subinterface belongs to. The period is required.
slot/port .subinterface-number
multipoint | point-to-point (Optional) Specifies a multipoint or point-to-point subinterface. The default is multipoint. :0 Subinterface created by applying the isdn x25 static-tei and the isdn x25 dchannel commands to the specified BRI interface. This interface must be configured for X.25.
Command Default
The default mode for subinterfaces is multipoint.
Command Modes
Global configuration
Cisco IOS Dial Technologies Command Reference November 2009
DIA-247
Dial Commands interface bri
Command History
Release 10.3 11.2F 11.2P
Modification This command was introduced. This command was enhanced with the capability to carry X.25 traffic on the D channel. This command was modified to include slot/port syntax for the PA-8B-ST and PA-4B-U port adapters on the Cisco 7200 series.
Usage Guidelines
Subinterfaces can be configured to support partially meshed Frame Relay networks. (Refer to the Frame Relay chapters in the Cisco IOS Wide-Area Networking Configuration Guide.) To specify the BRI interface that is created by enabling X.25 on a specified ISDN BRI interface, use the interface bri global configuration command with a subinterface 0 specification.
Examples
The following example configures BRI 0 to call and receive calls from two sites, use PPP encapsulation on outgoing calls, and use Challenge Handshake Authentication Protocol (CHAP) authentication on incoming calls:
interface bri 0 encapsulation ppp no keepalive dialer map ip 172.16.36.10 name EB1 234 dialer map ip 172.16.36.9 name EB2 456 dialer-group 1 isdn spid1 41346334600101 4633460 isdn spid2 41346334610101 4633461 isdn T200 1000 ppp authentication chap
The following example creates a BRI 0:0 interface for X.25 traffic over the D channel and then configures the new interface to carry X.25 traffic:
interface bri 0 isdn x25 dchannel isdn x25 static-tei 8 ! interface bri 0:0 ip address 10.1.1.2 255.255.255.0 x25 address 31107000000100 x25 htc 1 x25 suppress-calling-address x25 facility windowsize 2 2 x25 facility packetsize 256 256 x25 facility throughput 9600 9600 x25 map ip 10.1.1.3 31107000000200
Related Commands
Command dialer-group dialer map encapsulation
Description Controls access by configuring an interface to belong to a specific dialing group. Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Sets the encapsulation method used by the interface.
Cisco IOS Dial Technologies Command Reference
DIA-248
November 2009
Dial Commands interface bri
Command isdn spid1, isdn spid2 ppp bap call show interfaces bri
Description Defines the SPID number that has been assigned by the ISDN service provider for the B1 channel. Sets PPP BACP call parameters. Displays information about the BRI D channel or about one or more B channels.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-249
Dial Commands interface dialer
interface dialer
To define a dialer rotary group, use the interface dialer command in global configuration mode. interface dialer dialer-rotary-group-number no interface dialer dialer-rotary-group-number
Syntax Description
dialer-rotary-group-number
Number of the dialer rotary group in the range from 0 to 255.
Command Default
No dialer rotary groups are predefined.
Command Modes
Global configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
Dialer rotary groups allow you to apply a single interface configuration to a set of physical interfaces. This capability allows a group of interfaces to be used as a pool of interfaces for calling many destinations. Once the interface configuration is propagated to a set of interfaces, those interfaces can be used to place calls using the standard dial-on-demand routing (DDR) criteria. When multiple destinations are configured, any of these interfaces can be used for outgoing calls. Dialer rotary groups are useful in environments that require multiple calling destinations. Only the rotary group needs to be configured with the dialer map commands. The only configuration required for the interfaces is the dialer rotary-group command indicating that each interface is part of a dialer rotary group. Although a dialer rotary group is configured as an interface, it is not a physical interface. Instead, it represents a group of interfaces. Interface configuration commands entered after the interface dialer command will be applied to all physical interfaces assigned to specified rotary groups. Individual interfaces in a dialer rotary group do not have individual addresses. The dialer interface has a protocol address, and that address is used by all interfaces in the dialer rotary group.
Examples
The following example identifies interface dialer 1 as the dialer rotary group leader. Interface dialer 1 is not a physical interface, but represents a group of interfaces. The interface configuration commands that follow apply to all interfaces included in this group.
interface dialer 1 encapsulation ppp authentication chap dialer in-band ip address 10.2.3.4 dialer map ip 10.2.2.5 name YYY 14155553434 dialer map ip 10.3.2.6 name ZZZ
Cisco IOS Dial Technologies Command Reference
DIA-250
November 2009
Dial Commands interface multilink
interface multilink
To create a multilink bundle and enter multilink interface configuration mode to configure the bundle, use the interface multilink command in global configuration mode. To remove a multilink bundle, use the no form of this command. interface multilink multilink-bundle-number no interface multilink
Syntax Description
multilink-bundle-number Number of the multilink bundle (a nonzero number).
Command Default
No multilink bundles are created.
Command Modes
Global configuration
Command History
Release 12.0(3)T 12.0 12.2(16)BX 12.2(28)SB 12.2(31)SB2
Modification This command was introduced. This command was introduced on the PRE1 for the Cisco 10000 series router. This command was implemented on the PRE2. This command was integrated in Cisco IOS Release 12.2(28)SB for the PRE2. This command was introduced on the PRE3 and the range of valid values for multilink interfaces was expanded on the PRE3.
Usage Guidelines
Cisco 10000 Series Router
The following describes the valid multilink interface values for the Cisco 10000 series router:
• •
1 to 9999—(PRE2) Cisco IOS Release 12.2(28)SB and later releases 1 to 9999 and 65,536 to
– 1 to 9999 and 65,536 to 2,147,483,647 (Cisco IOS Release 12.2(31)SB2 and later releases) – 1 to 9999 and 65,536 to 2,147,483,647 (Cisco IOS Release 12.2(31)SB2 and later releases)
valid multilink-bundle-number values are from 1 to 2,147,483,647.
Examples
The following example creates multilink bundle 1:
interface multilink 1 ip address 192.168.11.4 255.255.255.192 encapsulation ppp ppp multilink keepalive
Cisco IOS Dial Technologies Command Reference November 2009
DIA-251
Dial Commands interface multilink
Related Commands
Command ppp multilink group
Description Restricts a physical link to joining only a designated multilink-group interface.
ppp multilink fragment disable Disables packet fragmentation.
Cisco IOS Dial Technologies Command Reference
DIA-252
November 2009
Dial Commands interface serial
interface serial
To specify a serial interface created on a channelized E1 or channelized T1 controller (for ISDN PRI, channel-associated signaling, or robbed-bit signaling), use the interface serial command in global configuration mode.
Cisco 7200 Series and Cisco 7500 Series Routers
interface serial slot/port:timeslot no interface serial slot/port:timeslot
Cisco AS5200 Series and Cisco 4000 Series Access Servers
interface serial controller-number:timeslot no interface serial controller-number:timeslot
Syntax Description
slot/port :timeslot
Slot number and port number where the channelized E1 or T1 controller is located. The slash mark is required. For ISDN, the D channel time slot, which is the :23 channel for channelized T1 and the :15 channel for channelized E1. PRI time slots are in the range from 0 to 23 for channelized T1 and in the range from 0 to 30 for channelized E1. For channel-associated signaling or robbed-bit signaling, the channel group number. The colon is required. On a dual port card, it is possible to run channelized on one port and primary rate on the other port.
controller-number Channelized E1 or T1 controller number.
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
You must explicitly specify a serial interface. The D channel is always the :23 channel for T1 and the :15 channel for E1.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-253
Dial Commands interface serial
Examples
The following example configures channel groups on time slots 1 to 11 and ISDN PRI on time slots 12 to 24 of T1 controller 0. Then the examples configures the first two channel groups as serial interfaces 0:0 and 0:1.
controller t1 0 channel-group 0 timeslot 1-6 channel-group 1 timeslot 7 channel-group 2 timeslot 8 channel-group 3 timeslot 9-11 pri-group timeslots 12-24 ! interface serial 0:0 ip address 172.18.13.2 255.255.255.0 encapsulation ppp ! interface serial 0:1 ip address 172.18.13.3 255.255.255.0 encapsulation ppp
The following example configures ISDN PRI on T1 controller 4/1 and then configures the D channel on the resulting serial interface 4/1:23:
controller t1 4/1 framing crc4 linecode hdb3 pri-group timeslots 1-24 interface serial 4/1:23 ip address 172.18.13.1 255.255.255.0 encapsulation ppp
Related Commands
Command controller
Description Configures a T1 or E1 controller and enters controller configuration mode.
show controllers t1 call-counters Displays the total number of calls and call durations on a T1 controller. show interfaces Displays statistics for all interfaces configured on the router or access server.
Cisco IOS Dial Technologies Command Reference
DIA-254
November 2009
Dial Commands interface virtual-ppp
interface virtual-ppp
To enter interface configuration mode and assign a virtual-PPP interface number, use the interface virtual-ppp command in global configuration mode. To disable a virtual-PPP interface, use the no form of this command. interface virtual-ppp number no interface virtual-ppp number
Syntax Description
number
Virtual-PPP interface number. Valid values range from one to 2147483647.
Command Default
No default behavior or values
Command Modes
Global configuration
Command History
Release 12.3(2)T
Modification This command was introduced.
Usage Guidelines
Use the interface virtual-ppp command to create a virtual interface with PPP encapsulation. Issuing the interface virtual-ppp command enters interface configuration mode.
Examples
The following example configures a virtual-PPP interface with the number 503 and enters interface configuration mode:
interface virtual-ppp 503
Related Commands
Command l2tp-class
Description Creates a template of L2TP control plane configuration settings that can be inherited by different pseudowire classes and enters L2TP class configuration mode. Specifies the name of an L2TP pseudowire class and enters pseudowire class configuration mode. Binds an attachment circuit to an L2TPv3 pseudowire for xconnect service.
pseudowire-class pseudowire
Cisco IOS Dial Technologies Command Reference November 2009
DIA-255
Dial Commands interface virtual-template
interface virtual-template
To create a virtual template interface that can be configured and applied dynamically in creating virtual access interfaces, use the interface virtual-template command in global configuration mode. To remove a virtual template interface, use the no form of this command. interface virtual-template number no interface virtual-template number
Syntax Description
number
Number used to identify the virtual template interface. Up to 200 virtual template interfaces can be configured. On the Cisco 10000 series router, up to 4095 virtual template interfaces can be configured.
Command Default
No virtual template interface is defined.
Command Modes
Global configuration (config)
Command History
Release 11.2F 12.2(4)T 12.2(28)SB 12.2(33)SRA 12.2(31)SB2 12.2(33)SXH
Modification This command was introduced. This command was enhanced to increase the maximum number of virtual template interfaces from 25 to 200. This command was integrated into Cisco IOS Release 12.2(28)SB. This command was integrated into Cisco IOS Release 12.2(33)SRA. This command was integrated into Cisco IOS Release 12.2(31)SB2. This command was integrated into Cisco IOS Release 12.2(33)SXH.
Usage Guidelines
A virtual template interface is used to provide the configuration for dynamically created virtual access interfaces. It is created by users and can be saved in NVRAM. After the virtual template interface is created, it can be configured in the same way as a serial interface. Virtual template interfaces can be created and applied by various applications such as virtual profiles, virtual private dialup networks (VPDNs), PPP over ATM, protocol translation, and Multichassis Multilink PPP (MMP).
Cisco 10000 Series Router
You can configure up to 4095 total virtual template interfaces on the Cisco 10000 series router. To ensure proper scaling and to minimize CPU utilization, we recommend the following virtual template interface settings:
• •
A keepalive timer of 30 seconds or greater using the keepalive command. The default is 10 seconds. Do not enable the Cisco Discovery Protocol (CDP). CDP is disabled by default. Use the no cdp enable command to disable CDP, if necessary.
Cisco IOS Dial Technologies Command Reference
DIA-256
November 2009
Dial Commands interface virtual-template
• •
Disable link-status event messaging using the no logging event link-status command. To prevent the virtual-access subinterfaces from being registered with the SNMP functionality of the router and using memory, do not use the router’s SNMP management tools to monitor PPP sessions. Use the no virtual-template snmp command to disable the SNMP management tools.
When a virtual template interface is applied dynamically to an incoming user session, a virtual access interface (VAI) is created. If you configure a virtual template interface with interface-specific commands, the Cisco 10000 series router does not achieve the highest possible scaling. To verify that the router does not have interface-specific commands within the virtual template interface configuration, use the test virtual-template number subinterface command.
Examples
Cisco 10000 Series Router
The following example creates a virtual template interface called Virtual-Template1:
Router(config)# interface Virtual-Template1 Router(config-if)# ip unnumbered Loopback1 Router(config-if)# keepalive 60 Router(config-if)# no peer default ip address Router(config-if)# ppp authentication pap Router(config-if)# ppp authorization vpn1 Router(config-if)# ppp accounting vpn1 Router(config-if)# no logging event link-status Router(config-if)# no virtual-template snmp
Virtual Template with PPP Authentication Example
The following example creates and configures virtual template interface 1:
interface virtual-template 1 type ethernet ip unnumbered ethernet 0 ppp multilink ppp authentication chap
IPsec Virtual Template Example
The following example shows how to configure a virtual template for an IPsec virtual tunnel interface.
interface virtual-template1 type tunnel ip unnumbered Loopback1 tunnel mode ipsec ipv4 tunnel protection ipsec profile virtualtunnelinterface
Related Commands
Command cdp enable clear interface virtual-access keepalive
Description Enables Cisco Discovery Protocol (CDP) on an interface. Tears down the live sessions and frees the memory for other client uses. Enables keepalive packets and to specify the number of times that the Cisco IOS software tries to send keepalive packets without a response before bringing down the interface. Displays the configuration of the active VAI that was created using a virtual template interface. Associates a tunnel interface with an IPsec profile. Sets the zone name for the connected AppleTalk network.
show interface virtual-access tunnel protection virtual interface
Cisco IOS Dial Technologies Command Reference November 2009
DIA-257
Dial Commands interface virtual-template
Command virtual-profile virtual template
Description Enables virtual profiles. Specifies the destination for a tunnel interface.
Cisco IOS Dial Technologies Command Reference
DIA-258
November 2009
Dial Commands ip address negotiated
ip address negotiated
To specify that the IP address for a particular interface is obtained via PPP/IPCP (IP Control Protocol) address negotiation, use the ip address negotiated command in interface configuration mode. To disable this feature, use the no form of this command. ip address negotiated [previous] no ip address negotiated [previous]
Syntax Description
previous
(Optional) IPCP attempts to negotiate the previously assigned address.
Command Default
No default behavior or values.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
Use the ip address negotiated interface command to enable a Cisco router to automatically negotiate its own registered WAN interface IP address from a central server (via PPP/IPCP) and to enable all remote hosts to access the global Internet using this single registered IP address.
Examples
The following example configures an asynchronous interface (interface async1) to obtain its IP address via PPP/IPCP address negotiation:
interface async1 ip address negotiated encapsulation ppp
Related Commands
Command encapsulation ip address ip unnumbered
Description Sets the encapsulation method used by the interface. Sets a primary or secondary IP address for an interface. Enables IP processing on an interface without assigning an explicit IP address to the interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-259
Dial Commands ip address-pool
ip address-pool
To enable a global default address pooling mechanism used to supply IP addresses to dial-in asynchronous, synchronous, or ISDN point-to-point interfaces, use the ip address-pool command in global configuration mode. To disable IP address pooling globally on all interfaces with the default configuration, use the no form of this command. ip address-pool {dhcp-pool | dhcp-proxy-client | local} no ip address-pool
Syntax Description
dhcp-pool
Uses on-demand address pooling as the global default address mechanism. This option supports only remote access PPP sessions using a Multiprotocol Label Switching (MPLS) Virtual Private Network (VPN). IP addresses are obtained from locally configured virtual routing and forwarding (VRF)-associated Dynamic Host Configuration Protocol (DHCP) pools. Uses the router as the proxy client between a third-party DHCP server and peers connecting to the router as the global default address mechanism. Uses the local address pool named default as the global default address mechanism.
dhcp-proxy-client local
Command Default
IP address pooling is disabled globally.
Command Modes
Global configuration
Command History
Release 11.0 12.2(8)T
Modification This command was introduced. The dhcp-pool keyword was added.
Usage Guidelines
The global default IP address pooling mechanism applies to all interfaces that have been left in the default setting of the peer default ip address command. If any peer default ip address command other than peer default ip address pool (the default) is configured, the interface uses that mechanism and not the global default mechanism. Thus all interfaces can be independently configured, or left unconfigured so that the global default configuration applies. This flexibility minimizes the configuration effort on the part of the administrator. The ip address-pool dhcp-pool command supports only remote access PPP sessions using an MPLS VPN. IP addresses are obtained from locally configured VRF-associated DHCP pools. A VRF VPN instance is a per-VPN routing information repository that defines the VPN membership of a customer site.
Cisco IOS Dial Technologies Command Reference
DIA-260
November 2009
Dial Commands ip address-pool
Examples
The following example specifies the DHCP on-demand address pooling mechanism as the global default mechanism for assigning peer IP addresses:
ip address-pool dhcp-pool
The following example specifies the DHCP proxy client mechanism as the global default mechanism for assigning peer IP addresses:
ip address-pool dhcp-proxy-client
The following example specifies a local IP address pool named “default” as the global default mechanism for all interfaces that have been left in their default setting:
ip address-pool local
Related Commands
Command
Description
peer default ip address Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-261
Dial Commands ip dhcp-client network-discovery
ip dhcp-client network-discovery
To control the sending of Dynamic Host Configuration Protocol (DHCP) Inform and Discover messages, use the ip dhcp-client network-discovery command in global configuration mode. To change or disable DHCP message control, use the no form of this command. ip dhcp-client network-discovery informs number-of-messages discovers number-of-messages period seconds no ip dhcp-client network-discovery informs number-of-messages discovers number-of-messages period seconds
Syntax Description
informs number-of-messages
Number of DHCP Inform messages. Valid choices are 0, 1, or 2 messages. Default is 0 messages.
discovers number-of-messages Number of DHCP Discover messages. Valid choices are 0, 1, or 2 messages. Default is 0 messages. period seconds Timeout period for retransmission of DHCP Inform and Discover messages. Valid periods are from 3 to 15 seconds. Default is 15 seconds.
Command Default
0 DHCP Inform and Discover messages (network discovery is disabled when both the informs and discovers keywords are set to 0); 15-second timeout period.
Command Modes
Global configuration
Command History
Release 12.2 12.2(28)SB 12.2(33)SRA 12.2SX
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(28)SB. This command was integrated into Cisco IOS Release 12.2(33)SRA. This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.
Usage Guidelines
The ip dhcp-client network-discovery command allows peer routers to dynamically discover Domain Name System (DNS) and NetBIOS name server information configured on a DHCP server using PPP IP Control Protocol (IPCP) extensions. Setting the number of DHCP Inform or Discover messages to 1 or 2 determines how many times the system sends a DHCP Inform or Discover message before stopping network discovery, as follows:
•
When the number of DHCP Inform messages is set to 1, once the first Inform messages is sent the system waits for a response from the DHCP server for the specified timeout period. If there is no response from the DHCP server by the end of the timeout period, the system sends a DHCP Discover message when the number of Discover messages is not set to 0. If the number of Discover messages is set to 1, network discovery stops. If the number of Discover messages is set to 2, the system waits
Cisco IOS Dial Technologies Command Reference
DIA-262
November 2009
Dial Commands ip dhcp-client network-discovery
again for a response from the DHCP server for the specified timeout period. If there is no response from the DHCP server by the end of this second timeout period, the system sends a second DHCP Discover message and stops network discovery.
•
When the number of DHCP Inform messages is set to 2, once the first Inform messages is sent, the system waits for a response from the DHCP server for the specified timeout period. If there is no response from the DHCP server by the end of the timeout period, the system sends another DHCP Inform message. If the number of Discover messages is set to 1, network discovery stops. If the number of Discover messages is set to 2, the system waits again for a response from the DHCP server for the specified timeout period. If there is no response from the DHCP server by the end of this second timeout period, the system sends a second DHCP Discover message and stops network discovery.
Network discovery also stops when the DHCP server responds to DHCP Inform and Discover messages before the configured number of messages and timeout period are exceeded. Setting the number of messages to 0 disables sending of DHCP Inform and Discover messages, and is the same as entering the no ip dhcp-client network-discovery command. When the ip dhcp-client network-discovery command is disabled, the system falls back to the static configurations made using the async-bootp dns-server and async-bootp nb-server global configuration commands or, as a last resort, to a DNS server address assigned with the ip name-server command.
Examples
The following example sets two DHCP Inform and Discovery messages and a timeout period of 12 seconds:
ip dhcp-client network-discovery informs 2 discovers 2 period 12
Related Commands
Command async-bootp ip dhcp-server
Description Configures extended BOOTP requests for asynchronous interfaces as defined in RFC 1084. Specifies which DHCP servers to use on a network, and specifies the IP address of one or more DHCP servers available on the network. Specifies the address of one or more name servers to use for name and address resolution.
ip name-server
Cisco IOS Dial Technologies Command Reference November 2009
DIA-263
Dial Commands ip dhcp client route
ip dhcp client route
To configure the Dynamic Host Configuration Protocol (DHCP) client to associate any added routes with a specified tracked object number, use the ip dhcp client command in interface configuration mode. To restore the default setting, use the no form of this command. ip dhcp client route track number no ip dhcp client route track
Syntax Description
route track number
Associates a tracked object number with the DHCP-installed static route. Valid values for the number argument range from 1 to 500.
Command Default
No routes are associated with a track number.
Command Modes
Interface configuration (config-if)
Command History
Release 12.3(2)XE 12.3(8)T 12.2(33)SXH 12.2(33)SRE 15.0(1)M
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.3(8)T. This command was integrated into Cisco IOS Release 12.2(33)SXH. This command was integrated into Cisco IOS Release 12.2(33)SRE. This command was integrated into Cisco IOS Release 15.0(1)M.
Usage Guidelines
The ip dhcp client command must be configured before the ip address dhcp command is configured on an interface. The ip dhcp client command is checked only when an IP address is acquired from DHCP. If the ip dhcp client command is specified after an IP address has been acquired from DHCP, the ip dhcp client command will not take effect until the next time the router acquires an IP address from DHCP.
Examples
The following example configures DHCP on an Ethernet interface and associates tracked object 123 with routes generated from this interface:
interface ethernet 0/0 ip dhcp client route track 123 ip address dhcp
Related Commands
Command ip address dhcp
Description Acquires an IP address on an Ethernet interface from the DHCP.
Cisco IOS Dial Technologies Command Reference
DIA-264
November 2009
Dial Commands ip dhcp-server
ip dhcp-server
To specify which Dynamic Host Configuration Protocol (DHCP) servers to use on your network, or to specify the IP address of one or more DHCP servers available on the network, use the ip dhcp-server command in global configuration mode. To remove a DHCP server IP address, use the no form of this command. ip dhcp-server [ip-address | name] no ip dhcp-server [ip-address | name]
Syntax Description
ip-address name
(Optional) IP address of a DHCP server. (Optional) Name of a DHCP server.
Command Default
The IP limited broadcast address of 255.255.255.255 is used for transactions if no DHCP server is specified. This default allows automatic detection of DHCP servers.
Command Modes
Global configuration
Command History
Release 11.0 12.2(33)SRA 12.2SX
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(33)SRA. This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.
Usage Guidelines
A DHCP server temporarily allocates network addresses to clients through the access server on an as-needed basis. While the client is active, the address is automatically renewed in a minimum of 20-minute increments. When the user terminates the session, the interface connection is terminated so that network resources can be quickly reused. You can specify up to ten servers on the network. In normal situations, if a SLIP or PPP session fails (for example, if a modem line disconnects), the allocated address will be reserved temporarily to preserve the same IP address for the client when dialed back into the server. This way, the session that was accidentally terminated can often be resumed. To use the DHCP proxy-client feature, enable your access server to be a proxy-client on asynchronous interfaces by using the ip address-pool dhcp-proxy-client command. If you want to specify which DHCP servers are used on your network, use the ip dhcp-server command to define up to ten specific DHCP servers.
Note
To facilitate transmission, configure intermediary routers (or access servers with router functionality) to use an IP helper address whenever the DHCP server is not on the local LAN and the access server is using broadcasts to interact with the DHCP server. Refer to the chapters about configuring IP addressing in the Cisco IOS IP Addressing Services Configuration Guide.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-265
Dial Commands ip dhcp-server
The ip address-pool dhcp-proxy-client command initializes proxy-client status to all interfaces defined as asynchronous on the access server. To selectively disable proxy-client status on a single asynchronous interface, use the no peer default ip address interface command.
Examples
The following command specifies a DHCP server with the IP address of 172.24.13.81:
ip dhcp-server 172.24.13.81
Related Commands
Command ip address-pool ip helper-address
Description Enables an address pooling mechanism used to supply IP addresses to dial-in asynchronous, synchronous, or ISDN point-to-point interfaces. Forwards UDP broadcasts, including BOOTP, received on an interface.
peer default ip address Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface. show cot dsp Displays information about the COT DSP configuration or current status.
Cisco IOS Dial Technologies Command Reference
DIA-266
November 2009
Dial Commands ip idle-group
ip idle-group
To configure interesting traffic on a virtual template interface for the PPP idle timer, use the ip idle-group command in interface configuration mode. To remove the configuration, use the no form of this command. ip idle-group {access-list-number | access-list-name} {in | out} no ip idle-group {access-list-number | access-list-name} {in | out}
Syntax Description
access-list-number access-list-name in out
IP access list number. IP access list name. Classifies IP inbound traffic for the PPP idle timer. Classifies IP outbound traffic for the PPP idle timer.
Command Default
No default behavior or values.
Command Modes
Interface configuration
Command History
Release 12.2(4)T 12.2(11)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5300, Cisco AS5400 and Cisco AS5800.
Usage Guidelines
The ip idle-group command is applied to a virtual template interface and configures interesting traffic on either inbound or outbound traffic.
Examples
The following example specifies access list 101 as interesting for inbound IP traffic and access list 102 as interesting for outbound IP traffic:
interface virtual-template 1 ppp timeout idle 60 ip idle-group 101 in ip idle-group 102 out
Related Commands
Command corlist incoming
Description Sets the PPP idle timeout parameters on a virtual template interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-267
Dial Commands ip local pool
ip local pool
To configure a local pool of IP addresses to be used when a remote peer connects to a point-to-point interface, use the ip local pool command in global configuration mode. To remove a range of addresses from a pool (the longer of the no forms of this command), or to delete an address pool (the shorter of the no forms of this command), use one of the no forms of this command. ip local pool {default | poolname} [low-ip-address [high-ip-address]] [group group-name] [cache-size size] [recycle delay seconds] no ip local pool poolname low-ip-address [high-ip-address] no ip local pool {default | poolname}
Syntax Description
default poolname low-IP-address [high-IP-address] group group-name cache-size size
Creates a default local IP address pool that is used if no other pool is named. Name of the local IP address pool. (Optional) First and, optionally, last address in an IP address range. (Optional) Creates a pool group. (Optional) Sets the number of IP address entries on the free list that the system checks before assigning a new IP address. Returned IP addresses are placed at the end of the free list. Before assigning a new IP address to a user, the system checks the number of entries from the end of the list (as defined by the cache-size size option) to verify that there are no returned IP addresses for that user. The range for the cache size is 0 to 100. The default cache size is 20. (Optional) Indicates the time (in seconds) to hold an IP address in the local pool before making it available for reuse.
recycle delay seconds
Command Default
No address pools are configured. Any pool created without the optional group keyword is a member of the base system group.
Command Modes
Global configuration
Command History
Release 11.0 11.3AA 12.1(5)DC 12.2(13)T
Modification This command was introduced. This command was enhanced to allow address ranges to be added and removed. This command was enhanced to allow pool groups to be created. This command was integrated into Cisco IOS Release 12.2(13)T and support was added for the Cisco 6400 node route processor 25v (NRP-25v) and Cisco 7400 platforms. The recycle delay keyword and seconds argument were added.
12.4(15)T
Cisco IOS Dial Technologies Command Reference
DIA-268
November 2009
Dial Commands ip local pool
Usage Guidelines
Use the ip local pool command to create one or more local address pools from which IP addresses are assigned when a peer connects. You may also add another range of IP addresses to an existing pool. To use a named IP address pool on an interface, use the peer default ip address pool interface configuration command. A pool name can also be assigned to a specific user using authentication, authorization, and accounting (AAA) RADIUS and TACACS functions. If no named local IP address pool is created, a default address pool is used on all point-to-point interfaces after the ip address-pool local global configuration command is issued. If no explicit IP address pool is assigned, but pool use is requested by use of the ip address-pool local command, the special pool named “default” is used. The optional group keyword and associated group name allows the association of an IP address pool with a named group. Any IP address pool created without the group keyword automatically becomes a member of a base system group. The optional recycle delay keyword and its associated time indicates the time in seconds to hold the IP address from the pool before making it available for reuse. An IP address pool name can be associated with only one group. Subsequent use of the same pool name, within a pool group, is treated as an extension of that pool, and any attempt to associate an existing local IP address pool name with a different pool group is rejected. Therefore, each use of a pool name is an implicit selection of the associated pool group.
Note
To reduce the chances of inadvertent generation of duplicate addresses, the system allows creation of the special pool named “default” only in the base system group, that is, no group name can be specified with the pool name “default.” All IP address pools within a pool group are checked to prevent overlapping addresses; however, no checks are made between any group pool member and a pool not in a group. The specification of a named pool within a pool group allows the existence of overlapping IP addresses with pools in other groups, and with pools in the base system group, but not among pools within a group. Otherwise, processing of the IP address pools is not altered by their membership in a group. In particular, these pool names can be specified in peer commands and returned in RADIUS and AAA functions with no special processing. IP address pools can be associated with Virtual Private Networks (VPNs). This association permits flexible IP address pool specifications that are compatible with a VPN and a VPN routing and forwarding (VRF) instance. The IP address pools can also be used with the translate commands for one-step vty-async connections and in certain AAA or TACACS+ authorization functions. Refer to the chapter “Configuring Protocol Translation and Virtual Asynchronous Devices” in the Cisco IOS Terminal Services Configuration Guide and the “System Management” part of the Cisco IOS Configuration Fundamentals Configuration Guide for more information. IP address pools are displayed with the show ip local pool EXEC command.
Examples
The following example creates a local IP address pool named “pool2,” which contains all IP addresses in the range 172.16.23.0 to 172.16.23.255:
ip local pool pool2 172.16.23.0 172.16.23.255
The following example configures a pool of 1024 IP addresses:
no ip local pool default ip local pool default 10.1.1.0 10.1.4.255
Cisco IOS Dial Technologies Command Reference November 2009
DIA-269
Dial Commands ip local pool
Note
Although not required, it is good practice to precede local pool definitions with a no form of the command to remove any existing pool, because the specification of an existing pool name is taken as a request to extend that pool with the new IP addresses. If the intention is to extend the pool, the no form of the command is not applicable. The following example configures multiple ranges of IP addresses into one pool:
ip local pool default 10.1.1.0 10.1.9.255 ip local pool default 10.2.1.0 10.2.9.255
The following examples show how to configure two pool groups and IP address pools in the base system group:
ip ip ip ip ip ip ip local local local local local local local pool pool pool pool pool pool pool p1-g1 10.1.1.1 10.1.1.50 group grp1 p2-g1 10.1.1.100 10.1.1.110 group grp1 p1-g2 10.1.1.1 10.1.1.40 group grp2 lp1 10.1.1.1 10.1.1.10 p3-g1 10.1.2.1 10.1.2.30 group grp1 p2-g2 10.1.1.50 10.1.1.70 group grp2 lp2 10.1.2.1 10.1.2.10
In the example:
• • •
Group grp1 consists of pools p1-g1, p2-g1, and p3-g1. Group grp2 consists of pools p1-g2 and p2-g2. Pools lp1 and lp2 are not associated with a group and are therefore members of the base system group.
Note that IP address 10.1.1.1 overlaps groups grp1, grp2, and the base system group. Also note that there is no overlap within any group including the base system group, which is unnamed. The following examples show configurations of IP address pools and groups for use by a VPN and VRF:
ip ip ip ip ip ip ip local local local local local local local pool pool pool pool pool pool pool p1-vpn1 10.1.1.1 10.1.1.50 group vpn1 p2-vpn1 10.1.1.100 10.1.1.110 group vpn1 p1-vpn2 10.1.1.1 10.1.1.40 group vpn2 lp1 10.1.1.1 10.1.1.10 p3-vpn1 10.1.2.1 10.1.2.30 group vpn1 p2-vpn2 10.1.1.50 10.1.1.70 group vpn2 lp2 10.1.2.1 10.1.2.10
The examples show configuration of two pool groups, including pools in the base system group, as follows:
• • •
Group vpn1 consists of pools p1-vpn1, p2-vpn1, and p3-vpn1. Group vpn2 consists of pools p1-vpn2 and p2-vpn2. Pools lp1 and lp2 are not associated with a group and are therefore members of the base system group.
Note that IP address 10.1.1.1 overlaps groups vpn1, vpn2, and the base system group. Also note that there is no overlap within any group including the base system group, which is unnamed. The VPN needs a configuration that selects the proper group by selecting the proper pool based on remote user data. Thus, each user in a given VPN can select an address space using the pool and associated group appropriate for that VPN. Duplicate addresses in other VPNs (other group names) are not a concern, because the address space of a VPN is specific to that VPN.
Cisco IOS Dial Technologies Command Reference
DIA-270
November 2009
Dial Commands ip local pool
In the example, a user in group vpn1 is associated with some combination of the pools p1-vpn1, p2-vpn1, and p3-vpn1, and is allocated addresses from that address space. Addresses are returned to the same pool from which they were allocated. The following example configures a recycle delay of 30 seconds to hold IP addresses in the pool before making them available for reuse:
ip local pool default 10.1.1.0 10.1.9.255 recycle delay 30
Related Commands
Command debug ip peer ip address-pool peer default ip address show ip local pool translate lat translate tcp
Description Displays additional output when IP address pool groups are defined. Enables an address pooling mechanism used to supply IP addresses to dial in asynchronous, synchronous, or ISDN point-to-point interfaces. Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface. Displays statistics for any defined IP address pools. Translates a LAT connection request automatically to another outgoing protocol connection type. Translates a TCP connection request automatically to another outgoing protocol connection type.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-271
Dial Commands ip route
ip route
To establish static routes, use the ip route command in global configuration mode. To remove static routes, use the no form of this command. ip route prefix mask {ip-address | interface-type interface-number [ip-address]} [dhcp] [distance] [name next-hop-name] [permanent | track number] [tag tag] no ip route prefix mask {ip-address | interface-type interface-number [ip-address]} [dhcp] [distance] [name next-hop-name] [permanent | track number] [tag tag]
Syntax Description
prefix mask ip-address interface-type interface-number dhcp
IP route prefix for the destination. Prefix mask for the destination. IP address of the next hop that can be used to reach that network. Network interface type and interface number. (Optional) Enables a Dynamic Host Configuration Protocol (DHCP) server to assign a static route to a default gateway (option 3).
Note
Specify the dhcp keyword for each routing protocol.
distance name next-hop-name permanent track number tag tag
(Optional) Administrative distance. The default administrative distance for a static route is 1. (Optional) Applies a name to the specified route. (Optional) Specifies that the route will not be removed, even if the interface shuts down. (Optional) Associates a track object with this route. Valid values for the number argument range from 1 to 500. (Optional) Specifies the tag value that can be used as a “match” value for controlling redistribution via route maps.
Command Default
No static routes are established.
Command Modes
Global configuration (config)
Command History
Release 10.0 12.3(2)XE 12.3(8)T 12.3(9) 12.2(33)SRE
Modification This command was introduced. This command was modified. The track keyword and number argument were added. This command was modified. The dhcp keyword was added. This command was integrated into Cisco IOS Release 12.3(9). This command was integrated into Cisco IOS Release 12.2(33)SRE.
Cisco IOS Dial Technologies Command Reference
DIA-272
November 2009
Dial Commands ip route
Release 12.2(33)SXH 15.0(1)M
Modification This command was integrated into Cisco IOS Release 12.2(33)SXH. This command was integrated into Cisco IOS Release 15.0(1)M.
Usage Guidelines
The establishment of a static route is appropriate when the Cisco IOS software cannot dynamically build a route to the destination. When you specify a DHCP server to assign a static route, the interface type and number and administrative distance may be configured also. If you specify an administrative distance, you are flagging a static route that can be overridden by dynamic information. For example, routes derived with Enhanced Interior Gateway Routing Protocol (EIGRP) have a default administrative distance of 100. To have a static route that would be overridden by an EIGRP dynamic route, specify an administrative distance greater than 100. Static routes have a default administrative distance of 1. Static routes that point to an interface on a connected router will be advertised by way of Routing Information Protocol (RIP) and EIGRP regardless of whether redistribute static commands are specified for those routing protocols. This situation occurs because static routes that point to an interface are considered in the routing table to be connected and hence lose their static nature. Also, the target of the static route should be included in the network (DHCP) command. If this condition is not met, no dynamic routing protocol will advertise the route unless a redistribute static command is specified for these protocols. With the following configuration:
rtr1 (serial 172.16.188.1/30)--------------> rtr2(Fast Ethernet 172.31.1.1/30) ------> router [rip | eigrp] network 172.16.188.0 network 172.31.0.0
•
RIP and EIGRP redistribute the route if the route is pointing to the Fast Ethernet interface:
ip route 172.16.188.252 255.255.255.252 FastEthernet 0/0
RIP and EIGRP do not redistribute the route with the following ip route command because of the split horizon algorithm:
ip route 172.16.188.252 255.255.255.252 serial 2/1
•
EIGRP redistributes the route with both of the following commands:
ip route 172.16.188.252 255.255.255.252 FastEthernet 0/0 ip route 172.16.188.252 255.255.255.252 serial 2/1
With the Open Shortest Path First (OSPF) protocol, static routes that point to an interface are not advertised unless a redistribute static command is specified. Adding a static route to an Ethernet or other broadcast interface (for example, ip route 0.0.0.0 0.0.0.0 Ethernet 1/2) will cause the route to be inserted into the routing table only when the interface is up. This configuration is not generally recommended. When the next hop of a static route points to an interface, the router considers each of the hosts within the range of the route to be directly connected through that interface, and therefore it will send Address Resolution Protocol (ARP) requests to any destination addresses that route through the static route. A logical outgoing interface, for example, a tunnel needs to be configured for a static route. If this outgoing interface is deleted from the configuration, the static route is removed from the configuration and hence does not show up in the routing table. To have the static route inserted into the routing table again, configure the outgoing interface once again and add the static route to this interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-273
Dial Commands ip route
The practical implication of configuring the ip route 0.0.0.0 0.0.0.0 ethernet 1/2 command is that the router will consider all of the destinations that the router does not know how to reach through some other route as directly connected to Ethernet interface 1/2. So the router will send an ARP request for each host for which it receives packets on this network segment. This configuration can cause high processor utilization and a large ARP cache (along with memory allocation failures). Configuring a default route or other static route that directs the router to forward packets for a large range of destinations to a connected broadcast network segment can cause your router to reload. Specifying a numerical next hop that is on a directly connected interface will prevent the router from using proxy ARP. However, if the interface with the next hop goes down and the numerical next hop can be reached through a recursive route, you may specify both the next hop and interface (for example, ip route 0.0.0.0 0.0.0.0 ethernet 1/2 10.1.2.3) with a static route to prevent routes from passing through an unintended interface. The name next-hop-name keyword and argument combination allows you to associate static routes with names in your running configuration. If you have several static routes, you can specify names that describe the purpose of each static route in order to more easily identify each one. The track number keyword and argument combination specifies that the static route will be installed only if the state of the configured track object is up.
Recursive Static Routing
In a recursive static route, only the next hop is specified. The output interface is derived from the next hop. For the following recursive static route example, all destinations with the IP address prefix address prefix 192.168.1.1/32 are reachable via the host with address 10.0.0.2:
ip route 192.168.1.1 255.255.255.255 10.0.0.2
A recursive static route is valid (that is, it is a candidate for insertion in the IPv4 routing table) only when the specified next hop resolves, either directly or indirectly, to a valid IPv4 output interface, provided the route does not self-recurse, and the recursion depth does not exceed the maximum IPv4 forwarding recursion depth. The following example defines a valid recursive IPv4 static route:
interface serial 2/0 ip address 209.165.201.1 255.255.255.252 exit ip route 192.168.1.1 255.255.255.255 10.0.0.2
The following example defines an invalid recursive IPv4 static route. This static route will not be inserted into the IPv4 routing table because it is self-recursive. The next hop of the static route, 192.168.1.0/30, resolves via the first static route 192.168.1.0/24, which is itself a recursive route (that is, it only specifies a next hop). The next hop of the first route, 192.168.1.0/24, resolves via the directly connected route via the serial interface 2/0. Therefore, the first static route would be used to resolve its own next hop.
interface serial 2/0 ip address 209.165.201.1 255.255.255.252 exit ip route 192.168.1.0 255.255.255.0 10.0.0.2 ip route 192.168.1.0 255.255.255.252 192.168.1.100
It is not normally useful to manually configure a self-recursive static route, although it is not prohibited. However, a recursive static route that has been inserted in the IPv4 routing table may become self-recursive as a result of some transient change in the network learned through a dynamic routing protocol. If this situation occurs, the fact that the static route has become self-recursive will be detected
Cisco IOS Dial Technologies Command Reference
DIA-274
November 2009
Dial Commands ip route
and the static route will be removed from the IPv4 routing table, although not from the configuration. A subsequent network change may cause the static route to no longer be self-recursive, in which case it is reinserted in the IPv4 routing table.
Note
IPv4 recursive static routes are checked at one-minute intervals. Therefore, a recursive static route may take up to a minute to be inserted into the routing table once its next hop becomes valid. Likewise, it may take a minute or so for the route to disappear from the table if its next hop becomes invalid.
Examples
The following example shows a selection of an administrative distance of 110. In this case, packets for network 10.0.0.0 will be routed to a router at 172.31.3.4 if dynamic information with an administrative distance less than 110 is not available.
ip route 10.0.0.0 255.0.0.0 172.31.3.4 110
Note
Specifying the next hop without specifying an interface when configuring a static route can cause traffic to pass through an unintended interface if the default interface goes down. The following example shows how to route packets for network 172.31.0.0 to a router at 172.31.6.6:
ip route 172.31.0.0 255.255.0.0 172.31.6.6
The following example shows how to route packets for network 192.168.1.0 directly to the next hop at 10.1.2.3. If the interface goes down, this route is removed from the routing table and will not be restored unless the interface comes back up.
ip route 192.168.1.0 255.255.255.0 Ethernet 0 10.1.2.3
The following example shows how to install the static route only if the state of track object 123 is up:
ip route 0.0.0.0 0.0.0.0 Ethernet 0/1 10.1.1.242 track 123
The following example shows how to use the dhcp keyword in a configuration of Ethernet interfaces 1 and to enable the interfaces to obtain the next-hop router IP addresses dynamically from a DHCP server:
ip route 10.165.200.225 255.255.255.255 ethernet 1 dhcp ip route 10.165.200.226 255.255.255.255 ethernet 2 dhcp 20
The following example shows that using the name next-hop-name keyword and argument combination for each static route in the configuration helps you remember the purpose for each static route:
ip route 172.0.0.0 255.0.0.0 10.0.0.1 name name1
The name for the static route is displayed when the show running-configuration command is entered:
Router# show running-config | include ip route ip route 172.0.0.0 255.0.0.0 10.0.0.1 name name2
Related Commands
Command network (DHCP) redistribute (IP)
Description Configures the subnet number and mask for a DHCP address pool on a Cisco IOS DHCP server. Redistributes routes from one routing domain into another routing domain.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-275
Dial Commands ip route (large-scale dial-out)
ip route (large-scale dial-out)
To establish static routes and define the next hop for large-scale dial-out, use the ip route command in global configuration mode. To remove static routes, use the no form of this command. ip route network-number network-mask {ip-address | interface} [distance] [name name] no ip route
Syntax Description
network-number network-mask ip-address interface distance name name
IP address of the target network or subnet. Network mask that lets you mask network and subnetwork bits. Internet address of the next hop that can be used to reach that network in standard IP address notation. Example: 10.1.1.1. Network interface name and number to use. (Optional) Administrative distance, which is a rating of the trustworthiness of a routing information source, such as an individual router or a group of routers. (Optional) Name of the user profile.
Command Default
No static route is established.
Command Modes
Global configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
A static route is appropriate when the communication server cannot dynamically build a route to the destination. If you specify an administrative distance, you are flagging a static route that can be overridden by dynamic information. For example, Interior Gateway Routing Protocol (IGRP)-derived routes have a default administrative distance of 100. To have a static route that would be overridden by an IGRP dynamic route, specify an administrative distance greater than 100. Static routes have a default administrative distance of 1. Static routes that point to an interface will be advertised using RIP, IGRP, and other dynamic routing protocols, regardless of whether redistribute static commands were specified for those routing protocols. These static routes will be advertised because static routes that point to an interface are considered to be connected in the routing table and hence lose their static nature. However, if you define a static route to an interface that is not in one of the networks defined in a network command, no dynamic routing protocols will advertise the route unless a redistribute static command is specified for these protocols. The user profile name is passed to an authentication, authorization, and accounting (AAA) server as the next hop for large-scale dial-out, and is the name argument with the -out suffix appended. The suffix is automatically supplied and is required because dial-in and user profile names must be unique.
Cisco IOS Dial Technologies Command Reference
DIA-276
November 2009
Dial Commands ip route (large-scale dial-out)
Examples
In the following example, an administrative distance of 110 was chosen. In this case, packets for network 10.0.0.0 will be routed via to the communication server at 172.19.3.4 if dynamic information with an administrative distance less than 110 is not available.
ip route 10.0.0.0 255.0.0.0 172.19.3.4 110
In the following example, packets for network 172.19.0.0 will be routed to the communication server at 172.19.6.6:
ip route 172.19.0.0 255.255.0.0 172.19.6.6
In the following example, the user profile named “profile1-out” will be retrieved from the AAA server:
ip route 10.0.0.0 255.255.255.255 Dialer0 name profile1
Related Commands
Command
Description
show ip route Displays all static IP routes, or those installed using the AAA route download function.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-277
Dial Commands ip rtp reserve
ip rtp reserve
To reserve a special queue for a set of Real-Time Transport Protocol (RTP) packet flows belonging to a range of User Datagram Protocol (UDP) destination ports, use the ip rtp reserve command in interface configuration mode. To disable the special queue for real-time traffic, use the no form of this command. ip rtp reserve lowest-udp-port range-of-ports [maximum-bandwidth] no ip rtp reserve
Syntax Description
lowest-udp-port range-of-ports maximum-bandwidth
Lowest UDP port number to which the packets are sent. Number, which when added to the lowest UDP port value, yields the highest UDP port value. (Optional) Bandwidth, in kilobits per second, reserved for the RTP packets to be sent to the specified UDP ports.
Command Default
This function is disabled by default. No default values are provided for the arguments.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
If the bandwidth needed for RTP packet flows exceeds the maximum bandwidth specified, the reserved queue will degrade to a best-effort queue. This command helps in improving the delay bounds of voice streams by giving them a higher priority.
Examples
The following example reserves a unique queue for traffic to destination UDP ports in the range 32768 to 32788 and reserves 1000 kbps bandwidth for that traffic:
ip rtp reserve 32768 20 1000
Related Commands
Command ppp multilink
Description Enables MLP on an interface and, optionally, enables dynamic bandwidth allocation.
ppp multilink fragment delay Specifies a maximum size, in units of time, for packet fragments on an MLP bundle. ppp multilink interleave Enables interleaving of packets among the fragments of larger packets on an MLP bundle.
Cisco IOS Dial Technologies Command Reference
DIA-278
November 2009
Dial Commands ip tcp async-mobility server
ip tcp async-mobility server
To enable asynchronous listening, which in turn allows TCP connections to TCP port 57, use the ip tcp async-mobility server command in global configuration mode. To turn listening off, use the no form of this command. ip tcp async-mobility server no ip tcp async-mobility server
Syntax Description
This command has no arguments or keywords.
Command Default
Asynchronous listening is disabled (turned off).
Command Modes
Global configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
After asynchronous listening is turned on by the ip tcp async-mobility server command, use the tunnel command to establish a network layer connection to a remote host. Both commands must be used to enable asynchronous mobility.
Examples
The following example shows how to configure asynchronous mobility. The tunnel command is used to establish a network layer connection with an IBM host named “mktg.”
Router# configure terminal Router(config)# ip tcp async-mobility server Router(config)# exit Router# tunnel mktg
Related Commands
Command tunnel
Description Sets up a network layer connection to a router.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-279
Dial Commands ip telnet comport
ip telnet comport
To enable the Cisco IOS Telnet server to use the RFC 2217 Com Port extensions, use the ip telnet comport command in global configuration mode. To disable RFC 2217 Com Port extensions, use the no form of this command. ip telnet comport {disconnect delay seconds | enable | flow level number-of-characters | receive window window-size} no ip telnet comport enable
Syntax Description
disconnect delay enable flow level receive window seconds number-of-charcters window-size
(Optional) Delay before TCP closes after the DTR drop.
Note
At lease one of these alternative keywords must be entered.
(Optional) Enables the Cisco IOS Telnet server to use the RFC 2217 Com Port extensions. (Optional) Sets the flow control level. (Optional) Sets the maximum TCP receive window size. Number of seconds to delay the TCP closure. Possible values: 0 to 360. Number of characters to be saved in the device buffer before sending an RFC 2217 SUSPEND message. Maximum window size. Possible values: 1 to 4128.
Command Default
Telnet Com Port extensions are enabled
Command Modes
Global configuration
Command History
Release 11.3(1) 12.1 12.2 12.3 12.4
Modification This command was introduced. This was integrated into Cisco IOS Release 12.1. This was integrated into Cisco IOS Release 12.2. This was integrated into Cisco IOS Release 12.3. This was integrated into Cisco IOS Release 12.4.
Usage Guidelines
RFC 2217 Telnet Com Port extensions are used to communicate modem hardware signal status from a modem on a network access server (NAS) to a TCP/IP client. An example would be a client PC using a package such as DialOut/EZ (Tacticalsoftware.com) to provide an emulated COM port via a TCP connection to a Cisco AS5000 NAS with integrated modems. When Com Port extensions are enabled on the NAS, the binary Telnet option (RFC 856) should be used. The Telnet client must connect to TCP ports 6000+ for individual lines, or 7000+ for rotaries on the Cisco NAS.
Cisco IOS Dial Technologies Command Reference
DIA-280
November 2009
Dial Commands ip telnet comport
Setting the Command to Avoid Interruptions
Although the default settings for the ip telnet comport command are suitable for most applications, in a few cases some settings should be changed for efficient communications. Two possible situations are described below.
•
Preventing Data Buffer Overflows Before the application can send data it must determine the modem’s readiness for transmission. This checking process generates some initial data. If many of these checks occur in a short period of time, the data will be buffered. Command ip telnet comport can be set to prevent a buffer overflow from of these trivial data events. In this case, the ip telnet comport flow level (range: 1 through 1023) is adjusted. This enables the PC-hosted comm-serv to send a signal to the remote to prevent (SUSPEND) transmission of any data or commands. When the application is actually ready to receive data, the remote can start transmissions.
•
Handling DTR Drops When a Data Terminal Ready (DTR, a signal pin on a serial interface) is dropped during a communcation, the PC application may incorrectly interpret the event as an error. This situation can be prevented by changing the disconnect delay (range is 1 to 360 seconds) of command ip telnet comport . Adding this delay gives the application time to receive and properly act on the DTR drop message before the tcp connection is closed down.
Examples
The following example disables Telnet Com Port extensions:
no ip telnet comport enable
Related Commands
Command debug telnet
Description Displays information about Telnet option negotiation messages for incoming Telnet connections to a Cisco IOS Telnet server.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-281
Dial Commands ip telnet hidden
ip telnet hidden
To hide IP address or host name information when a Telnet session is established, use the ip telnet hidden command in global configuration mode. To make IP address or hostname information visible, use the no form of this command. ip telnet hidden {addresses | hostnames} no ip telnet hidden {addresses | hostnames}
Syntax Description
addresses hostnames
Specifies that IP addresses will not be displayed when a Telnet session is established. Specifies that host names will not be displayed when a Telnet session is established.
Command Default
IP addresses and host names are visible
Command Modes
Global configuration
Command History
Release 12.2(1)
Modification This command was introduced.
Usage Guidelines
By default, when a Telnet client connects to the server, the client will display a message with the server IP address and host name, as shown in the following example:
Router# telnet is-dialer Trying is-dialer.cisco.com (10.20.0.167)... Open
The ip telnet hidden command can be configured to hide the IP address of the client or the host name of the client in the message. Configuring the ip telnet hidden addresses command results in the client displaying a message with the IP address of the server hidden, as shown in the following example:
Router# telnet is-dialer Trying is-dialer.cisco.com address #1 ... Open
Configuring the ip telnet hidden hostnames command results in the client displaying a message with the host name of the server hidden, as shown in the following example:
Router# telnet is-dialer Trying (10.20.0.167) ... Open
Cisco IOS Dial Technologies Command Reference
DIA-282
November 2009
Dial Commands ip telnet hidden
Configuring both the ip telnet hidden addresses and ip telnet hidden hostnames commands results in the client displaying a message with both the IP address and the host name of the server hidden, as shown in the following example:
Router# telnet is-dialer Trying address #1 ... Open
Examples
The following example configures the Telnet client to hide both IP addresses and host name information when connecting to the server:
ip telnet hidden addresses ip telnet hidden hostnames
Related Commands
Command busy-message ip telnet quiet telnet
Description Creates a “host failed” message that displays when a connection fails. Suppresses the display of Telnet connection messages. Logs in to a host that supports Telnet.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-283
Dial Commands ip telnet quiet
ip telnet quiet
To suppress the display of Telnet connection messages, use the ip telnet quiet command in global configuration mode. To cancel this option, use the no form of this command. ip telnet quiet no ip telnet quiet
Syntax Description
This command has no arguments or keywords.
Command Default
Telnet connection message suppression is disabled by default.
Command Modes
Global configuration
Command History
Release 12.1
Modification This command was introduced.
Usage Guidelines
The ip telnet quiet command does not suppress TCP or error messages. It is most useful to Internet service providers, to allow them to hide the onscreen messages displayed during connection, including Internet addresses, from subscription users.
Examples
The following example globally disables onscreen connect messages:
ip telnet quiet
The following example shows the login and logout messages displayed during login and logout when the ip telnet quiet command has not been configured to suppress Cisco IOS software messages:
Router# telnet Server3 Translating "Server3"...domain server (171.68.89.42) [OK] Trying Server3--Server3.cisco.com (171.68.89.42)... Open Kerberos: No default realm defined for Kerberos!
login:User2 Password: Welcome to OpenVMS VAX version V6.1 on node CRAW Last interactive login on Tuesday, 15-DEC-1998 11:01 Last non-interactive login on Sunday, 3-JAN-1999 22:32 Server3)logout User2 logged out at 16-FEB-2000 09:38:27.85 [Connection to Server3 closed by foreign host]
Cisco IOS Dial Technologies Command Reference
DIA-284
November 2009
Dial Commands ip telnet quiet
The following example shows the limited messages displayed during login and logout when the ip telnet quiet command has been configured to suppress Cisco IOS software messages:
Router# telnet Server3 login:User2 Password: Welcome to OpenVMS VAX version V6.1 on node CRAW Last interactive login on Tuesday, 15-DEC-1998 11:01 Last non-interactive login on Sunday, 3-JAN-1999 22:32 Server3)logout User2
logged out at
16-FEB-2000 09:38:27.85
Related Commands
Command busy-message rlogin telnet
Description Creates a “host-failed” message that displays when a connection fails. Logs in to a UNIX host using rlogin. Logs in to a host that supports Telnet.
service hide-telnet-address Hides addresses while trying to establish a Telnet session.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-285
Dial Commands ip telnet timeout retransmit
ip telnet timeout retransmit
To specify a maximum period that TCP will attempt to retransmit a segment for a Telnet connection, use the ip telnet timeout command in global configuration mode. To remove the maximum TCP retransmission period, use the no form of this command. ip telnet timeout retransmit seconds no ip telnet timeout retransmit
Syntax Description
seconds
Number of seconds for the timeout value. Values can range from 1 to 2147483.
Command Default
no ip telnet timeout retransmit
Command Modes
Global configuration
Command History
Release 12.4(9)T
Modification This command was introduced.
Usage Guidelines
Configure the ip telnet timeout command to specify an explicit maximum period that TCP will attempt to retransmit a segment for a Telnet connection. For the default setting (no ip telnet timeout retransmit), TCP’s retransmit timeout will be based on the estimated round trip time for the connection (typically, seven or eight minutes).
Note
If Telnet has no data to transmit, the TCP connection remains indefinitely (regardless of whether the other end is reachable), unless you configure TCP keepalives. This setting has an effect on connections using the Telnet protocol (whether inbound or outbound), not on connections using other protocols such as rlogin and ssh (secure shell).
Examples
The following example sets the TCP retransmit time to a value of 12 hours:
Router(config)#ip telnet timeout retransmit 432000
Related Commands
Command service tcp-keepalives-in service tcp-keepalives-out telnet
Description Enables TCP keepalives on an inbound connection. Enables TCP keepalives on an outbound connection. Logs in to a host that supports Telnet.
Cisco IOS Dial Technologies Command Reference
DIA-286
November 2009
Dial Commands ip telnet tos
ip telnet tos
To set the type of service (ToS) precedence bits in the IP header for Telnet packets sent by the router, use the ip telnet tos command in global configuration mode. To restore the default value, use the no form of this command. ip telnet tos hex-value no ip telnet tos
Syntax Description
hex-value
Hexadecimal value of the ToS precedence bits in the IP header. Valid values range from 0 to FF. The default value is 0xC0.
Command Default
The default ToS value for Telnet packets is 0xC0.
Command Modes
Global configuration (config)
Command History
Release 11.2(10)P 11.3(1) 12.2(33)SRE
Modification This command was introduced. This command was integrated into Cisco IOS Release 11.3(1). This command was integrated into Cisco IOS Release 12.2(33)SRE.
Usage Guidelines
Compatibility with older Telnet clients may require the configuration of the ip telnet tos 0 command.
Examples
The following example configures a ToS precedence bit value of 0xF0 in the IP header:
Router(config)# ip telnet tos F0
The following example displays the output for an invalid ToS precedence value:
Router(config)# ip telnet tos F2 %Invalid TOS F2
Related Commands
Command telnet
Description Logs in to a host that supports Telnet.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-287
Dial Commands ipx compression cipx
ipx compression cipx
To enable compression of Internetwork Packet Exchange (IPX) packet headers in a PPP session, use the ipx compression cipx command in interface configuration mode. To disable compression of IPX packet headers in a PPP session, use the no form of this command. ipx compression cipx number-of-slots no ipx compression cipx
Syntax Description
number-of-slots
Number of stored IPX headers allowed. The range is from 10 to 256. A slot is similar to a table entry for a complete IPX header. When a packet is received, the receiver stores the complete IPX header in a slot and tells the destination which slot it used. As subsequent CIPX packets are sent, the receiver uses the slot number field to determine which complete IPX header to associate with the CIPX packet before passing the packet up to IPX.
Command Default
No compression of IPX packets during a PPP session. Default number of slots is 16.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This interface configuration command enables IPX header compression on PPP links.
Examples
The following example enables IPX header compression for PPP:
encapsulation ppp ipx compression cipx 128
Related Commands
Command
Description
show ipx compression Displays the current status and statistics of IPX header compression during PPP sessions.
Cisco IOS Dial Technologies Command Reference
DIA-288
November 2009
Dial Commands ipx ppp-client
ipx ppp-client
To enable a nonrouting Internetwork Packet Exchange (IPX) client to connect to an asynchronous interface, the interface must be associated with a loopback interface configured to run IPX. To permit such connections, use the ipx ppp-client command in interface configuration mode. To disable a nonrouting IPX client, use the no form of this command. ipx ppp-client loopback loopback-interface-number no ipx ppp-client loopback loopback-interface-number
Syntax Description
loopback
Loopback interface configured with a unique IPX network number.
loopback-interface-number Number of the loopback interface.
Command Default
IPX client connections are not permitted over PPP.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This command enables IPX clients to log in to the router from a device running a virtual terminal protocol, then issue the PPP command at the EXEC prompt to connect to a remote device. You must first configure a loopback interface with a unique IPX network number. The loopback interface is then assigned to an asynchronous interface, which permits IPX clients to connect to the asynchronous interface.
Examples
The following example configures IPX to run over PPP on asynchronous interface 3:
ipx routing 0000.0c07.b509 interface loopback0 no ip address ipx network 544 ipx sap-interval 2000 interface ethernet0 ip address 172.21.14.64 ipx network AC150E00 ipx encapsulation SAP interface async 3 ip unnumbered ethernet0 encapsulation ppp async mode interactive async default ip address 172.18.1.128 ipx ppp-client loopback0 ipx sap-interval 0
Cisco IOS Dial Technologies Command Reference November 2009
DIA-289
Dial Commands ipx ppp-client
Related Commands
Command interface loopback ipx network
Description Creates a loopback interface. Enables IPX routing on a particular interface and optionally selects the type of encapsulation (framing).
Cisco IOS Dial Technologies Command Reference
DIA-290
November 2009
Dial Commands isdn all-incoming-calls-v120
isdn all-incoming-calls-v120
To configure an ISDN BRI or PRI interface to answer all incoming calls as V.120 when the terminal adapter uses V.120 signaling but does not send the Lower-Layer Compatibility field in Setup messages, use the isdn all-incoming-calls-v120 command in interface configuration mode. To remove this configuration, use the no form of the command. isdn all-incoming-calls-v120 no isdn all-incoming-calls-v120
Syntax Description
This command has no arguments or keywords.
Command Default
By default, ISDN interfaces answer calls as synchronous serial with PPP encapsulation.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
Use this command only when you want all incoming calls to be answered as V.120. If you want the interface to automatically detect whether the incoming call uses V.120 or PPP encapsulation, use the autodetect encapsulation command. This command applies only when the incoming call originates on an asynchronous device and needs to terminate in an available vty on the router.
Examples
The following partial example shows that BRI 0 is configured to answer all calls as V.120:
interface bri 0 isdn all-incoming-calls-v120
Related Commands
Command autodetect encapsulation
Description Enables automatic detection of the encapsulation types in operation over a point-to-point link to a specified serial or ISDN interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-291
Dial Commands isdn answer1, isdn answer2
isdn answer1, isdn answer2
To have the router verify a called-party number or subaddress number in the incoming setup message for ISDN BRI calls, if the number is delivered by the switch, use the isdn answer1 command in interface configuration mode. To remove the verification request, use the no form of this command. isdn answer1 [called-party-number][:subaddress] no isdn answer1 [called-party-number][:subaddress] To have the router verify an additional called-party number or subaddress number in the incoming setup message for ISDN BRI calls, if the number is delivered by the switch, use the isdn answer2 command in interface configuration mode. To remove this second verification request, use the no form of this command. isdn answer2 [called-party-number][:subaddress] no isdn answer2 [called-party-number][:subaddress]
Syntax Description
called-party-number
(Optional) Telephone number of the called party. At least one value—called-party-number or subaddress—must be specified. The maximum number of digits for called-party-number is 50. (Optional) Identifies the number that follows as a subaddress. Use the colon (:) when you configure both the called party number and the subaddress, or when you configure only the subaddress. (Optional) Subaddress number used for ISDN multipoint connections. At least one value—called-party-number or subaddress—must be specified. The maximum number of digits for subaddress is 50.
:
subaddress
Command Default
The router does not verify the called party or subaddress number.
Command Modes
Interface configuration
Command History
Release 10.3
Modification This command was introduced.
Usage Guidelines
If you do not specify the isdn answer1 or isdn answer2 command, all calls are processed or accepted. If you specify the isdn answer1 or isdn answer2 command, the router must verify the incoming called-party number and the subaddress before processing or accepting the call. The verification proceeds from right to left for the called-party number; it also proceeds from right to left for the subaddress number. You can configure just the called-party number or just the subaddress. In such a case, only that part is verified. To configure a subaddress only, include the colon (:) before the subaddress number.
Cisco IOS Dial Technologies Command Reference
DIA-292
November 2009
Dial Commands isdn answer1, isdn answer2
You can declare a digit a “don’t care” digit by configuring it as an x or X. In such a case, any incoming digit is allowed.
Examples
In the following example, 5550122 is the called-party number and 1234 is the subaddress:
interface bri 0 isdn answer1 5550122:1234
In the following example, only the subaddress is configured:
interface bri 0 isdn answer1 :1234
Cisco IOS Dial Technologies Command Reference November 2009
DIA-293
Dial Commands isdn autodetect
isdn autodetect
To enable the automatic detection of ISDN SPIDs and switch type, use the isdn autodetect command in interface configuration mode. To disable the automatic detection of ISDN SPIDs and switch type, use the no form of this command. isdn autodetect no isdn autodetect
Syntax Description
This command has no arguments or keywords.
Command Default
The automatic detection of ISDN SPIDs and switch type is disabled.
Command Modes
Interface configuration
Command History
Release 12.0(3)T
Modification This command was introduced.
Usage Guidelines
This command applies to North America only. If you are outside of North America, you must use the isdn switch-type (BRI) or isdn switch-type (PRI) interface configuration command to specify the ISDN switch type.
Examples
The following example enables the automatic detection of ISDN SPIDs and switch type:
isdn autodetect
Related Commands
Command isdn spid1, isdn spid2 isdn switch-type (BRI) isdn switch-type (PRI)
Description Defines the SPID number that has been assigned by the ISDN service provider for the B1 channel. Specifies the central office switch type on the ISDN BRI interface. Specifies the central office switch type on the ISDN PRI interface.
Cisco IOS Dial Technologies Command Reference
DIA-294
November 2009
Dial Commands isdn bcac service audit
isdn bcac service audit
To enable service audits on an interface configured for B-Channel Availability Control (BCAC), use the isdn bcac service audit command in interface configuration mode. To disable service audits, use the no form of this command. isdn bcac service audit no isdn bcac service audit
Syntax Description
This command has no arguments or keywords.
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
This commands starts service audits for all triggers. Use the isdn bcac service audit trigger command to selectively enable and disable audit triggers.
Examples
The following example shows how to configure service audits on serial interface 2:23:
interface serial 2:23 isdn bcac service audit
Related Commands
Command
Description
isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface. isdn bcac service audit Enables individual BCAC service triggers. trigger isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer. isdn bcac service update linkup Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-295
Dial Commands isdn bcac service audit
Command isdn bcac service update provision isdn service
Description Enables the functionality of service status for provisioning ISDN PRI B channels. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-296
November 2009
Dial Commands isdn bcac service audit interface
isdn bcac service audit interface
To specify that B-Channel Availability Control (BCAC) service audit needs to be triggered on the entire interface, use the isdn bcac service audit interface command in interface configuration mode. To change or remove the specification, use the no form of this command. isdn bcac service audit interface no isdn bcac service audit interface
Syntax Description
This command has no arguments or keywords.
Command Default
The default can be to trigger audits on a single channel, a group of channels, or the entire interface, depending upon the type of trigger set. See the “Usage Guidelines” section for the isdn bcac service audit trigger command for the list of triggers.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
Use this command when the service audit needs to be triggered on the entire interface when a condition to trigger the service audit is triggered for any channel.
Examples
The following example shows how to configure service audits on serial interface 2:23:
interface serial 2:23 isdn bcac service audit interface
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Enables individual BCAC service triggers. trigger isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer. isdn bcac service update linkup Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-297
Dial Commands isdn bcac service audit interface
Command isdn bcac service update provision isdn service
Description Enables the functionality of service status for provisioning ISDN PRI B channels. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-298
November 2009
Dial Commands isdn bcac service audit trigger
isdn bcac service audit trigger
To reenable individual B-Channel Availability Control (BCAC) service triggers, use the isdn bcac service audit trigger command in interface configuration mode. To disable individual service triggers, use the no form of this command. isdn bcac service audit trigger number no isdn bcac service audit trigger number
Syntax Description
number
A number from 1 to 6 that disables specific service triggers; see a list of these triggers in the “Usage Guidelines” section.
Command Default
All triggers are configured.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
The service audit procedure can be used by the either the user or network side to bring both ends of the interface into agreement about the service status through an exchange of SERV and SERV ACK messages. Following is the list of triggers with the conditions that cause them. Triggers 1 through 4 are triggered by single-channel audits. Trigger 5 occurs on the entire interface. Trigger 6 applies to a group of channels, which in some cases may apply to the entire interface.
• • •
Trigger 1: Upon receiving an incoming call indicating a channel that is in the out-of-service (OOS) or Maint (maintenance) state. Trigger 2: Upon receiving an unsolicited SERV ACK message when the received service status differs from the current status. Trigger 3: Upon receiving an unallowed response to a SERV message. An unallowed response means a SERV ACK message, which indicates a higher availability than was sent in the SERV message. Trigger 4: Upon receiving an ISDN call clearing message with cause code 44 (requested channel not available) when this message is not caused by “glare,” which is a SETUP message collision requesting the same channel. Trigger 5: Once every 24 hours on all channels. Trigger 6: Once every hour on all channels that are in the OOS or Far-end state.
•
• •
Cisco IOS Dial Technologies Command Reference November 2009
DIA-299
Dial Commands isdn bcac service audit trigger
Examples
The following example shows how to disable service trigger 4 on serial interface 2:23:
interface serial 2:23 no isdn bcac service audit trigger 4
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface. isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer. isdn bcac service update linkup isdn bcac service update provision isdn service Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages. Enables the functionality of service status for provisioning ISDN PRI B channels. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-300
November 2009
Dial Commands isdn bcac service retry in-serv-on-fail
isdn bcac service retry in-serv-on-fail
To specify that the B-Channel Availability Control (BCAC) service state of the channel needs to be changed to In Service because no acknowledgment was received, use the isdn bcac service retry in-serv-on-fail command in interface configuration mode. To change or remove this specification, use the no form of this command. isdn bcac service retry in-serv-on-fail no isdn bcac service retry in-serv-on-fail
Syntax Description
This command has no arguments or keywords.
Command Default
Original service state is maintained.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
Use this command when there is a need to change the service state of a channel to In Service when no acknowledgment is received, even after retransmitting the service message the maximum number of allowed times. If this command is not configured, the original service state is maintained.
Examples
The following example shows how to configure an option whereby, on service message exchange failure, the service state of the concerned channel or channels will be set to In Service:
interface serial 2:23 isdn bcac service retry in-serv-on-fail
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface. isdn bcac service audit Enables individual BCAC service triggers. trigger isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer. isdn bcac service update linkup Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-301
Dial Commands isdn bcac service retry in-serv-on-fail
Command isdn bcac service update provision isdn service
Description Enables the functionality of service status for provisioning ISDN PRI B channels. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-302
November 2009
Dial Commands isdn bcac service retry max
isdn bcac service retry max
To specify the maximum number of times a B-Channel Availability Control (BCAC) service message can be retransmitted when unacknowledged, use the isdn bcac service retry max command in interface configuration mode. To remove or change the specification, use the no form of this command. isdn bcac service retry max retries no isdn bcac service retry max retries
Syntax Description
retries
A number from 0 to 127 that determines the maximum number of times that a service message can be retransmitted when unacknowledged. Default is 2.
Command Default
Maximum retransmissions is 2.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
When a SERV message is sent to the far side, SERV message timer T3M1 or T323 is started. If no SERV ACK message is received before these timers expire, the SERV message is retransmitted. This command determines how many times retransmission occurs.
Examples
The following example shows how to set the maximum service message retransmissions on serial interface 2:23 to 50:
interface serial 2:23 isdn bcac service retry max 50
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface. isdn bcac service audit Enables individual BCAC service triggers. trigger isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer. isdn bcac service update linkup Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-303
Dial Commands isdn bcac service retry max
Command isdn bcac service update provision isdn service
Description Enables the functionality of service status for provisioning ISDN PRI B channels. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-304
November 2009
Dial Commands isdn bcac service timer
isdn bcac service timer
To change the value of the B-Channel Availability Control (BCAC) T3M1 or T323 service message timer, use the isdn bcac service timer command in interface configuration mode. To change the timer value, use the no form of this command. isdn bcac service timer milliseconds no isdn bcac service timer milliseconds
Syntax Description
milliseconds
Length, in milliseconds (ms), of the T3M1 or T323 service message timer. Valid range is from 500 to 120000 ms; default is 120000 ms.
Command Default
The T3M1 or T323 service message timer defaults to 120000 ms.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
The T3M1 or T323 service message timer is started when a SERV message is sent to the far side.
Examples
The following example shows how to change the service timers to 600 ms on serial interface 2:23:
interface serial 2:23 isdn bcac service timer 600
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface. isdn bcac service audit Enables individual BCAC service triggers. trigger isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service update linkup Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-305
Dial Commands isdn bcac service timer
Command isdn bcac service update provision isdn service
Description Enables the functionality of service status for provisioning ISDN PRI B channels. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-306
November 2009
Dial Commands isdn bcac service update linkup
isdn bcac service update linkup
To trigger updates of the B-Channel Availability Control (BCAC) service states between peer nodes through exchange of SERV and SERV ACK messages, use the isdn bcac service update linkup command in interface configuration mode. To disable triggering of updates, use the no form of this command. isdn bcac service update linkup no isdn bcac service update linkup
Syntax Description
This command has no arguments or keywords.
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
This command updates the service states of all the channels to the far side of the interface by exchanging SERV and SERV ACK messages whenever ISDN Layer 2 comes up. Use the isdn bcac service update linkup command to bring the service state of the channels on the interface in synchronization with its peer through the exchange of SERV messages. This synchronizing of the service states will be triggered whenever ISDN Layer 2 comes up. This command can be used with the isdn service command in cases where the service state of the channels needs to be synchronized when the ISDN Layer 2 comes up, and in particular, when the ISDN Layer 2 comes up after the router has reloaded.
Examples
The following example shows how to trigger service state updates on serial interface 2:23:
interface serial 2:23 isdn bcac service update linkup
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface. isdn bcac service audit Enables individual BCAC service triggers. trigger
Cisco IOS Dial Technologies Command Reference November 2009
DIA-307
Dial Commands isdn bcac service update linkup
Command
Description
isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer. isdn bcac service update provision isdn service Enables the functionality of service status for provisioning ISDN PRI B channels. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-308
November 2009
Dial Commands isdn bcac service update provision
isdn bcac service update provision
To enable functionality of service status for provisioning the ISDN B channels, use the isdn bcac service update provision command in interface configuration mode. To disable provisioning, use the no form of this command. isdn bcac service update provision no isdn bcac service update provision
Syntax Description
This command has no arguments or keywords.
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
This command enables functionality of service status for provisioning the B channels, which for the Cisco implementation happens only on reboot.
Examples
The following example shows how to enable the service service status for provisioning the B channels on serial interface 2:23:
interface serial 2:23 isdn bcac service update provision
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface. isdn bcac service audit Enables individual BCAC service triggers. trigger isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-309
Dial Commands isdn bcac service update provision
Command isdn bcac service update linkup isdn service
Description Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference
DIA-310
November 2009
Dial Commands isdn bchan-number-order
isdn bchan-number-order
To configure an ISDN PRI interface to make outgoing call selection in ascending descending, or round-robin order, use the isdn bchan-number-order command in interface configuration mode. To restore the default, use the no form of this command or reconfigure the interface with the new value. isdn bchan-number-order {ascending | descending} [round-robin] no isdn bchan-number-order
Syntax Description
ascending
Makes the outgoing B-channel selection in ascending order as follows:
• •
Channels 1 to 24 for a T1 controller Channels 1 to 31 for an E1 controller Channels 24 to 1 for a T1 controller Channels 31 to 1 for an E1 controller
descending
Makes the outgoing B-channel selection in descending order as follows:
• •
round-robin
(Optional) Enables a round-robin B-channel selection scheme.
Command Default
Selection default is ascending for the network side; descending for the user side.
Command Modes
Interface configuration
Command History
Release 11.3T 12.3(1)
Modification This command was introduced. The round-robin keyword was added.
Usage Guidelines
This command supports ascending, descending, and round-robin B-channel selection schemes. This command is for PRI configuration only. This command supports ascending and descending B-channel selection by instructing the router to select the lowest or highest available B channel starting at either channel B1 (ascending) or channel B23 for a T1 and channel B31 for an E1 (descending). In the ascending B-channel selection scheme, for example, if the channel selected for the last call was channel 14, then if channel x, where x is any channel number less than or equal to 14, becomes available by the time a channel is selected for the next call, that channel will be selected for the call. In the round-robin B-channel selection scheme, the next channel selected is the current channel number x plus 1 for ascending, or current channel number x minus 1 for descending configuration. When the channel selection software routine reaches channel 1 (the bottom for descending) or channel 23 for T1 and channel 31 for E1 (the top for ascending), the software routine wraps around. An example for a descending configuration: After reaching channel 1, the routine goes back to channel 31 or 23 and then decrements the count from there.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-311
Dial Commands isdn bchan-number-order
Examples
The following example configures the outgoing B-channel order on a PRI interface to be in ascending order. The router will select the lowest available B channel beginning with channel B1.
interface serial 5:10 isdn bchan-number-order ascending
The following example configures the outgoing B-channel order on a PRI interface to be round-robin in ascending order.
interface serial 4:23 isdn bchan-number-order ascending round-robin
Cisco IOS Dial Technologies Command Reference
DIA-312
November 2009
Dial Commands isdn busy
isdn busy
To set a false busy signal on an ISDN B channel, use the isdn busy command in interface configuration mode. To remove this condition, use the no form of this command. isdn busy dsl number b_channel number no isdn busy dsl number b_channel number
Syntax Description
dsl number
Digital subscriber loop (DSL) number.
b_channel number B channel or range of B channels to be set to the false busy signal. B channel numbers range from 1 to 24; 0 indicates the entire interface. The state of the channel, which is obtained using the show isdn command with the status keyword, can also be added to the command.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 12.0
Modification This command was introduced.
Usage Guidelines
This command gives the impression that a call is active when the channel is actually idle. Use the b_channel 0 keywords to set a false busy signal on the entire interface. Use the show isdn command with the status keyword to display the DSL number and channel state.
Examples
The following example sets the entire PRI interface to a false busy signal; the DSL number was obtained using the show isdn command with the status keyword, and then used in the command.
isdn busy dsl 3 b_channel 0 state 1
The following example sets the false busy signal on B channel 11; the DSL number was obtained using the show isdn command with the status keyword, and then used in the command.
isdn busy dsl 3 b_channel 11 state 2
Related Commands
Command isdn service
Description Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-313
Dial Commands isdn busy
Cisco IOS Dial Technologies Command Reference
DIA-314
November 2009
Dial Commands isdn call interface
isdn call interface
The isdn call interface command is replaced by the isdn test call interface command. See the isdn test call interface command for more information.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-315
Dial Commands isdn caller
isdn caller
To configure ISDN caller ID screening and optionally to enable ISDN caller ID callback for legacy dial-on-demand routing (DDR), use the isdn caller command in interface configuration mode. To disable this feature, use the no form of this command. isdn caller phone-number [callback] [exact] no isdn caller phone-number [callback] [exact]
Syntax Description
phone-number callback exact
Remote telephone number for which to screen. Use the letter X to represent a single “don’t care” digit. The maximum length of each number is 25 digits. (Optional) Enables callback. (Optional) Performs matching on incoming telephone number exactly as entered.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 10.0 11.2F 12.1
Modification This command was introduced. This command was implemented on additional Cisco router and access server platforms. The exact keyword was added.
Usage Guidelines
This command configures the router to accept calls from the specified number.
Note
Caller ID screening requires a local switch or router that is capable of delivering the caller ID to the router. If you enable caller ID screening but do not have such a switch or router, no calls are allowed in. Caller ID screening is available on Cisco 7200 and 7500 series, Cisco 4000 series, Cisco 3000 series, and Cisco 2500 series routers that have one or more BRIs. When the optional callback keyword is used and a call is received from one of the callback numbers, the initial call is rejected (hence, not subject to tolls) and a callback is initiated to that calling number. When Xs are used in the callback number, dialer caller screening is based on a best match system that uses the number of Xs as a criterion. To make callback calls only to specified numbers or ranges of numbers but to accept any other incoming calls, make sure that the number of Xs in any configuration line that uses the callback keyword is less than the number of Xs in any configuration line that does not use the keyword. For example, if you use at most four Xs in the configuration lines with the callback keyword, then to accept calls from other numbers use at least five Xs in a configuration line that does not use the keyword.
Cisco IOS Dial Technologies Command Reference
DIA-316
November 2009
Dial Commands isdn caller
When a telephone number is entered without the exact keyword, the software compares each number going from right to left until matching numbers are detected. For example, if the phone-number argument is 4085550134, calls from telephone numbers 0134, 50134, 5550134, and 4085550134 would be accepted, but calls from telephone numbers 44 and 4155550134 would be rejected. If you want to accept a telephone number exactly as it is configured, enter it with the exact keyword. For example, if the phone-number argument is 5550112 and the exact keyword is applied, only the telephone number 5550112 is accepted; calls from telephone numbers 408550112 and 50112 would be rejected. The maximum length of each telephone number is 25 characters. There is no limit on the numbers you can specify per interface.
Examples
The following example configures the router to accept a call containing the numbers 415 555-0134:
isdn caller 4155550134
The following example configures the router to accept a call only from telephone number 555-0134:
isdn caller 5550134 exact
In the above example, a call from telephone number 415 555-0134 would be rejected. The following example configures the router to accept a call with telephone number containing 415 555-01 and any numbers in the last two positions:
isdn caller 41555501xx
In the following example, callback calls will be made only to numbers in the 555 exchange, but any other telephone number can call in:
isdn caller 408555xxxx callback isdn caller xxxxx
Related Commands
Command show dialer
Description Displays general diagnostic information for interfaces configured for DDR.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-317
Dial Commands isdn calling-number
isdn calling-number
To configure an ISDN PRI or BRI interface to present the number of the device making the outgoing call, use the isdn calling-number command in interface configuration mode. To remove a previously configured calling number, use the no form of this command. isdn calling-number calling-number no isdn calling-number
Syntax Description
calling-number
Number of the device making the outgoing call; only one entry is allowed.
Command Default
No calling number is presented.
Command Modes
Interface configuration
Command History
Release 10.3
Modification This command was introduced.
Usage Guidelines
An interface can have only one ISDN calling-number entry. For ISDN BRI, this command is intended for use when the ISDN network offers TS014 tariffing, in which devices present the calling (billing) number. For ISDN PRI, this command is intended for use when the network offers better pricing on calls in which devices present the calling number (that is, the billing number). The calling number information is included in the outgoing setup message.
Note
This command cannot be used with German 1TR6 ISDN BRI switches. It can be used with all other switches, including all ISDN PRI switches.
Examples
The following example first configures the T1 interface, then configures the D channel interface to present the billing number 4233570925 when it makes outgoing calls:
controller t1 1/1 framing esf linecode b8zs pri-group timeslots 1-23 isdn switchtype primary-4ess ! interface serial 1/1:23 ip address 10.1.1.1 255.255.255.0 encapsulation ppp isdn calling-number 4233570925 dialer map ip 10.1.1.2 name mymap 14193460913
Cisco IOS Dial Technologies Command Reference
DIA-318
November 2009
Dial Commands isdn calling-number
In the following example, the ISDN BRI interface is configured to present the number 5550112 when it makes outgoing calls:
interface bri 0 isdn calling-number 5550112
Related Commands
Command interface dialer interface serial
Description Configures a BRI interface and enters interface configuration mode. Specifies a serial interface created on a channelized E1 or channelized T1 controller (for ISDN PRI, CAS, or robbed bit signaling).
Cisco IOS Dial Technologies Command Reference November 2009
DIA-319
Dial Commands isdn calling-party-num
isdn calling-party-num
To specify whether the network-provided or user-provided calling party number is selected when two calling party numbers are sent from a primary NET5 switch on ISDN, use the isdn calling-party-num command in interface configuration mode. To reset the default value, use the no form of this command. isdn calling-party-num {network-provided | user-provided} [first | last] no isdn calling-party-num
Syntax Description
network-provided user-provided first last
Network-provided calling party number. User-provided calling party number. (Optional) Specifies that the first number provided as the calling number information element (IE) should be used to display the calling party number. (Optional) Specifies that the last number provided as the calling number IE should be used to display the calling party number.
Command Default
The first user-provided calling party number is used to display the calling party number.
Command Modes
Interface configuration
Command History
Release 12.2 12.3(7)T 12.3(7)
Modification This command was introduced for the primary ISDN NET5 switch. The first and last keywords were added and this command was integrated into this release. This command was integrated into this release.
Usage Guidelines
The isdn calling-party-num command is useful for customers who use network-provided and user-provided calling party numbers for accounting purposes. The selected number will be used by dialer filters, such as those configured with the isdn caller command. Use the optional first and last keywords for instances when more than one calling number is sent. By default, the first number is used, and subsequent numbers are not recognized. If you specify last in the command syntax, the last calling number displays in the caller ID display. An example application of the last keyword can be seen in an enterprise customer using multiple 800 numbers in an intelligent network service from a PSTN service provider. If a PSTN user dials (from 919-555-1111, for example) the customer’s 800 number, the PSTN service provider routes the call to the customer's telephone number (for example, 408-555-0100) based on the 800 number. The incoming ISDN SETUP message from the PSTN has two user-provided calling party IEs:
• •
The 800 number that the user dialed The calling party number of the PSTN user (919-555-1111)
Cisco IOS Dial Technologies Command Reference
DIA-320
November 2009
Dial Commands isdn calling-party-num
Because the Cisco IOS gateway always uses the first user-provided calling party number by default, the IP phone user is able to see only the 800 number and not the actual calling party number of the PSTN user, unless the last keyword is entered in the command syntax.
Examples
The following example shows how to configure the ISDN switch to accept network-provided calling party numbers. If more than one number is provided, the last number provided is used as the calling party number:
interface Serial0:23 no ip address encapsulation ppp dialer rotary-group 1 isdn switch-type primary-net5 isdn protocol-emulate network isdn incoming-voice modem isdn calling-number 1111111 isdn calling-party-num network-provided last isdn T310 40000 no cdp enable
Related Commands
Command isdn caller isdn calling-number
Description Configures ISDN caller ID screening and optionally enables ISDN caller ID callback for legacy DDR. Configures an ISDN PRI or BRI interface to present the number of the device making the outgoing call.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-321
Dial Commands isdn channel-id invert extended-bit
isdn channel-id invert extended-bit
To invert the value of the extend bit (0x80) in the last octet of the channel ID information element, use the isdn channel-id invert extended-bit command in interface configuration mode. To restore the default setting, use the no form of this command. isdn channel-id invert extended-bit no isdn channel-id invert extended-bit
Syntax Description
This command has no arguments or keywords.
Command Default
The last octet of the channel ID information element is not inverted.
Command Modes
Interface configuration
Command History
Release 12.2
Modification This command was introduced.
Usage Guidelines
Use this command if you use a primary-DMS 100 switch type to ensure compatibility with a Setup or Call Proceeding message containing a channel ID information element. This command can be used only with ISDN PRI. This command replaces the isdn-flip-chan-flag command.
Examples
The following example configures the router to invert the extended bit in the last octet of the channel ID information element:
isdn channel-id invert extended-bit
Cisco IOS Dial Technologies Command Reference
DIA-322
November 2009
Dial Commands isdn conference-code
isdn conference-code
To activate three-way call conferencing, use the isdn conference-code command in interface configuration mode. To disable three-way call conferencing, use the no form of this command. isdn conference-code code no isdn conference-code
Syntax Description
code
Number from 0 to 999 (ISDN conference code).
Command Default
The default code is 60.
Command Modes
Interface configuration
Command History
Release 12.0(3)T
Modification This command was introduced.
Usage Guidelines
Use this command if your ISDN line is connected to an NI1 or a Nortel DMS-100 Custom switch. Your telephone service provider should provide an ISDN conference code when you order three-way call conferencing.
Examples
The following example specifies 61 as the ISDN conference code:
isdn conference-code 61
Cisco IOS Dial Technologies Command Reference November 2009
DIA-323
Dial Commands isdn disconnect interface
isdn disconnect interface
The isdn disconnect interface command is replaced by the isdn test disconnect interface command. See the isdn test disconnect interface command for more information.
Cisco IOS Dial Technologies Command Reference
DIA-324
November 2009
Dial Commands isdn disconnect-cause
isdn disconnect-cause
To send a specific ISDN cause code to the switch, use the isdn disconnect-cause command in interface configuration mode. To return to the default condition, use the no form of this command. isdn disconnect-cause {cause-code-number | busy | not-available} no isdn disconnect-cause
Syntax Description
cause-code-number busy not-available
Sends a cause code number (submitted as integer in the range of 1 through 127) to the switch. Sends the USER-BUSY code to the switch. Sends the CHANNEL-NOT-AVAILABLE code to the switch.
Command Default
The default condition is no cause code override. If the isdn disconnect-cause command is not configured, the default cause codes for the application are sent.
Command Modes
Interface configuration
Command History
Release 12.0(5)T
Modification This command was introduced.
Usage Guidelines
The isdn disconnect-cause command overrides specific cause codes (such as modem availability and resource pooling) that are sent to the switch by ISDN applications. When the isdn disconnect-cause command is implemented, the configured cause codes are sent to the switch; otherwise, the default cause codes for the application are sent. ISDN protocol errors are still reflected in the cause codes and are not overridden.
Examples
The following example sends the CHANNEL-NOT-AVAILABLE code to the ISDN switch:
interface serial0:20 isdn disconnect-cause not-available
Related Commands
Command isdn disconnect-cause
Description Sends a specific ISDN cause code to the switch.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-325
Dial Commands isdn fast-rollover-delay
isdn fast-rollover-delay
To control the timing between successive dial attempts, use the isdn fast-rollover-delay command in interface configuration mode. To remove or change a value, use the no form of this command. isdn fast-rollover-delay seconds no isdn fast-rollover-delay
Syntax Description
seconds
Number of seconds between dial attempts.
Command Default
No default timer.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This command provides a timer separate from the dialer wait-for-carrier timer to control the amount of time that elapses before calls are redialed. This delay is provided to allow the old call to be torn down completely before the new call is attempted. The isdn fast-rollover-delay command is necessary on some ISDN switches because the new call may be attempted before the old call is completely torn down, which causes the second call or the callback to fail. Use this command when all the following conditions are true:
• • • •
A BRI has two phone numbers configured, one for each B channel. You are dialing in to this BRI. You have a dialer map or dialer string for each phone number. The first call succeeds but the second call continuously fails.
When these conditions occur, set the isdn fast-rollover-delay command to 5 seconds and try again. A delay of 5 seconds should cover most cases. Configure sufficient delay to make sure that the ISDN RELEASE_COMPLETE message has been sent or received before the fast rollover call is made. Use the debug isdn q931 command to display this information. When the isdn fast-rollover-delay command is configured on a client requesting callback, the callback client first confirms whether the callback server has placed a call back to the callback client before dialing any subsequent numbers.
Cisco IOS Dial Technologies Command Reference
DIA-326
November 2009
Dial Commands isdn fast-rollover-delay
Examples
The following partial example sets the fast-rollover delay that is suggested when all the conditions specified in the list in the “Usage Guidelines” are true:
isdn fast-rollover-delay 5
Related Commands
Command dialer map dialer wait-for-carrier-time (map-class) ppp callback (DDR)
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Specifies the length of time to wait for a carrier when dialing out to the dial string associated with a specified map class. Enables a dialer interface that is not a DTR interface to function either as a callback client that requests callback or as a callback server that accepts callback requests.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-327
Dial Commands isdn flip-chan-flag
isdn flip-chan-flag
The isdn flip-chan-flag command is replaced by the isdn channel-id invert extended-bit command. See the isdn channel-id invert extended-bit command for more information.
Cisco IOS Dial Technologies Command Reference
DIA-328
November 2009
Dial Commands isdn guard-timer
isdn guard-timer
To enable a managed timer for authentication requests, use the isdn guard-timer command in interface configuration mode. To reset the timer to its default value, use the no form of this command. isdn guard-timer milliseconds [on-expiry {accept | reject}] no isdn guard-timer
Syntax Description
milliseconds on-expiry accept reject
Number of milliseconds that the network access server (NAS) waits for a response from the AAA security server. The valid range is from 1000 through 20,000. (Optional) Determines whether calls are accepted or rejected after the specified number of milliseconds has expired. If no expiry action is selected, calls are rejected. (Optional) Calls are accepted if the guard-timer expires before AAA responds. (Optional) Calls are rejected if the guard-timer expires before AAA responds.
Command Default
The default timer value is eight (8) seconds and calls are rejected when the timer expires.
Command Modes
Interface configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
The guard-timer starts when the DNIS number is sent to AAA for authentication. When the timer expires, authentication ends and the call is accepted or rejected based on the configured expiry action.
Examples
The following example sets the guard-timer to six (6) seconds and specifies that the call should be rejected if AAA does not respond within that interval:
interface serial 1/0/0:23 isdn guard-timer 6000 on-expiry reject
Related Commands
Command aaa preauth
Description Enables authentication using DNIS numbers.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-329
Dial Commands isdn incoming alerting add-PI
isdn incoming alerting add-PI
To add a Progress Indicator (PI) in an incoming ALERTING messages during ISDN B-channel cut-through, use the isdn incoming alerting add-PI command in interface configuration mode. To remove the indicator, use the no form of this command. isdn incoming alerting add-PI no isdn incoming alerting add-PI
Syntax Description
This command has no arguments or keywords.
Command Default
On North American ISDN switches, the default behavior is to add the PI in incoming ALERTING messages. On ISDN switches compliant with the European Telecommunications Standards Institute (ETSI), the default behavior is to not add the PI in incoming ALERTING messages.
Command Modes
Interface configuration
Command History
Release 12.3
Modification This command was introduced for ISDN BRI and PRI interfaces.
Usage Guidelines
The isdn incoming alerting add-PI and no isdn incoming alerting add-PI commands provide a way for switch types conforming to different standards to handle B-channel cut-through. These commands apply to both ISDN BRI and PRI connections. North American switch types such as the 5ESS, 4ESS, DMS, and NI allow cut-through when an ALERTING message is received. ISDN B-channel cut-through for customer premises equipment (CPE) should happen upon receipt of a channel ID Information Element (IE) in the CALL_PROC message. For this reason, the default on North American ISDN switches is to add the PI in incoming ALERTING message. On ETSI-compliant ISDN switches, the default behavior is to not add the PI in incoming ALERTING messages. But ETSI also specifies that when the remote device is playing tones or announcements, it should also include the PI in the ALERTING message. This is not the default behavior for ETSI-compliant switches, but the isdn incoming alerting add-PI command allows Cisco IOS software to support this behavior. The isdn incoming alerting add-PI and no isdn incoming alerting add-PI commands can be used on switches that do not want to add the PI in incoming ALERTING messages and on those switches that cannot handle or do not want the PI in incoming ALERTING messages.
Cisco IOS Dial Technologies Command Reference
DIA-330
November 2009
Dial Commands isdn incoming alerting add-PI
Examples
Because the the isdn incoming alerting add-PI command is the default for a North American ISDN switch, the following example shows that when the interface configuration is displayed, the isdn incoming alerting add-PI command is not listed, even if it was explicitly configured:
Router(config)# interface BRI1/0 Router(config-if)# no ip address Router(config-if)# isdn switch-type basic-dms100 Router(config-if)# isdn spid1 40876726760101 5459374 Router(config-if)# isdn spid2 51076726760101 5459375 Router(config-if)# isdn incoming-voice voice Router(config-if)# isdn incoming alerting add-PI Router(config-if)# end Router(config)# end Router# show running interface BRI1/0 Building configuration... Current configuration : 167 bytes ! interface BRI1/0 no ip address isdn switch-type basic-dms100 isdn spid1 40876726760101 5459374 isdn spid2 51076726760101 5459375 isdn incoming-voice voice end
The following example shows that when the the no isdn incoming alerting add-PI command is configured on a North American ISDN switch, the command is listed in the interface configuration:
Router(config)# interface BRI1/0 Router(config-if)# no isdn incoming alerting add-PI Router(config-if)# end Router(config)# end Router# show running interface BRI1/0 Building configuration... Current configuration : 201 bytes ! interface BRI1/0 no ip address isdn switch-type basic-dms100 isdn spid1 4087672676 5459374 isdn spid2 51076726760101 5459375 isdn incoming-voice voice no isdn incoming alerting add-PI end
Because the default for ETSI-compliant ISDN switches is no isdn incoming alerting add-PI, the following example shows that when the the isdn incoming alerting add-PI command is added to the configuration for a NET3 switch, the command is listed in the interface configuration:
Router(config-if)# no ip address Router(config-if)# isdn switch-type basic-net3 Router(config-if)# isdn spid1 40876726760101 5459374 Router(config-if)# isdn spid2 51076726760101 5459375 Router(config-if)# isdn incoming-voice voice Router(config-if)# isdn incoming alerting add-PI Router(config-if)# end Router(config)# end Router# show running interface BRI1/0 Building configuration...
Cisco IOS Dial Technologies Command Reference November 2009
DIA-331
Dial Commands isdn incoming alerting add-PI
Current configuration : 165 bytes ! interface BRI1/0 no ip address isdn switch-type basic-net3 isdn spid1 40876726760101 5459374 isdn spid2 51076726760101 5459375 isdn incoming-voice voice isdn incoming alerting add-PI end
If the configuration for the NET3 switch were changed back to contain no isdn incoming alerting add-PI, the command would not be listed in the interface configuration, because this is the default behavior for ETSI-compliant switches:
Current configuration : 165 bytes ! interface BRI1/0 no ip address isdn switch-type basic-net3 isdn spid1 40876726760101 5459374 isdn spid2 51076726760101 5459375 isdn incoming-voice voice end
Cisco IOS Dial Technologies Command Reference
DIA-332
November 2009
Dial Commands isdn incoming ie
isdn incoming ie
To specify that the channel-id and display information elements (IEs) may be accepted in incoming ISDN messages, use the isdn incoming ie command in interface configuration mode. To indicate that one of these IEs may not be accepted in incoming ISDN messages, use the no form of this command. isdn incoming ie {channel-id [accept-qsig-variant] | display {dms250 | transparent}} [redirecting-selection {first | last}] no isdn incoming ie {channel-id [accept-qsig-variant] | display {dms250 | transparent}} [redirecting-selection {first | last}]
Syntax Description
channel-id accept-qsig-variant
Information element pertaining to the channel ID. (Optional) Specifies that the ISDN D channel supports QSIG switches that send a variant (the D-channel selector bit is not set) of the normal channel ID IE usage for calls that are “signaling only.” Information element pertaining to the text display. (Optional) Configures the router to accept the ISDN incoming message when octet 3 of the display IE has been modified for compatibility with the DMS-250 switch type.
Note
display dms250
This keyword is available only when the display keyword is entered. This option controls the handling of octet 3 of the display IE in the incoming message, and applies only when DMS-100 or DMS-250 switches must interoperate with other switch types.
transparent
(Optional) Configures the router to accept the ISDN message when the display IE has been packed in the incoming message without modifying or inserting octet 3. This is the default behavior for non-DMS switches.
Note
This keyword is available only when the display keyword is entered. This option controls the handling of octet 3 of the display IE in the incoming message, and applies only when DMS-100 or DMS-250 switches must interoperate with other switch types.
redirecting-selection
(Optional) Selects the first or the last redirect number (RDN) when multiple RDN IEs are received on an incoming ISDN call. The first keyword selects the first RDN received; the last keyword selects the last RDN received.
Note
The first and last keywords are available only when the redirecting-selection keyword is entered.
Command Default
Supported IEs are accepted in applicable incoming messages by default. The channel ID does not accept IEs with the QSIG variant, and the display IE for DMS-250 (transparent) is not altered. When multiple RDN IEs are received on an incoming ISDN call, the last RDN is automatically selected.
Command Modes
Interface configuration
Cisco IOS Dial Technologies Command Reference November 2009
DIA-333
Dial Commands isdn incoming ie
Command History
Release 12.3(7)T 12.4(7) 12.4(8)
Modification This command was introduced. The accept-qsig-variant keyword was added. The redirecting-selection, first, and last keywords were added.
Usage Guidelines
Incompatibility between ISDN switch types at the originating and terminating gateways can prevent provided IEs from being passed end-to-end. Cisco devices can be configured to transparently accept incoming unsupported IEs, allowing full interworking between different switch types. Use the isdn incoming ie command to configure a Cisco router to transparently accept unsupported IEs to its peer. IEs may be sent in any codeset. However IEs can be manually controlled using only the isdn incoming ie command when they are sent in codeset 0. IEs will be accepted only in applicable message types. To configure the router so it will not accept channel ID and display IEs, use the no isdn incoming ie command.
Note
If the isdn gateway-max-interworking command is enabled, IEs that are invalid for some destination switch types may be passed. This can result in the occurrence of undesirable events.
Note
If the isdn protocol-emulate command is switched between the network and user configurations, the isdn outgoing ie command reverts to its default setting. The isdn outgoing ie command must be reissued to restore the manual configuration.
Examples
The following example configures the serial interface for the QSIG D channel to accept “malformed” channel-id IEs:
interface se3/0:3:23 isdn incoming ie channel-id accept-qsig-variant end
The following example configures the serial interface to select the first RDN IE when multiple RDN IEs are received on an incoming ISDN call:
interface se3/0:3:23 isdn incoming ie redirecting-selection first end
Related Commands
Command isdn gateway-maxinterworking isdn outgoing ie isdn protocol-emulate
Description Prevents an H.323 gateway from checking for ISDN protocol compatibility and dropping IEs in call messages. Specifies that an IE may be passed in outgoing ISDN messages. Configures an ISDN data or voice port to emulate network or user functionality.
Cisco IOS Dial Technologies Command Reference
DIA-334
November 2009
Dial Commands isdn incoming-voice
isdn incoming-voice
To route all incoming voice calls to the modem and determine how they will be treated, use the isdn incoming-voice command in interface configuration mode. To disable the setting or return to the default, use the no form of this command. isdn incoming-voice {voice | data [56 | 64] | modem [56 | 64]} no isdn incoming-voice {voice | data [56 | 64] | modem [56 | 64]}
Syntax Description
voice data
Incoming voice calls bypass the modems and be handled as a voice call. Incoming voice calls bypass the modems and will be handled as digital data. If the data keyword is selected, you can specify a B-channel bandwidth of either 56 kbps or 64 kbps. Incoming voice calls are passed over to the digital modems, where they negotiate the appropriate modem connection with the far-end modem. If this keyword is selected, you can specify a B-channel bandwidth of either 56 kbps or 64 kbps. If no argument is entered, the default value is 64.
modem
Command Default
If you do not enter the 56 or 64 keywords after the data keyword, the default value will be 64 kbps.
Command Modes
Interface configuration
Command History
Release 11.1 11.1AA 12.0(2)XC 11.2 11.3NA 12.0(3)T
Modification This command was introduced for ISDN PRI interfaces. This command was implemented on ISDN BRI interfaces. This command was implemented on ISDN BRI interfaces. This command was enhanced for channelized T1 and integrated into Cisco IOS Release 11.2. This command was implemented on additional Cisco router and access server platforms. This command was implemented on additional Cisco router and access server platforms.
Usage Guidelines
Unless you specify otherwise, all calls received by the router and characterized as voice calls are treated as normal ISDN calls, which are handled as digital data and not passed over to the modem. Ordinarily, a data device ignores incoming voice calls, but the tariff structure for data and voice calls might make it less expensive to do “data over voice” calls. If you use the voice keyword, incoming ISDN voice calls will be treated as voice calls and handled by either a modem or a voice DSP as directed by CSM. If the default value is configured and the bearer capability of the incoming call is the voice keyword, the call will be rejected.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-335
Dial Commands isdn incoming-voice
To answer incoming voice calls at a configured rate (overriding the incoming data rate in the call), use the data keyword. To establish speedier connections for analog calls to the router, use the isdn incoming-voice command with the modem keyword to have voice calls routed through digital modems (as pulse-code modulated analog data) instead of being treated as digital data. Configure this command on each D channel in the access server or router. Incoming circuit-switched data calls are not affected by this command.
Note
Use the isdn incoming-voice modem command only when you are using ISDN. You must use this command to carry voice over a modem when using ISDN PRI.
Examples
The following example designates incoming ISDN voice calls to be treated as voice calls:
interface 10 isdn incoming-voice voice
The following example for channelized T1 configures the D channel (hence, all B channels) to answer all incoming voice calls at 56 kbps:
interface serial 0:23 isdn incoming-voice data 56
The following example routes all incoming voice calls through the modem as analog data:
interface BRI 0/0 isdn incoming-voice modem
The following example enables incoming and outgoing ISDN calls to route to the modems using the D channel serial interface:
interface serial 0:23 isdn incoming-voice modem
Cisco IOS Dial Technologies Command Reference
DIA-336
November 2009
Dial Commands isdn layer1-emulate
isdn layer1-emulate
To configure the Layer 1 operation of a BRI voice port as clock master (NT) or slave (TE), use the isdn layer1-emulate command in interface configuration mode. To restore the default (user), use the no form of this command. isdn layer1-emulate {user | network} no isdn layer1-emulate
Syntax Description
user network
Physical interface operation in clock slave mode (as TE). Physical interface operation in clock master mode (as NT).
Command Default
Layer 1 port operation is as user (TE functionality as clock slave).
Command Modes
Interface configuration
Command History
Release 12.0(3)XG 12.1(3)XI
Modification This command was introduced on the MC3810. This command was implemented on the Cisco 2600 and Cisco 3600 series.
Usage Guidelines
If you use the no isdn layer1-emulate network command, the physical layer port operation defaults to user.
Examples
The following example configures the Layer 1 operation of a BRI voice port as QSIG clock slave (TE):
configure terminal interface bri 1 isdn layer1-emulate user
Related Commands
Command isdn protocol-emulate (dial)
Description Configures the Layer 2 and Layer 3 port protocol of a BRI voice port or a PRI interface to emulate NT (network) or TE (user) functionality.
network-clock-priority Specifies the clock-recovery priority for the BRI voice ports in a BVM.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-337
Dial Commands isdn layer2-flap
isdn layer2-flap
To send RESTART or STATUS ENQUIRY messages over the ISDN PRI line when a Layer 2 link flap and recovery occurs, use the isdn layer2-flap command in interface configuration mode. To disable sending these messages, use the no form of this command. isdn layer2-flap {restart | status-enq} no isdn layer2-flap {restart | status-enq}
Syntax Description
restart status-enq
Sends a RESTART message to the remote peer. Sends a STATUS-ENQUIRY message to the remote peer.
Command Default
This command is disabled by default, in which case, no RESTART or STATUS-ENQUIRY messages are sent in the event of a Layer 2 flap and recovery.
Command Modes
Interface configuration
Command History
Release 12.4(15)T
Modification This command was introduced.
Usage Guidelines
When you include the isdn layer2-flap command in the ISDN configuration, the router (as a user agent) sends a RESTART or STATUS-ENQUIRY message to the remote peer when a Layer 2 flap and recovery occurs. This notification enhances the gateway’s ability to gracefully recover from a Layer 2 flap or failure error condition. This graceful recovery frees gateway resources to handle future calls and to increase the call completion rate. Use the isdn layer2-flap command with the isdn timer t309 command in your configuration. The isdn timer t309 command enables the router to hold or drop calls. The effect of using these two commands in the event of a Layer 2 flap and recovery is summarized as follows:
• •
Layer 2 failure and then a Layer 2 recovery before the T309 timer expires (with T309 timer enabled)—STATUS-ENQUIRY message Layer 2 failure and then a Layer 2 recovery after the T309 timer expires or with the T309 timer not enabled—RESTART message
Examples
The following example shows how to enable the router to send a RESTART message when a Layer 2 flap or failure error condition occurs and recovery happens after the T309 timer has expired (or the T309 timer is not enabled):
isdn layer2-flap restart
Cisco IOS Dial Technologies Command Reference
DIA-338
November 2009
Dial Commands isdn layer2-flap
Related Commands
Command isdn timer t309
Description Changes the value of the T309 timer to clear the network connection and to release the B channel and call reference when a data-link disconnection occurs.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-339
Dial Commands isdn leased-line bri
isdn leased-line bri
To configure an ISDN BRI for leased-line service, or to configure both 64-kbps leased-line and ISDN service on the same BRI, use the isdn leased-line bri command in global configuration mode. To remove or change channel configurations, use the no form of this command. isdn leased-line bri number/number [b1 | b2 | 128 | 144 | Return-key] no isdn leased-line bri number/number [b1 | b2 | 128 | 144 | Return-key]
Syntax Description
number/number b1 b2 128 144 Return-key
BRI interface numbers (enter the slash to separate the physical interface numbers). (Optional) Uses channel B1 as a 64-kbps leased line and channel B2 for ISDN service on a single ETSI NET3 switch on a Cisco 800 series router. (Optional) Uses channel B2 as a 64-kbps leased line and channel B1 for ISDN service on a single ETSI NET3 switch on a Cisco 800 series router. (Optional) Combines B1 and B2 channels for 128-kbps leased-line service. (Optional) Combines B1 and B2 channels for 144-kbps leased-line service. (Optional) Configures two 64-kbps leased lines instead of two B channels. Press the Return or Enter key at the end of the isdn leased-line bri number/number command instead of entering a keyword.
Command Default
Disabled
Command Modes
Global configuration
Command History
Release 11.2F 12.2(4)T
Modification This command was introduced. The b1 and b2 keywords were added to allow the BRI channels on an ETSI NET3 switch on a Cisco 800 series router to be split into leased-line and ISDN services.
Usage Guidelines
Use the isdn leased-line bri command to configure an ISDN BRI for leased-line service by aggregating two BRI B channels into a single pipe at a speed of 128 or 144 kbps, or configuring both a 64-kbps leased line and ISDN service on a single European Telecommunications Standards Institute (ETSI) NET3 switch on Cisco 800 series routers. This command also supports two separate 64-kbps leased lines, where the BRI interface is configured as two separate leased lines instead of two B channels. No keyword is required for this configuration; just press the Return or Enter key at the end of the isdn leased-line bri number/number command string. This configuration is different than using the 128 keyword, which configures a single 128-kbps leased line. When you use the no isdn leased-line bri command to change the channel configuration, you must also perform a system reload in order for the change to take effect.
Cisco IOS Dial Technologies Command Reference
DIA-340
November 2009
Dial Commands isdn leased-line bri
When you use an ISDN BRI interface for access over leased lines, configure the ISDN BRI as a synchronous serial interface and do not configure ISDN calling and called numbers.
Examples
The following example configures the BRI interface for leased-line access at 128 kbps in Japan:
isdn leased-line bri0/0 128
Because of the leased-line—not dialed—environment, configuration of ISDN called and calling numbers is not needed and not used. The BRI 0 interface is henceforth treated as a synchronous serial interface, with the default High-Level Data Link Control (HDLC) encapsulation. The following example configures BRI channel B1 for 64-kbps leased-line service and channel B2 for ISDN service:
isdn switch-type basic-net3 isdn leased-line bri0/0 b1 ! interface bri0/0 ip address 10.1.1.1 255.255.255.0 no ip address dialer pool-member 1 interface bri0/0:1 ip address 10.1.1.2 255.255.255.0 encapsulation ppp no ip address
The following example configures two 64-kbps leased lines:
isdn leased-line bri0/0
Related Commands
Command isdn switch-type (BRI)
Description Specifies the central office switch type on the ISDN BRI interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-341
Dial Commands isdn logging
isdn logging
To enable logging of ISDN syslog messages, use the isdn logging command in global configuration mode. To disable logging, use the no form of this command. isdn logging no isdn logging
Syntax Description
This command has no arguments or keywords.
Command Default
This command is disabled by default.
Command Modes
Global configuration
Command History
Release 12.3(1)
Modification This command was introduced.
Usage Guidelines
This command supports syslog logging of the following ISDN events:
• • •
ISDN Layer 2 Up and Down events at severity 3. ISDN SERV, SERV ACK, RESTART, RESTART ACK, and STATUS ENQ messages at severity 4. ISDN SERV status audit messages for various triggers at different severities.
Examples
The following example shows how to configure ISDN syslog logging:
isdn logging
Related Commands
Command isdn bchan-number-order isdn protocol-emulate
Description Configures an ISDN PRI interface to make outgoing call selection in ascending, descending, or round-robin order. Configures an ISDN data or voice port to emulate network or user functionality.
Cisco IOS Dial Technologies Command Reference
DIA-342
November 2009
Dial Commands isdn map
isdn map
To override the default ISDN type and plan generated by the router with custom values, use the isdn map command in interface configuration mode. To revert to the default ISDN type and plan, use the no form of this command. isdn map address {{address | reg-exp} plan plan type type | transparent} no isdn map address {{address | reg-exp} plan plan type type | transparent}
Syntax Description
address address
Specifies that the default ISDN type and plan will be overridden. Address map, which can be to either the calling number or the called number. This argument specifies the address for which the ISDN type and plan will be overridden. Regular expression for pattern matching. This argument specifies that the ISDN type and plan will be overridden for addresses that match the regular expression. ISDN numbering plan. Valid values for the plan argument are as follows:
• • • • • • • • •
reg-exp plan plan
any—Any type of dialed number. data—X.121 data numbering plan. ermes—European Radio Message System numbering plan. isdn—E.164 ISDN/Telephony numbering plan. national—Number called to reach a subscriber in the same country, but outside the local network. private—Private numbering plan. reserved—Reserved for extension. telex—F.69 telex numbering plan. unknown—Number of a type that is unknown by the network. abbreviated—Abbreviated representation of the complete number as supported by this network. any—Any type of called number. international—Number called to reach a subscriber in another country. national—Number called to reach a subscriber in the same country, but outside the local network. network—Administrative or service number specific to the serving network. reserved—Reserved for extension. subscriber—Number called to reach a subscriber in the same local network. unknown—Number of a type that is unknown by the network.
type type
ISDN number type. Valid values for the type argument are as follows:
• • • • • • • •
transparent
Specifies that the ISDN type and plan values received in raw messages from the ISDN originating gateway will take priority over the ISDN type and plan values received in the H.225 SETUP messages.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-343
Dial Commands isdn map
Command Default
The default is the ISDN type and plan generated by the router.
Command Modes
Interface configuration
Command History
Release 12.0(6)T 12.3(7)T
Modification This command was introduced. The transparent keyword was added.
Usage Guidelines
The default ISDN type and plan can be overridden with custom values on a per-number basis or for numbers that match regular expression patterns. If you use the isdn map command to configure custom values for the ISDN type and plan, these values take priority over any other ISDN type and plan values. The order of precedence for ISDN type and plan values is as follows, beginning with the highest precedence:
• • • •
Type and plan values configured with the isdn map command. Type and plan values from voice translation rules specified with the rule (voice translation-rule) command. Values received in the H.225 SETUP messages. Values received from the ISDN originating gateway in raw messages.
Configuring the isdn map command with the transparent keyword results in raw messages received from the ISDN originating gateway receiving priority over H.225 SETUP messages. When the isdn map command is configured with the transparent keyword, the order of precedence for ISDN type and plan values is as follows:
• • • •
Type and plan values configured with the isdn map command. Type and plan values from voice translation rules specified with the rule (voice translation-rule) command. Values received from the ISDN originating gateway in raw messages. Values received in the H.225 SETUP messages.
Examples
The following example overrides any plan and type used for any ISDN calls with a called or calling number that exactly matches 123:
interface serial1:23 isdn map address 123 plan isdn type unknown
The following example overrides any plan and type used for ISDN calls with a called or calling number that begins with the numerals 12:
interface serial1:23 isdn map address 12.* plan data type subscriber
The following example matches any number that ends with the number 7:
interface serial1:23 isdn map address .*7 plan data type subscriber
Cisco IOS Dial Technologies Command Reference
DIA-344
November 2009
Dial Commands isdn map
The following example reverses the precedence of ISDN type and plan values received from the ISDN originating gateway and from the H.225 SETUP message:
interface serial1:23 isdn map address transparent
Related Commands
Command rule (voice translation-rule)
Description Defines a translation rule.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-345
Dial Commands isdn modem-busy-cause
isdn modem-busy-cause
The isdn modem-busy-cause command is replaced by the isdn disconnect-cause command. See the isdn disconnect-cause command for more information.
Cisco IOS Dial Technologies Command Reference
DIA-346
November 2009
Dial Commands isdn negotiate-bchan
isdn negotiate-bchan
To enable the router to accept a B channel that is different from the B channel requested in the outgoing call setup message, use the isdn negotiate-bchan command in interface configuration mode. To restore the default condition, use the no form of this command. isdn negotiate-bchan [resend-setup] [cause-codes cause-code1 [cause-code2...cause-code16]] no isdn negotiate-bchan [resend-setup] [cause-codes cause-code1 [cause-code2...cause-code16]]
Syntax Description
resend-setup
(Optional) Enables a single reattempt of a setup message if a disconnect message with a cause code of 44 is received before alerting. Supports NET5 and NI2 PRI switches only. (A Code 44 cause code means that the requested circuit or channel is not available. For more information, refer to the International Telecommunications Union [ITU] Q.850 standard.) (Optional) Specifies up to 16 cause codes that will alert the gateway to reattempt a call. This reattempt may or may not be on the same B channel as the previous attempt. The value of each cause-code argument is a number from 1 to 127 corresponding to an ISDN cause code number. If the cause-codes keyword is entered, at least one cause code must be entered or the command will not be accepted. Separate multiple cause code entries with spaces. Once the cause-codes keyword is entered, cause code 44 will no longer cause a call reattempt unless 44 is specifically entered as one of the cause codes.
Note
cause-codes cause-code
The validity of each cause code is not checked by the gateway.
Command Default
B channel negotiation is not enabled. Most PRI switch types set the default channel ID to Exclusive in the setup message. An exception is the NI2 switch, which sets the default to Preferred. If the cause-codes keyword is not entered, it is assumed that you want ISDN cause code 44.
Command Modes
Interface configuration
Command History
Release 11.3 12.2 12.2(15)T
Modification This command was introduced. The resend-setup keyword was implemented for NET5 and NI2 PRI switches. The cause-codes keyword was implemented on the Cisco AS5350 and Cisco AS5400.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-347
Dial Commands isdn negotiate-bchan
Usage Guidelines
The isdn negotiate-bchan command enables the router to negotiate the B channel by setting the channel ID information element to Preferred in the setup message. If this command is not configured, the channel ID is set to the default of the switch, which is usually Exclusive. Exclusive means that only the requested B channel is accepted. If the requested B channel is not available, the call is cleared. The isdn negotiate-bchan command is supported for all PRI switch types. The resend-setup keyword is supported only for NET5 and NI2 switches. This command is not supported for BRI interfaces. The cause-codes keyword allows you to configure the gateway to reattempt a call when a cause code other than 44 is received from the PSTN. Refer to the “ISDN Cause Codes” table in the appendix of the Cisco IOS Debug Command Reference for a list of ISDN cause codes.
Examples
The following example enables a call to be reattempted when a disconnect with cause code of 44 is received before alerting:
interface serial0:23 isdn negotiate-bchan resend-setup
The following example shows that cause codes 34, 44, and 63 have been configured:
interface serial0:23 isdn negotiate-bchan resend-setup cause-codes 34 44 63
Related Commands
Command
Description
isdn bchan-number-order Configures an ISDN PRI interface to make an outgoing call selection in ascending or descending order. isdn switch-type (PRI) Specifies the Central Office switch type on the ISDN PRI interface.
Cisco IOS Dial Technologies Command Reference
DIA-348
November 2009
Dial Commands isdn not-end-to-end
isdn not-end-to-end
To override the speed that the network reports it will use to deliver the call data, use the isdn not-end-to-end command in interface configuration mode. To disable the configured end-to-end speed, use the no form of this command. isdn not-end-to-end {56 | 64} no isdn not-end-to-end
Syntax Description
56 64
Answers all voice calls at 56 kbps. Answers all voice calls at 64 kbps.
Command Default
The default line speed is 64 kbps.
Command Modes
Interface configuration
Command History
Release 10.3
Modification This command was introduced.
Usage Guidelines
Note
The isdn not-end-to-end command is valid only when an incoming Layer 3 Setup message contains a Progress Information Element in the message. The command is validated on a call-by-call basis, depending upon the message. This command might be needed to handle incoming calls properly. Although a call might originate at a speed of 56 kbps, the network or internetworking networks might improperly deliver the call to the user at a speed of 64 kbps. This creates a speed mismatch and causes the data to be garbled. Enabling this command makes the router look more closely at the information elements of the incoming call to determine a speed. A speed mismatch can occur when the source and destination ISDN ports do not belong to the same network.
Examples
The following example sets the line speed for incoming calls to 56 kbps:
isdn not-end-to-end 56
Cisco IOS Dial Technologies Command Reference November 2009
DIA-349
Dial Commands isdn nsf-service
isdn nsf-service
To configure Network Specific Facilities (NSF) on an ISDN PRI for outgoing calls configured as voice calls, use the isdn nsf-service command in interface configuration mode. To remove NSF on an ISDN PRI, use the no form of this command. isdn nsf-service {megacom | sdn} no isdn nsf-service {megacom | sdn}
Syntax Description
megacom sdn
Dial voice calls using AT&T Megacom NSF. Dial voice calls using AT&T SDN NSF.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 11.3(5)T
Modification This command was introduced.
Usage Guidelines
This command is used specifically on a PRI (channelized T1) to request NSF services supported on primary AT&T 4ESS (primary-4ess) switch types only.
Examples
The following example sets outgoing voice calls to use AT&T SDN NSF:
interface serial 0:23 isdn-nsf-service sdn
Related Commands
Command dialer map dialer voice-call map-class dialer
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites. Configures the dialer map class for an NSF dialing plan to support outgoing voice calls. Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback.
Cisco IOS Dial Technologies Command Reference
DIA-350
November 2009
Dial Commands isdn number
isdn number
To change the maximum number of digits in a called number information element, use the isdn number command in interface configuration mode. isdn number [called enbloc limit]
Syntax Description
called enbloc limit
Attributes for the ISDN number of the called party. Allows the ISDN terminal to send the ISDN number of the called party in a single SETUP message. Maximum number of digits allowed in a SETUP message, in the range from 1 to 32.
Command Default
20 digits
Command Modes
Interface configuration
Command History
Release 12.2
Modification This command was introduced.
Usage Guidelines
The maximum number of digits sent in the initial call SETUP is defaulted to 20 digits. The default of 20 digits chosen because some switches cannot handle more than 20 digits. Some countries in Europe are changing their calling plans and will require calls to be made using more than 20 digits. The isdn number called enbloc command is used when the maximum number of octets in the called number information element in a SETUP message must be changed from the 20-digit default to the user desired limit. With this command, the user can configure the maximum number from 1 to 32 digits. This command is available for ISDN interfaces and applicable to both BRI and PRI interfaces.
Note
This command is enabled for only the following switch types: BRI_NET3_STYPE PRI_NET5_SYTPE
Examples
The following example configures the called number information element for 32 digits:
Router(config-if) isdn number called enbloc 32
Cisco IOS Dial Technologies Command Reference November 2009
DIA-351
Dial Commands isdn outgoing ie
isdn outgoing ie
To specify that an information element (IE) may be passed in outgoing ISDN messages, use the isdn outgoing ie command in interface configuration mode. To specify that an IE may not be passed in outgoing ISDN messages, use the no form of this command. isdn outgoing ie ie [codeset_0 {message message-type | shiftcodeset codeset_6 } | dms250 | nooct3 | transparent] no isdn outgoing ie ie [codeset_0 {message message-type | shiftcodeset codeset_6 } | dms250 | nooct3 | transparent]
Syntax Description
ie codeset_0
The IE to pass in outgoing ISDN messages. Valid values for the ie argument are listed in Table 14. (Optional) Specifies that the IE will be packed in ISDN codeset 0. Codeset 0 is the International Telecommunication Union (ITU) standard codeset. Codeset 0 is the default codeset; however you must issue the codeset_0 keyword if you want to specify a message type. (Optional) Specifies a particular outgoing message to pass an IE in. Valid values for the message-type argument are listed in Table 15. If you do not specify a message type, the IE will be passed in all applicable message types. (Optional) Specifies that octet 3 of the display IE is modified for compatibility with the DMS-250 switch type before it is packed in the setup message.
Note
message message-type
dms250
This keyword is available only when display is entered for the ie argument.This option controls the handling of octet 3 of the display IE in the setup message, and applies only when DMS-100 or DMS-250 switches must interoperate with other switch types. See the “Usage Guidelines” section for more information.
nooct3
(Optional) Specifies that octet 3 of the display IE is stripped from the display IE before it is packed in the setup message. This is the default behavior for DMS-100 and DMS-250 switches.
Note
This keyword is available only when display is entered for the ie argument. This option controls the handling of octet 3 of the display IE in the setup message, and applies only when DMS-100 or DMS-250 switches must interoperate with other switch types. See the “Usage Guidelines” section for more information.
Cisco IOS Dial Technologies Command Reference
DIA-352
November 2009
Dial Commands isdn outgoing ie
transparent
(Optional) Specifies that the display IE is packed in the setup message without modifying or inserting octet 3. This is the default behavior for non-DMS switches.
Note
This keyword is available only when display is entered for the ie argument. This option controls the handling of octet 3 of the display IE in the setup message, and applies only when DMS-100 or DMS-250 switches must interoperate with other switch types. See the “Usage Guidelines” section for more information.
shiftcodeset codeset_6
(Optional) Specifies that the display IE should be packed in codeset 6 in outgoing messages, rather than codeset 0.
Note
This keyword is available only when display is entered for the ie argument, and can be configured only for 4ESS or 5ESS switch types. See the “Usage Guidelines” section for more information.
Command Default
Supported IEs are passed in applicable outgoing messages by default.
Command Modes
Interface configuration
Command History
Release 12.3(7)T
Modification The isdn outgoing ie command was introduced and replaces the isdn outgoing ie redirecting-number command.
Usage Guidelines
Incompatibility between ISDN switch types at the originating and terminating gateways can prevent provided IEs from being passed end-to-end. Cisco devices can be configured to transparently pass unsupported IEs, allowing full interworking between different switch types. Use the isdn outgoing ie command to configure a Cisco router to transparently pass unsupported IEs to its peer. IEs may be packed in any codeset. However, the isdn outgoing ie command can manually control IEs packed in codeset 0 only. IEs will be passed only in applicable message types. The router can be configured to not pass IEs using the no isdn outgoing ie command. You may use the isdn gateway-max-interworking command to globally configure the Cisco router to transparently pass all unsupported IEs to its peer. However, the isdn outgoing ie command provides much finer control.
Note
If the isdn gateway-max-interworking command is enabled, IEs that are invalid for some destination switch types may be passed. This can cause undesirable events to occur.
Note
If the isdn protocol-emulate command is switched between the network and user keyword configurations, the isdn outgoing ie command reverts to its default setting. The isdn outgoing ie command must be reissued to restore the manual configuration.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-353
Dial Commands isdn outgoing ie
Options That Are Specific to the Display IE
DMS-100 and DMS-250 switch types format the display IE using an additional octet that is not used by other switch types, octet 3. Octet 3 specifies the calling party name, and is mandatory for DMS-100 and DMS-250 switch types. DMS-100 and DMS-250 switches each use a different value for octet 3. For these switch types to interoperate properly with each other or with other switch types, octet 3 must be modified. Use the dms250, nooct3, or transparent keyword to control the interoperation of a DMS-100 or DMS-250 switch with other switch types. 4ESS and 5ESS switch types do not support the display IE. If a message with a display IE packed in codeset 0 is passed out of a PRI interface with one of these switch types, the display IE will be dropped. However, these switches will pass any unknown IE that is packed in codeset 6. Use the shiftcodeset codeset_6 keywords to specify that the display IE should be packed in codeset 6 before being sent out a PRI interface with a 4ESS or 5ESS switch. Table 14 lists the IEs that can be entered for the ie argument. Not all IEs can be controlled using the isdn outgoing ie command.
Table 14 ISDN IE Values
IE called-number called-subaddr caller-number caller-subaddr connected-number connected-subaddr display extended-facility facility high-layer-compat low-layer-compat network-facility notify-indicator progress-indicator redirecting-number user-user
IE Description The number the call is placed to. The subadress the call is placed to. The number the call originates from. The subadress the call originates from. If a disconnect occurs during a conference, this indicates the number of the remaining caller. If a disconnect occurs during a conference, this indicates the subadress of of the remaining caller. Information about the text display. Information about extended facility requests. Information about facility requests. Information about higher layer compatibility. Information about lower layer compatibility. Information about network facility requests. Information about notifications. Information about the call in progress. The number that is redirecting the call. Information about the users at either end of the call.
Table 15 lists the ISDN messages that can be entered for the message-type argument.
Table 15 ISDN Outgoing Message Types
Outgoing Message Type alerting callproc
Message Type Description Alerting message. Call proceeding message.
Cisco IOS Dial Technologies Command Reference
DIA-354
November 2009
Dial Commands isdn outgoing ie
Table 15
ISDN Outgoing Message Types (continued)
Outgoing Message Type connect disconnect facility information progress rel_comp release setup setup-ack
Message Type Description Connect message. Disconnect message. Facility message. Information message. Progress message. Release complete message. Release message. Setup message. Setup acknowledge message.
Examples
The following example enables the passing of the redirect number IE in for all applicable outgoing message types for a PRI-NI switch:
interface Serial 0:15 no ip address isdn switch-type primary-ni isdn incoming-voice modem no cdp enable isdn outgoing ie redirecting-number
The following example enables the passing of the called number IE in an outgoing alert message for a PRI-NI switch:
interface Serial 0:15 no ip address isdn switch-type primary-ni isdn incoming-voice modem no cdp enable isdn outgoing ie called-number codeset_0 message alerting
The following example configures a DMS-100 switch to reformat octet 3 for interoperability with a DMS-250 switch:
interface Serial 0:23 no ip address dialer idle-timeout 999999 isdn switch-type primary-dms100 isdn incoming-voice modem no cdp enable isdn outgoing ie display dms250
The following example configures a DMS-100 switch to drop octet from the display IE:
interface Serial0:23 no ip address dialer idle-timeout 999999 isdn switch-type primary-dms100 isdn incoming-voice modem no cdp enable isdn outgoing ie display nooct3
Cisco IOS Dial Technologies Command Reference November 2009
DIA-355
Dial Commands isdn outgoing ie
The following example configures a DMS-100 switch to pack the display IE without modifying octet 3:
interface Serial0:23 no ip address dialer idle-timeout 999999 isdn switch-type primary-dms100 isdn incoming-voice modem no cdp enable isdn outgoing ie display transparent
The following example configures a switch to pack the display IE in codeset 6 before sending it out of an interface configured with a 4ESS switch:
interface Serial 0:23 no ip address isdn switch-type primary-4ess isdn incoming-voice modem no cdp enable isdn outoing ie display codeset_0 shiftcodeset codeset_6
Related Commands
Command isdn gateway max-interworking isdn outgoing display-ie isdn protocol-emulate
Description Prevents an H.323 gateway from checking for ISDN protocol compatibility and dropping IEs in call messages. Enables the display IE to be sent in the outgoing ISDN message if provided by the upper layers, such as voice or modem. Configures an ISDN data or voice port to emulate network or user functionality.
Cisco IOS Dial Technologies Command Reference
DIA-356
November 2009
Dial Commands isdn outgoing ie redirecting-number
isdn outgoing ie redirecting-number
Note
Beginning in Cisco IOS Release 12.3(7)T, the isdn outgoing ie redirecting-number command is replaced by the isdn outgoing ie command. See the isdn outgoing ie command for more information. To enable passing of the redirect number information element (IE) in the setup message from the Cisco router to its peer, use the isdn outgoing ie redirecting-number command in interface configuration mode. To disable passing of the redirect number IE in the setup message from the Cisco router to its peer, use the no form of this command. isdn outgoing ie redirecting-number no isdn outgoing ie redirecting-number
Syntax Description
This command has no arguments or keywords.
Command Default
The redirecting number IE will be passed in the setup message for the following switch types only by default:
• • • • • • •
basic-dms100 basic-ni primary-dms100 primary-4ESS primary-5ESS primary-ni primary-ni2c
For all other switch types, the redirecting number IE will not be passed by default.
Command Modes
Interface configuration
Command History
Release 12.2(15)T5 12.3(7)T
Modification This command was introduced. This command was replaced by the isdn outgoing ie command.
Usage Guidelines
Use the isdn outgoing ie redirecting-number command to enable passing of the redirect number IE in the setup message from the Cisco router to its peer. Some switch types do not support the redirect number IE, so to ensure compatibility with a peer that does support the redirect number IE you may enable the passing of the redirect number IE using the isdn outgoing ie redirecting-number command.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-357
Dial Commands isdn outgoing ie redirecting-number
Note
If the isdn protocol-emulate command is switched between the network and user keyword configurations, the isdn outgoing ie command reverts to its default setting. The isdn outgoing ie command must be reissued to restore the manual configuration.
Examples
The following example enables the passing of the redirect number IE for a NET5 switch on a serial interface:
interface Serial 0:15 isdn outgoing ie redirecting-number
Related Commands
Command isdn outgoing ie isdn protocol-emulate
Description Specifies that an IE should be passed in outgoing ISDN messages. Configures an ISDN data or voice port to emulate network or user functionality.
Cisco IOS Dial Technologies Command Reference
DIA-358
November 2009
Dial Commands isdn outgoing-voice
isdn outgoing-voice
To set information transfer capability on outgoing calls for all switch types, use the isdn outgoing-voice command in interface configuration mode. To revert to the default state, use the no form of this command. isdn outgoing-voice info-transfer-capability {3.1kHz-audio | speech} no isdn outgoing-voice
Syntax Description
info-transfer-capability 3.1kHz-audio speech
Specifies information transfer capability for voice calls. Sets capability to 3.1 kHz audio. Sets capability to speech.
Command Default
No information transfer capabilities set.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
This command is used on outgoing voice calls only, and sets standard information transfer capability.
Examples
The following example sets information transfer capability on outgoing voice calls to speech:
interface serial 0:23 isdn outgoing-voice info-transfer-capability speech
Related Commands
Command isdn incoming-voice
Description Specifies how to process incoming ISDN voice and data calls.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-359
Dial Commands isdn overlap-receiving
isdn overlap-receiving
To enable overlap receiving on an ISDN interface, use the isdn overlap-receiving command in interface configuration mode. To disable overlap receiving on an ISDN interface, use the no form of this command. isdn overlap-receiving [T302 milliseconds] no isdn overlap-receiving
Syntax Description
T302 milliseconds
(Optional) The number of milliseconds that the T302 timer should wait before expiring. Valid values for the milliseconds argument range from 500 to 20000. The default value is 10000 (10 seconds).
Command Default
Overlap receiving is not enabled.
Command Modes
Interface configuration
Command History
Release 12.1
Modification This command was introduced.
Usage Guidelines
In some situations, the default timer value of the T302 timer is too long. You can shorten the duration of the timer by specifying the T302 keyword with the number of milliseconds necessary. When configuring outbound peer matching and overlap receiving, use the isdn overlap-receiving command with the destination-pattern command. You must configure the commands to allow the router to wait for all the digits to be received before the call is routed. To do this, use the T control character after the digits in the destination pattern specified with the destination-pattern command. Optionally, you can shorten the duration of the T302 timer when you specify the isdn overlap-receiving command.
Examples
The following example shows how to enable overlap receiving on the ISDN interface:
interface serial 0:23 isdn overlap-receiving
The following example shows how to enable overlap receiving on the ISDN interface and set the T302 timer to 2 seconds:
interface serial 0:23 isdn overlap-receiving T302 2000
Cisco IOS Dial Technologies Command Reference
DIA-360
November 2009
Dial Commands isdn overlap-receiving
Related Commands
Command destination-pattern isdn service
Description Specifies either the prefix or full E.164 telephone number to be used for a dial peer. Takes an individual B channel or an entire PRI interface out of service or sets it to a different channel service state that is passed in to the switch.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-361
Dial Commands isdn overlap-receiving calltypes all
isdn overlap-receiving calltypes all
To enable overlap receiving for all call types, use the isdn overlap-receiving calltypes all command in interface configuration mode. To disable overlap receiving for all call types, use the no form of this command. isdn overlap-receiving calltypes all no isdn overlap-receiving calltypes all
Syntax Description
This commands has no arguments or keywords.
Command Default
Overlap receiving is not enabled.
Command Modes
Interface configuration
Command History
Release 12.2(13)T
Modification This command was introduced.
Usage Guidelines
The isdn overlap-receiving calltypes all command enables overlap receiving for all nonvoice calls that use data dial peers, and it enables an ISDN interface to proceed with a call when a sufficient number of digits are received. These digits are determined by the destination-pattern command under the data dial peer configuration. This command is supported on the Cisco AS5350, Cisco AS5400, and Cisco AS5850 routers.
Examples
The following example shows how to enable overlap receiving:
interface serial 0:23 isdn overlap-receiving calltypes all
Related Commands
Command destination-pattern dial-peer no-match disconnect-cause isdn overlap-receiving
Description Specifies either the prefix or full E.164 telephone number to be used for a dial peer. Disconnects the incoming ISDN or CAS call when no inbound voice or modem dial peer is matched. Enables overlap receiving on an ISDN interface.
Cisco IOS Dial Technologies Command Reference
DIA-362
November 2009
Dial Commands isdn piafs-enabled
isdn piafs-enabled
To enable the PRI to take Personal Handyphone Internet Access Forum Standard (PIAFS) calls on MICA technologies modems, use the isdn piafs-enabled command in interface configuration mode. To disable the function, use the no form of this command. isdn piafs-enabled no isdn piafs-enabled
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Interface configuration
Command History
Release 12.1(2)XH 12.1(3)T 12.1(5)T 12.2(2)XA
Modification This command was introduced on the Cisco AS5300. This command was integrated into Cisco IOS Release 12.1(3)T. This command was integrated into Cisco IOS Release 12.1(5)T and support was added for the Cisco AS5800. Support was added for PIAFS version 2.1 using Cisco MICA 8.2.3.0 was added.
Note
PIAFS 2.1 is not supported on Cisco AS5800 universal access servers for this release.
12.2(2)XB1 12.2(11)T
This command was implemented on the Cisco AS5800 platform. This command was integrated into Cisco IOS Release 12.2(11)T.
Examples
The following example shows how to enable the PRI to take PIAFS calls:
Router(config)# interface serial 0:23 Router(config-if)# isdn piafs-enabled
Cisco IOS Dial Technologies Command Reference November 2009
DIA-363
Dial Commands isdn point-to-point-setup
isdn point-to-point-setup
To configure the ISDN port to send SETUP messages on the static terminal endpoint identifier (TEI), use the isdn point-to-point-setup command in interface configuration mode. To restore the default, use the no form of this command. isdn point-to-point-setup no isdn point-to-point-setup
Syntax Description
This command has no arguments or keywords.
Command Default
The BRI port sends SETUP messages on the static TEI (TEI 127).
Command Modes
Interface configuration
Command History
Release 12.1(3)XI
Modification This command was introduced.
Usage Guidelines
This command only applies if a static TEI has been activated with the isdn static-tei command.
Examples
The following example configures the BRI port to send SETUP messages on the static TEI:
interface bri 1 isdn point-to-point-setup
Related Commands
Command isdn tei-negotiation (global)
Description Configures when Layer 2 becomes active and ISDN TEI negotiation occurs.
Cisco IOS Dial Technologies Command Reference
DIA-364
November 2009
Dial Commands isdn protocol-emulate
isdn protocol-emulate
To emulate the network side of an ISDN configuration for a PRI Net5 or PRI NTT switch type, use the isdn protocol-emulate command in interface configuration mode. To disable ISDN emulation, use the no form of this command. isdn protocol-emulate {network | user} no isdn protocol-emulate {network | user}
Syntax Description
network user
Network side of an ISDN configuration. User side of an ISDN configuration.
Command Default
No default behavior or values
Command Modes
Interface configuration mode
Command History
Release 12.0(3)XG 12.1(1)T 12.2(2)XB 12.2(2)XB1 12.2(8)T 12.2(11)T 12.3
Modification This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco MC3810 concentrator. This command was introduced in the T train. This command was implemented on the Cisco AS5350 and Cisco AS5400. This command was implemented on the Cisco AS5850. This command was implemented on the Cisco IAD2420 series. This command is not supported on the access servers in this release. This command was implemented on the following platforms: Cisco AS5350, Cisco AS5400, and Cisco AS5850. This command was enhanced to support network emulation capability on the Lucent 4ESS, 5ESS, and Nortel DMS-100 ISDN switch types. These switch types can be configured as a network, but no additional changes were made and not all network side features are supported. Added support for the PRI NTT switch type.
12.3(8)T
Usage Guidelines
• • •
The current ISDN signaling stack can emulate the ISDN network side, but it does not conform to the specifications of the various switch types in emulating the network side. This command enables the Cisco IOS software to replicate the public switched network interface to a Private Branch Exchange (PBX). To emulate NT (network) or TE (user) functionality, use this command to configure the layer 2 and layer 3 port protocol of a BRI voice port or a PRI interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-365
Dial Commands isdn protocol-emulate
•
Use this command to configure the Cisco AS5300 PRI interface to serve as either the primary QSIG slave or the primary QSIG master. To disable QSIG signaling, use the no form of this command; the layer 2 and layer 3 protocol emulation defaults to user. This feature is supported for the PRI Net5 and PRI NTT switch types.
•
Examples
The following example configures the interface (configured for Net5) to emulate the network-side ISDN:
Router(config)# int s0:15 Router(config-if)# isdn protocol-emulate network
The following example configures the layer 2 and layer 3 function of T1 PRI interface 23 to act as the QSIG master (NT):
interface serial 1:23 isdn protocol-emulate network
The following example configures the layer 2 and layer 3 function of a BRI voice port to operate as QSIG slave (TE):
interface bri 1 isdn protocol-emulate user
The following example configures the layer 2 and layer 3 function of an E1 PRI interface to operate as QSIG slave (TE):
interface serial 4:23 isdn protocol-emulate user
Related Commands
Command isdn bchan-number-order isdn logging isdn switch-type (PRI) network-clock-priority pri-group nec-fusion show cdapi show rawmsg
Description Configures an ISDN PRI interface to make outgoing call selection in ascending, descending, or round-robin order. Enables logging of ISDN syslog messages. Specifies the central office switch type on the ISDN PRI interface. Specifies the clock-recovery priority for the BRI voice ports in a BVM. Configures the NEC PBX to support FCCS. Displays the CDAPI. Displays the raw messages owned by the required component.
Cisco IOS Dial Technologies Command Reference
DIA-366
November 2009
Dial Commands isdn reject
isdn reject
To reject an incoming ISDN BRI or PRI call based on type, use the isdn reject command in interface configuration mode. To re-allow the incoming call type, use the no form of this command. isdn reject {cause cause-code | data [56 | 64] | piafs | v110 | v120 | vod | voice [3.1khz | 7khz | speech]} no isdn reject {cause cause-code | data [56 | 64] | piafs | v110 | v120 | vod | voice [3.1khz | 7khz | speech]}
Syntax Description
cause cause-code data [56 | 64]
Rejects call based on cause code value. Rejects incoming data call. If the optional 56 or 64 keyword is not specified, all data calls, including data over voice, are rejected. Use the optional 56 keyword to reject data coming in at 56 kbps. Use the optional 64 keyword to reject data coming in at 64 kbps. Rejects incoming Personal Handyphone Internet Access Forum Standard (PIAFS) calls. Rejects incoming V.110 calls. Rejects incoming V.120 calls. Rejects incoming voice-over-data calls, or calls characterized by 64 kbps unrestricted digital data. Although the bearer capability for these calls indicates an incoming data call, the call is treated as voice over data. See the “Usage Guidelines” for more information. Rejects incoming voice and modem calls characterized by one of three information transfer capability types: 3.1 kHz, 7 kHz, and speech, which are defined by using, in corresponding order, the 3.1khz, 7khz, and speech keywords. If none of the optional keywords is used, all voice calls except voice over data are rejected.
piafs v110 v120 vod
voice [3.1khz | 7khz | speech]
Command Default
Incoming calls are rejected based on D-channel bearer capability information (cause code 65).
Command Modes
Interface configuration
Command History
Release 12.0 12.2
Modification This command was introduced. The cause cause-code keyword and argument were added.
Usage Guidelines
The isdn reject command rejects incoming calls based on D-channel bearer capability information. If this command is configured with the cause cause-code keyword and argument, it will override the default value and use the configured cause code specified to reject the call. For example, if the isdn reject data command is configured so that data calls are rejected with cause code set to 65 (“bearer
Cisco IOS Dial Technologies Command Reference November 2009
DIA-367
Dial Commands isdn reject
capability not implemented” and the default), you can change the cause code to 2, so that data calls will then be rejected with cause code 2. Refer to the ISDN Switch Types, Codes, and Values appendix in the Cisco IOS Debug Command Reference for a list of ISDN cause code values. The settings for the isdn incoming-voice interface configuration command determine how the call is handled based on bearer capability information, as follows:
• • •
isdn incoming-voice voice—Calls bypass the modem and are handled as a voice call. isdn incoming-voice data—Calls bypass the modem and are handled as digital data. isdn incoming-voice modem—Calls are passed to a digital modem and the call negotiates the appropriate modem connection with the far-end modem.
When the ISDN interface is configured for incoming voice with the isdn incoming-voice voice command and the ISDN bearer capability indicates the call as unrestricted digital data (i = 0x8890), the call is handled as voice over data. You can assign as many reject incoming call type statements as needed to reject unwanted calls on the ISDN interface. This command works on any Cisco platform that supports ISDN PRI and BRI interfaces.
Examples
The following example configuration rejects all incoming data and voice-over-data calls but accepts voice calls:
interface serial 2/0:23 no ip address no logging event link-status dialer-group 1 isdn switch-type primary-net5 isdn incoming-voice voice isdn map address 222 plan isdn type national isdn T309 80000 isdn reject data isdn reject vod isdn reject v120 isdn reject v110 isdn reject piafs
The following example sets the ISDN interface to reject incoming PIAFS calls:
interface serial 2/0:23 isdn reject piafs
The following example sets cause code 21 to reject all incoming data calls:
interface serial 2/0:23 isdn reject data isdn reject cause 21
Related Commands
Command isdn incoming-voice
Description Specifies how to process incoming ISDN voice and data calls.
Cisco IOS Dial Technologies Command Reference
DIA-368
November 2009
Dial Commands isdn send-alerting
isdn send-alerting
To specify that an Alerting message be sent before a Connect message when making ISDN calls, use the isdn send-alerting command in interface configuration mode. To disable the Alerting information element, use the no form of this command. isdn send-alerting no isdn send-alerting
Syntax Description
This command has no arguments or keywords.
Command Default‘
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
Some switches may want an Alerting message to be sent by the router before sending a Connect message. This is usually seen in a voice and data type of network.
Examples
In the following example, the isdn send-alerting command applies to an ISDN BRI interface:
interface BRI0 description connected to PBX 61886 ip address 172.26.1.1 255.255.255.0 encapsulation ppp isdn send-alerting isdn sending-complete dialer idle-timeout 20 dialer map ip 172.26.1.2 name name1 61884 dialer map ip 172.26.1.3 name name2 61885 dialer-group 1 ppp authentication chap
Related Commands
Command
Description
isdn sending-complete Specifies that the Sending Complete IE is included in the outgoing Setup message.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-369
Dial Commands isdn send-alerting
Cisco IOS Dial Technologies Command Reference
DIA-370
November 2009
Dial Commands isdn sending-complete
isdn sending-complete
To specify that the Sending Complete information element (IE) is included in the outgoing Setup message, use the isdn sending-complete command in interface configuration mode. To disable the Sending Complete information element, use the no form of this command. isdn sending-complete no isdn sending-complete
Syntax Description
This command has no arguments or keywords.
Command Default
This command is disabled by default.
Command Modes
Interface configuration (config-if)
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
The Sending Complete IE tells the switch that all the digits and information necessary for the call are contained in this Setup message. Some switches in some countries want a Sending Complete information element to be included in the outgoing Setup message to indicate that the entire number is included. The Sending Complete IE is required in Hong Kong and Taiwan, and the isdn sending-complete command forces it to be sent.
Examples
In the following example, the isdn sending-complete command applies to an ISDN BRI interface:
interface BRI0 description connected to PBX 61886 ip address 172.31.1.1 255.255.255.0 encapsulation ppp isdn sending-complete dialer idle-timeout 20 dialer map ip 172.31.1.2 name name1 61884 dialer map ip 172.31.1.3 name name2 61885 dialer-group 1 ppp authentication chap
The following example enables sending complete IE information on a serial interface:
interface serial 0:15 description connected to PBX 61886 ip address 10.1.1.1 255.255.255.0 encapsulation ppp isdn sending-complete dialer idle-timeout 20 dialer map ip 10.1.1.2 name name1 61884
Cisco IOS Dial Technologies Command Reference November 2009
DIA-371
Dial Commands isdn sending-complete
dialer map ip 10.1.1.3 name name3 61885 dialer-group 1 ppp authentication chap
Related Commands
Command isdn send-alerting
Description Specifies that an Alerting message be sent before a Complete message when making ISDN calls.
Cisco IOS Dial Technologies Command Reference
DIA-372
November 2009
Dial Commands isdn service
isdn service
To take an individual B channel or an entire PRI interface out of service or set it to a different channel service state that is passed to a time-division multiplexing (TDM) switch at the Public Switched Telephone Network (PSTN), use the isdn service command in interface configuration mode. To remove the configuration, use the no form of the command. isdn service [dsl number | nfas-int number] b_channel number state {0 | 1 | 2} [hard | immediate | soft] no isdn service
Syntax Description
dsl number nfas-int number
(Optional) Digital subscriber loop number; displayed with the show isdn status command. DSL numbers range from 0 to 31. (Optional) The Non-Facility Associated Signaling (NFAS) member interface number that has a B channel or channels to which you want to do maintenance. B channel, or a range of B channels separated by a dash, to be set with the passed-in state value. Specifying number as 0 sets the entire PRI interface to a specific state value. B channel numbers range from 0 to 31, or 0 for the complete interface. Desired channel service state to be set on the channels. Note that the ISDN service messages are sent only for switch types that support them. A state change from lower availability to higher availability is possible only after a service acknowledgment (SERV ACK) message is received. The following channel service state values are supported: 0—In Service. Restore a channel or channels to service. 1—Maintenance. An intermediate state between In Service and Out of Service. 2—Out of Service (OOS). Take a channel or channels out of service. The switch might drop calls on active channels. Additionally, you can provide one of the following optional keywords to control when to modify the state of the B channel or channels:
•
b_channel number
state {0 | 1 | 2} [hard | immediate | soft]
hard—(Optional) Sends the service (SERV) message immediately, even if the channel is active, and clears the call if there is any. If there is no active call, this keyword has the same effect as using the immediate keyword. immediate—(Optional) This keyword is the default. It sends the service message, but does not clear the call. The switch might clear the active channels if the state is changed to Maintenance or OOS. soft—(Optional) Moves the active channel or channels to a pending change state. The service message is sent after the channel becomes idle.
•
•
Command Default
Disabled
Cisco IOS Dial Technologies Command Reference November 2009
DIA-373
Dial Commands isdn service
Command Modes
Interface configuration
Command History
Release 11.3 12.2 12.3
Modification This command was introduced. The dsl keyword was made optional. The hard, immediate, and soft keywords were added as state keyword options.
Usage Guidelines
Use this command to manage channels on ISDN NFAS and Primary Rate Interfaces (PRI) on Cisco routers. Use the b_channel 0 keywords to set the entire PRI interface to the specified state value. Use the optional soft and immediate state keywords to take switches down gracefully, without impacting calls in progress. The hard keyword sends an immediate service message to the connected switch that will disconnect active B channels and drop active calls. To display the digital subscriber loop (DSL) number on NFAS interfaces, use the show isdn service EXEC command. To find the NFAS interface value, use the pri-group T1 controller configuration command. This command can be used only on North American switch types, because it supports the service message.
Examples
The following example sets all the PRI B channel on the interface to the maintenance state:
isdn service b_channel 0 state 1
The following example restores B channels 2 through 4; the DSL number was obtained using the show isdn command with the status keyword, and the DSL number was then used in the command:
isdn service dsl 2 b_channel 2-4 state 0
The following example sets B channels 13 to 24 to the OOS state:
isdn service nfas-int 3 b_channel 13-24 state 1
In the following example, the first statement sets B channels 17 through 20 to the maintenance state and marks any busy B channel (or channels) as pending; the channel will change to the service state only when it becomes idle. The second statement will cause the service message to be sent immediately and will clear the call. If there is no call, the second statement will have the same effect as the immediate keyword, that is, it will send the service message, but will not clear the call.
isdn service b_channel 17-20 state 1 soft isdn service b_channel 21 state 1 hard
Related Commands
Command
Description
isdn bcac service audit Enables service audits on an interface configured for BCAC. isdn bcac service audit Specifies that the BCAC service audit needs to be triggered on the entire interface interface.
Cisco IOS Dial Technologies Command Reference
DIA-374
November 2009
Dial Commands isdn service
Command
Description
isdn bcac service audit Enables individual BCAC service triggers. trigger isdn bcac service retry Specifies that the BCAC service state of the channel needs to be changed to in-serv-on-fail In Service because no acknowledgment was received. isdn bcac service retry Specifies the maximum number of times a BCAC service message can be max retransmitted when unacknowledged. isdn bcac service timer Changes the value of the BCAC T3M1 or T323 service message timer. isdn bcac service update linkup isdn bcac service update provision show isdn Triggers updates of the BCAC service states between peer nodes through exchange of SERV and SERV ACK messages. Enables the functionality of service status for provisioning ISDN PRI B channels. Displays the information about memory, Layer 2 and Layer 3 timers, and the status of PRI channels.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-375
Dial Commands isdn silent-boot
isdn silent-boot
To prevent the transmission and receipt of ISDN packets by the router during the boostrap loading process, use the isdn silent-boot command in global configuration mode. To allow the transmission and receipt of ISDN packets by the router during the boostrap loading process, use the no form of this command. isdn silent-boot no isdn silent-boot
Syntax Description
This command has no arguments or keywords.
Command Default
The transmission and receipt of ISDN packets by the router is allowed during the bootstrap process.
Command Modes
Global configuration (config)
Command History
Release 12.2
Modification This command was introduced.
Usage Guidelines
ISDN traffic will not be sent from any interfaces on the router (ISDN BRI or PRI) when you use the isdn silent-boot command. Disabling the ISDN traffic on the router is appropriate when the router is part of a hunt group that is accepting incoming ISDN calls because you do not want the router to receive calls until after it has reloaded and is ready to accept the incoming calls.
Examples
The following example disables ISDN traffic:
Router(config)# isdn silent-boot
Cisco IOS Dial Technologies Command Reference
DIA-376
November 2009
Dial Commands isdn snmp busyout b-channel
isdn snmp busyout b-channel
To enable PRI B channels to be busied out via Simple Network Management Protocol (SNMP), use the isdn snmp busyout b-channel command in interface configuration mode. To prevent B channels from being busied out via SNMP, use the no form of this command. isdn snmp busyout b-channel no isdn snmp busyout b-channel
Syntax Description
This command has no arguments or keywords.
Command Default
The default value is TRUE; that is, setting busyout using SNMP is allowed.
Command Modes
Interface configuration (config-if)
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
To busy out B-channels on a PRI, the ISDN switch must support service messages. The isdn snmp busyout b-channel command sets the MIB object, cpmDS0BusyoutAllow, indicating whether or not the switch supports service messages, thereby allowing the busyout of B channels. When the network access server receives an SNMP request for a busyout, it checks the value of this object. If the no isdn snmp busyout b-channel command is configured, the busyout request fails.
Examples
The following example allows the busyout of B-channels for serial interface 0:23:
configure terminal interface serial 0:23 isdn snmp busyout b-channel
Cisco IOS Dial Technologies Command Reference November 2009
DIA-377
Dial Commands isdn spid1, isdn spid2
isdn spid1, isdn spid2
To associate up to three ISDN local directory numbers (LDNs) provided by your telephone service provider to the first service profile identifier (SPID), use the isdn spid1 command in interface configuration mode. To disable the specified SPID and prevent access to the switch, use the no form of this command. isdn spid1 spid-number ldn [ldn] [ldn] no isdn spid1 spid-number ldn [ldn] [ldn] To associate up to three ISDN LDNs provided by your telephone service provider to the second service SPID, use the isdn spid2 interface configuration command. To disable the specified SPID and prevent access to the switch, use the no form of this command. isdn spid2 spid-number ldn [ldn] [ldn] no isdn spid2 spid-number ldn [ldn] [ldn]
Syntax Description
spid-number
Number identifying the service to which you have subscribed. This value is assigned by the ISDN service provider and is usually a 10-digit telephone number with additional digits such as 40855501220101. ISDN LDN, which is a 7-digit number assigned by the service provider. You can optionally specify a second and third LDN.
ldn
Command Default
A default SPID number and ISDN local directory numbers are not defined.
Command Modes
Interface configuration (config-if)
Command History
Release 10.3 12.0(3)T
Modification This command was introduced. This command was enhanced with the option of associating the SPID with up to three LDNs.
Usage Guidelines
This command applies only to North America and is required for DMS-100 and National ISDN switches. Typically, DMS-100 and National ISDN switch implementations using BRI interfaces with SPIDS require two terminal endpoint identifiers (TEIs), two SPIDS, and two phone numbers. If you want to take advantage of both B channels, it is advised you configure the router with the LDN value after the SPID.
Cisco IOS Dial Technologies Command Reference
DIA-378
November 2009
Dial Commands isdn spid1, isdn spid2
Note
Some DMS-100 and National ISDN switch installations may be configured as a “hunt group” whereby all calls are initially forwarded to the primary number. Under these circumstances, you should not configure the LDN. You can determine this by enabling the debug isdn q931 command. If the endpoint identifier (EID) information element is delivered in the incoming setup message, then the switch is addressing the TEIs with the EID, instead of the LDN. If you want the SPID to be automatically detected, you can specify 0 for the spid-number argument. The ISDN switch checks for the LDN to determine whether both channels can be used to transmit and receive data. If there is not an LDN present, then only the B1 channel can be used for full-duplex communication. However, the B2 channel can still be used to make outgoing calls. If you include the local directory number in the no form of this command, access to the switch is permitted, but the other B channel may not be able to receive incoming calls.
Examples
The following example defines, on the router, a SPID and LDN for the B1 channel:
isdn spid1 41555501130101 5550113
The following example shows how to specify that the SPID should be automatically detected, that the primary ISDN local directory number is 4085550111, and that the secondary number is 4085550122:
isdn spid1 0 4085550111 4085550122
The following example defines, on the router, a SPID and LDN for the B2 channel:
isdn spid2 41555501140101 5550114
The following example specifies that the SPID should be automatically detected, that the primary ISDN local directory number is 4085550111, and that the secondary number is 4085550122:
isdn spid2 0 4085550111 4085550122
Related Commands
Command isdn autodetect
Description Enables the automatic detection of ISDN SPIDs and switch type.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-379
Dial Commands isdn spoofing
isdn spoofing
To enable ISDN spoofing so that loss of Layer 1 or Layer 2 connectivity of the ISDN BRI interface is not detected by the Trunk Group Resource Manager (TGRM) or similar application, use the isdn spoofing command in interface configuration mode. To disable ISDN spoofing so the TGRM or similar application can detect when the BRI interface is not operational (when the Layer 1 or Layer 2 connection is down), use the no form of this command. isdn spoofing no isdn spoofing
Syntax Description
This command has no arguments or keywords.
Command Default
The ISDN BRI interface is spoofing, which means that applications always see the BRI interface connection as operational (unless the interface has been manually shut down [ADMINDOWN state]).
Command Modes
Interface configuration (config-if)
Command History
Release 12.3(14)T
Modification This command was introduced.
Usage Guidelines
The ISDN BRI interface is spoofing by default. Spoofing makes the ISDN BRI interface available (up) for operation (for dialing in ISDN), even if the interface is down. For an ISDN BRI interface to be set to a down condition, the interface must be manually shut down (IDBS_ADMINDOWN state). Spoofing enables upper layers to dial out even when the interface is down. Some upper layer modules, such as TGRM and similar applications, allow dial-out only if the channel is available. If the record for TGRM or similar application is notified of the actual status of BRI, then the TGRM or similar application can dial out accordingly. In this case, the no isdn spoofing command is appropriate.
Note
ISDN spoofing can be applied only to BRI interfaces—it does not apply to PRI interfaces.
Examples
The following example shows how to configure an ISDN BRI interface to disable ISDN spoofing:
Router# config terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# interface bri0/0 Router(config-if)# no isdn spoofing Router(config-if)#
Cisco IOS Dial Technologies Command Reference
DIA-380
November 2009
Dial Commands isdn spoofing
Related Commands
Command interface bri show isdn status
Description Configures a BRI interface and enters interface configuration mode. Displays the status of all ISDN interfaces or a specific ISDN interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-381
Dial Commands isdn static-tei
isdn static-tei
To configure a static ISDN Layer 2 terminal endpoint identifier (TEI) over the D channel, use the isdn static-tei command in interface configuration mode. To remove a static TEI configuration, use the no form of this command. isdn static-tei tei-number no isdn static-tei tei-number
Syntax Description
tei-number
Terminal endpoint identifier, in the range from 0 to 63.
Command Default
Dynamic TEI (no isdn static-tei)
Command Modes
Interface configuration (config-if)
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
Depending on the telephone company you subscribe to, you may have a dynamically or statically assigned TEI for your ISDN service. The default TEI behavior is dynamic, and the isdn static-tei command changes that behavior to static for the specified service. When you reconfigure a TEI with the isdn static-tei command, you must activate the configuration using the shutdown and no shutdown commands.
Examples
The following example configures German Anlagenanschluss ISDN lines. These lines are often provided in a group intended to be connected to single ISDN device such as a private branch exchange. To use the Anlagenanschluss ISDN lines on a Cisco router, you must set the TEI to 0, as follows:
Router# configure terminal Router(config)# interface bri 0 Router(config-if)# isdn static-tei 0 Router(config-if)# shutdown Router(config-if)# no shutdown
Related Commands
Command interface bri isdn x25 static-tei shutdown
Description Configures a BRI interface and enters interface configuration mode. Configure a static TEI for X.25 over the ISDN D channel. Disables an interface.
Cisco IOS Dial Technologies Command Reference
DIA-382
November 2009
Dial Commands isdn switch-type (BRI)
isdn switch-type (BRI)
To specify the central office switch type on the ISDN interface, use the isdn switch-type command in global or interface configuration mode. To remove an ISDN switch type, use the no form of this command. isdn switch-type switch-type no isdn switch-type switch-type
Syntax Description
switch-type
ISDN service provider switch type. Table 16 in the “Usage Guidelines” section lists the supported switch types.
Defaults
No ISDN switch type is specified.
Command Modes
Global configuration (config) Interface configuration (config-if)
Command History
Release 9.21 11.3T 12.0(3)XG
Modification This command was introduced as a global command. This command was introduced as an interface command. The basic-qsig and primary-qsig switch type options were added to support BRI QSIG voice signaling.
Usage Guidelines
For the Cisco AS5300 access server, you have the choice of configuring the isdn-switch-type command to support Q.SIG in either global configuration mode or interface configuration mode. When entered in global configuration mode, the setting applies to the entire Cisco AS5300 access server. When entered in interface configuration mode, the setting applies only to the T1/E1 interface specified. The interface configuration mode setting overrides the global configuration setting.
Note
This command can be entered in either global configuration or interface configuration mode. When entered in global configuration mode, the basic-qsig switch type command specifies that the Cisco MC3810 use QSIG signaling on all BRI interfaces; when entered in interface configuration mode, the command specifies that an individual BRI voice interface use QSIG signaling. The interface configuration mode setting overrides the global configuration setting on individual interfaces.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-383
Dial Commands isdn switch-type (BRI)
For example, if you have a Q.SIG connection on one line as well as on the PRI port, you can configure the ISDN switch type in one of the following combinations:
• • •
Set the global isdn-switch-type command to support Q.SIG and set the interface isdn-switch-type command for interface serial 0:23 to a PRI setting such as 5ess. Set the global isdn-switch-type command to support PRI 5ess and set the interface isdn-switch-type command for interface serial 1:23 to support Q.SIG. Configure the global isdn-switch-type command to another setting (such as switch type VN3), set the interface isdn-switch-type command for interface serial 0:23 to a PRI setting, and set the interface isdn-switch-type command for interface serial 1:23 to support Q.SIG.
For the Cisco MC3810 router, if you are using different Cisco MC3810 BRI port interfaces with different ISDN switch types, you can use global and interface commands in any combination, as long as you remember that interface commands always override a global command. For example, if you have a BRI QSIG switch interface on BRI voice ports 1, 2, 3 and 4, but a BRI 5ess switch interface on BRI backup port 0, you can configure the ISDN switch types in any of the following combinations:
• • •
Enter the isdn switch-type basic-qsig global configuration command, and enter the isdn switch-type bri-5ess command on interface 0. Enter the isdn switch-type bri-5ess global configuration command, and enter the isdn switch-type basic-qsig command on interfaces 1, 2, 3, and 4 individually. Enter the isdn switch-type bri-5ess command on interface 0, and enter the isdn switch-type basic-qsig command on interfaces 1, 2, 3, and 4 individually.
If you use the no isdn switch-type global configuration command, any switch type that was originally entered in global configuration mode is canceled; however, any switch type originally entered on an interface is not affected. If you use the no isdn switch-type interface configuration command, any switch type configuration on the interface is canceled.
Note
In the Cisco MC3810, ISDN BRI voice ports support only switch type basic-qsig; ISDN BRI backup ports support all other listed switch types, but not basic-qsig.
Note
The dial-peer codec command must be configured before any calls can be placed over the connection to the PINX. The default codec type is G729a. If you are using the Multiple ISDN Switch Types feature to apply ISDN switch types to different interfaces, refer to the chapters “Configuring ISDN BRI” and “Configuring ISDN PRI” in the Cisco IOS Dial Technologies Configuration Guide for additional details. The Cisco IOS command parser accepts the following switch types: basic-nwnet3, vn2, and basic-net3; however, when viewing the NVRAM configuration, the basic-net3 or vn3 switch types are displayed, respectively. To remove an ISDN switch type from an ISDN interface, specify the no isdn switch-type switch-type command.
Cisco IOS Dial Technologies Command Reference
DIA-384
November 2009
Dial Commands isdn switch-type (BRI)
Table 16 lists supported BRI switch types by geographic area.
Table 16 ISDN Service Provider BRI Switch Types
Keywords by Area
Voice/PBX Systems
Switch Type PINX (PBX) switches with QSIG signaling per Q.931 German 1TR6 ISDN switch NET3 ISDN BRI for Norway NET3, Australia NET3, and New Zealand NET3switch types; ETSI-compliant switch types for Euro-ISDN E-DSS1 signaling system French ISDN BRI switches Japanese NTT ISDN switches Lucent (AT&T) basic rate 5ESS switch Northern Telecom DMS-100 basic rate switch National ISDN switches No switch defined
basic-qsig
Australia, Europe, UK
basic-1tr6 basic-net3
vn3
Japan
ntt
North America
basic-5ess basic-dms100 basic-ni
All Users
none
Examples
The following example configures the French VN3 ISDN switch type:
isdn switch-type vn3
The following example uses the Multiple ISDN Switch Types feature and shows use of the global ISDN switch type basic-ni keyword (formerly basic-ni1) and the basic-net3 interface-level switch type keyword. ISDN switch type basic-net3 is applied to BRI interface 0 and overrides the global switch setting.
isdn switch-type basic-ni ! interface BRI0 isdn switch-type basic-net3
The following example configures the Cisco MC3810 router to use BRI QSIG signaling for all of its BRI voice ports:
isdn switch-type basic-qsig
The following example configures the Cisco MC3810 to use BRI QSIG signaling for BRI voice port 1. On port 1, this setting overrides any different signaling set in the previous example.
interface bri 1 isdn switch-type basic-qsig
Cisco IOS Dial Technologies Command Reference November 2009
DIA-385
Dial Commands isdn switch-type (PRI)
isdn switch-type (PRI)
To specify the central office switch type on the ISDN interface, or to configure the Cisco MC3810 PRI interface to support QSIG signaling, use the isdn switch-type command in global or interface configuration mode. To disable the switch or QSIG signaling on the ISDN interface, use the no form of this command. isdn switch-type switch-type no isdn switch-type switch-type
Syntax Description
switch-type
Service provider switch type; see Table 17 for a list of supported switches.
Command Default
The switch type defaults to none, which disables the switch on the ISDN interface.
Command Modes
Global configuration (confi) Interface configuration (config-if)
Note
This command can be entered in either global configuration mode or in interface configuration mode. When entered in global configuration mode, the setting applies to the entire Cisco MC3810. When entered in interface configuration mode, the setting applies only to the T1/E1 interface specified. The interface configuration mode setting overrides the global configuration setting.
Command History
Release 9.21 11.3T 12.0(2)T
Modification This command was introduced as a global command. This command was introduced as an interface command. The primary-qsig-slave and primary-qsig master switch type options were added to support PRI QSIG signaling.
Usage Guidelines
You have a choice of configuring the isdn-switch-type command to support QSIG at either the global configuration level or at the interface configuration level. For example, if you have a QSIG connection on one line as well as on the BRI port, you can configure the ISDN switch type in one of the following combinations:
• • •
Set the global isdn-switch-type command to support QSIG, and set the interface isdn-switch-type command for the interface bri 0 command to a BRI setting such as 5ess. Set the global isdn-switch-type command to support BRI 5ess, and set the interface isdn-switch-type command for the interface serial 1:23 command to support QSIG. Configure the global isdn-switch-type command to another setting (such as switch type VN3), and then set the interface isdn-switch-type command for the interface bri 0 command to a BRI setting, and set the interface isdn-switch-type command for the interface serial 1:23 command to support QSIG.
Cisco IOS Dial Technologies Command Reference
DIA-386
November 2009
Dial Commands isdn switch-type (PRI)
The voice-port codec command must be configured before any calls can be placed over the connection to the PINX. The default codec type is G729a. To disable the switch on the ISDN interface, specify the isdn switch-type none command. Table 17 lists supported PRI switch types by geographic area.
Note
If you are using the Multiple ISDN Switch Types feature to apply the ISDN switch types to different interfaces, refer to the chapter “Setting Up Basic ISDN Service” in the Cisco IOS Dial Technologies Configuration Guide for additional details.
Table 17 ISDN Service Provider PRI Switch Types
Keywords by Area
Voice/PBX Systems
Switch Type Supports QSIG signaling per Q.931. Network side functionality is assigned with the isdn protocol-emulate command. NET5 ISDN PRI switch types for Asia, Australia, and New Zealand; ETSI-compliant switches for Euro-ISDN E-DSS1 signaling system. Japanese ISDN PRI switch. AT&T 4ESS switch type for the United States. AT&T 5ESS switch type for the United States. NT DMS-100 switch type for the United States. National ISDN switch type. No switch defined.
primary-qsig
Australia and Europe
primary-net5
Japan
primary-ntt
North America
primary-4ess primary-5ess primary-dms100 primary-ni
All users
none
Examples
The following example demonstrates the Multiple ISDN Switch Type Feature. The global ISDN switch type setting is basic-net3. The PRI interface (channelized T1 controller), is configured to use the isdn switch-type primary-net5 command and BRI interface 0 is configured for the isdn switch-type basic-ni command (formerly isdn switch-type basic-ni1).
isdn switch-type basic-net3 ! interface serial0:23 isdn switch-type primary-net5 ip address 172.21.24.85 255.255.255.0 ! interface BRI0 isdn switch-type basic-ni
The following example configures T1 interface 23 on the Cisco AS5300 to support Q.SIG signaling:
interface serial 1:23 isdn switch-type primary-qsig
Cisco IOS Dial Technologies Command Reference November 2009
DIA-387
Dial Commands isdn switch-type (PRI)
Related Commands
Command
Description
isdn protocol-emulate Configures the Layer 2 and Layer 3 port protocol of a BRI voice port or a (dial) PRI interface to emulate NT (network) or TE (user) functionality. pri-group nec-fusion show cdapi show rawmsg Configures your NEC PBX to support FCCS. Displays the CDAPI. Displays the raw messages owned by the required component.
Cisco IOS Dial Technologies Command Reference
DIA-388
November 2009
Dial Commands isdn t306
isdn t306
Note
Effective with Cisco IOS Release 12.4(11)T, the isdn t306 command is replaced by the isdn timer command. See the isdn timer command for more information. To set a timer for disconnect messages sent by a router, use the isdn t306 command in interface configuration mode. To reset to the default, use the default or no form of this command. isdn t306 milliseconds default isdn t306 no isdn t306
Syntax Description
milliseconds
Time, in milliseconds, that the router waits before disconnecting a call after it receives a disconnect message with a progress indicator of 8. Range is from 1 to 400000. This keyword resets the default value for the T306 timer.
default
Command Default
Default depends on the switch, usually from 5000 to 30000 ms.
Command Modes
Interface configuration (config-if)
Command History
Release 12.1(3)XI 12.1(5)T 12.2(2)XA 12.2(2)XB1 12.2(11)T 12.4(11)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.1(5)T. This command was implemented on the Cisco AS5400 and Cisco AS5350. This command was implemented on the Cisco AS5850. This command was integrated into Cisco IOS Release 12.2(11)T. This command was replaced by the isdn timer command.
Usage Guidelines
The T306 timer is designed for routers that are configured as an ISDN network-side switch. When a router sends out a disconnect message with a progress indicator of 8, it disconnects the call after waiting for the specified number of milliseconds (ms) while the in-band announcement or error tone is playing. Be sure to set the timer long enough for the announcement to be heard or the tone to be recognized. This command is used only for disconnect messages with a progress indicator of 8; otherwise, the T305 timer is used. The default and no forms of this command have the same result: the timer waits for the default number of ms before disconnecting the call.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-389
Dial Commands isdn t306
Examples
The following example sets the T306 timer to 60000 ms for serial interface 0:23:
interface serial 0:23 isdn t306 60000
Related Commands
Command isdn t309
Description Changes the value of the timer to clear the network connection, and release the B channel and call reference when a data-link disconnection has occurred. Changes the value of the T310 timer for Call Proceeding messages. Changes the value of the T321 timer for D channel switchover when the primary D channel fails.
isdn t310 isdn timer t321
Cisco IOS Dial Technologies Command Reference
DIA-390
November 2009
Dial Commands isdn t310
isdn t310
Note
Effective with Cisco IOS Release 12.4(11)T, the isdn t310 command is replaced by the isdn timer command. See the isdn timer command for more information. To set a timer for the call proceeding state, use the isdn t310 comman in interface configuration mode. To reset to the default, use the no form of this command. isdn t310 milliseconds no isdn t310
Syntax Description
milliseconds
Time, in milliseconds, that the router waits before disconnecting a call after receiving a call proceeding message. Range is from 1 to 400000.
Command Default
Default depends on the switch; usually from 5000 to 30000 ms.
Command Modes
Interface configuration (config-if)
Command History
Release 12.1(3)XI 12.1(5)T 12.2(2)XA 12.2(2)XB1 12.2(11)T 12.4(11)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.1(5)T. This command was implemented on the Cisco AS5350 and Cisco AS5400. This command was implemented on the Cisco AS5850. This command was integrated into Cisco IOS Release 12.2(11)T. This command was replaced by the isdn timer command.
Usage Guidelines
The T310 timer starts when a router receives a call proceeding message; it stops when the call exits the call proceeding state, typically when the call moves to the alerting, connect, or progress state. If the timer expires while the call is in the call proceeding state, the router releases the call. Set the timer to match the specific characteristics of your network.
Examples
The following example sets the T310 timer to 40,000 ms for serial interface 0:23:
interface serial 0:23 isdn t310 40000
Cisco IOS Dial Technologies Command Reference November 2009
DIA-391
Dial Commands isdn t310
Related Commands
Command isdn protocol-emulate isdn t306 isdn test call interface
Description Sets a timer for disconnect messages. Changes the value of the T306 timer to disconnect a call after the router sends a disconnect message. Changes the value of the T309 timer to clear the network connection, and to release the B channel and call reference when a data-link disconnection has occurred. Changes the value of the T321 timer for D-channel switchover when the primary D channel fails.
isdn timer t321
Cisco IOS Dial Technologies Command Reference
DIA-392
November 2009
Dial Commands isdn tei-negotiation (global)
isdn tei-negotiation (global)
To configure when Layer 2 becomes active and ISDN terminal endpoint identifier (TEI) negotiation occurs, use the isdn tei-negotiation command in global configuration mode. To remove TEI negotiation configuration, use the no form of this command. isdn tei-negotiation [first-call | powerup] no isdn tei-negotiation
Syntax Description
first-call powerup
(Optional) ISDN TEI negotiation should occur when the first ISDN call is placed or received. (Optional) ISDN TEI negotiation should occur when the router is powered on.
Command Default
The powerup state is the default condition.
Command Modes
Global configuration (config)
Command History
Release 9.21
Modification This command was introduced as a global command.
Usage Guidelines
This command is for BRI configuration only. This command is useful for switches that may deactivate Layers 1 and 2 when there are no active calls or primary DMS-100 switches which activate TEI when the first ISDN call is placed or received.
Examples
The following example applies the isdn tei negotiation first-call command to BRI interface 0. BRI interface 1 will use the isdn tei negotiation powerup command, which is the default setting. Defaults settings do not appear in the router configuration.
isdn switch-type basic-net ! interface bri0 ! Configure the ISDN switch type on this interface and set TEI negotiation to first-call. isdn switch-type basic-ni isdn tei-negotiation first-call ! BRI interface 1 uses the default TEI negotiation value. interface bri1
Cisco IOS Dial Technologies Command Reference November 2009
DIA-393
Dial Commands isdn tei-negotiation (interface)
isdn tei-negotiation (interface)
To configure when Layer 2 becomes active and ISDN terminal endpoint identifier (TEI) negotiation occurs, use the isdn tei-negotiation command in interface configuration mode. To remove TEI negotiation from an interface, use the no form of this command. isdn tei-negotiation {first-call | powerup} {preserve | remove} no isdn tei-negotiation
Syntax Description
first-call powerup preserve remove
ISDN TEI negotiation occurs when the first ISDN call is placed or received. ISDN TEI negotiation occurs when the router is powered up. Preserves dynamic TEI negotiation when ISDN Layer 1 flaps, and when the clear interface or the shutdown and no shutdown EXEC commands are executed. Removes dynamic TEI negotiation when ISDN Layer 1 flaps, and when the clear interface or the shutdown and no shutdown EXEC commands are executed.
Command Default
The powerup state is the default condition. Depending on the ISDN switch type configured, the default action is to preserve or remove the TEI negotiation options.
Command Modes
Interface configuration (config-if)
Command History
Release 11.3T 12.2
Modification This command was introduced as an interface command. The preserve and remove keywords were added.
Usage Guidelines
This command is for BRI configuration only. The first-call and powerup, and preserve and remove command pairs are mutually exclusive, that is, you must choose only one command from either the first-call and powerup or preserve and remove command pairs, per command line. The no isdn tei-negotiation command returns the configuration to default to the powerup state. Use of the preserve keyword causes different behavior depending on the ISDN switch type configured, that is, the TEI negotiation configured will be preserved during ISDN Layer 1 flaps, and when the clear interface or the shutdown and no shutdown EXEC commands are executed, on the switch types listed in Table 18.
Table 18 Switch Types with Preserved TEI Negotiation
Switch Type French ISDN switch types Lucent (AT&T) basic rate 5ESS switch
Cisco IOS Keyword vn2, vn3 basic-5ess
Cisco IOS Dial Technologies Command Reference
DIA-394
November 2009
Dial Commands isdn tei-negotiation (interface)
Table 18
Switch Types with Preserved TEI Negotiation (continued)
Switch Type Northern Telecom DMS-100 basic rate switch National ISDN basic rate switch
Cisco IOS Keyword basic-dms100 basic-ni
PINX (PBX) switches with QSIG signaling per Q.931 basic-qsig For all other ISDN switch types, the TEI negotiation will be removed during ISDN Layer 1 flaps, and when the clear interface or the shutdown and no shutdown EXEC commands are executed. Use the remove keyword to specifically set one of the switches listed in Table 18 to the remove state. The first-call keyword and its functionality are not supported on U.S. switch types (basic-ni, basic-5ess, basic-dms100, primary-ni, primary-4ess, primary-5ess, and primary-dms100), especially for service profile identifier (SPID) negotiations. The first-call keyword and its functionality are supported on European switch types (basic-net3 and primary-net5) to prevent Layer 2 activity when there are no Layer 3 calls.
Examples
The following example shows the ISDN TEI negotiation configuration with default settings. (Defaults settings do not appear in the router configuration.)
interface BRI0/0 no ip address isdn switch-type basic-ni cdapi buffers regular 0 cdapi buffers raw 0 cdapi buffers large 0
The following example shows how to set TEI negotiation timing to the first call:
Router(config-if)# isdn tei-negotiation first-call Router(config-if)# exit Router(config)# exit Router# show startup-config . . . interface BRI0/0 no ip address isdn switch-type basic-ni isdn tei-negotiation first-call cdapi buffers regular 0 cdapi buffers raw 0 cdapi buffers large 0interface BRI0/0
The following example shows how to change TEI negotiation timing back to the default power-up state:
Router(config-if)# no isdn tei-negotiation Router(config-if)# exit Router(config)# exit Router# show startup-config . . . interface BRI0/0 no ip address isdn switch-type basic-ni cdapi buffers regular 0 cdapi buffers raw 0
Cisco IOS Dial Technologies Command Reference November 2009
DIA-395
Dial Commands isdn tei-negotiation (interface)
cdapi buffers large 0
The following example shows how to remove TEI negotiation when ISDN Layer 1 flaps (the preserve state is the default for the National ISDN basic rate switch):
Router(config-if)# isdn tei-negotiation remove Router(config-if)# exit Router(config)# exit Router# show startup-config . . . interface BRI0/0 no ip address isdn switch-type basic-ni isdn tei-negotiation first-call isdn tei-negotiation remove cdapi buffers regular 0 cdapi buffers raw 0 cdapi buffers large 0
The following example shows how to return the National ISDN basic rate switch to its default preserve state:
Router(config-if)# no isdn tei-negotiation Router(config-if)# exit Router(config)# exit Router# show startup-config . . . interface BRI0/0 no ip address isdn switch-type basic-ni isdn tei-negotiation first-call cdapi buffers regular 0 cdapi buffers raw 0 cdapi buffers large 0
Cisco IOS Dial Technologies Command Reference
DIA-396
November 2009
Dial Commands isdn test call interface
isdn test call interface
To make an ISDN data call, use the isdn test call interface command in privileged EXEC mode. isdn test call interface interface-number dialing-string [speed {56 | 64}]
Syntax Description
interface-number dialing-string speed {56 | 64}
Interface number. Telephone number used for making ISDN data call. (Optional) Line speed (56 or 64 kbps) used for making ISDN data call.
Command Default
The default B-channel speed is 64 kbps.
Command Modes
Privileged EXEC (#)
Command History
Release 12.2
Modification This command was introduced.
Usage Guidelines
You can use the isdn test call interface command to test your DDR configuration. You can also use this command to verify the dialing string and speed without having to know the IP address of the remote router or without configuring a dialer map or string. The isdn test call interface command replaces the isdn call interface command.
Examples
The following example makes an ISDN data call through interface bri 0 to 555-0111 and at a line speed of 56 kbps:
isdn test call interface bri 0 5550111 speed 56
Related Commands
Command isdn caller
Description Disconnects an ISDN data call without bringing down the interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-397
Dial Commands isdn test disconnect interface
isdn test disconnect interface
To disconnect an ISDN data call without bringing down the interface, use the isdn test disconnect interface command in privileged EXEC mode. isdn test disconnect interface type number {b1 | b2 | all}
Syntax Description
type number b1 b2 all
Interface type and number, such as bri 0. B channel 1. B channel 2. B channels 1 and 2.
Command Default
A default interface is not defined.
Command Modes
Privileged EXEC
Command History
Release 12.2
Modification This command was introduced.
Usage Guidelines
You can use the isdn test disconnect interface command to disconnect any ongoing data calls placed manually or caused by DDR. The isdn test disconnect interface command replaces the isdn disconnect interface command.
Examples
The following example disconnects an ISDN data call through interface bri 0 and B channel 1:
isdn test disconnect interface bri 0 b1
Related Commands
Command
Description
isdn call interface Makes an ISDN data call.
Cisco IOS Dial Technologies Command Reference
DIA-398
November 2009
Dial Commands isdn timer
isdn timer
Note
Effective with Cisco IOS Release 12.4(11)T, the isdn timer command replaces the isdn t-activate, isdn t306, isdn t310, isdn timer t309, and isdn timer t321 commands. If any of these replaced commands are entered, the command-line interface responds with a message indicating the new syntax and a request that you update the startup configuration with the running configuration. To identify and configure an ISDN timer and change the value of the timer for network and call connect and disconnect waiting periods, use the isdn timer command in interface configuration mode. To restore the default value, use the no form of this command. isdn timer timer milliseconds no isdn timer timer milliseconds
Syntax Description
timer
Identifies the type of ISDN timer to be configured. The timer is the wait period between two signficant events (the events vary according to the type of timer selected). The following are acceptable ISDN timers: t-activate, t200, t203, t300s, t301, t303, t306, t307, t309, t310, and t321. Number of milliseconds (ms) that the router or switch waits before taking action. Values for the different ISDN timers are as follows:
• • • • • • • • • • • Note
milliseconds
t-activate—The range is from 1000 to 15,000. The default is 4000 (5000 is recommended). t200—The range is from 400 to 400,000. The default is 1000. t203—The range is from 400 to 400,000. The default is 10,000. t300s—The range is from 500 to 86,400,000. The default is 300,000. t301—The range is from 180,000 to 86,400,000. The default is switch-dependent. t303—The range is from 400 to 86,400,000. The default is 10,000. t306—The range is from 400 to 86,400,000. The default is switch-dependent. t307—The range is from 30,000 to 300,000. The default is 180,000. t309—The range is from 0 to 86,400,000. The default is 90,000. t310—The range is from 400 to 400,000. The default is 10,000. t321—The range is from 0 to 86,400,000. The default is 30,000. Setting the timer to 0 for the T309 and T321 timers causes the expiration time to be infinite so the wait period will never expire.
Command Default
The default values vary according to the type of ISDN timer and, in some cases, are switch-dependent. To restore a specific default value, use the no isdn timer command.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-399
Dial Commands isdn timer
Command Modes
Interface configuration
Command History
Release 12.4(11)T
Modification This command was introduced. This command replaces the isdn t-activate, isdn t306, isdn t310, isdn timer t309, and isdn timer t321 commands and standardizes the syntax for ISDN timer configuration.
Usage Guidelines
Selection of the different timers serves different purposes in the ISDN configuration. The functions of the different ISDN timers are as follows:
•
t-activate—The T-activate timer starts when the voice gateway sends a Facility message to the public switched telephone network (PSTN). If a response is not received within the specified time, the Tool Command Language (TCL) Interactive Voice Response (IVR) script for Malicious Call Identification (MCID) is notified. Depending on how the script is written, it could reinvoke MCID or perform some other action, such as playing a message if the MCID attempt fails. The ISDN interface must use the NET5 switch type, which is set using the isdn switch-type primary-net5 command. Protocol emulation must be set to user, which is the default for the isdn protocol-emulate command. t200—The T200 timer defines the wait period until the retransmission of a message will occur. This wait period must exceed the time it takes to send a frame and receive its acknowledgment. t203—The T203 timer specifies the maximum wait period between exchanges of Q.921 frames. Although the default is 10,000 ms, most switches allow modification of this timer as needed. In cases of long distances and delay, this timer should be modified for continued operation. t300s—The T300S timer is specific to Cisco IOS software configurations. The T300S timer specifies the wait period between attempts to initiate ISDN Layer 2 communication. t301—The T301 timer is configured on the user side and the network side. On the user side, the timer indicates Call Delivered—Alerting Received. On the network side, this timer indicates Call Received—Alerting Received. t303—The T303 timer starts when a calling party initiates call establishment by transferring a setup message on the assigned signaling virtual channel across the interface. If no response to the setup message is received by the user side before the first expiry of the T303 timer, the setup message will be retransmitted and the T303 timer restarted. If the user side has not received any response to the setup message after the final expiry of timer T303, the user side manually clears the call internally. t306—The T306 timer is configured on the network side. The T306 timer defines a wait period only for disconnect messages with a progress indicator of 8. When a router sends out a disconnect message with a progress indicator of 8, it disconnects the call after waiting for the specified number of milliseconds while the in-band announcement or error tone is playing. The timer must be set with sufficient duration for the announcement to be heard or the tone to be recognized. t307—The T307 timer is configured on the network side for BRI switch-types (Primary-net5, Primary-NI, and Primary-NI2C) for Suspend—Remove message processing.
• •
• •
•
•
•
Cisco IOS Dial Technologies Command Reference
DIA-400
November 2009
Dial Commands isdn timer
•
t309—The T309 timer defines a wait period before clearing the network connection and releasing the B channel and call reference when a data-link disconnection has occurred. When a data link layer malfunction occurs, calls that are not in the active state are cleared. For calls that are not in the active state, the T309 timer is started. The timer is stopped when the data link is reconnected. If the T309 timer expires prior to the reestablishment of the data link, the network clears the connection and call to the remote user, sending a disconnect cause of 27 to indicate that the call destination is out of order. The network releases and disconnects the B channel and releases the call reference, thereby entering the Null state. The T309 timer is mandatory for routers that are configured as ISDN network-side switches. The implementation of the T309 timer is optional for the user side of the network. t310—The T310 timer starts when a router receives a call proceeding message; it stops when the call exits the call proceeding state, typically when the call moves to the alerting, connect, or progress state. If the timer expires while the call is in the call-proceeding state, the router releases the call. t321—The T321 timer specifies a wait period for D-channel switchover when the primary D channel fails. The T321 timer must be implemented when you use the D-channel backup procedure involving D-channel switchover.
•
•
Examples
The following example sets the T309 timer to 60,000 ms (60 seconds) for serial interface 0:24:
interface serial 0:24 isdn timer t309 60000
The following example sets the T321 timer expiration to 0 ms so that it will never expire for serial interface 0:24:
interface serial 0:24 isdn timer t321 0
The following example shows the configuration of an ISDN timer on serial interface 0:23:
interface serial0:23 isdn switch-type primary-net5 ip address 10.10.10.0 255.255.255.0 isdn suppserv mcid isdn t-activate 5000
Related Commands
Command isdn protocol-emulate isdn switch-type primary-net5 isdn t-activate isdn t306 isdn t310 isdn timer t309
Description Configures the PRI interface to serve as either the primary slave (user) or the primary master (network). Specifies the central office switch type on the ISDN interface as NET5. Specifies how long the gateway waits for a response from the PSTN after sending a MCID request. Changes the value of the T306 timer to disconnect a call after the router sends a disconnect message. Changes the value of the T310 timer for call proceeding messages. Changes the value of the T309 timer to clear the network connection and to release the B channel and call reference when a data-link disconnection has occurred. Changes the value of the T321 timer for D-channel switchover when the primary D channel fails.
isdn timer t321
Cisco IOS Dial Technologies Command Reference November 2009
DIA-401
Dial Commands isdn timer t309
isdn timer t309
Note
Effective with Cisco IOS Release 12.4(11)T, the isdn timer t309 command is replaced by the isdn timer command. See the isdn timer command for more information. To change the value of the T309 timer to clear the network connection and to release the B channel and call reference when a data-link disconnection has occurred, use the isdn timer t309 command in interface configuration mode. To restore the default value, use the no form of this command. isdn timer t309 milliseconds no isdn timer t309
Syntax Description
milliseconds
Number of milliseconds (ms) that the router waits before clearing the network connection, and releasing the B channel and call reference. Values are from 0 to 86,400,000 ms (0 to 86,400 seconds).
Command Default
90,000 ms (90 seconds)
Command Modes
Interface configuration
Command History
Release 12.2 12.4(11)T
Modification This command was introduced. This command was replaced by the isdn timer command.
Usage Guidelines
When a data link layer malfunction occurs, calls that are not in the active state are cleared. For calls that are not in the active state, the T309 timer is started. The timer is stopped when the data link is reconnected. If the T309 timer expires prior to the reestablishment of the data link, the network clears the connection and call to the remote user, sending a disconnect cause of 27 to indicate that the call destination is out of order. The network releases and disconnects the B channel, and releases the call reference, entering the Null state. The T309 timer is mandatory for routers that are configured as an ISDN network-side switch and by default the timer is set to expire after 90,000 ms (90 seconds). The implementation of the T309 timer is optional for the user side of the network. The isdn timer t309 command is used for changing the value of the T309 timer.
Note
Setting the timer to 0 causes the timer expiry to become infinite so the wait period never expires.
Examples
The following example sets the T309 timers to 60,000 ms (60 seconds) for serial interface 0:24:
interface serial 0:24 isdn timer t309 60000
Cisco IOS Dial Technologies Command Reference
DIA-402
November 2009
Dial Commands isdn timer t309
Related Commands
Command isdn t306 isdn t310 isdn timer t321
Description Changes the value of the T306 timer to disconnect a call after the router sends a disconnect message. Changes the value of the T310 timer for call proceeding messages. Changes the value of the T321 timer for D-channel switchover when the primary D channel fails.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-403
Dial Commands isdn timer t321
isdn timer t321
Note
Effective with Cisco IOS Release 12.4(11)T, the isdn timer t321command is replaced by the isdn timer command. See the isdn timer command for more information. To change the value of the timer for D-channel switchover when the primary D channel fails, use the isdn timer t321 command in interface configuration mode. To restore the default value, use the no form of this command. isdn timer t321 milliseconds no isdn timer t321
Syntax Description
milliseconds
Number of milliseconds (ms) that the router waits before sending a DL-ESTABLISH request on both D channels to request a switchover. Values are from 0 to 86,400,000.
Command Default
The default wait period is 30,000 ms.
Command Modes
Interface configuration
Command History
Release 12.2 12.4(11)T
Modification This command was introduced. This command was replaced by the isdn timer command.
Usage Guidelines
The T321 timer must be set when you use the D-channel backup procedure involving D-channel switchover. The isdn timer t321 command is used for changing the value of the T321 timer.
Note
Setting the timer to 0 causes the timer expiry to become infinite so that the wait period never expires.
Examples
The following example sets the T321 timers to 25 ms for serial interface 0:23:
interface serial 0:23 isdn timer t321 25
Cisco IOS Dial Technologies Command Reference
DIA-404
November 2009
Dial Commands isdn timer t321
Related Commands
Command isdn t306 isdn timer t309
Description Changes the value of the T306 timer to disconnect a call after the router sends a disconnect message. Changes the value of the T309 timer to clear the network connection, and to release the B channel and call reference when a data-link disconnection has occurred. Changes the value of the T310 timer for call proceeding messages.
isdn t310
Cisco IOS Dial Technologies Command Reference November 2009
DIA-405
Dial Commands isdn transfer-code
isdn transfer-code
To activate call transferring, use the isdn transfer-code command in interface configuration mode. To disable call transferring, use the no form of this command. isdn transfer-code code no isdn transfer-code
Syntax Description
code
Number from 0 to 999 (ISDN transfer code).
Command Default
The default code is 61.
Command Modes
Interface configuration
Command History
Release 12.0(3)T
Modification This command was introduced.
Usage Guidelines
Use this command if your ISDN line is connected to a NI1 or a Nortel DMS-100 Custom switch. Your telephone service provider should issue an ISDN transfer code when you order call transferring.
Examples
The following example specifies 62 as the ISDN transfer code:
isdn transfer-code 62
Cisco IOS Dial Technologies Command Reference
DIA-406
November 2009
Dial Commands isdn transparent
isdn transparent
To configure an ISDN interface to pass specified cause-code values transparently from VoIP to PSTN on the terminating gateway without mapping the values, use the isdn transparent command in interface configuration mode. To disable the transparent handling of specified cause codes, use the no form of this command. isdn transparent cause-value cause-value no isdn transparent cause-value cause-value
Syntax Description
cause-value
Sends a cause-code value number (submitted as an integer in the range of 1 through 127) to the switch. You can include up to 16 cause-code values in each command.
Command Default
When the isdn transparent command is not enabled, all ISDN cause-code values are mapped according to the configuration when they are passed from VoIP to PSTN on the terminating gateway.
Command Modes
Interface configuration
Command History
Release 12.2(15)T9 12.3(7)XI 12.3(8)T 12.3(8)
Modification This command was introduced. This command was integrated into this release. This command was integrated into this release. This command was integrated into this release.
Usage Guidelines
This command must be enabled under the serial D-channel to pass specified cause-code values transparently. The command syntax allows you to configure up to 16 cause-code values to be passed transparently at the terminating gateway.
Examples
The following example shows how to configure the serial D-channel interface 7/7:23 to pass ISDN cause codes 4, 42, and 95 transparently at the terminating gateway:
Router# configure terminal Router(config)# interface serial7/7:23 Router(config-if)# isdn transparent cause-value 4 42 95 Router(config-if)# end
Related Commands
Command interface serial
Description Specifies a serial interface created on a channelized E1 or channelized T1 controller (for ISDN PRI, CAS, or robbed-bit signaling).
Cisco IOS Dial Technologies Command Reference November 2009
DIA-407
Dial Commands isdn twait-disable
isdn twait-disable
To delay a National ISDN BRI switch a random time before activating the Layer 2 interface when the switch starts up, use the isdn twait-disable command in interface configuration mode. To remove the delay, use the no form of this command. isdn twait-disable no isdn twait-disable
Syntax Description
This command has no arguments or keywords.
Command Default
This command is enabled by default.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
The random-length delay set by this command prevents mass power failures from causing the network ISDN switches to be overwhelmed when power returns and all the devices startup at the same time. The random delay is in the range 1 to 300 seconds.
Examples
The following example configures a random wait period after a power failure:
isdn twait-disable
Cisco IOS Dial Technologies Command Reference
DIA-408
November 2009
Dial Commands isdn v110 only
isdn v110 only
To selectively accept incoming V.110 calls based on data bit, parity, and stop bit modem communication settings, use the isdn v110 only command in interface configuration mode. To change or disable the expected incoming V.110 modem call configuration, use the no form of this command. isdn v110 only [databits {5 | 7 | 8}] [parity {even | mark | none | odd | space}] [stopbits {1 | 1.5 | 2}] no isdn v110 only
Syntax Description
databits {5 | 7 | 8}
(Optional) Allowed data bits, as follows:
• • •
5—Allow 5 data bits only. 7—Allow 7 data bits only. 8—Allow 8 data bits only. even—Allow even parity only. mark—Allow mark parity only. none—Allow no parity only. odd—Allow odd parity only. space—Allow space parity only. 1—Allow 1 stop bit only. 1.5—Allow 1.5 stop bits only. 2—Allow 2 stop bits only.
parity {even | mark | none | odd | space}
(Optional) Allowed parity, as follows:
• • • • •
stopbits {1 | 1.5 | 2}
(Optional) Allowed stop bits, as follows:
• • •
Command Default
No default behavior or values.
Command Modes
Interface configuration
Command History
Release 12.1(4)T
Modification This command was introduced.
Usage Guidelines
The isdn v110 only command provides a way to screen incoming V.110 modem calls and reject any calls that do not have the communication settings configured as the network expects them to be.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-409
Dial Commands isdn v110 only
Examples
The following example filters out all V.110 modem calls except those with communication settings of 8 data bits, no parity bit, and 1 stop bit:
interface serial 0:23 isdn v110 only databits 8 parity none stopbits 1
Cisco IOS Dial Technologies Command Reference
DIA-410
November 2009
Dial Commands isdn v110 padding
isdn v110 padding
To enable the padded V.110 modem speed report required by the V.110 modem standard, use the isdn v110 padding command in interface configuration mode. To disable the padded V.110 modem speed report, use the no form of this command. isdn v110 padding no isdn v110 padding
Syntax Description
This command has no arguments or keywords.
Command Default
V.110 modem speed padding is enabled.
Command Modes
Interface configuration
Command History
Release 12.2(8)T
Modification This command was introduced.
Usage Guidelines
The no isdn v110 padding command is useful for networks with devices such as terminal adapters (TAs) and global system for mobile communication (GSM) handsets that do not fully conform to the V.110 modem standard. The V.110 modem standard specifies that the incoming asynchronous data must be padded by adding stop elements to fit the nearest channel rate. For example, a 14400 bits per second (bps) user data signaling rate is adapted to a synchronous 19200-bps stream rate. The software reports the adapted rate (19200 bps) to the modem for an incoming V.110 call. However, for those devices that do not fully conform to the V.110 supplications, the software must report the speed as 14400 instead of 19200 to the modem for a successful connection. By setting the modem interface to no isdn v110 padding, padding is disabled and the actual bit rate can be reported to the modem.
Examples
The following example shows how to disable V.110 asynchronous-to-synchronous padding:
! interface Serial0:23 no ip address isdn switch-type primary-ni isdn bchan-number-order ascending no isdn v110 padding no cdp enable
Cisco IOS Dial Technologies Command Reference November 2009
DIA-411
Dial Commands isdn voice-priority
isdn voice-priority
To control the priority of data and voice calls for the telephones, fax machines, and modems connected to the router telephone ports, use the isdn voice-priority command in interface configuration mode. To disable a specified ISDN voice priority setting and to use the default setting, use the no form of this command. isdn voice-priority local-directory-number {in | out} {always | conditional | off} no isdn voice-priority local-directory-number
Syntax Description
local-directory-number in out always conditional off
Local ISDN directory number assigned by your telephone service provider. Incoming voice call. Outgoing voice call. Always bump a data call for a voice call. Bump a data call only if there is more than one call to the same destination. Never bump a data call for a voice call.
Command Default
A data call is never bumped for an incoming or outgoing voice call.
Command Modes
Interface configuration
Command History
Release 12.0(3)T
Modification This command was introduced.
Usage Guidelines
If an ISDN circuit endpoint is busy with a data call or calls and either a voice call comes in (incoming) or you attempt to place a voice call (outgoing), the data call is handled according to the setting of isdn voice-priority command. If you are in North America and have multiple ISDN directory numbers associated with a SPID, the outgoing voice priority that you set for any of these directory numbers applies to the other directory numbers. For example, if you enter the following commands, the outgoing voice priority for all directory numbers specified in the isdn spid1 command is set to conditional:
isdn spid1 0 4085550111 4085550122 4085550133 isdn voice-priority 5550111 out conditional
The setting of the pots dialing-method command affects when you hear a busy signal in the following situation:
• •
A data call cannot be bumped. You are trying to make an outgoing call.
Cisco IOS Dial Technologies Command Reference
DIA-412
November 2009
Dial Commands isdn voice-priority
If the setting is overlap, you hear a busy signal when you pick up the handset. If the setting is enblock, you initially hear a dial tone and then a busy signal.
Examples
The following example specifies that a data call for the specified ISDN directory number never be bumped for an incoming or an outgoing voice call:
isdn voice-priority 5550111 in off isdn voice-priority 5550111 out off
Related Commands
Command
Description
isdn spid1, isdn spid2 Defines the SPID number that has been assigned by the ISDN service provider for the B1 channel. pots dialing-method Specifies how the Cisco 800 series router collects and sends digits dialed on your connected telephones, fax machines, or modems.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-413
Dial Commands isdn x25 dchannel
isdn x25 dchannel
To create a configurable interface for X.25 traffic over the ISDN D channel, use the isdn x25 dchannel command in interface configuration mode. To remove the interface, use the no form of this command. isdn x25 dchannel [q931-broadcast] no isdn x25 dchannel [q931-broadcast]
Syntax Description
q931-broadcast
(Optional) Enables a gateway to share the same terminal endpoint identifier (TEI) for sending X.25 Set Asynchronous Balanced Mode Extended (SABME) and ITU Q.931 packet mode responses.
Command Default
Command is disabled
Command Modes
Interface configuration
Command History
Release 11.2F 12.4(6)T
Modification This command was introduced. This command was enhanced with the optional q931-broadcast keyword to enable the ITU Q.931 service access point identifier (SAPI) value 16 procedures for call setup that accepts X.25 calls on the BRI D channel on Japanese and some European telephone switches that require that procedure.
Usage Guidelines
This command creates a new, configurable interface, which can be specified as interface brix:0 in commands, where x is the original BRI interface number. For example, on a Cisco 4500 router with an MBRI, if the isdn x25 dchannel command is configured on interface BRI 5, the new interface is bri5:0 and can be used for configuring the other parameters for X.25 over the D channel. These parameters include the addresses and the map statements. To display the new interface, use the more system:running-config command. The optional q931-broadcast keyword is supported only on the ISDN BRI interface user side. Although regular X.25 and ISDN configuration commands may be sufficient to enable this feature, the Japanese NTT ISDN switch types expect the same TEI to be shared. By default, Cisco gateways will try to use two different TEIs and expect the switch to establish an X.25 link on the TEI that responds. The Japanese NTT switch does not follow this procedure and expects the Cisco router to share the same TEI. Cisco recommends that deployments interworking with the Japanese NTT switch type use the optional q931-broadcast keyword to enable sharing of the TEI and avoid interworking incompatibilities. The optional q931-broadcast keyword can also be used in configurations for other switch types such as the European NET3 that require sharing of the TEIs. You can verify the X.25 call accept procedure using the debug isdn events, debug isdn command with the optional mgmnt keyword, and debug isdn q931 EXEC commands.
Cisco IOS Dial Technologies Command Reference
DIA-414
November 2009
Dial Commands isdn x25 dchannel
Examples
The following example creates BRI interface 0 and configures it for X.25 over the ISDN D channel. This example uses dynamic TEIs, not a static TEI.
interface bri1 isdn x25 dchannel interface bri1:0 ip address 10.1.1.2 255.255.255.0 x25 address 31107000000100 x25 htc 1 x25 suppress-calling-address x25 facility windowsize 2 2 x25 facility packetsize 256 256 x25 facility throughput 9600 9600 x25 map ip 10.1.1.3 31107000000200 x25 map ip 10.1.1.4 31107000000800
The following is a typical configuration that enables SAPI 0 procedures that accept X.25 calls on the ISDN D channel, on ISDN BRI interface 0:
isdn switch-type basic-ntt x25 routing ! interface BRI0 no ip address no ip directed-broadcast dialer load-threshold 1 either isdn switch-type basic-net3 isdn x25 dchannel q931-broadcast ! interface BRI0:0 ip address 192.168.1.1 255.255.255.252 no ip directed-broadcast no ip mroute-cache x25 address 12503372501 x25 htc 2 x25 map ip 192.168.1.2 2231146 !
Related Commands
Command debug isdn
Description Displays messages about what is occurring in the structure and operation of ISDN in the Cisco IOS software. Displays information about call setup and teardown of ISDN Layer 3 network connection between the user (router) side and the network side. Configures a BRI interface and enters interface configuration mode. Specifies the central office switch type on the ISDN interface.
debug isdn events Displays ISDN events occurring on the user (router) side of the ISDN interface. debug isdn q931 interface bri isdn switch-type
Cisco IOS Dial Technologies Command Reference November 2009
DIA-415
Dial Commands isdn x25 static-tei
isdn x25 static-tei
To configure a static ISDN Layer 2 terminal endpoint identifier (TEI) for X.25 over the ISDN D channel, use the isdn x25 static-tei command in interface configuration mode. Use the no form of this command if dynamic TEIs will be used on the interface that is to carry X.25 traffic over the D channel. isdn x25 static-tei tei-number no isdn x25 static-tei tei-number
Syntax Description
tei-number
Terminal endpoint identifier, in the range from 0 to 63.
Command Default
Disabled
Command Modes
Interface configuration
Command History
Release 11.2F
Modification This command was introduced.
Usage Guidelines
This command applies to ISDN BRI interfaces only. Only one static TEI is allowed per BRI interface. If a second static TEI is configured, the first static TEI is overwritten. Some switches require a static TEI be used for X.25 over the ISDN D channel. When the isdn x25 dchannel command is invoked without the isdn x25 static-tei command, a dynamic TEI is chosen.
Examples
The following example creates static TEI 8 on the X.25-over-ISDN-D channel:
interface bri0 isdn x25 dchannel isdn x25 static-tei 8
Because the isdn x25 static-tei command is missing, the following example configuration sets dynamic TEIs for the ISDN channel:
interface bri0 isdn x25 dchannel
Related Commands
Command interface bri isdn x25 dchannel
Description Configures a BRI interface and enters interface configuration mode. Creates a configurable interface for X.25 traffic over the ISDN D channel.
Cisco IOS Dial Technologies Command Reference
DIA-416
November 2009
Dial Commands l2tp tunnel retransmit initial retries
l2tp tunnel retransmit initial retries
To configure the number of times that the router will attempt to send out the initial Layer 2 Tunnel Protocol (L2TP) control packet for tunnel establishment before considering a peer busy, use the l2tp tunnel retransmit initial retries command in VPDN group or VPDN template configuration mode. To restore the default value, use the no form of this command. l2tp tunnel retransmit initial retries number no l2tp tunnel retransmit initial retries
Syntax Description
number
Number of retransmission attempts. Valid values range from 1 to 1000. The default value is 2.
Command Default
The router will resend the initial L2TP control packet twice.
Command Modes
VPDN group configuration VPDN template configuration
Command History
Release 12.2(4)T 12.2(11)T 12.2(28)SB
Modification This command was introduced. This command was implemented on the Cisco 1760, Cisco AS5300, Cisco AS5400, and Cisco AS5800 platforms. This command was integrated into Cisco IOS Release 12.2(28)SB.
Usage Guidelines
Use the l2tp tunnel retransmist initial retries command to configure the number of times a device will attempt to resend the initial control packet used to establish an L2TP tunnel.
Examples
The following example configures the router to attempt to send the initial L2TP control packet five times for tunnels associated with the virtual private dialup network (VPDN) group named group1:
vpdn-group group1 l2tp tunnel retransmit initial retries 5
Related Commands
Command l2tp tunnel busy timeout
Description Configures the amount of time that the router will wait before attempting to recontact a router that was previously busy.
l2tp tunnel retransmit Configures the amount of time that the router will wait before resending an initial timeout initial L2TP control packet out to establish a tunnel. l2tp tunnel retransmit Configures the number of retransmission attempts made for a L2TP control retries packet.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-417
Dial Commands l2tp tunnel retransmit initial retries
Command
Description
l2tp tunnel retransmit Configures the amount of time that the router will wait before resending an timeout L2TP control packet. vpdn-group vpdn-template Creates a VPDN group and enters VPDN group configuration mode. Creates a VPDN template and enters VPDN template configuration mode.
Cisco IOS Dial Technologies Command Reference
DIA-418
November 2009
Dial Commands limit base-size
limit base-size
To define the base number of simultaneous connections that can be done in a single customer or virtual private dialup network (VPDN) profile, use the limit base-size command in customer profile configuration or VPDN profile configuration mode. To remove the limitation, use the no form of this command. limit base-size {base-number | all} no limit base-size {base-number | all}
Syntax Description
base-number all
Maximum number of simultaneous connections or sessions that can be used in a specified customer or VPDN profile, in the range from 0 to 1000. Accept all calls (default). Use this keyword if you do not want to limit or apply overflow session counting to a customer or VPDN profile.
Command Default
The base size is set to all.
Command Modes
Customer profile configuration VPDN profile configuration
Command History
Release 12.0(4)XI
Modification This command was introduced.
Usage Guidelines
Use the limit base-size command to define the base number of simultaneous connections in a single customer or VPDN profile. The session limit applies to all the physical resource groups and pools configured in a single customer profile. If you want to define the number of overflow calls granted to a customer profile by using the limit overflow-size command, do not use the all keyword in the limit base-size command; instead, specify a base number.
Examples
The following example shows the total number of simultaneous connections limited to a base size of 48:
resource-pool profile customer customer1_isp limit base-size 48
Related Commands
Command limit overflow-size resource-pool profile customer
Description Defines the number of overflow calls granted to one customer or VPDN profile. Creates a customer profile.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-419
Dial Commands limit overflow-size
limit overflow-size
To define the number of overflow calls granted to one customer or virtual private dialup network (VPDN) profile, use the limit overflow-size command in customer profile configuration or VPDN profile configuration mode. To remove the overflow configuration, use the no form of this command. limit overflow-size {overflow-calls | all} no limit overflow-size {overflow-calls | all}
Syntax Description
overflow-calls Number of overflow calls to grant, in the range from 0 to 1000. Default is 0. all Accept all overflow calls.
Command Default
The overflow size is set to 0.
Command Modes
Customer profile configuration VPDN profile configuration
Command History
Release 12.0(4)XI
Modification This command was introduced.
Usage Guidelines
Use the limit overflow-size customer or VPDN profile configuration command to define the number of overflow calls granted to one customer or VPDN profile. The overflow is not applied if the limit base-size command is set using the all keyword.
Examples
The following example shows 20 overflow calls granted to the customer profile called customer1_isp:
resource-pool profile customer customer1_isp limit overflow-size 20
Related Commands
Command limit base-size resource-pool profile customer
Description Defines the base number of simultaneous connections that can be done in a single customer or VPDN profile. Creates a customer profile.
Cisco IOS Dial Technologies Command Reference
DIA-420
November 2009
Dial Commands line-power
line-power
To configure an ISDN BRI port to supply line power to the terminal equipment (TE), use the line-power command in interface configuration mode. To disable the line power supply, use the no form of this command. line-power no line-power
Syntax Description
This command has no arguments or keywords.
Command Default
The BRI port does not supply line power.
Command Modes
Interface configuration
Command History
Release 12.0(3)XG 12.0(4)T 12.1(3)XI
Modification This command was introduced on the Cisco MC3810 access concentrator. This command was integrated into Cisco IOS Release 12.0(4)T. This command was implemented on the Cisco 2600 and Cisco 3600 series.
Usage Guidelines
This command is supported only if an installed BRI voice module (BVM) or BRI VIC is equipped to supply line power (phantom power). This command is used only on a BRI port operating in NT mode. A BRI port operating in TE mode is automatically disabled as a source of line power, and the line-power command is rejected. When you use the line-power command, the line power provision is activated on a BRI port if the port is equipped with the hardware to supply line power. When you enter the no line-power command, the line power provision is deactivated on a BRI port.
Note
If the BRI port is operating in NT mode, the line-power command will be accepted, but will have no effect if a BVM is not equipped to supply line power.
Examples
The following example configures a BRI port to supply power to an attached TE device (only if the BVM is equipped to supply line power):
interface bri 1 line-power
Cisco IOS Dial Technologies Command Reference November 2009
DIA-421
Dial Commands logging event nfas-status
logging event nfas-status
To enable the production of log messages when ISDN layer 2 changes occur on NFAS D-channels. (Primary or Backup D-channels up/down, and active/alternate D-channel changes), use the logging event nfas-status command in interface configuration mode. To disable notification, use the no form of this command. logging event nfas-status no logging event nfas-status
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled (does not produce reports).
Command Modes
Interface configuration
Command History
Release 12.2(13)T
Modification This command was introduced.
Usage Guidelines
This configuration command should be entered on each ISDN serial interface. This configuration command should be entered when the user wishes to see the NFAS D-channel status changes. Should “logging event link-status” not be configured, no indication may be provided when the NFAS D-channel status changes.
Examples
The following example shows how to enable the production of log messages when ISDN layer 2 changes occur on NFAS D-channels using the logging event nfas-status command.
Router(config-if)# logging event nfas-status
Cisco IOS Dial Technologies Command Reference
DIA-422
November 2009
Dial Commands loopback (controller el)
loopback (controller el)
To loop an entire E1 line (including all channel groups defined on the controller) toward the line and back toward the router or access server, use the loopback command in controller configuration mode. To remove the loop, use the no form of this command. loopback no loopback
Syntax Description
This command has no arguments or keywords.
Command Default
Loopback function is disabled.
Command Modes
Controller configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This command is useful for testing the DCE channel service unit/data service unit (CSU/DSU) itself. To display interfaces currently in loopback operation, use the show interfaces loopback EXEC command.
Examples
The following example configures the loopback test on the E1 line:
controller e1 0 loopback
Related Commands
Command show interfaces loopback
Description Displays information about the loopback interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-423
Dial Commands loopback local (controller)
loopback local (controller)
To loop an entire T1 line (including all channel groups defined on the controller) toward the line and the router or access server, use the loopback local command in controller configuration mode. To remove the loop, use the no form of this command. loopback local no loopback local
Syntax Description
This command has no arguments or keywords.
Command Default
Loopback function is disabled.
Command Modes
Controller configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This command is useful for testing the DCE channel service unit/data service unit (CSU/DSU) itself. To display interfaces currently in loopback operation, use the show interfaces loopback EXEC command.
Examples
The following example configures the loopback test on the T1 line:
controller t1 0 loopback local
Related Commands
Command
Description
show interfaces loopback Displays information about the loopback interface.
Cisco IOS Dial Technologies Command Reference
DIA-424
November 2009
Dial Commands loopback local (interface)
loopback local (interface)
To loop a channelized T1 or channelized E1 channel group, use the loopback local command in interface configuration mode. To remove the loop, use the no form of this command. loopback local no loopback local
Syntax Description
This command has no arguments or keywords.
Command Default
Loopback function is disabled.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This command is useful for looping a single channel group in a channelized environment without disrupting the other channel groups. To display interfaces currently in loopback operation, use the show interfaces loopback EXEC command.
Examples
The following example configures the loopback test on the T1 line:
interface serial 1/0:22 loopback local
Related Commands
Command show interfaces loopback
Description Displays information about the loopback interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-425
Dial Commands loopback remote (controller)
loopback remote (controller)
To loop packets from a MultiChannel Interface Processor (MIP) through the channel service unit/data service unit (CSU/DSU), over a dedicated T1 link, to the remote CSU at the single destination for this T1 link and back, use the loopback remote command in controller configuration mode. To remove the loop, use the no form of this command. loopback remote no loopback remote
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Controller configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This command applies only when the device supports the remote function. It is used for testing the data communication channels. For MIP cards, this controller configuration command applies if only one destination exists at the remote end of the cloud, the entire T1 line is dedicated to it, and the device at the remote end is a CSU (not a CSU/DSU). This is an uncommon case; MIPs are not usually used in this way. To display interfaces currently in loopback operation, use the show interfaces loopback EXEC command.
Examples
The following example configures a remote loopback test:
interface serial 0 loopback remote
Related Commands
Command show interfaces loopback
Description Displays information about the loopback interface.
Cisco IOS Dial Technologies Command Reference
DIA-426
November 2009
Dial Commands map-class dialer
map-class dialer
To define a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback, use the map-class dialer command in global configuration mode. map-class dialer class-name no map-class dialer class-name
Syntax Description
class-name
Unique class identifier.
Command Default
Command is disabled; no class name is provided.
Command Modes
Global configuration
Command History
Release 11.0
Modification This command was introduced.
Usage Guidelines
The class-name argument in the map-class dialer command used to specify the class must be the same as a class-name argument used in a dialer map command. This command is used on the PPP callback server, not on the callback client. This command is used to define classes of calls for PPP callback for dial-on-demand routing (DDR), for ISDN Advice of Charge, and for Network Specific Facilities (NSF) call-by-call dialing plans. For NSF call-by-call support on ISDN Primary-4ESS switches only, use one of the dialing-plan keywords listed in Table 19.
Table 19 NSF Keywords and Supported Services
Keyword sdnplan megaplan accuplan
NSF Dialing Plan SDN MEGACOMM ACCUNET
Data Yes No Yes
Voice Yes Yes Yes
International GSDN (Global SDN) Yes Yes
Examples
The following example configures the PPP callback server on an ISDN BRI interface on a router. The callback server requires an enable timeout and a map class to be defined.
interface BRI0 ip address 10.1.1.7 255.255.255.0 encapsulation ppp dialer callback-secure dialer enable-timeout 2
Cisco IOS Dial Technologies Command Reference November 2009
DIA-427
Dial Commands map-class dialer
dialer map ip 10.1.1.8 name mymap class dial1 81012345678901 dialer-group 1 ppp callback accept ppp authentication chap ! map-class dialer dial1 dialer callback-server username
The following example configures the ISDN switch type to Primary-4ESS and configures ISDN PRI on T1 controller 1/0, and sets the D channel for dialer map classes that reference the NSF dialing plans. Finally, the map-class dialer command uses a dialing plan keyword and the dialer outgoing command refers to the same plan.
isdn switch-type primary-4ess ! ! controller T1 1/0 framing esf linecode b8zs pri-group timeslots 1-24 ! interface Serial1/0:23 description This is the DMS D-channel 415-886-9503 ip address 10.1.1.3 255.255.255.0 encapsulation ppp no keepalive dialer map ip 10.1.1.1 name mymap class sdnplan 14155770715 dialer map ip 10.1.1.2 name hermap class megaplan 14155773775 dialer map ip 10.1.1.4 name hismap class accuplan 14155773778 dialer-group 1 ppp authentication chap ! map-class dialer sdnplan dialer outgoing sdn ! map-class dialer megaplan dialer voice-call dialer outgoing mega ! map-class dialer accuplan dialer outgoing accu
The following partial example configures BRI interface 0 to function as the callback server on the shared network. The callback server requires an enable timeout and a map class to be defined.
interface BRI0 ip address 10.2.1.7 255.255.255.0 encapsulation ppp dialer callback-secure dialer enable-timeout 2 dialer map ip 10.2.1.8 name mymap class dial1 81012345678901 dialer-group 1 ppp callback accept ppp authentication chap ! map-class dialer dial1 dialer callback-server username
The following example configures a map class named “mymap” and sets an ISDN speed of 56 kbps for the class.
map-class dialer mymap isdn speed 56
Cisco IOS Dial Technologies Command Reference
DIA-428
November 2009
Dial Commands map-class dialer
Related Commands
Command dialer map
Description Configures a serial interface or ISDN interface to call one or multiple sites or to receive calls from multiple sites.
dialer string (legacy DDR) Specifies the destination string (telephone number) to be called for interfaces calling a single site. show controllers e1 Displays information about the E1 links supported by the NPM (Cisco 4000) or MIP (Cisco 7500 series).
Cisco IOS Dial Technologies Command Reference November 2009
DIA-429
Dial Commands member
member
To alter the configuration of an asynchronous interface that is a member of a group, use the member command in interface configuration mode. To restore defaults set at the group master interface, use the no form of this command. member asynchronous-interface-number command no member asynchronous-interface-number command
Syntax Description
asynchronous-interface-number command
Number of the asynchronous interface to be altered. One or both of the following commands entered for this specific interface:
• •
peer default ip address description
Command Default
No individual configurations are set for member interfaces.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
You can customize a member interface by using the member command. Interfaces are designated as members of a group by using the interface group-async and group-range commands.
Examples
The following example defines interface 3 with a description of line 3, which is attached to a Hayes Optima modem:
interface group-async 0 member 3 description line #3 Hayes Optima
Related Commands
Command group-range
Description Creates a list of member asynchronous interfaces (associated with a group interface).
interface group-async Creates a group interface that will serve as master, to which asynchronous interfaces can be associated as members.
Cisco IOS Dial Technologies Command Reference
DIA-430
November 2009
Dial Commands member (dial peer cor list)
member (dial peer cor list)
To add a member to a dial peer class of restrictions (COR) list, use the member command in dial peer COR list configuration mode. To remove a member from a list, use the no form of this command. member class-name no member class-name
Syntax Description
class-name
Class name previously defined in dial peer COR custom configuration mode by using of the name command.
Command Default
No default behavior or values.
Command Modes
Dial peer COR list configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Examples
The following example adds three members to the COR list named list3:
dial-peer cor list list3 member 900_call member 800_call member catchall
Related Commands
Command dial-peer cor list
Description Defines a COR list name.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-431
Dial Commands modem always-on
modem always-on
To set a tty line to always be ready to interpret characters from network elements, use the modem always-on command in line configuration mode. To disable this function, use the no form of this command. modem always-on no modem always-on
Syntax Description
This command has no arguments or keywords.
Command Default
The tty line waits to recieve a data set ready (DSR), RING, or clear to send (CTS) signal before interpreting characters from network elements.
Command Modes
Line configuration
Command History
Release 12.4(4)T
Modification This command was introduced.
Usage Guidelines
To set the line as available to receive calls coming from the network via the router, you must also configure the line with the autocommand x28 command.
Examples
The following example configures tty line 97 to interpret characters received from network elements without having to wait for other incoming signals:
Router(config)# line 97 Router(config-line)# modem always-on
Related Commands
Command autocommand modem printer x28
Description Automatically executes a command when a user connects to a particular line. Configures a line to receive a DSR signal before it will interpret incoming characters from a network element. Enters X.28 mode and accesses an X.25 network or sets X.3 PAD parameters.
Cisco IOS Dial Technologies Command Reference
DIA-432
November 2009
Dial Commands modem answer-timeout
modem answer-timeout
To set the amount of time that the Cisco IOS software waits for the Clear to Send (CTS) signal after raising the data terminal ready (DTR) signal in response to RING, use the modem answer-timeout command in line configuration mode. To revert to the default value, use the no form of this command. modem answer-timeout seconds no modem answer-timeout
Syntax Description
seconds
Timeout interval in seconds, in the range from 0 to 65535.
Command Default
15 seconds
Command Modes
Line configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
This command is useful for modems that take a long time to synchronize to the appropriate line speed. For more information, see the chapter “Creating and Using Modem Chat Scripts” in the Cisco IOS Dial Technologies Configuration Guide.
Examples
The following example sets the timeout interval to 20 seconds for the modem connected to lines 3 through 13:
line 3 13 modem answer-timeout 20
Related Commands
Command modem callin modem inout
Description Supports dial-in modems that use the DTR signal to control the off-hook status of the modem. Configures a line for both incoming and outgoing calls.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-433
Dial Commands modem at-mode
modem at-mode
To open a directly connected session and enter AT command mode, which is used for sending AT (modem attention) commands to Microcom manageable modems, use the modem at-mode command in EXEC mode. modem at-mode slot/port no modem at-mode slot/port
Syntax Description
slot/port
Slot number and modem port number. Include the slash mark when entering this variable.
Command Default
Command is disabled.
Command Modes
EXEC
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
Manageable modems return “OK” if the AT command you send is successfully enabled. Press Ctrl-C after sending an AT command to close the directly connected session.
Note
This command does not apply to basic modems that have out-of-band ports.
Examples
The following example opens a directly connected session on modem 1/1, enters AT command mode on modem 1/1, and transmits the AT commands through the out-of-band feature of modem 1/1:
Router# modem at-mode 1/1 You are now entering AT command mode on modem (slot 1 / port 1). Please type CTRL-C to exit AT command mode. at%v MNP Class 10 V.34/V.FC Modem Rev 1.0/85 OK at\s IDLE LAST DIAL 000:00:00
NET ADDR: FFFFFFFFFFFF MODEM HW: SA 2W United States 4 RTS 5 CTS 6 DSR - CD 20 DTR - RI
Cisco IOS Dial Technologies Command Reference
DIA-434
November 2009
Dial Commands modem at-mode
MODULATION MODEM BPS MODEM FLOW MODEM MODE V.23 OPR. AUTO ANS. SERIAL BPS BPS ADJUST SPT BPS ADJ. ANSWER MESSGS SERIAL FLOW PASS XON/XOFF PARITY
IDLE 28800 OFF AUT OFF ON 115200 OFF 0 ON BHW OFF 8N
AT%G0 AT\G0 AT\N3 AT%F0 ATS0=1 AT%U0 AT\J0 AT\W0 ATQ0 AT\Q3 AT\X0 AT
Related Commands
Command clear modem
Description Resets the hardware for one or more manageable modems on access servers and routers.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-435
Dial Commands modem at-mode-permit
modem at-mode-permit
To permit a Microcom modem to accept a directly connected session, use the modem at-mode-permit command in line configuration mode. To disable permission for modems to accept a direct connection, use the no form of this command. modem at-mode-permit no modem at-mode-permit
Syntax Description
This command has no arguments or keywords.
Command Default
Command is enabled.
Command Modes
Line configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
After you enter this command, enter the modem at-mode command to enable a directly connected session on the modem. From AT command mode, you can enter AT (modem attention) commands directly from your terminal session. For a complete list of supported AT commands, refer to the AT command documentation that came with your access server or router. The no modem at-mode-permit command disables a modem from accepting a direct connection, which is useful for ensuring modem security.
Note
This command does not apply to basic modems, which do not have out-of-band ports.
Examples
The following example permits the modem connected to TTY line 1 to accept a directly connected session:
line 1 modem at-mode-permit
Related Commands
Command clear modem modem at-mode
Description Resets the hardware for one or more manageable modems on access servers and routers. Opens a directly connected session and enters AT command mode, which is used for sending AT commands to Microcom manageable modems.
Cisco IOS Dial Technologies Command Reference
DIA-436
November 2009
Dial Commands modem autoconfigure discovery
modem autoconfigure discovery
To configure a line to discover which kind of modem is connected to the router and to configure that modem automatically, use the modem autoconfigure discovery command in line configuration mode. To disable this feature, use the no form of this command. modem autoconfigure discovery no modem autoconfigure discovery
Syntax Description
This command has no arguments or keywords.
Command Default
No default behavior or values.
Command Modes
Line configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
The modem is identified each time the line is reset. If a modem cannot be detected, the line continues retrying for 10 seconds. When the modem type is determined, this information remains stored until the modem is recycled or disconnected. Using Discovery mode is much slower than configuring a line directly. Each time the modem is reset (every time a chat reset script is executed), a string of commands is sent to the modem, the first one being “return to factory-defaults.”
Examples
The following example automatically discovers which kind of modem is attached to the router or access server:
modem autoconfigure discovery
Related Commands
Command modem autoconfigure type
Description Directs a line to attempt to configure the attached modem using a predefined modemcap.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-437
Dial Commands modem autoconfigure type
modem autoconfigure type
To direct a line to attempt to configure the attached modem using the entry for the modem-type argument, use the modem autoconfigure type command in line configuration mode. To disable this feature, use the no form of this command. modem autoconfigure type modem-type no modem autoconfigure type
Syntax Description
modem-type
Modem type, such as a Codex 3260.
Command Default
No default behavior or values.
Command Modes
Line configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
The modem is reconfigured each time the line goes down.
Examples
The following example automatically configures the attached modem using the codex_3260 modemcap entry:
modem autoconfigure type codex_3260
Related Commands
Command modem autoconfigure discovery
Description Configures a line to discover which kind of modem is connected to the router and to configure that modem automatically.
Cisco IOS Dial Technologies Command Reference
DIA-438
November 2009
Dial Commands modem autotest
modem autotest
Support for the modem autotest command was removed in Cisco IOS Release 12.2(11)T. The use of this command is not recommended. In most cases, nonfunctional integrated modems will automatically be removed from service by the system. See the modem recovery action command and the spe recovery command for more configuration options for nonfunctional modems. For further information about MICA modem recovery, refer to the Configuring MICA Modem Recovery technical note. For further information about NextPort service processing element (SPE) recovery, refer to the Configuring NextPort SPE Recovery technical note.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-439
Dial Commands modem bad
modem bad
To remove an integrated modem from service and indicate it as suspected or proven to be inoperable, use the modem bad command in line configuration mode. To restore a modem to service, use the no form of this command. modem bad no modem bad
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Line configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
If you mark a modem as inoperable, it appears as Bad—without the asterisk (*)—in the Status column of the show modem command output. A modem marked inoperable by the modem startup-test command appears as Bad* in the show modem command output. Use the no modem bad command to unmark a modem as Bad* or Bad and restore it for dialup connection services.
Note
Only idle modems can be marked bad by the modem bad command. If you want to mark a modem bad that is actively supporting a call, first issue the modem shutdown command then issue the modem bad command.
Examples
The first part of the following example shows a successful connection between modem 2/1 and modem 2/0, which verifies normal operating conditions between these two modems. However, when modem 2/1 is tested against modem 2/3, the back-to-back modem test fails. Therefore, modem 2/3 is suspected or proven to be inoperable. Modem 2/3 is removed from dialup services through the use of the modem bad command on line 28.
Router# test modem back-to-back 2/1 2/0 Repetitions (of 10-byte packets) [1]: 10 Router# %MODEM-5-B2BCONNECT: Modems (2/1) and (2/0) connected in back-to-back test: CONN ECT9600/REL-MNP %MODEM-5-B2BMODEMS: Modems (2/0) and (2/1) completed back-to-back test: success/ packets = 20/20
Cisco IOS Dial Technologies Command Reference
DIA-440
November 2009
Dial Commands modem bad
Router# test modem back-to-back 2/1 2/3 Repetitions (of 10-byte packets) [1]: 10 Router# %MODEM-5-BADMODEMS: Modems (2/3) and (2/1) failed back-to-back test: NOCARRIER Router# configure terminal Router(config)# line 28 Router(config-line)# modem bad Router(config-line)# end
Related Commands
Command modem startup-test show modem at-mode test modem back-to-back
Description Performs diagnostic testing on each integrated modem during the rebooting process. Displays a high-level performance report for all the modems or a single modem. Diagnoses an integrated modem that may not be functioning properly.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-441
Dial Commands modem buffer-size
modem buffer-size
To configure the size of the history event queue buffer for integrated modems installed in an access server or router, use the modem buffer-size command in global configuration mode. modem buffer-size events no modem buffer-size events
Syntax Description
events
Defined number of modem events that each manageable modem is able to store. Default is 100 events.
Command Default
100 modem events
Command Modes
Global configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
A large buffer size uses substantial amounts of processing memory. If the processing memory is running low, reduce the modem buffer size. To display modem events, use the show modem log command.
Note
This command does not apply to basic modems that have out-of-band ports.
Examples
The following example enables each modem in the access server to store 150 modem events:
modem buffer-size 150
Related Commands
Command show modem log
Description Displays the modem history event status performed on a manageable modem or group of modems.
Cisco IOS Dial Technologies Command Reference
DIA-442
November 2009
Dial Commands modem busyout
modem busyout
To gracefully disable a modem from dialing or answering calls, use the modem busyout command in line configuration mode. To reenable a modem, use the no form of this command. modem busyout no modem busyout
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Line configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
The disabling action is not executed until the active modem returns to an idle state. No active connections are interrupted when you enter this command. If the modem busyout-threshold command is set, this command will be delayed until the DS0 lines to the exchange are taken out of service. For T3 cards the message “No Controller configured” might appear for unconfigured T1 links in the T3.
Examples
The following example disables the modem associated with line 1/0/5 from dialing and answering calls. You do not specify a slot or port number with this command.
line 1/0/5 modem busyout
The following example busyouts a range of modems:
line 1/0/5 1/0/72 modem busyout
The following example disables the modem associated with line 1 from dialing and answering calls. You do not specify a slot or port number with this command.
line 1 modem busyout
Cisco IOS Dial Technologies Command Reference November 2009
DIA-443
Dial Commands modem busyout
Related Commands
Command busyout ds0 busyout (channel)
Description Informs the central-office switch that a channel is out-of-service. Forces a DS0 time slot on a controller into the busyout state.
modem shutdown Abruptly shuts down an active or idle modem installed in an access server or router.
Cisco IOS Dial Technologies Command Reference
DIA-444
November 2009
Dial Commands modem busyout-threshold
modem busyout-threshold
To define a threshold to maintain a balance between the number of DS0s and modems, use the modem busyout-threshold command in global configuration mode. To remove the threshold, use the no form of this command. modem busyout-threshold threshold-number no modem busyout-threshold threshold-number
Syntax Description
threshold-number
Number of modems that are free when the router should enforce the stipulation that the number of free DS0 lines is less than or equal to the number of modems.
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Release 11.3(2)AA
Modification This command was introduced.
Usage Guidelines
The modem busyout-threshold command functionality is also often termed autobusyout. This command applies to all DS0 lines coming into the router and counts all free modems in all pools. The modem busyout-threshold command periodically checks to determine if the number of free modems is less than the user specified threshold and if it is it ensures that the number of free DS0 channels is less than or equal to the number of modems. This command should be used only where excess calls to one router are forwarded by the exchange to an additional router on the same exchange group number. Because the modem busyout-threshold command checks only periodically, the threshold should be greater than the number of calls the user expects to receive in 1 minute plus a safety margin. For example, if the user receives an average of 10 calls per minute, then a threshold of 20 would be advised. Very small thresholds should be avoided because they do not allow sufficient time for the exchange to respond to out-of-service notifications from the router, and callers may receive busy signals when free modems are all used.
Caution
The number of DS0 lines in normal operating conditions should be approximately equal to the number of modems (for example, within 30). If this is not the case, it will cause a lot of messaging traffic to the exchange and may cause active calls to be dropped. This caution is not a concern for short periods, that is, when modem cards are replaced. On T3 controllers, any contained T1 controllers that are not in use should be undeclared to remove them from the autobusyout list.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-445
Dial Commands modem busyout-threshold
Note
On T3 controllers, any contained T1 controllers that are not in use should be undeclared to remove them from the autobusyout list.This command is the same as the ds0 busyout-threshold command for the Cisco AS5300 and AS5800 access servers.
Examples
The following example shows how you might configure the modem busyout-threshold command:
modem busyout-threshold 30
Related Commands
Command busyout modem busyout modem shutdown
Description Informs the central-office switch that a channel is out-of-service. Disables a modem from dialing or answering calls whereby the disabling action is not executed until the active modem returns to an idle state. Abruptly shuts down an active or idle modem installed in an access server or router.
ds0 busyout (channel) Forces a DS0 timeslot on a controller into the busyout state.
Cisco IOS Dial Technologies Command Reference
DIA-446
November 2009
Dial Commands modem callin
modem callin
To support dial-in modems that use the data terminal ready (DTR) signal to control the off-hook status of the modem, use the modem callin command in line configuration mode. To disable this feature, use the no form of this command. modem callin no modem callin
Syntax Description
This command has no arguments or keywords.
Command Default
No modem control
Command Modes
Line configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
In response to the RING signal, the router raises the DTR signal, which indicates to the modem that it should answer the call. At the end of the session, the Cisco IOS software lowers the DTR signal, which disconnects the modem. This command is useful for older modems that do not support autoanswer. This command uses clear to send (CTS), whereas other modem commands in the Cisco IOS software use data set ready (DSR). Only use the modem callin command on the ASM terminal server, where hardware flow control is not possible. If you have a Cisco 2500 or 3600 series router, use the modem dialin command instead.
Examples
The following example configures lines 10 through 16 for dial-in modems that can run at speeds from 300 to 19,200 bits per second:
line 10 16 modem callin autobaud
Related Commands
Command modem answer-timeout modem inout
Description Sets the amount of time that the Cisco IOS software waits for the CTS signal after raising the DTR signal in response to RING. Configures a line for both incoming and outgoing calls.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-447
Dial Commands modem callout
modem callout
To configure a line for reverse connections, use the modem callout command in line configuration mode. To disable this feature, use the no form of this command. modem callout no modem callout
Syntax Description
This command has no arguments or keywords.
Command Default
No modem control
Command Modes
Line configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
This command supports ports connected to computers that would normally be connected to modems. It causes the access server to act somewhat like a modem. This command uses the clear to send (CTS) signal and should be used only on access servers that do not support hardware flow control. If you have an access server that is newer than the ASM terminal server (such as a Cisco 2500 or Cisco 3600 series routers, or a Cisco AS5100 or Cisco AS5200 access servers), use the modem host command instead. The modem callout command uses CTS, whereas the modem host command uses data set ready/ data carrier detect (DSR/DCD.) If CTS is used for modem control instead of DSR/DCD, it prevents CTS from being used by hardware flow control.
Examples
The following example configures lines 17 through 32 in reverse connection mode to a large terminal switch. By using Telnet to connect to a TCP port on this host, the user gets the next free line in the rotary group.
line 17 32 rotary 1 modem callout
Related Commands
Command modem inout show async-bootp
Description Configures a line for both incoming and outgoing calls. Displays the extended BOOTP request parameters that have been configured for asynchronous interfaces.
Cisco IOS Dial Technologies Command Reference
DIA-448
November 2009
Dial Commands modem call-record
modem call-record
To activate the logging of a summary of modem events upon the termination of a call, use the modem call-record command in global configuration mode. To deactivate modem event logging of calls, use the no form of this command. modem call-record terse [quiet] [max userid character-max] no modem call-record
Syntax Description
terse quiet
Specifies that only significant data is logged to the Modem Call Record (MCR). (Optional) Specifies that the MCR is sent only to the syslog server and not to the console.
max userid (Optional) Sets the maximum number of characters of the user ID that will be entered character-max into the MCR. The default length is 30 characters.
Command Default
Logging of modem events is off.
Command Modes
Global configuration
Command History
Release 11.3(6)AA 11.3(9)AA 12.0(4)T 12.1(1) 12.1(2)T
Modification This command was introduced. The max-userid keyword was added. The max-userid keyword was added. Support was added for NM-AM and NM-DM modem boards on the Cisco 2600 and Cisco 3600 series routers. The quiet keyword was added.
Usage Guidelines
The modem management subsytem provides event logs for each modem at each major event during usage of the modems. The volume of event logs being generated makes the monitoring of modem calls for debugging purposes difficult. The MCR log, activated using the modem call-record command, will log a summary of a modem call to syslog upon termination of the call. If a call fails to establish a connection, the call will be summarized in a Modem Call Failed Record. The MCR is written to the syslog and can be displayed using the terminal monitor or show logging command, or by examining files on a syslog server. The modem call-record command is supported on Cisco AS5200, AS5300, AS5800, 2600, and 3600 routers with integrated MICA technologies and Microcom modems. For systems with NextPort modems, use the spe call-record modem command. The information provided in the MCR log and the Modem Call Failed Record log varies depending on the type of modem being used. Table 20 describes the significant fields in the display for MICA technologies and Microcom modems.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-449
Dial Commands modem call-record
Table 20
modem call-record Field Descriptions
Field Interface slot Interface controller unit Interface channel Modem type Modem slot/port Call id Userid IP address Calling number Called number Connected standard
Description Interface slot of device assigned for call. Interface controller unit of device assigned for call. Interface channel of device assigned for call. Modem type used for call. Physical location for modem handling the call. Unique Call Identifier assigned to the modem call by the call switching module. User ID of caller. IP address assigned for caller. Modem calling number. Modem called number. Standard used for connection. Possible values are Bell103, Bell212, K56Flex 1.1, V.17, V.21, V.22, V.22bis, V.23, V.27, V.29, V.32, V.32bis, V.32terbo. V.34, V.34+, and V.90. Protocol user for connection. Possible values are ARA1.0, ARA2.0, ASYNC Mode, FAX Mode, LAP-M, MNP, SS7/COT, and SYNC Mode. Compression method used for connection. Possible values are MNP5 data, none, V.42bis both, V.42bis RX, and V.42bis TX. Actual bit rate from the remote Digital Signal Processor (DSP) to the local DSP at connect. Actual bit rate from the local DSP to the remote DSP at connect. Actual bit rate from the remote DSP to the local DSP at disconnect. Actual bit rate from the local DSP to the remote DSP at disconnect. Actual robbed bit signaling (RBS) pattern observed by the modem. The six LSBs of the returned value indicate the periodic RBS pattern where a one denotes a pulse code modulation sample with a robbed bit. (Only reported for K56Flex). Amount of digital padding (attenuation) in downlink, in decibels (dB). (Only reported for V.90 and K56Flex.) Count of total retrains and speed shifts. Signal quality values in a range from 0 to 7, where 0 is the worst. The units are arbitrary, approximating abs(log10(SNR)). Signal-to-noise ratio, ranging from 0 to 70 in dB steps. Count of total characters received for SYNC/ASYNC connection. Count of total characters sent for SYNC/ASYNC connection.
1
Connect protocol
Compression Initial RX bit rate Initial TX bit rate Final RX bit rate Final TX bit rate RBS pattern1
Digital pad1 Total retrains1 Signal quality value1 SNR Characters received Characters transmitted Characters received BAD
Total number of parity errored characters received (for ASYNC connections).
Cisco IOS Dial Technologies Command Reference
DIA-450
November 2009
Dial Commands modem call-record
Table 20
modem call-record Field Descriptions (continued)
Field Error correction frames received OK Error correction frames transmitted Error correction frames received BAD/ABORTED1 Call timer Final state Disconnect reason
Description Count of error-free Error Correction frames received. Incorrect or duplicate frames are not included. Count of unique Error Correction frames sent. Re-sent frames are not included. Total error correction retransmissions requested by this modem during the course of the link. Duration of call, in seconds. State of modem call before it terminated. Reason for call being disconnected. Each modem type handles parameter differently.
1. These fields are displayed only for MICA technologies modems.
Examples
The following example shows the activation of MCR logging:
modem call-record terse
The following is the MCR of a successful call on a MICA technologies modem:
*Aug 15 01:34:08.775: %CALLRECORD-3-MICA_TERSE_CALL_REC: DS0 slot/contr/channel=1/0/22 modem=mica slot/port=1/2 call_id=0x3 userid=user1 ip=124.34.45.120 calling=#4085550112 called=#4085550122 std=V.34+ prot=LAP-M comp=None init-rx/tx b-rate=31200/33600 finl-rx/tx b-rate=33600/33600 rbs=0 d-pad=None retr=2 sq=2 snr=28 rx/tx chars=1067/0 bad=0 rx/tx ec=0/0 bad=0 time=139 finl-state=Steady disc=0xA220 Type (=5 ): Rx (line to host) data flushing, not OK Class (=2 ): EC condition, locally detected Reason (=32): received DISC frame -- normal LAPM termination
The following is the MCR of a failed call on a MICA technologies modem:
*Aug 15 16:47:54.527: %CALLRECORD-3-MICA_TERSE_CALL_FAILED_REC: DS0 slot/contr/channel=1/0/22 modem=mica slot/port=1/2 call_id=0x9 calling=4085550112# called=#4085550122 time=2 finl-state=Link disc=0x7F06 Type (=3 ): Condition occurred during call setup Class (=31): Requested by host Reason (=6 ): network indicated disconnect
The following is the MCR of a successful call on a Microcom modem:
01:17:30: %CALLRECORD-3-MCOM_TERSE_CALL_REC: DS0 slot/contr/channel=0/0/22 modem=microcom_server slot/port=0/2 call_id=0x3 userid=sque ip=124.34.46.111 calling=#4085550111 called=#4085550122 std=V34 prot=Normal comp=None Init-RX/TX b-rate=33600/31200 Finl-RX/TX b-rate=33600/33600 SNR=47 RX/TX chars=0/0 RX/TX EC=0/0 time=73 Disc(local)=0x9 DTR Drop Disc(remote)=0x0 Unknown
Cisco IOS Dial Technologies Command Reference November 2009
DIA-451
Dial Commands modem call-record
The following is the MCR of a failed call on a Microcom modem:
Microcom Terse Modem Call Failed Record Log: 19:28:55: %CALLRECORD-3-MCOM_TERSE_CALL_FAILED_REC: DS0 slot/contr/channel=0/0/0 modem=microcom_server slot/port=0/2 call_id=0xA003 calling=4085550111# called=#4085550122 time=0 finl-state=Dialing/Answering disc(local)=0x9 DTR Drop disc(remote)=0x0 Unknown
Related Commands
Command calltracker call-record show logging spe call-record modem terminal monitor
Description Enables call record syslog generation for the purpose of debugging, monitoring, or externally saving detailed call record information. Displays the state of logging (syslog). Generates a modem call record at the end of each call. Displays debug command output and system error messages for the current terminal and session.
Cisco IOS Dial Technologies Command Reference
DIA-452
November 2009
Dial Commands modem country mica
modem country mica
To configure the modem country code for a bank of MICA technologies modems, use the modem country mica command in global configuration mode. To remove a country code from service, use the no form of this command. modem country mica country no modem country mica country
Syntax Description
country
Country name. See Table 21 for a list of the supported country name keywords.
Command Default
Command is disabled.
Command Modes
Global configuration
Command History
Release 11.2 P
Modification This command was introduced.
Usage Guidelines
Table 21 lists the supported codes for the country argument.
Table 21 MICA Country Names
australia austria belgium china cyprus czech-republic (Czech/Slovak Republic) denmark e1-default (Default E1, a-law) finland france germany hong-kong india ireland israel italy
Cisco IOS Dial Technologies Command Reference November 2009
DIA-453
Dial Commands modem country mica
Table 21
MICA Country Names (continued)
japan malaysia netherlands new-zealand norway poland portugal russia singapore south-africa spain sweden switzerland t1-default (Defaults T1, u-law) taiwan thailand turkey united-kingdom usa
Examples
The following example sets the MICA technologies modems for operation in Sweden:
modem country mica sweden
Related Commands
Command
Description
modem country microcom_hdms Configures the modem country code for a bank of Microcom modems.
Cisco IOS Dial Technologies Command Reference
DIA-454
November 2009
Dial Commands modem country microcom_hdms
modem country microcom_hdms
To configure the modem country code for a bank of Microcom High Density Management System (HDMS) modems, use the modem country microcom_hdms command in global configuration mode. To remove a country code from service, use the no form of this command. modem country microcom_hdms country no modem country microcom_hdms country
Syntax Description
country
Country name. See Table 22 for a list of the supported country name keywords.
Command Default
No country code is enabled.
Command Modes
Global configuration
Command History
Release 11.2 P 12.0
Modification This command was introduced. The europe keyword was added.
Usage Guidelines
Table 22 lists the supported codes for the country argument.
Table 22 Microcom Country Names
argentina australia austria belgium brazil canada chile china columbia czech-republic (Czech/Slovak Republic) denmark europe finland france germany
Cisco IOS Dial Technologies Command Reference November 2009
DIA-455
Dial Commands modem country microcom_hdms
Table 22
Microcom Country Names (continued)
greece hong-kong hungary india indonesia finland israel italy japan korea malaysia mexico netherlands norway peru philippines poland portugal saudi-arabia singapore south-africa spain sweden switzerland taiwan thailand united-kingdom usa
Examples
The following example shows the different duplex configuration options you can configure on a Cisco AS5300:
Router(config)# modem country microcom_hdms ? argentina australia austria belgium chile china columbia Argentina Australia Austria Belgium Chile China Columbia
Cisco IOS Dial Technologies Command Reference
DIA-456
November 2009
Dial Commands modem country microcom_hdms
czech-republic denmark europe finland france germany greece hong-kong india indonesia ireland israel italy japan korea malaysia mexico netherlands new-zealand norway peru philippines poland portugal saudi-arabia singapore south-africa spain sweden switzerland taiwan thailand united-kingdom usa
Czech/Slovak Republic Denmark Europe Finland France Germany Greece Hong Kong India Indonesia Ireland Israel Italy Japan Korea Malaysia Mexico Netherlands New Zealand Norway Peru Philippines Poland Portugal Saudi Arabia Singapore South Africa Spain Sweden Switzerland Taiwan Thailand United Kingdom USA
Related Commands
Command modem country mica
Description Configures the modem country code for a bank of MICA technologies modems.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-457
Dial Commands modem country smart_acf
modem country smart_acf
To customize the modem firmware behavior according to the country of deployment, use the modem country smart_acf command in global configuration mode. To restore the default value, use the no form of this command. modem country smart_acf country-name no modem country smart_acf country-name
Syntax Description
country-name
Name of the country. For valid argument values, see the table in the “Usage Guidelines” section.
Command Default
United States and Canada
Command Modes
Global configuration
Command History
Release 12.3(4)XD 12.3(7)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.3(7)T on Cisco 2600 series and Cisco 3700 series routers.
Usage Guidelines
Use this command to set the modem for use in a specific country. When a country name is specified, the firmware customizes the modem for use in the country where it is deployed. The following table includes valid values for the country-name argument and the country or countries associated with each argument value. Valid Values for the country-name Argument argentina australia austria belgium brazil bulgaria china croatia czech denmark finland france Country or Countries Where Located Argentina Australia Austria Belgium and Luxemburg Brazil Bulgaria China Croatia Czechoslovakia Denmark and Iceland Finland France
Cisco IOS Dial Technologies Command Reference
DIA-458
November 2009
Dial Commands modem country smart_acf
Valid Values for the country-name Argument germany greece hongkong hungary india ireland israel italy japan jordan korea malaysia mexico morocco netherlands newzealand norway poland portugal romania russia safrica singapore slovenia spain sweden switzerland taiwan thailand turkey uae uk usa
Country or Countries Where Located Germany Greece Hong Kong Hungary India Ireland Israel Italy Japan Jordan Korea Malaysia Mexico Morocco Netherlands New Zealand Norway Poland Portugal Romania Russia South Africa Singapore Slovenia Spain Sweden Switzerland Taiwan and Peru Thailand Turkey United Arab Emirates United Kingdom United States and Canada
Examples
The following example sets the modem for use in Turkey:
Router# config terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# modem country smart_acf turkey
Cisco IOS Dial Technologies Command Reference November 2009
DIA-459
Dial Commands modem country smart_acf
Related Commands
Command show modem version
Description Displays the software version and the crash log of the modem.
Cisco IOS Dial Technologies Command Reference
DIA-460
November 2009
Dial Commands modem cts-required
modem cts-required
The modem cts-required command is replaced by the modem printer command. See the description of the modem printer command for more information.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-461
Dial Commands modem dialin
modem dialin
To configure a line to enable a modem attached to the router to accept incoming calls only, use the modem dialin command in line configuration mode. To disable this feature, use the no form of this command. modem dialin [delay] no modem dialin
Syntax Description
delay
(Optional) Causes the operating system to delay assertion of the data terminal ready (DTR) signal until a network connection is established.
Command Default
Incoming calls to the modem are not permitted.
Command Modes
Line configuration
Command History
Release 11.1 12.2(4)T
Modification This command was introduced. The delay keyword was added to support the Cisco modem user interface.
Usage Guidelines
This command supports modems that can automatically handle telephone line activity, such as answering the telephone after a certain number of rings. The delay keyword is useful when using the modemui EXEC command with software that requires a signal assertion to recognize that a connection has been established. It may be necessary to reroute the router DTR signal to an alternate EIA-232 pin such as Carrier Detect (CD) for the delay to work properly.
Examples
The following example configures a line for a high-speed modem:
line 5 modem dialin
The following example shows how to set up a delay in a line configured for the Cisco modem user interface feature:
line aux 0 login authentication modem modem dialin delay autocommand modemui transport input all stopbits 1 speed 38400 flowcontrol hardware
Cisco IOS Dial Technologies Command Reference
DIA-462
November 2009
Dial Commands modem dialin
Related Commands
Command modem inout modemui parity
Description Configures a line for both incoming and outgoing calls. Enters the Cisco modem user interface mode. Defines generation of a parity bit.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-463
Dial Commands modem dialout controller
modem dialout controller
To specify a particular T1 or E1 controller through which to dial out, use the modem dialout controller command in line configuration mode. To disable the command, use the no form of this command. modem dialout controller {e1 | t1} controller-list no modem dialout controller
Syntax Description
e1 t1 controller-list
Wide-area digital transmission scheme used predominantly in Europe. Wide-area digital carrier facility. List of controllers through which to dial out. The range is from 0 to 7. List the controllers individually (1, 2, 3, for example).
Command Default
All T1 and E1 controllers are used for dial out.
Command Modes
Line configuration
Command History
Release 12.2
Modification This command was introduced.
Usage Guidelines
This command is only supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, and Cisco AS5800.
Examples
In the following example, the router is configured to use the controller t1 0, t1 1, t1 3 (and no others) when dialing out from lines 1 through 60:
line 1 60 modem dialout controller t1 0,1,3
Cisco IOS Dial Technologies Command Reference
DIA-464
November 2009
Dial Commands modem dtr-active
modem dtr-active
To configure a line to leave data terminal ready (DTR) signals low, unless the line has an active incoming connection or an EXEC process, use the modem dtr-active command in line configuration mode. To disable this feature, use the no form of this command. modem dtr-active no modem dtr-active
Syntax Description
This command has no arguments or keywords.
Command Default
No modem control.
Command Modes
Line configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
This command does not use the Carrier Detect (CD) signal. This command can be useful if the line is connected to an external device (for example, a time-sharing system) that must know whether a line is in active use. The modem dtr-active command is similar to the no modem line configuration command.
Examples
The following example configures a line for low DTR:
line 5 modem dtr-active
Related Commands
Command modem printer
Description Configures a line to require a DSR signal instead of CTS.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-465
Dial Commands modem enable
modem enable
To enable backup dial capability through the console port (change the console port into an auxiliary port), use the modem enable command in line configuration mode. To return the auxiliary port to a console port, use the no form of this command. modem enable [autodetect] no modem enable
Syntax Description
autodetect
(Optional) Automatically senses the type of device connected on the console line.
Command Default
This command is not configured by default, and is applicable only on the console line.
Command Modes
Line configuration
Command History
Release 12.2(8)YN 12.2(13)ZG 12.3(2)T
Modification This command was introduced. The optional autodetect keyword was added to this command for Cisco 831, 836, and 837, and Cisco SOHO 91 and 97 routers. This command was integrated into Cisco IOS Release 12.3(2)T.
Usage Guidelines
On the Cisco 831, 836, and 837, and SOHO 91 and 97 routers, the console port and the auxiliary port share the same physical RJ-45 port. The console port must be changed to act as a virtual auxiliary port using the modem enable [autodetect] command before the dial backup and remote management capabilities can be enabled. Use the show line autodetect EXEC command to determine when a modem or a console has been detected. This command displays the following messages to indicate the type or state of connection on the console line:
• • • • •
Detection State: Console Attached—A DTE console or terminal device is attached. Detection State: Modem Attached—A DCE asynchronous modem device is attached. Detection State: Nothing Attached—No cable is attached to the EIA/TIA--232 port on the router. Detection State: Init State—Autodetection has been enabled, but no changes have been detected. Detection State: Feature not enabled—No device connection is detected.
Note
The auto detection capability on the Cisco 831, 836, and 837 routers that detects whether a modem or console is attached to its RJ-45 console port will not work when the router is booting up. The routers use the data set ready (DSR) and clear to send (CTS) pin statuses to detect whether a modem or console is attached.
Cisco IOS Dial Technologies Command Reference
DIA-466
November 2009
Dial Commands modem enable
Examples
The following example enables the line autodetect option:
Router(config-line)# modem enable autodetect
Use the show line autodetect command to determine when a modem or a console has been detected:
Router# show line autodetect Detection State: Nothing Attached Router# show line autodetect Detection State: Console Attached
Related Commands
Command show line autodetect
Description Displays type or state of connection on the console line.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-467
Dial Commands modem hold-reset
modem hold-reset
To reset and isolate integrated modems for extensive troubleshooting, use the modem hold-reset command in line configuration mode. To restart a modem, use the no form of this command. modem hold-reset no modem hold-reset
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Line configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
The modem hold-reset command for the V.110 port module resets the processor on board the module only if the command is executed on all 12 ports. If the modem hold-reset command is issued on only a portion of the V.110 ports, the processor will not reset. This command is also used to reset a modem that is frozen in a suspended state. Disable the suspended modem with the modem hold-reset command, and then restart initialization with the no modem hold-reset command.
Examples
The following example disables the suspended modem using tty line 4 and resets the modem’s initialization:
line 4 modem hold-reset no modem hold-reset
The following examples resets a 12-port V.110 port module. You must specify the entire tty line range for the entire bank of ports.
line 1 12 modem hold-reset no modem hold-reset
Related Commands
Command modem autotest
Description Automatically and periodically performs a modem diagnostics test for modems inside the access server or router.
Cisco IOS Dial Technologies Command Reference
DIA-468
November 2009
Dial Commands modem host
modem host
To configure a line for reverse connections where hardware flow control is also required, use the modem host command in line configuration mode. To disable the line modem control for reverse connections, use the no form of this command. modem host no modem host
Syntax Description
This command has no arguments or keywords.
Command Default
No modem control
Command Modes
Line configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
This command supports ports connected to computers that would normally be connected to modems. This command causes the access server to act like a modem. The modem host command is identical in operation to the modem callout command except that data set ready/data carrier detect (DSR/DCD) is used for modem control instead of clear to send (CTS). This frees CTS for use by hardware flow control.
Examples
The following example configures a line to send a DSR/DCD active signal to the modem for data switches and hosts:
line 5 modem host
Related Commands
Command modem callout modem printer
Description Configures a line for reverse connections. Configures a line to require a DSR signal instead of CTS.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-469
Dial Commands modem inout
modem inout
To configure a line for both incoming and outgoing calls, use the modem inout command in line configuration mode. To disable the configuration, use the no form of this command. modem inout no modem inout
Syntax Description
This command has no arguments or keywords.
Command Default
No modem control.
Command Modes
Line configuration
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
This command uses DSR and RING signals for carrier detection. The Cisco IOS software does not support any dialing protocols; therefore, the host system software or the user must provide any special dialing commands when using the modem for outgoing calls.
Examples
The following example configures a line for both incoming and outgoing calls:
line 5 modem inout
Related Commands
Command parity
Description Defines generation of a parity bit.
Cisco IOS Dial Technologies Command Reference
DIA-470
November 2009
Dial Commands modem cts-alarm
modem cts-alarm
To enable the router to react to a Clear to Send (CTS) drop from a remote device, and to clear an existing EXEC session, use the modem cts-alarm command in line configuration mode. To disable the system from reacting to CTS drops from remote devices, and to have the router ignore to CTS drops, use the no form of this command.
modem cts-alarm no modem cts-alarm
Syntax Description
This command does not have any keywords or arguments.
Command Default
The system does not react to CTS drops.
Command Modes
Line configuration (config-line)
Command History
Release 12.0T 12.2(4)T
Modification This command was introduced. This command was integrated into the Cisco IOS Release 12.2(4)T.
Usage Guidelines
This command allows a router to react to asynchronous devices that signal state changes via CTS. When an asynchronous line is used to connect to remote devices, the modem cts-alarm command allows the router to react to a CTS drop from the remote device and clear any existing EXEC session that it might have. By default, the recovery and EXEC restart sessions are not triggered by CTS changes if the modem-cts-alarm command is not configured.
Examples
The following example shows how to configure a line for a modem:
Router# configure terminal Router(config)# line 8 9 Router(config-line)# modem cts-alarm Router(config)# end Router#
Cisco IOS Dial Technologies Command Reference November 2009
DIA-471
Dial Commands modem link-info poll time
modem link-info poll time
To set the polling interval at which link statistics are retrieved from the MICA technologies modem, use the modem link-info poll time command in global configuration mode. To return to the default condition, use the no form of this command. modem link-info poll time seconds no modem link-info poll time seconds
Syntax Description
seconds
Number of seconds between polling intervals. The valid range is from 10 to 65535.
Command Default
Link statistics are not polled.
Command Modes
Global configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
The modem link-info poll time command periodically polls active modem sessions to collect information such as attempted transmit and receive rates, maximum and minimum transmit and receive rates, and locally and remotely issued retrains and speedshift counters. This data is polled from MICA portware and passed unsolicited to Cisco IOS software. Enabling the modem link-info poll time command disables the modem poll time command. Any modem poll time configuration is ignored because all modem events are sent to the access server unsolicited and no longer require polling by Cisco IOS software.
Note
The modem link-info poll time command consumes a substantial amount of memory, approximately 500 bytes for each MICA modem call. You should use this command only if you require the specific data that it collects; for instance, if you have enabled Call Tracker on your access server using the calltracker call-record command.
Examples
The following example polls link statistics at 90 second intervals:
modem link-info poll time 300
Cisco IOS Dial Technologies Command Reference
DIA-472
November 2009
Dial Commands modem link-info poll time
Related Commands
Command calltracker call-record show call calltracker active show call calltracker handle show call calltracker history show modem calltracker
Description Enables Call Tracker on the access server. Displays the detailed data stored within Call Tracker for active calls. Displays the detailed data stored within Call Tracker for a specific call specified unique call handle identifier. Displays the detailed data stored within Call Tracker for terminated calls. Displays the detailed data stored within Call Tracker for the last call on the specified modem.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-473
Dial Commands modem log
modem log
To configure the types of EIA/TIA events that are stored in the modem log, use the modem log command in line configuration mode. To prevent a type of EIA/TIA event from being stored in the modem log, use the no form of this command. modem log {cts | dcd | dsr | dtr | ri | rs232 | rts | tst} no modem log {cts | dcd | dsr | dtr | ri | rs232 | rts | tst}
Syntax Description
cts dcd dsr dtr ri rs232 rts tst
Specifies that EIA/TIA clear to send (CTS) events are stored in the modem log. Specifies that EIA/TIA data carrier detect (DCD) events are stored in the modem log. Specifies that EIA/TIA data set ready (DSR) events are stored in the modem log. Specifies that EIA/TIA data terminal ready (DTR) events are stored in the modem log. Specifies that EIA/TIA ring indication (RI) events are stored in the modem log. Specifies that all EIA/TIA events are stored in the modem log. Specifies that EIA/TIA request to send (RTS) events are stored in the modem log. Specifies that EIA/TIA transmit signal timing (TST) events are stored in the modem log.
Command Default
No EIA/TIA events are logged.
Command Modes
Line configuration
Command History
Release 11.3AA 12.0(5)T
Modification This command was introduced for the Cisco AS5300 access server. This command was implemented on the Cisco AS5800 access server.
Usage Guidelines
Use the modem log command to suppress the storage of undesired EIA/TIA history events in the modem log.
Examples
The following example configures the storage of EIA/TIA CTS and DSR events on lines 1 through 120:
line 1 120 modem log cts modem log dsr
Related Commands
Command show modem log
Description Displays the modem history event status performed on a manageable modem or group of modems.
Cisco IOS Dial Technologies Command Reference
DIA-474
November 2009
Dial Commands modem min-speed max-speed
modem min-speed max-speed
To configure various modem-service parameters, use the modem min-speed max-speed command in service profile configuration mode. To remove modem parameters, use the no form of this command. modem min-speed {bps | any} max-speed {bps | any [modulation value][error-correction value][compression value]} no modem min-speed {bps | any} max-speed {bps | any [modulation value][error-correction value][compression value]}
Syntax Description
bps any modulation value error-correction value compression value
Minimum and maximum bit rate for the modems, which can be from 300 to 56,000 bits per second (bps). The bit rate must be in V.90 increments. Any minimum or maximum speed. (Optional) Sets a maximum negotiated speed. Replace the value argument with one of the following choices: any, k56flex, v22bis, v34, or v90. Replace the value argument with one of the following choices: any, 1apm, mnp4, none. Replace the value argument with one of the following choices: any, mnp5, none, v42bis.
Command Default
No modem service parameters are defined by default. Any default services provided by the modems will be available.
Command Modes
Service profile configuration
Command History
Release 12.0(4)XI
Modification This command was introduced.
Examples
The following example shows the modem service parameters for the service profile named user1sample configured for any minimum or maximum and sets a maximum negotiated speed to k56flex.
resource-pool profile service user1sample modem min-speed any max-speed any modulation k56flex
Cisco IOS Dial Technologies Command Reference November 2009
DIA-475
Dial Commands modem poll retry
modem poll retry
To set the maximum number of polling attempts used to retrieve performance statistics from a modem installed in an access server or router, use the modem poll retry command in global configuration mode. To change or remove the polling attempts, use the no form of the command. modem poll retry polling-attempts no modem poll retry polling-attempts
Syntax Description
polling-attempts
Maximum number of polling attempts. The configuration range is from 0 to 10 attempts, and the default is 3.
Command Default
Three polling attempts
Command Modes
Global configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
Higher settings cause the software to keep polling one modem for status and to avoid polling other modems, which decreases the amount of statistics that are gathered.
Note
This command does not apply to basic modems that have out-of-band ports.
Examples
The following example configures the server to attempt to retrieve statistics from a local modem up to five times before discontinuing the polling effort:
modem poll retry 5
Related Commands
Command clear modem modem poll time modem status-poll
Description Resets the hardware for one or more manageable modems on access servers and routers. Sets the time interval between modem polls, which are used to periodically retrieve and report modem statistics. Polls for modem statistics through the out-of-band feature of a modem.
Cisco IOS Dial Technologies Command Reference
DIA-476
November 2009
Dial Commands modem poll time
modem poll time
To set the time interval between modem polls, which are used to periodically retrieve and report modem statistics, use the modem poll time command in global configuration mode. To restore the 12-second default setting, use the no form of this command. modem poll time interval no modem poll time interval
Syntax Description
interval
Interval, in seconds, between polls. The configuration range is from 2 to 120 seconds, and the default is 12 seconds.
Command Default
12 seconds
Command Modes
Global configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
This command does not apply to basic modems, which do not have out-of-band ports.
Examples
The following example sets the time interval between polls to 10 seconds:
modem poll time 10
Related Commands
Command
Description
modem min-speed max-speed Sets the maximum number of polling attempts used to retrieve performance statistics from a modem installed in an access server or router. modem status-poll Polls for modem statistics through the out-of-band feature of a modem.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-477
Dial Commands modem printer
modem printer
To configure a line to require receipt of a data set ready (DSR) modem control signal, use the modem printer command in line configuration mode. To require the clear to send (CTS) modem control signal instead, use the no form of this command. modem printer [always-on] [delay] no modem printer [always-on] [delay]
Syntax Description
always-on
(Optional) Enables the line to interpret characters received from network elements after receiving a DSR signal. The line need not wait for a CTS signal. (Optional) Causes router to delay assertion of the data terminal ready (DTR) signal until a network connection has been established.
delay
Command Default
The modem requires the CTS signal. Hardware flow control cannot be configured concurrently.
Command Modes
Line configuration mode.
Command History
Release 11.1 12.2(15)T 12.4(4)T
Modification This command was introduced. Support was added for the delay keyword. Support was added for the always-on keyword.
Usage Guidelines
Use the modem printer command to set DSR as the modem control signal, leaving the CTS signal free for use with hardware flow control. This allows hardware flow control to be configured concurrently. Although the modem dialin command supports modems concurrently with hardware flow control, the other auxiliary modem control options for printers, such as modem cts-required, use CTS instead of DSR/carrier detect (CD), as the CD signal. To make the line available to receive calls coming from the network via the router with the always- on keyword, you must also configure that line with the autocommand x28 command.
Examples
The following example configures a line to send a DSR signal to the modem:
Router(config)# line 5 Router(config-line)# modem printer
The following example configures a line to become ready to interpret characters from network elements when it receives a DSR signal:
Router(config)# line 5 Router(config-line)# modem printer always-on
Cisco IOS Dial Technologies Command Reference
DIA-478
November 2009
Dial Commands modem printer
Related Commands
Command autocommand flowcontrol modem always-on modem dialin x28
Description Automatically executes a command when a user connects to a particular line. Sets the method of data flow control between the router and a terminal or other serial device. Sets a tty line to always be ready to interpret characters from network elements. Configures a line to enable a modem attached to the router to accept incoming calls only. Enters X.28 mode and accesses an X.25 network or sets X.3 PAD parameters.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-479
Dial Commands modem recovery action
modem recovery action
To specify a modem recovery action, use the modem recovery action command in global configuration mode. To turn the modem recovery action off, use the no form of this command. modem recovery action {disable | download | none} no modem recovery action
Syntax Description
disable download none
Marks the modem bad. Recovers by firmware download (default). Sets the modem into a recovery pending state, thus stopping the modem from accepting new calls. Does not try to recover. Ignores the recovery threshold and just keeps running.
Command Default
The default setting is download.
Command Modes
Global configuration
Command History
Release 12.0 12.1(2.3)T
Modification This command was introduced. This command was no longer supported on Cisco AS5800 platforms.
Usage Guidelines
MICA technologies portware is downloaded on a modular basis and not on a modem basis. Thus, reloading MICA portware requires all 6 or 12 modems in a module to be reloaded.
Note
Beginning with Cisco IOS Release 12.1(2.3)T1, the modem recovery action command is no longer supported for MICA technologies modems on the Cisco AS5800 platforms. To specify a modem recovery action for MICA technologies modems on the Cisco AS5800 platforms, use the spe recovery command. After a modem has been deemed faulty, the configured action will take place on the modem. The following choices are possible: disable, download, and none.
Examples
The following example sets the recovery action to mark the modem as bad:
modem recovery action disable
Cisco IOS Dial Technologies Command Reference
DIA-480
November 2009
Dial Commands modem recovery action
Related Commands
Command modem recovery threshold modem recovery-time
Description Specifies the threshold, which starts the modem recovery process. Sets the maximum amount of time the call-switching module waits for a local modem to respond to a request before it is considered locked in a suspended state.
modem recovery maintenance Specifies the scheduled modem maintenance recovery behavior.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-481
Dial Commands modem recovery maintenance
modem recovery maintenance
To specify the modem maintenance recovery behavior, use the modem recovery maintenance command in global configuration mode. To change or turn off this behavior, use the no form of this command. modem recovery maintenance {action {disable | drop-call | reschedule} | max-download recovery-downloads | schedule {immediate | pending} | time hh:mm | window minutes} no modem recovery maintenance
Syntax Description
action disable drop-call reschedule
Mode of recovery. The default is set to reschedule. Marks the modem bad. Marks the originally faulty modem as bad and returns all other modems back into service. Forces firmware download by dropping holding calls. This action forces the recovery by dropping any active calls remaining on modems within the module. Reschedules firmware download to next maintenance time. Leaves the originally faulty modem as needing recovery and returns all other modems into service. Recovery will be attempted again on the following day. The default is set to reschedule.
max-download Maximum simultaneous recovery downloads. You must choose one number from recovery-downloads 1 to 30. A range of values is not supported. schedule Scheduling method for modem recovery. Determines if the system should attempt module recovery as soon as a problem is found or wait for the maintenance window. Immediately attempts modem recovery. Delays recovery until maintenance time (default). Time of day for scheduled modem recovery, in hours and minutes. This is the actual time of day when the modem recovery maintenance process wakes up and starts recovering MICA technologies modems. The default time is 3:00 a.m. Amount of time for normal recovery to take place. This is the delay timer in minutes, which is from 0 to 360.
immediate pending time hh:mm
window minutes
Command Default
The default mode of recovery (action) is set to reschedule. The default schedule is set to pending. The default time for scheduled modem recovery is 3:00 a.m.
Command Modes
Global configuration
Command History
Release 12.0 12.1(2.3)T1
Modification This command was introduced. This command was no longer supported on Cisco AS5800 platforms.
Cisco IOS Dial Technologies Command Reference
DIA-482
November 2009
Dial Commands modem recovery maintenance
Usage Guidelines
MICA portware is downloaded on a modular basis and not on a modem basis. Thus, reloading MICA portware requires all 6 or 12 modems in a module to be reloaded.
Note
Beginning with Cisco IOS Release 12.1(2.3)T1, the modem recovery maintenance command is no longer supported for MICA technologies modems on the Cisco AS5800 platforms. To specify a modem recovery action for MICA technologies modems on the Cisco AS5800 platforms, use the spe recovery command. Every 24 hours, the modem recovery maintenance process will wake up and attempt to recover any modems that are in the pending recovery state. When a MICA module attempts to reload its portware, it must avoid taking down any modem connections that may exist. As such, the recovery process sets all modems currently not in use to recovery pending state. If any modems on the module are active, the recovery process waits for the calls to terminate normally. To avoid capacity problems from attempting recovery for an excessively long time period, a maintenance window is configured to require the modem recovery to take place within a specific timeframe. Otherwise, a given action is performed on that module when the window expires. The default window is 60 minutes. This behavior is set using the modem recovery maintenance window minutes command. When the modem recovery maintenance window expires, one of the following actions is performed on the modem module awaiting recovery: disable, reschedule, or drop-call. The disable option is associated with the modem recovery action command. When the modem recovery maintenance process starts, it attempts to recover all modems in the recovery pending state. This attempt can be on all modules on a given system. Thus, to avoid taking down all modems on a given system, only a maximum of simultaneous module recoveries can take place. The default is dynamically calculated to be 20 percent of the modules on a given system. This configuration allows that value to be overridden. These options are associated with the modem recovery maintenance max-download command.
Examples
The following examples show the available options for this command:
Router(config)# modem recovery maintenance ? action max-download schedule time window Mode of recovery Maximum simultaneous recovery downloads Scheduling method for modem recovery Time of day for scheduled modem recovery Amount of time for normal recovery to take place
Router(config)# modem recovery maintenance action ? disable drop-call reschedule Mark the modem bad Force firmware download by dropping holding calls Reschedule firmware download to next maintenance time
Router(config)# modem recovery maintenance max-download ? <1-30> Number of MICA modules which can be simultaneously recovered
Router(config)# modem recovery maintenance schedule ? immediate Attempt recovery immediately pending Delay recovery until maintenance time
Cisco IOS Dial Technologies Command Reference November 2009
DIA-483
Dial Commands modem recovery maintenance
The following example shows how to set modem recovery maintenance to start immediately:
modem recovery maintenance schedule immediate
Related Commands
Command modem recovery action modem recovery threshold modem recovery-time
Description Specifies the modem recovery mode when a modem has been identified as faulty. Specifies the threshold, which starts the modem recovery process. Sets the maximum amount of time the call-switching module waits for a local modem to respond to a request before it is considered locked in a suspended state.
Cisco IOS Dial Technologies Command Reference
DIA-484
November 2009
Dial Commands modem recovery threshold
modem recovery threshold
To specify a failed call threshold that starts the modem recovery process, use the modem recovery threshold command in global configuration mode. To disable the threshold value, use the no form of this command. modem recovery threshold failed-calls no modem recovery threshold
Syntax Description
failed-calls
Number of consecutive call attempts that fail to queue up before the modem is deemed faulty, in the range from 1 to 1000.
Command Default
30 call attempts are enabled by default.
Command Modes
Global configuration
Command History
Release 12.0 12.1(2.3)T1
Modification This command was introduced. This command was no longer supported on Cisco AS5800 platforms.
Usage Guidelines
MICA technologies portware is downloaded on a modular basis and not on a modem basis. Thus, reloading MICA portware requires all 6 or 12 modems in a module to be reloaded.
Note
Beginning with Cisco IOS Release 12.1(2.3)T1, the modem recovery threshold command is no longer supported for MICA technologies modems on the Cisco AS5800 platforms. To specify a modem recovery action for MICA technologies modems on the Cisco AS5800 platforms, use the spe recovery command.
Examples
The following example shows how to set the modem recovery threshold to 12 failed calls:
modem recovery threshold 12
Related Commands
Command modem recovery action
Description Specifies the modem recovery mode when a modem has been identified as faulty. Sets the maximum amount of time the call-switching module waits for a local modem to respond to a request before it is considered locked in a suspended state.
modem recovery maintenance Specifies the scheduled modem maintenance recovery behavior. modem recovery-time
Cisco IOS Dial Technologies Command Reference November 2009
DIA-485
Dial Commands modem recovery-time
modem recovery-time
To set the maximum amount of time the call-switching module waits for a local modem to respond to a request before it is considered locked in a suspended state, use the modem recovery-time command in global configuration mode. To set a 5-minute response time, which is the default setting, use the no form of this command. modem recovery-time response-time no modem recovery-time
Syntax Description
response-time
Maximum amount of time, in minutes, for which local modems wait for a response; default is 5 minutes.
Command Default
5 minutes
Command Modes
Global configuration
Command History
Release 11.2 12.1(2.3)T
Modification This command was introduced. This command was no longer supported on Cisco AS5800 platforms.
Usage Guidelines
This command does not apply to basic modems that do not have out-of-band ports. After the call-switching module resets a suspended modem, it recovers to a default call switching module state.
Note
Beginning with Cisco IOS Release 12.1(2.3)T, the modem recovery-time command is no longer supported for MICA technologies modems on the Cisco AS5800 platforms. To specify a modem recovery action for MICA technologies modems on the Cisco AS5800 platforms, use the spe recovery command.
Examples
The following example configures the call-switching module to wait for 8 minutes:
modem recovery-time 8
Cisco IOS Dial Technologies Command Reference
DIA-486
November 2009
Dial Commands modem recovery-time
Related Commands
Command modem recovery action
Description Specifies the modem recovery mode when a modem has been identified as faulty. Specifies the threshold, which starts the modem recovery process.
modem recovery maintenance Specifies the scheduled modem maintenance recovery behavior. modem recovery threshold
Cisco IOS Dial Technologies Command Reference November 2009
DIA-487
Dial Commands modem ri-is-cd
modem ri-is-cd
The modem ri-is-cd command is replaced by the modem dialin command. See the description of the modem dialin command for more information.
Cisco IOS Dial Technologies Command Reference
DIA-488
November 2009
Dial Commands modem shutdown
modem shutdown
To abruptly shut down an active or idle modem installed in an access server or router, use the modem shutdown command in line configuration mode. To take the modem out of a shutdown state and place it back in service, use the no form of this command. modem shutdown no modem shutdown
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Line configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
Enable the no modem shutdown command to restore to service a modem that has been shut down.
Examples
The following example abruptly shuts down the modem associated with line 1/0/6. All active calls on the modem are dropped immediately.
line 1/0/6 modem shutdown
The following example abruptly shuts down a range of modems:
line 1/0/5 1/0/72 modem shutdown
The following example abruptly shuts down the modem associated with line 2 on a Cisco AS5300. All active calls on the modem are dropped immediately.
line 2 modem shutdown
Related Commands
Command modem busyout
Description Disables a modem from dialing or answering calls whereby the disabling action is not executed until the active modem returns to an idle state.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-489
Dial Commands modem startup-test
modem startup-test
Support for the modem startup-test command was removed in Cisco IOS Release 12.2(11)T. The use of this command is not recommended. In most cases, nonfunctional integrated modems will automatically be removed from service by the system. See the modem recovery action command and the spe recovery command for more configuration options for nonfunctional modems. For further information about MICA modem recovery, refer to the Configuring MICA Modem Recovery technical note. For further information about NextPort service processing element (SPE) recovery, refer to the Configuring NextPort SPE Recovery technical note.
Cisco IOS Dial Technologies Command Reference
DIA-490
November 2009
Dial Commands modem status-poll
modem status-poll
To poll for modem statistics through a modem’s out-of-band feature, use the modem status-poll command in line configuration mode. To disable status polling through the out-of-band feature for a specified modem, use the no form of this command. modem status-poll no modem status-poll
Syntax Description
This command has no arguments or keywords.
Command Default
Command is enabled.
Command Modes
Line configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
This command applies only to manageable modems that have out-of-band ports.
Note
This command does not apply to basic modems that have out-of-band ports.
Examples
The following example enables modem status polling through TTY line 1:
line 1 modem status-poll
Related Commands
Command modem min-speed max-speed
Description Sets the maximum number of polling attempts used to retrieve performance statistics from a modem installed in an access server or router. Sets the time interval between modem polls, which are used to periodically retrieve and report modem statistics.
modem poll time
Cisco IOS Dial Technologies Command Reference November 2009
DIA-491
Dial Commands modemcap edit
modemcap edit
To change a modem value that was returned from the show modemcap command, use the modemcap edit command in global configuration mode. modemcap edit modem-name attribute at-command
Syntax Description
modem-name attribute at-command
Name of the modem whose values are being edited. Modem capability, or attribute, as defined by the show modemcap command. The AT command equivalent (such as &F).
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
Modemcaps are printed within the configuration file. You can edit them using this command. Configure one attribute of one modem at a time. See the modem-capability values defined by the show modemcap command.
Examples
The following example adds the factory default entry, &F, to the configuration file. This entry and others like it are stored in a database that is referenced by the configuration file.
modemcap edit codex_3250 factory-default &F
Related Commands
Command modemcap entry show modemcap
Description Stores and compresses information about the capability of a specified modem. Displays the values set for the current modem and lists the modems for which the router has entries.
Cisco IOS Dial Technologies Command Reference
DIA-492
November 2009
Dial Commands modemcap entry
modemcap entry
To store and compress information about the capability of a specified modem, use the modemcap entry command in global configuration mode. To disable this feature, use the no form of this command. modemcap entry modem-type no modemcap entry modem-type
Syntax Description
modem-type
Type of supported modem as specified in Table 23.
Command Default
The capability values that exist in the specified modem at the time that the command is issued
Command Modes
Global configuration
Command History
Release 11.1 12.1(5)T
Modification This command was introduced. This command was implemented on the Cisco 2600 series and the Cisco 3600 series.
Usage Guidelines
This command displays the capability of the specified modem. Modemcaps are printed within the configuration file and are intended to be edited using the modemcap edit command. The modemcap entry command does not display values that are not set in the modem. Use the modemcap entry command with the show modemcap command to interpret the capability of the specified modem. Table 23 lists the modemcap entries for supported modems.
Table 23 Modemcap Entries for Supported Modems
Modemcap Name
External Modems
Modem Type Motorola Codex 3260 Generic “Hayes” interface Global Village Teleport Hayes Optima1 NEC PIAFS TA NEC V.34 NEC V.110 TA Telebit T3000 U.S. Robotics Courier U.S. Robotics Sportster
codex_3260 default global_village hayes_optima nec_piafs nec_v34 nec_v110 telebit_t3000 usr_courier usr_sportster
Cisco IOS Dial Technologies Command Reference November 2009
DIA-493
Dial Commands modemcap entry
Table 23
Modemcap Entries for Supported Modems (continued)
Modemcap Name viva
Internal Modems
Modem Type Viva (Rockwell ACF with MNP) Cisco (NEC) internal V.110 TA (AS5200) Cisco MICA HMM/DMM digital Microcom HDMS chassis Cisco (Microcom) analog (NM-AM-2600/3600) Cisco (Microcom) V.34/56K digital (AS5300) Cisco NextPort CSMV/6 digital
cisco_v110 mica microcom_hdms microcom_mimic microcom_server nextport
1. This built-in modemcap is not recommended for use on an Optima because it sets the modem to automatic speed buffering. This modemcap disables error control and may result in poor performance. Instead, use modemcap default.
Examples
The following example shows how to select a U.S. Robotics Sportster modem type:
modemcap entry usr_sportster
Related Commands
Command show modemcap
Description Displays the values set for the current modem and lists the modems for which the router has entries.
modem hold-reset Resets and isolates integrated modems for extensive troubleshooting.
Cisco IOS Dial Technologies Command Reference
DIA-494
November 2009
Dial Commands modem-pool
modem-pool
To create a new modem pool or to specify an existing modem pool, use the modem-pool command in global configuration mode. To delete a modem pool from the access server configuration, use the no form of this command. modem-pool name no modem-pool name
Syntax Description
name
Name of a modem pool.
Command Default
All modems are configured to be part of one system default modem pool (displayed as System-def-Mpool by the show modem-pool command.). For example, if you have 120 MICA technologies modems loaded in your access server, 120 modems are in the default modem pool.
Command Modes
Global configuration
Command History
Release 11.2P
Modification This command was introduced.
Usage Guidelines
Modem pools enable you to physically partition or virtually partition your access server for dial-in and dial-out access. Physical partitioning makes one access server appear as if it is multiple access servers loaded with different types of modem services (for example, v.34 modems, fax capable modems, and point-of-sale (POS) modems). Each service is part of one modem pool and assigned a unique Dialed Number Information Service (DNIS) number. Virtual partitioning creates one large modem pool on the access server, but enables different customers to dial in and share the modem resources. Each customer is assigned its own DNIS number. Each customer is given overflow protection, which guarantees a certain number of simultaneous connections.
Note
MICA and Microcom modems support incoming analog calls over ISDN PRI. However, only MICA technologies modems support modem pooling for CT1 and CE1 configurations with channel-associated signaling.
Examples
The following example creates a modem pool called v90service. After the modem-pool v90service command is issued, modem pool configuration mode is accessed and the router prompt changes.
modem-pool v90service
Cisco IOS Dial Technologies Command Reference November 2009
DIA-495
Dial Commands modem-pool
Related Commands
Command clear modempool-counters pool-member show modem-pool
Description Clears active or running counters associated with one or more modem pools. Assigns a range of modems to a modem pool. Displays the configuration and connection status for one or more modem pools.
called-number (modem pool) Assigns a called party number to a pool of modems.
Cisco IOS Dial Technologies Command Reference
DIA-496
November 2009
Dial Commands modemui
modemui
To enter Cisco modem user interface mode and enter Hayes-compatible modem commands, use the modemui command in EXEC mode. modemui [modem-commands]
Syntax Description
modem-commands (Optional) Hayes-compatible modem commands. Table 24 lists the modem commands supported on Cisco routers. Multiple commands may be entered.
Command Default
No default behavior or values.
Command Modes
EXEC
Command History
Release 12.2(4)T
Modification This command was introduced.
Usage Guidelines
Use the modemui command to enter interactive Cisco modem user interface mode, which allows the Hayes-compatible modem command subset listed in Table 24 to be entered. The modemui EXEC command can also be entered with the autocommand line configuration command to configure the Cisco modem user interface feature as part of line configuration.
Note
Before entering the modem command that dials the modem telephone number, you must map the telephone number to an appropriate IP host using the Cisco IOS ip host global configuration command.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-497
Dial Commands modemui
Table 24
Cisco-Supported Hayes Modem Commands
Hayes Modem Commands Description AT DTstring DPstring Attention command. Enters modem command execution mode. You can add any of the command settings listed in this table to the AT command. Dials outbound tone (T) or pulse (P) call. The string following the T or P character is used as an argument to the Cisco IOS connect EXEC command. Before dialing, you must set up an appropriate IP host using the Cisco IOS ip host global configuration command. For example:
ip host t555-0112 4023 10.0.0.51
Valid characters for string are the same as the characters that are used in a host name for the Cisco IOS connect command, as follows:
• • • •
The numbers 0 through 9 Uppercase letters A through Z Lowercase letters a through z The . (period), - (hyphen), and _ (underscore) characters
No other characters (such as # or *) are accepted in the dial string, and unsupported characters are stripped before dialing occurs. En Echo mode. Values for n are as follows:
• •
0 turns off command echo. 1 turns on command echo (default).
Hn In
Hangup mode. A value of 0 or 1 closes the connection. Information mode. The information displayed is set in a banner configured with the Cisco IOS MODEMUI-VERSION global configuration command. Acceptable values for n are the numbers 0 through 6. Online mode. A value of 0 or 1 resumes the connection. Quiet mode. Values for n are as follows:
• •
On Qn
0 displays modem result codes (default). 1 inhibits modem result codes display (quiet mode). The standard Hayes modem S-register settings S0 through S53 are accepted by Cisco IOS software, but do not have any effect. S201—Command mode parity sniffing. If the value (v) for S201 is 0 (default), parity for both the command and data portions of a call are controlled by the Cisco IOS parity and databits line configuration commands. If the value (v) for S201 is 1, mark or space parity for the command session will be taken from the Hayes AT part of the command, and the data portion will be 8-bit transparent.
Sn=v
Set selected register (S-register).
Note
Choose one of the following S-registers for n:
•
Cisco IOS Dial Technologies Command Reference
DIA-498
November 2009
Dial Commands modemui
Table 24
Cisco-Supported Hayes Modem Commands (continued)
Hayes Modem Commands Description
•
S202—Output mask. This setting allows mark parity to be unconditionally implemented for the command characters. The default value for S202 is 0 (no parity). The value 128 causes command characters to be sent with mark parity.
•
S203—Connect delay. Allows a delay in seconds to be added to the time between when the ATD command is executed and when the call success or failure code is displayed. This delay is sometimes required because a Telnet connection is established more quickly than placing a telephone call. The value for S203 can be a number from 0 to 255. The actual value applied to the connect delay is 10 percent of the number entered for v. For example, a value of 300 sets a connect delay of 30 seconds. The default value is 0.
•
S204—Connect code. Allows the result code for a successful connection to be specified. The default is code 1 for the unextended mode, but you can configure one of the following numbers to display a selected line speed. For example, connection code 10 selects CONNECT 2400. By allowing the code to be expressed explicitly, you can allow for a “CONNECT 2400” response message to be displayed, regardless of the actual line speed. The default for v is 0, or choose one of the following connection codes:
– 9—CONNECT 1200 – 10—CONNECT 2400 – 11—CONNECT 4800 – 12—CONNECT 9600 – 13—CONNECT 14400 – 14—CONNECT 19200 – 15—CONNECT 38400 – 16—CONNECT 57600
Sn? Vn
S-register query. The value for n is the number of the S-register to query (S201 through S204; see the preceding list). Result code format. Values for n are as follows:
• •
0 displays a short result report. 1 displays a long result report (default).
Xn Z Z99
Extended result codes. The value for n is any nonzero number, which appends /NONE to the connect message. Also see the preceding description for S-register S204, for changing the reported connection speed. Reset to default configuration. Choose one of the following reset options:
• •
ATZ returns the Cisco modem user interface to its default state and re-executes the initialization string provided in the modemui command. ATZ99 returns to the standard Cisco IOS software user interface (EXEC) mode.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-499
Dial Commands modemui
Examples
The following example shows how to configure a line for the Cisco modem user interface feature and set the modem in no-echo, short-response mode:
line aux 0 login authentication modem modem dialin delay autocommand modemui ATE0V0 transport input all stopbits 1 speed 38400 flowcontrol hardware
The following example shows how to enter Cisco modem user interface mode from the Cisco IOS EXEC mode and enter Hayes-compatible AT commands to dial and test the modem:
Router# modemui AT OK ATDT4155551234 CONNECT User Access Verification Username:
Related Commands
Command autocommand connect ip host modemui-version
Description Configures the Cisco IOS software to automatically execute a command when a user connects to a particular line. Logs in to a host that supports Telnet, rlogin, or LAT. Defines a static host name-to-address mapping in the host cache. Displays a banner in response to the Hayes information mode command.
Cisco IOS Dial Technologies Command Reference
DIA-500
November 2009
Dial Commands modemui-version
modemui-version
To display a banner as a response to the Hayes modem information command, use the modemui-version command in global configuration mode. To remove or change the banner display, use the no form of this command. modemui-version delimiter banner-text delimiter no modemui-version delimiter banner-text delimiter
Syntax Description
delimiter banner-text
Character that you choose, such as # or /, to signal the beginning and end of the banner message. Banner message text.
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Release 12.2(4)T
Modification This command was introduced.
Usage Guidelines
Use the modemui-version command to configure banners for the Hayes information mode command (ATIn).
Examples
The following example configures the modem user interface banner to display the modem model and code revision in response to the ATI6 Cisco modem user interface command:
modemui-version / Telebit T3000, Version 1.5 /
Related Commands
Command modemui
Description Enters Cisco modem user interface mode.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-501
Dial Commands multilink
multilink
To limit the total number multilink PPP (MLP) sessions for all virtual private dialup network (VPDN) multilink users, enter the multilink command in VPDN group configuration mode. To remove the MLP session limit, enter the no form of this command. multilink {bundle bundles | link links} no multilink {bundle bundles | link links}
Syntax Description
bundle bundles
Configures the number of MLP bundles supported for a VPDN group. In general, each user requires one bundle. Valid values for the bundles argument range from 0 to 32,767. Configures the number of sessions supported for each bundle. Valid values for the links argument range from 0 to 32,767.
link links
Command Default
No MLP session limit is set.
Command Modes
VPDN group configuration
Command History
Release 12.0(4)XI 12.0(5)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.0(5)T.
Usage Guidelines
Use the multilink VPDN group configuration command to limit the total number of sessions for all MLP users. Each user requires one bundle, regardless if the user is a remote modem client or an ISDN client. One modem client using one B channel requires one link. One ISDN BRI node may require up to two links for one BRI line connection. The second B channel of an ISDN BRI node comes up when the maximum threshold is exceeded.
Examples
The following example configures a VPDN group called group1 to initiate Layer 2 Tunnel Protocol (L2TP) tunnels to the tunnel server at IP address 10.2.2.2. Ten MLP bundles are configured for users that dial in to the domain cisco.com. Each bundle is configured to support a maximum of 5 links, limiting the total number of MLP sessions to 50.
Router(config)# vpdn-group group1 Router(config-vpdn)# request-dialin Router(config-vpdn-req-in)# protocol l2tp Router(config-vpdn-req-in)# domain cisco.com Router(config-vpdn-req-in)# exit Router(config-vpdn)# initiate-to ip 10.2.2.2 Router(config-vpdn)# multilink bundle 10 Router(config-vpdn)# multilink link 5
Cisco IOS Dial Technologies Command Reference
DIA-502
November 2009
Dial Commands multilink
Related Commands
Command request-dialin
Description Creates a request dial-in VPDN subgroup that configures a NAS to request the establishment of a dial-in tunnel to a tunnel server, and enters request dial-in VPDN subgroup configuration mode. Creates a VPDN group and enters VPDN group configuration mode.
vpdn-group
Cisco IOS Dial Technologies Command Reference November 2009
DIA-503
Dial Commands multilink bundle-name
multilink bundle-name
To select a method for naming multilink bundles, use the multilink bundle-name command in global configuration mode. To remove the selection method, use the no form of this command. multilink bundle-name {authenticated | endpoint | both} no multilink bundle-name {authenticated | endpoint | both}
Syntax Description
authenticated Authenticated name of the peer. This is the default. endpoint both Endpoint discriminator of the peer. Authenticated name and endpoint discriminator of the peer.
Command Default
Authenticated name of the peer.
Command Modes
Global configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
The authenticated keyword defines the selection criteria for the bundle name as the authenticated name, the endpoint discriminator if the link is not authenticated, or the caller ID if neither an authenticated name nor an endpoint is supplied. The endpoint keyword defines the selection criteria for the bundle name as the endpoint discriminator, the authenticated name if no endpoint is supplied, or the caller ID if neither an authenticated name nor an endpoint is supplied. The both keyword defines the selection criteria for the bundle name as an authenticated name-endpoint discriminator pair, the authenticated name if no endpoint is supplied, the endpoint discriminator if the link is not authenticated, or the caller ID if neither an authenticated name nor an endpoint is supplied.
Examples
The following example sets the selection criteria for the multilink bundle name as the endpoint discriminator:
multilink bundle-name endpoint
Cisco IOS Dial Technologies Command Reference
DIA-504
November 2009
Dial Commands multilink max-fragments
multilink max-fragments
The multilink max-fragments command is replaced by the ppp multilink fragment maximum command. See the description of the ppp multilink fragment maximum command for more information.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-505
Dial Commands multilink virtual-template
multilink virtual-template
To specify a virtual template from which the specified Multilink PPP (MLP) bundle interface can clone its interface parameters, use the multilink virtual-template command in global configuration mode. To remove the defined virtual template, use the no form of the command. multilink virtual-template number no multilink virtual-template number
Syntax Description
number
Number of the virtual template to be used to clone the MLP bundle interface. An integer in the range from 1 to the largest number of virtual templates the software image supports (typically 25).
Command Default
No template is specified.
Command Modes
Global configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
Configuring a specific IP address in a virtual template can result in the establishment of erroneous routes and the loss of IP packets.
Examples
The following example specifies that virtual template 1 is to be used for MLP ,and then defines virtual template 1:
multilink virtual-template 1 interface virtual-template 1 ip unnumbered ethernet 0 encapsulation ppp ppp multilink ppp authentication chap
Related Commands
Command interface virtual-template
Description Creates a virtual template interface that can be configured and applied dynamically in creating virtual access interfaces.
Cisco IOS Dial Technologies Command Reference
DIA-506
November 2009
Dial Commands multilink-group
multilink-group
The multilink-group command is replaced by the ppp multilink group command. See the description of the ppp multilink group command for more information.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-507
Dial Commands name (dial peer cor custom)
name (dial peer cor custom)
To specify the name for a custom class of restrictions (COR), use the name command in dial peer COR custom configuration mode. To remove a specified COR, use the no form of this command. name class-name no name class-name
Syntax Description
class-name
Name that describes the specific COR.
Command Default
No default behavior or values.
Command Modes
Dial peer COR custom configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
The dial-peer cor custom and name commands define the names of capabilities on which to apply COR operation. Examples of names might include any of the following: call1900, call527, call9, or call 911. You must define the capabilities before you specify the COR rules. You can define a maximum of 64 COR names.
Examples
The following example defines three COR names:
dial-peer cor custom name 900_call name 800_call name catchall
Related Commands
Command dial-peer cor custom name
Description Specifies that named CORs apply to dial peers. Assigns a name to the internal adapter.
Cisco IOS Dial Technologies Command Reference
DIA-508
November 2009
Dial Commands netbios nbf
netbios nbf
To enable the NetBIOS Frames Protocol (NBF) on an interface, use the netbios nbf command in interface configuration mode. To disable NetBIOS Frames Protocol support on an interface, use the no form of this command. netbios nbf no netbios nbf
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Examples
The following example enables NBF on asynchronous interface 1 (connected to remote access client using a NetBEUI application) and Ethernet interface 0 (connected to the remote router):
interface async 1 netbios nbf interface ethernet 0 netbios nbf
Related Commands
Command netbios name-cache
Description Defines a static NetBIOS name cache entry, tying the server with the name netbios-name to the mac-address, and specifying that the server is accessible either locally through the interface-name specified, or remotely through the ring-group group-number specified. Displays NetBEUI connection information. Displays a list of NetBIOS cache entries.
show nbf sessions show netbios cache
Cisco IOS Dial Technologies Command Reference November 2009
DIA-509
Dial Commands network-clock-priority
network-clock-priority
To specify the clock-recovery priority for the BRI voice ports in a BRI voice module (BVM), use the network-clock-priority command in interface configuration mode. To restore the default (low) clock-recovery priority, use the no form of this command. network-clock-priority {low | high} no network-clock-priority {low | high}
Syntax Description
low high
The BRI port is second priority to recover clock. The BRI port is first priority to recover clock.
Command Default
Each BRI voice port has low clock-recovery priority. The BRI VIC port provides clocking (high).
Command Modes
Interface configuration
Command History
Release 12.0(3)XG 12.1(3)XI
Modification This command was introduced on the Cisco MC3810 concentrator. This command was implemented on the Cisco 2600 series and Cisco 3600 series.
Usage Guidelines
Because the BRI voice interface card can support both ISDN NT and TE ports, this command allows a “local loop” to be configured for testing. By default the TE port on the BRI VIC receives the clock source to drive the whole BRI (network-clock-priority high). Setting the clock priority to low allows the connected port to provide clocking. This command becomes effective only when the BVM is the clock source for the Cisco MC3810, which can happen in one of three ways:
• • •
When the BVM is specified as the first-priority network clock source through the network-clock-select command. When the BVM is specified as a lower-priority network clock source, and a higher-priority network clock source is lost. When the BVM is the only network clock source.
The BRI voice port supplying clock operates as a line source; if there are other BRI voice ports configured as TE, they operate in loop-timed mode. Regardless of the network-clock-priority setting, the first TE-configured BRI voice port that becomes active is automatically chosen to supply clock. The clock source does not change if another BRI voice port configured for network-clock-priority high becomes active.
Cisco IOS Dial Technologies Command Reference
DIA-510
November 2009
Dial Commands network-clock-priority
If the chosen clocking port becomes inactive, the system searches for clock on the active TE-configured ports in the following order:
1. 2.
Ports configured as network-clock-priority high in order from lowest (1) to highest (4). Ports configured as network-clock-priority low in order from lowest (1) to highest (4).
If the originally chosen port then reactivates, it resumes its role as clock source regardless of its network-clock-priority setting. If you enter either the no network-clock-priority low or the no network-clock-priority high command, the network clock priority defaults to low.
Examples
The following example configures BRI voice port 1 as a first priority clock source:
interface bri 0/1 network-clock-priority high
Related Commands
Command number
Description Specifies selection priority for the clock sources.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-511
Dial Commands number
number
To add a Calling Line Identification (CLID) or Dialed Number Identification Service (DNIS) number to a dialer group, use the number command in CLID group configuration or DNIS group configuration mode followed by the specifying number. To remove a number from a group, use the no form of this command. number id-number no number id-number
Syntax Description
id-number
CLID or DNIS number, which can have up to 65 digits.
Note
The CLID screening feature rejects this number if it matches the CLID of an incoming call. Valid CLID numbers are all numeric, or numbers that contain the wildcard x. You can use x (signifying a single number don’t care state), X or . as wildcards within each CLID number. The asterisk (*) wildcard is not accepted.
Command Default
No default behavior or values.
Command Modes
CLID group configuration DNIS group configuration
Command History
Release 12.0(4)XI 12.1(5)T
Modification This command was introduced. This command was enhanced to add CLID numbers to a CLID group and DNIS numbers to a DNIS group.
Usage Guidelines
You can organize CLID numbers for a customer or service type into a CLID group. You can add multiple CLID groups to a customer profile. Add all CLID numbers into one CLID group, or subdivide the CLID numbers using criteria such as call type, geographical location, or division. The Cisco IOS software also includes a feature that streamlines the DNIS configuration process. By replacing any digit with an X (for example, issuing the number 555222121x command), clients dialing different numbers, such as 5552221214 or 5552221215, are automatically mapped to the same customer profile. The X variable is a placeholder for the digits 1 through 9.
Examples
The following example shows the command to use to assign a number to a CLID group named group1:
dialer clid group group1 number 2121212121
Cisco IOS Dial Technologies Command Reference
DIA-512
November 2009
Dial Commands number
The following example shows a DNIS group called dnis_isp_1 and DNIS numbers 1234 and 5678 assigned to the DNIS group:
dialer dnis group dnis_isp_1 number 1234 number 5678
Related Commands
Command clid group dnis group resource-pool call treatment discriminator
Description Adds a CLID group to a discriminator. Includes a group of DNIS numbers in a customer profile. Creates a call discrimination profile.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-513
Dial Commands number
Cisco IOS Dial Technologies Command Reference
DIA-514
November 2009
Dial Commands peer default ip address
peer default ip address
To specify an IP address, an address from a specific IP address pool, or an address from the Dynamic Host Configuration Protocol (DHCP) mechanism to be returned to a remote peer connecting to this interface, use the peer default ip address command in interface configuration mode. To disable a prior peer IP address pooling configuration on an interface, or to remove the default address from your configuration, use the no form of this command. peer default ip address {ip-address | dhcp-pool | dhcp | pool [pool-name]} no peer default ip address
Syntax Description
ip-address
Specific IP address to be assigned to a remote peer dialing in to the interface. To prevent duplicate IP addresses from being assigned on more than one interface, this argument cannot be applied to a dialer rotary group nor to an ISDN interface. Retrieves an IP address from an on-demand address pool. This option only supports remote access (PPP) sessions into MPLS VPNs. Retrieves an IP address from the DHCP server. Uses the global default mechanism as defined by the ip address-pool command unless the optional pool-name argument is supplied. This is the default. (Optional) Name of a local address pool created using the ip local pool command. DHCP retrieves an address from this pool regardless of the global default mechanism setting.
dhcp-pool dhcp pool pool-name
Command Default
The default is pool.
Command Modes
Interface configuration
Command History
Release 11.0 12.2(8)T
Modification This command was introduced. The dhcp-pool keyword was added.
Usage Guidelines
This command applies to point-to-point interfaces that support the PPP or Serial Line Internet Protocol (SLIP) encapsulation. This command sets the address used on the remote (PC) side.
Note
This command replaces the async default ip address command. This command allows an administrator to configure all possible address pooling mechanisms on an interface-by-interface basis.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-515
Dial Commands peer default ip address
The peer default ip address command can override the global default mechanism defined by the ip address-pool command on an interface-by-interface basis, as follows:
•
For all interfaces not configured with a peer default IP address mechanism (equivalent to selecting the peer default ip address pool command), the router uses the global default mechanism that is defined by the ip address-pool command. If you select the peer default ip address pool pool-name form of this command, then the router uses the locally configured pool on this interface and does not follow the global default mechanism. If you select the peer default ip address ip-address form of this command, the specified IP address is assigned to any peer connecting to this interface and any global default mechanism is overridden for this interface. If you select the peer default ip address dhcp form of this command, the DHCP proxy-client mechanism is used by default on this interface and any global default mechanism is overridden for this interface. If you select the peer default ip address dhcp-pool form of this command, the DHCP on-demand address pooling mechanism is used by default on this interface and any global default mechanism is overridden for this interface.
• •
•
•
Examples
The following command specifies that this interface will use a local IP address pool named pool3:
peer default ip address pool pool3
The following command specifies that this interface will use the IP address 172.19.34.21:
peer default ip address 172.19.34.21
The following command reenables the global default mechanism to be used on this interface:
peer default ip address pool
The following example specifies address 192.168.7.51 for asynchronous interface 6:
line 20 speed 115200 interface async 6 peer default ip address 192.168.7.51
Related Commands
Command async dynamic address encapsulation slip exec ip address-pool ip dhcp-server ip local pool ppp
Description Specifies dynamic asynchronous addressing versus default addressing. Enables SLIP encapsulation. Allows an EXEC process on a line. Enables an address pooling mechanism used to supply IP addresses to dial in asynchronous, synchronous, or ISDN point-to-point interfaces. Specifies which DHCP servers to use on a network, and specifies the IP address of one or more DHCP servers available on the network. Configures a local pool of IP addresses to be used when a remote peer connects to a point-to-point interface. Starts an asynchronous connection using PPP.
Cisco IOS Dial Technologies Command Reference
DIA-516
November 2009
Dial Commands peer default ip address
Command show cot dsp slip
Description Displays information about the COT DSP configuration or current status. Starts a serial connection to a remote host using SLIP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-517
Dial Commands peer ip address forced
peer ip address forced
To force the router to assign a peer the next available IP address in the pool for an interface, use the peer ip address forced command in interface configuration mode. To allow a peer to negotiate a specific IP address or to allow the router to attempt to assign a peer its previously assigned IP address, use the no form of this command. peer ip address forced no peer ip address forced
Syntax Description
This command has no arguments or keywords.
Command Default
When a network device dials in to a Cisco network access server (NAS) that is configured to assign an IP address to the network device, the NAS attempts to assign the device the address it was assigned previously. If that address is unavailable or if no address in the pool was assigned previously, the NAS then assigns the next available address in its pool.
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
The peer ip address forced command is used for point-to-point interfaces that support a link framing protocol such as PPP where the NAS will assign a peer IP address from an address pool as a result of the following conditions:
• •
The NAS is configured with a pool of network addresses at the interface supporting the peers (configured by use of the ip local-pool command). The NAS is configured to assign IP addresses to peers from a pool. A pool of IP addresses can be configured and applied at the interface by use of the ip address-pool command and the peer default ip address pool command or as a RADIUS server directive. The peer is configured to request an IP address from the NAS server (for example, as configured by use of the ip address negotiated command).
•
To force the NAS to allocate the next available IP address from the pool for the interface, use the peer ip address forced command. Any attempts to allocate a previously held IP address or a specifically requested IP address are suppressed; instead, the NAS allocates the next available IP address from the specified pool. This feature can be used to prevent users from obtaining the same IP address for each dial-in session.
Cisco IOS Dial Technologies Command Reference
DIA-518
November 2009
Dial Commands peer ip address forced
Examples
The following example specifies that the interface will allocate the next available address from the pool whenever an address is requested from a pool:
interface Virtual-template 1 peer default ip address pool poolA poolB peer ip address forced
The following example specifies that the interface will allow a peer to negotiate an IP address or will attempt to assign a previously assigned address:
interface Virtual-template 1 peer default ip address pool poolA poolB no peer ip address forced
Related Commands
Command ip address negotiated ip address-pool ip local-pool
Description Specifies that the IP address for a particular interface is obtained via PPP IPCP address negotiation. Enables an address pooling mechanism used to supply IP addresses to dial-in asynchronous, synchronous, or ISDN point-to-point interfaces. Configures a local pool of IP addresses to be used when a remote peer connects to a point-to-point interface.
peer default ip address Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface. ppp Starts an asynchronous connection using PPP when you want to connect from a remote node computer to an EXEC session on the access server and want to connect from the access server to a device on the network.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-519
Dial Commands peer match aaa-pools
peer match aaa-pools
To specify that any IP address pool name supplied by authentication, authorization, and accounting (AAA) servers must also be present in the list of pool names specified in the peer default ip address pool interface configuration command, use the peer match aaa-pools command in interface configuration mode. To configure the software to use any pool name supplied by the AAA server (default configuration), use the no form of this command. peer match aaa-pools no peer match aaa-pools
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Interface configuration
Command History
Release 12.0(6)T
Modification This command was introduced.
Usage Guidelines
This command provides the ability to control or restrict the use of pool names supplied by AAA to only those pool names that are configured on the router. This ability is useful in cases where the AAA server and the router and its local configuration are controlled by different administrators, as would be the case for a wholesale dial supplier where the AAA servers are owned by individual customers. When the peer match aaa-pools command is configured on an interface, the IP address pool names used are those specified in the local configuration as part of the peer default ip address command and the pool names supplied by the AAA server. When the no peer match aaa-pools command is used, pool name selection is controlled by the AAA server, as follows: When the AAA server supplies a pool name, that is the only pool used. If AAA does not supply a pool name, then the normal IP default pool name processing is used as described in the peer default ip address command page.
Examples
The following example shows how to configure pool name restrictions in a Resource Pool Management (RPM) customer profile template:
template Word multilink max-fragments peer match aaa-pools peer default ip address pool poolA poolB ppp ipcp dns 10.1.1.1 resource-pool profile customer WORD source template Word aaa group-configuration AAA-group1
Cisco IOS Dial Technologies Command Reference
DIA-520
November 2009
Dial Commands peer match aaa-pools
template user_direct peer default ip address pool mypool ppp authentication chap isdn-users ppp multilink
Related Commands
Command ip local pool peer default ip address
Description Configures a local pool of IP addresses to be used when a remote peer connects to a point-to-point interface. Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface. Directs the pool software to use the local pool name configured with the peer default ip address interface configuration command to supplement the pool names supplied by AAA. Suppresses an attempt to load all dynamic pools from the AAA server when a missing pool name is encountered.
peer pool backup
peer pool static
Cisco IOS Dial Technologies Command Reference November 2009
DIA-521
Dial Commands peer pool backup
peer pool backup
To provide backup IP address pool names supplied by authentication, authorization, and accounting (AAA) with local pool names, use the peer pool backup command in interface configuration mode. To disable the local pool name backup feature, use the no form of this command. peer pool backup no peer pool backup
Syntax Description
This command has no arguments or keywords.
Command Default
No backup IP address pool names are configured
Command Modes
Interface configuration
Command History
Release 12.2(8)B 12.3(4)T 12.2(28)SB
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.3(4)T. This command was integrated into Cisco IOS Release 12.2(28)SB.
Usage Guidelines
The peer pool backup command is useful in large-scale dial-out environments with a large number of independently controlled AAA servers. Difficulties arise when the network access server (NAS) must provide IP address pool name resolution when a new pool is introduced by one of the AAA servers before that pool is set up on the NAS, or when an existing local pool becomes exhausted but the AAA server actually has other pools that would be acceptable as IP address sources. The peer pool backup command uses the local pool names configured with the peer default ip address pool interface configuration command to supplement the pool names supplied by AAA. The problems of pool name resolution and exhaustion can be solved by configuring backup pool names on a per-interface basis using both the peer default ip address pool and peer pool backup interface configuration commands. You may also configure local restrictions on the use of AAA-supplied pool names to a NAS-specified set by adding the peer match aaa-pools interface configuration command to the configuration. The peer match aaa-pools command specifies that any AAA-supplied pool name must match one of the pool names supplied with the peer default ip address pool command. See the “Examples” section for an example.
Cisco IOS Dial Technologies Command Reference
DIA-522
November 2009
Dial Commands peer pool backup
Examples
In the following example, the search order for backup pool names set by the peer default ip address pool command is pool1 then pool2. These pools will be used when the NAS cannot resolve a pool name or when an existing pool of IP addresses is exhausted.
interface Dialer1 ip unnumbered FastEthernet0 encapsulation ppp dialer pool 1 dialer idle-timeout 3600 dialer-group 1 peer pool backup peer default ip address pool pool1 pool2 no fair-queue no cdp enable ppp authentication chap
In the following example, assume that there is a AAA-supplied IP address pool named poolA. By adding the peer match aaa-pools command to the configuration, the AAA-supplied pool named poolA will not be used because it does not appear in the peer default ip address pool command; only the pools named pool1 and pool2 will be searched.
interface serial 1:23 ip address 10.4.4.1 255.255.255.0 encapsulation ppp ppp authentication chap dialer-group 1 peer pool backup peer match aaa-pools peer default ip address pool pool1 pool2 isdn switch-type primary-5ess
Related Commands
Command ip local pool
Description Configures a local pool of IP addresses to be used when a remote peer connects to a point-to-point interface.
peer default ip address Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface. peer match aaa-pools peer pool static Specifies that any AAA-supplied pool name must match one of the pool names supplied with the peer default ip address pool command. Suppresses an attempt to load all dynamic pools from a AAA server when a missing pool name is encountered.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-523
Dial Commands peer pool static
peer pool static
To suppress an attempt to load all dynamic pools from an authentication, authorization, and accounting (AAA) server when a missing pool name is encountered, use the peer pool static command in interface configuration mode. To disable the suppression of dynamic pool loading and restore the normal dynamic pool loading behavior, use the no form of this command. peer pool static no peer pool static
Syntax Description
This command has no arguments or keywords.
Command Default
Dynamic pools are loaded
Command Modes
Interface configuration
Command History
Release 12.2(8)B 12.3(4)T 12.2(28)SB
Modification This command was introduced. This feature was integrated into Cisco IOS Release 12.3(4)T. This command was integrated into Cisco IOS Release 12.2(28)SB.
Usage Guidelines
The peer pool static command controls attempts by the pool software to load dynamic pools in response to a pool request from a specific interface. These dynamic pools are loaded at system startup and refreshed whenever a pool name not configured on the network access server (NAS) is specified for IP address allocation. Because the behavior of the NAS in response to a missing pool name can be changed using the peer pool backup interface configuration command, you may need to use the peer pool static command to control attempts to load all dynamic pools when the AAA-supplied pool name is not an existing local pool name. The peer pool static command provides a two-minute interval between attempts to download dynamic IP pools when a missing pool name is encountered.
Examples
The following partial example shows how to disable loading dynamic pools using the peer pool static command:
aaa new-model aaa authentication ppp default group radius aaa authorization exec default group radius aaa authorization network default group radius ! interface ATM0/0/0 no ip address no ip directed-broadcast no ip route-cache no atm ilmi-keepalive .
Cisco IOS Dial Technologies Command Reference
DIA-524
November 2009
Dial Commands peer pool static
. . interface Virtual-Template1 ip address 10.4.4.1 255.255.255.0 encapsulation ppp ppp authentication chap no ip directed-broadcast peer pool static peer pool static peer default ip address pool pool3 pool4 pool5 ip classless radius-server host 172.30.166.121 radius-server key lab radius-server vsa send accounting radius-server vsa send authentication ! ip local pool pool2 10.4.4.2 ip local pool pool3 10.4.4.3 ip local pool pool4 10.4.4.4 ip local pool pool5 10.4.4.5
In this configuration, any attempt to load a dynamic pool name is suppressed; only the backup pool names defined by the peer default ip address pool command will be used.
Related Commands
Command ip local pool
Description Configures a local pool of IP addresses to be used when a remote peer connects to a point-to-point interface.
peer default ip address Specifies an IP address, an address from a specific IP address pool, or an address from the DHCP mechanism to be returned to a remote peer connecting to this interface. peer pool backup Directs the pool software to use the local pool name configured with the peer default ip address pool interface configuration command to supplement the pool names supplied by AAA.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-525
Dial Commands permission (dial peer voice)
permission (dial peer voice)
To specify whether incoming or outgoing calls are permitted on the defined dial peer, use the permission command in dial peer voice configuration mode. To remove the specified permission, use the no form of this command. permission {orig | term | both | none} no permission {orig | term | both | none}
Syntax Description
orig term both none
This dial peer is permitted to originate calls. Thus, the access server can accept incoming calls from the dial peer. This dial peer is permitted to terminate calls. Thus, the access server can send outgoing calls to the dial peer. This dial peer is permitted to originate and terminate calls. Both incoming and outgoing calls are permitted (default). No incoming or outgoing calls can be made to or from this dial peer.
Command Default
Both incoming and outgoing calls are permitted.
Command Modes
Dial peer voice configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
After a dial peer is associated with an incoming call, the permission is checked to determine whether incoming calls are permitted on the dial peer. If permission is not set to orig or both, the incoming call is blocked. After a dial peer is matched for an outgoing call, the permission is checked to determine whether outgoing calls are permitted on the dial peer. If permission is not set to term or both, the outgoing call using this dial peer fails.
Note
The call may “rotary” to the next dial peer if the current dial peer does not have the huntstop command set.
Cisco IOS Dial Technologies Command Reference
DIA-526
November 2009
Dial Commands permission (dial peer voice)
Examples
The following example configures a dial peer and sets its permission to both originate and terminate calls:
dial-peer voice 526 pots answer-address 408526.... corlist incoming list2 direct-inward-dial permission both
Related Commands
Command dial-peer voice
Description Enters dial-peer voice configuration mode and defines a remote VoIP dial peer.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-527
Dial Commands pool-range
pool-range
To assign a range of modems to a modem pool, use the pool-range command in modem-pool configuration mode. To remove the range of modems, use the no form of the command. pool-range [tty] {modem1-modemN | x/y} no pool-range [tty] {modem1-modemN | x/y}
Syntax Description
tty modem1-modemN
(Optional) Sets the range to terminal controller (TTY) lines. Range of lines, which correspond to a range of modems or to a modem pool. A hyphen (-) is required between the two numbers. The range of modems you can choose from is equivalent to the number of modems in your access server that are not currently associated with another modem pool, up to a maximum of 48. Slot/port numbers for an internal modem. A range of numbers is not accepted. The slash mark is required.
x/y
Command Default
Command is disabled. All modems are configured to be part of the system default modem pool.
Command Modes
Modem pool configuration
Command History
Release 11.2P
Modification This command was introduced on the Cisco AS5200 and Cisco AS5300.
Usage Guidelines
For a complete description of modem pools and how they are configured on Cisco access servers, see the command page for the modem-pool command. Replace themodem1-modemN arguments with the modem TTY line numbers that correspond with the range of modems you want in the modem pool. TTY line numbers start from 1, and they map to modem numbers that start from 0. For example, if you want to include modems 1/0 through 1/23 in a pool range, use the TTY line numbers 1 to 24. To verify the modem to TTY line numbering scheme, use the show modem slot/port command.
Note
MICA technologies modems and Microcom modems support incoming analog calls over ISDN PRI. However, only MICA modems support modem pooling for CT1 and CE1 configurations with channel–associated signaling.
Cisco IOS Dial Technologies Command Reference
DIA-528
November 2009
Dial Commands pool-range
Examples
The following example assigns modem TTY line numbers 30 to 50 to a modem pool. The Dialed Number Information Service (DNIS) number is set to 2000. The customers dialing 2000 are guaranteed access to 21 modems. The 22nd client to dial in is refused connectivity because the maximum number of allowable connections is exceeded.
modem-pool v90service pool-range 30-50 called-number 2000 max-conn 21 exit
The 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 tty 30 % TTY 30 is already in another pool.
Related Commands
Command called-number (modem pool) clear modempool-counters modem-pool
Description Assigns a called party number to a pool of modems. Clears active or running counters associated with one or more modem pools. Creates a new modem pool or specifies an existing modem pool, which allows you to physically or virtually partition your access server for dial-in and dial-out access. Displays the configuration and connection status for one or more modem pools.
show modem-pool
Cisco IOS Dial Technologies Command Reference November 2009
DIA-529
Dial Commands port (global)
port (global)
To enter the port configuration mode, use the port command in global configuration mode. To exit port configuration mode, use the no form of this command.
Cisco AS5400 with NextPort DFC
port {slot | slot/port} [slot | slot/port] no port {slot | slot/port} [slot | slot/port]
Cisco AS5800 with Universal Port Card
port {shelf/slot | shelf/slot/port} [shelf/slot | shelf/slot/port] no port {shelf/slot | shelf/slot/port} [shelf/slot | shelf/slot/port]
Syntax Description
slot slot/port
All ports on the specified slot. For the Cisco AS5400, slot values range from 0 to 7. Entering a second slot value will specify a range of slots. All ports on the specified slot and SPE. For the Cisco AS5400, slot values range from 0 to 7 and port values range from 0 to 107. The slash mark is required. Entering a second slot and SPE value will specify a range of slots. All ports on the specified shelf and slot. For the Cisco AS5800, shelf values are 0 and 1, and UPC slot values range from 2 to 11. The slash mark is required. Entering a second shelf and slot value will specify a range of slots. All ports on the specified SPE. For the Cisco AS5800, shelf values are 0 and 1, slot values range from 2 to 11, and port values range from 0 to 323. The slash marks are required. Entering a second shelf, slot, and SPE value will specify a range of slots.
shelf/slot
shelf/slot/port
Command Default
Command is disabled.
Command Modes
Global configuration
Command History
Release 12.1(3)T
Modification This command was introduced.
Usage Guidelines
The port command helps you to enter the port configuration mode. The port configuration mode allows you to shut down or put individual ports or ranges of ports in busyout mode.
Cisco IOS Dial Technologies Command Reference
DIA-530
November 2009
Dial Commands port (global)
Examples
The following example shows how to enter port configuration mode on ports 1 to 18 to perform further tasks on the ports:
Router(config)# port 1/1 1/18 Router(config-port)# shutdown
Related Commands
Command clear port
Description Resets the port and clears any active calls to the port.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-531
Dial Commands port modem autotest
port modem autotest
To automatically and periodically perform a modem diagnostics test for modems inside the universal gateway or router, use the port modem autotest command in global configuration mode. To disable or turn off the modem autotest service, use the no form of this command. port modem autotest {error threshold | minimum modems | time hh:mm [hours]} no port modem autotest
Syntax Description
error threshold
Maximum modem error threshold. When the system detects this many errors with the modems, the modem diagnostics test is automatically triggered. Specify a threshold count from 3 to 50.
minimum modems Minimum number of modems that will remain untested and available to accept calls during each test cycle. You can specify from 5 to 48 modems. The default is 6 modems on the Cisco AS5400. The range for the Cisco AS5800 is from 73 to 756. time hh:mm Time you want the modem autotest to begin. You must use the military time convention and a required colon (:) between the hours and minutes variables for this feature. For example, 1:30 p.m. is issued as 13:30. (Optional) Long-range time variable used to set the modem autotest more than one day in advance. The range of hours is from 1 hour to 168 hours. For example, if you want to run the test once per week, issue 168. There are 168 hours in one week.
hours
Command Default
Modem diagnostics tests are disabled.
Command Modes
Global configuration
Command History
Release 11.3 12.1(1)XD
Modification This command was introduced. This command was introduced on the Cisco AS5400 as the port modem autotest command and replaced the modem autotest command for the NextPort dial feature card (DFC) only. This command was implemented on the Cisco AS5400 and Cisco AS5800. This command was implemented on the Cisco AS5350. This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5350.
12.1(3)T 12.1(5)XM1 12.2(11)T
Cisco IOS Dial Technologies Command Reference
DIA-532
November 2009
Dial Commands port modem autotest
Examples
The following example shows how to set the modem autotest to run once per week at 3:00 a.m. Additionally, the autotest activates if the system detects a modem error count higher than 40 errors. Determine the current time set on the access server with the show clock EXEC command. In this example, the time and date set is 3:00 p.m, Monday, January 6, 2003:
Router# show clock *15:00:01.031 EST Jan 06 2003
Enter global configuration mode and set the time you want the modem autotest to activate. In this example, the access server is configured to run the modem autotest at 3:00 a.m. and every 168 hours (week) thereafter:
Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# port modem autotest time 03:00 168
Configure the autotest to activate if the system detects a high modem error count. In this example, the autotest activates if the system detects a modem error count higher than 40 errors. For the list of modem errors that are monitored by the modem autotest command, see the show modem call-stats command.
Router(config)# port modem autotest error 40
Related Commands
Command modem autotest show clock show modem show modem test
Description Automatically and periodically performs a modem diagnostics test for modems inside the access server or router. Displays the system clock. Displays a high-level performance report for all the modems or a single modem inside Cisco AS5200 and Cisco AS5300 access servers. Displays the modem test log.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-533
Dial Commands ppp
ppp
To start an asynchronous connection using PPP, use the ppp command in EXEC mode. ppp {/default | {remote-ip-address | remote-name} [@tacacs-server]} [/routing] negotiate
Syntax Description
/default remote-ip-address
Makes a PPP connection when a default address has been configured. The slash mark is required. IP address of the client workstation or PC. This parameter can be specified only if the line is set for dynamic addresses using the async address dynamic line configuration command. Name of the client workstation or PC. This parameter can be specified if the line is set for dynamic addresses using the async address dynamic line configuration command. (Optional) IP address or IP host name of the TACACS server to which the user’s TACACS authentication request is sent. The at sign is required. (Optional) Indicates that the remote system is a router and that routing messages should be exchanged over the link. The line must be configured for asynchronous routing using PPP encapsulation. The slash mark is required. Use PPP negotiated IP address.
remote-name
@tacacs-server /routing
negotiate
Command Modes
EXEC
Command History
Release 10.0
Modification This command was introduced.
Usage Guidelines
When you connect from a remote node computer to an EXEC session on the access server and want to connect from the access server to a device on the network, issue the ppp command. If you specify an address for the TACACS server (either /default or @tacacs-server), the address must be the first parameter in the command after you type ppp. If you do not specify an address or enter the default keyword, you are prompted for an IP address or host name. You can enter the default keyword at this point. To terminate a session, disconnect from the device on the network using the command specific to that device. Then, exit from the EXEC by using the exit command.
Examples
The following example shows a line that is in asynchronous mode using PPP encapsulation. The name of the computer (ntpc in this example) must be in the Domain Name System (DNS) so that it can be resolved to a real IP address). The computer must be running a terminal emulator program.
Router# ppp ntpc@server1
Cisco IOS Dial Technologies Command Reference
DIA-534
November 2009
Dial Commands ppp accm
ppp accm
To specify the Asynchronous Control Character Map (ACCM) to be negotiated with a mobile station or sent to a peer in PPP outbound requests, use the ppp accm command in interface configuration mode. To restore the default state, use the no form of this command. ppp accm hex-number no ppp accm
Syntax Description
hex-number
Specifies the initial value for the ACCM. The value must be a hexadecimal number in the range from 0x0 to 0xFFFFFFFF, where the bit positions from right to left correspond to the characters 0x00 through 0x1F. The default character map (0xA0000) escapes the characters represented by 0x11 (^Q, DC1, and X-on) and 0x13 (^S, DC3, and X-off).
Note
The leading 0x is not necessary when entering the hex-number argument , but is accepted by the software.
Command Default
0xA0000.
Command Modes
Interface configuration
Command History
Release 12.1(3)XS 12.2
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2.
Usage Guidelines
The ACCM is a four octet hexadecimal number that is sent to a peer in a PPP outbound Config-Request packet, informing the peer of which characters need to be escaped during transmission of Asynchronous HDLC (AHDLC) frames containing control characters. The escaped characters set by the ppp accm command are useful for allowing data to pass uninterpreted through a network that would normally interpret the control sequences as a command. For example, the ^Q and ^S characters are software flow control commands used by asynchronous modems to start and stop data transmissions. To allow these characters to be sent as part of a data stream and not be interpreted as control codes by intervening devices, the characters must be escaped, and the ppp accm command specifies which characters to use. The TIA/EIA/IS-835-B requires that the PDSN propose an ACCM of 0x00000000. To be compliant with TIA/EIA/IS-835-B, ppp accm 00000000 must be configured on the virtual template interface on Cisco PDSN. The ppp accm command is meaningful only on asynchronous interfaces. If entered on other interface types, it will be ignored.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-535
Dial Commands ppp accm
Examples
In the following example, all characters can be transmitted intact to the receiver so that it is not necessary for the transmitter to escape anything:
interface async 0 encapsulation ppp ppp accm 0
Related Commands
Command ppp authentication
Description Specifies CHAP or PAP authentication.
Cisco IOS Dial Technologies Command Reference
DIA-536
November 2009
Dial Commands ppp acfc local
ppp acfc local
To configure high-level data link control (HDLC) address and control field compression (ACFC) options in configuration requests, use the ppp acfc local command in interface configuration mode. To return the router to the default for ACFC handling, use the no form of this command. ppp acfc local {request | forbid} no ppp acfc local
Syntax Description
request forbid
The ACFC option is included in outbound configuration requests. The ACFC option is not sent in outbound configuration requests, and requests from a peer to add the ACFC option are not accepted.
Command Default
ACFC handling is automatically selected based on the type of link, as follows: For asynchronous links, the router responds as if the request keyword were selected and the router includes the ACFC option in outbound configuration requests. For synchronous links, the router responds as if the forbid keyword were selected and the ACFC option is not sent out in configuration outbound requests and requests from a peer to add the ACFC option are not accepted.
Command Modes
Interface configuration
Command History
Release 12.2(7) 12.2(15)B
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(15)B.
Usage Guidelines
This command configures ACFC requests in outbound configuration requests. The ppp acfc local command allows ACFC handling to be disabled, thus allowing the HDLC framing and the protocol field to remain uncompressed. Prior to the introduction of the ppp acfc local command, negotiation and use of ACFC was entirely dependent upon the link type (synchronous or asynchronous) and was not under the independent control of a system administrator, and this is still the default condition. The ppp acfc local command allows the system administrator to control over when PPP negotiates the HDLC ACFC options during initial LCP negotiations, and how the results of the PPP negotiation are applied.
Note
Using ACFC can result in minor gains in effective bandwidth because they reduce the amount of framing overhead for each packet. However, using ACFC changes the alignment of the network data in the frame, which in turn can impair the switching efficiency of the packets both at the local and remote ends of the connection. For these reasons, it is generally recommended that ACFC not be enabled without carefully considering the potential results.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-537
Dial Commands ppp acfc local
Examples
The following example shows how to configure a router to exclude ACFC options from its configuration requests:
ppp acfc local forbid
Related Commands
Command ppp acfc remote ppp pfc remote ppp pfc local
Description Configures the ACFC option in configuration requests received from a remote peer. Configures the PFC option in configuration requests received from a remote peer. Configures the PFC option in configuration requests.
Cisco IOS Dial Technologies Command Reference
DIA-538
November 2009
Dial Commands ppp acfc remote
ppp acfc remote
To configure how high-level data link control (HDLC) address and control field compression (ACFC) options in configuration requests are received from a remote peer, use the ppp acfc remote command in interface configuration mode. To return the router to the default for ACFC handling, use the no form of this command. ppp acfc remote {apply | reject | ignore} no ppp acfc remote
Syntax Description
apply reject ignore
ACFC options are accepted and ACFC may be performed on frames sent to the remote peer. ACFC options are explicitly ignored. ACFC options are accepted, but ACFC is not performed on frames sent to the remote peer.
Command Default
ACFC handling is automatically selected based on the type of link, as follows: For asynchronous links, the router responds as if the apply keyword were selected and the router accepts ACFC options received from a remote peer and may perform ACFC on frames sent to the peer. For synchronous links, the router responds as if the ignore keyword were selected and ACFC options received from a remote peer are accepted, but ACFC is not performed on frames sent to the remote peer.
Command Modes
Interface configuration
Command History
Release 12.2(7) 12.2(15)B
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(15)B.
Usage Guidelines
If ACFC is negotiated during PPP negotiation, Cisco routers may omit the HDLC header on links using HDLC encapsulation. This command allows ACFC handling to be disabled during PPP negotiation, thus allowing the HDLC framing and the protocol field to remain uncompressed. Prior to the introduction of the ppp acfc remote command, negotiation and use of ACFC was entirely dependent upon the link type (synchronous or asynchronous) and was not under the independent control of a system administrator, and this is still the default condition. The ppp acfc remote command allows the system administrator control over when PPP negotiates the HDLC ACFC options during initial LCP negotiations, and how the results of the PPP negotiation are applied.
Note
Using ACFC can result in minor gains in effective bandwidth because they reduce the amount of framing overhead for each packet. However, using ACFC changes the alignment of the network data in the frame, which in turn can impair the switching efficiency of the packets both at the local and remote ends of the connection. For these reasons, it is generally recommended that ACFC not be enabled without carefully
Cisco IOS Dial Technologies Command Reference November 2009
DIA-539
Dial Commands ppp acfc remote
considering the potential results.
Examples
The following example configures ACFC options received from a remote peer to be rejected:
ppp acfc remote reject
Related Commands
Command ppp acfc local ppp pfc remote ppp pfc local
Description Configures the ACFC option in configuration requests. Configures the PFC option in configuration requests received from a remote peer. Configures the PFC option in configuration requests.
Cisco IOS Dial Technologies Command Reference
DIA-540
November 2009
Dial Commands ppp bap call
ppp bap call
To set PPP Bandwidth Allocation Protocol (BAP) call parameters, use the ppp bap call command in interface configuration mode. To disable processing of a specific type of incoming connection, use the no form of this command. ppp bap call {accept | request | timer seconds} no ppp bap call {accept | request | timer}
Syntax Description
accept request
Peer initiates link addition. This is the default. Local side initiates link addition.
timer seconds Number of seconds to wait between call requests the router sends, in the range from 2 to 120 seconds. No default value is set.
Command Default
Peers can initiate the addition of links to a multilink bundle; the timer is disabled.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
This command can be included in a virtual interface template for configuring virtual interfaces or can be used to configure a dialer interface.
Examples
The following example configures a dialer interface to accept calls. Accepting calls is the default, but the command is included for the sake of the example.
interface dialer 1 ip unnumbered ethernet 0 encapsulation ppp ppp multilink bap ppp bap call accept ppp bap link types isdn analog dialer load threshold 30 ppp bap timeout pending 60
Related Commands
Command ppp bap callback ppp bap drop
Description Enables PPP BAP callback and set callback parameters. Sets parameters for removing links from a multilink bundle.
ppp bap link types Specifies the types of links that can be included in a specific multilink bundle.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-541
Dial Commands ppp bap callback
ppp bap callback
To enable PPP Bandwidth Allocation Protocol (BAP) callback and set callback parameters, use the ppp bap callback command in interface configuration mode. To remove the PPP BAP callback configuration, use the no form of this command. ppp bap callback {accept | request | timer seconds} no ppp bap callback {accept | request | timer}
Syntax Description
accept request
Local router initiates link addition upon peer notification. Local router requests that a peer initiate link addition.
timer seconds Number of seconds to wait between callback requests the router sends, in the range from 2 to 120 seconds. Disabled by default.
Command Default
Callback is disabled, and no callback parameters are set. The timer is disabled.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Examples
The following example configures a BRI interface for active mode BAP:
interface bri 0 ip unnumbered ethernet 0 dialer load-threshold 10 either dialer map ip 172.21.13.101 name bap-peer 14085778899 encapsulation ppp ppp multilink bap ppp bap call request ppp bap callback accept no ppp bap call accept no ppp bap drop accept ppp bap pending timeout 30 ppp bap number default 5664567 ppp bap number secondary 5664568
Related Commands
Command ppp bap drop ppp bap link types show ppp bap
Description Sets parameters for removing links from a multilink bundle. Specifies the types of links that can be included in a specific multilink bundle. Displays the configuration settings and run-time status for a multilink bundle.
Cisco IOS Dial Technologies Command Reference
DIA-542
November 2009
Dial Commands ppp bap drop
ppp bap drop
To set parameters for removing links from a multilink bundle, use the ppp bap drop command in interface configuration mode. To disable a specific type of default processing, use the no form of this command. ppp bap drop {accept | after-retries | request | timer seconds} no ppp bap drop {accept | after-retries | request | timer}
Syntax Description
accept after-retries request
Peer can initiate link removal. Enabled by default. Local router can remove the link without Bandwidth Allocation Protocol (BAP) negotiation when no response to the drop requests arrives. Local router can initiate removal of a link. Enabled by default.
timer seconds Number of seconds to wait between drop requests sent.
Command Default
accept, request: Peers can initiate link removal and this router also can initiate link removal. no ppp bap drop after-retries: The link is not dropped when there is no response to drop requests. timer: Disabled, no default value is defined.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
The no ppp bap drop accept command disables the router’s ability to respond favorably to link drop requests from a peer. However, the router can still remove the link when it receives such requests. The no ppp bap drop after-retries command is the default behavior; the ppp bap drop after-retries command must be entered explicitly to be effective. The no ppp bap drop request command disables the router’s ability to send link drop requests to a peer. However, the peer can still remove the link on its own behalf; for example, when there is too little traffic to justify keeping the link up. The ppp bap max command specifies the maximum number of requests and retries.
Examples
The following partial example sets a 60-second wait between drop requests:
ppp bap drop timer 60
Related Commands
Command ppp bap max
Description Sets upper limits on the number of retransmissions for PPP BAP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-543
Dial Commands ppp bap link types
ppp bap link types
To specify the types of links that can be included in a specific multilink bundle, use the ppp bap link types command in interface configuration mode. To remove a type of interface that was previously allowed to be added, use the no form of this command. ppp bap link types [isdn] [analog] no ppp bap link types [isdn] [analog]
Syntax Description
isdn analog
(Optional) ISDN interfaces can be added to a multilink bundle. This is the default. (Optional) Asynchronous serial interfaces can be added to a multilink bundle.
Command Default
ISDN interfaces are added to the multilink bundle (isdn keyword).
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
The choice of keywords must suit the interfaces configured for Multilink PPP. For example, if you have configured a dialer rotary with only ISDN interfaces, only the isdn keyword would be appropriate. If the configuration allows both ISDN and asynchronous interfaces, both isdn and analog keywords could be used; the multilink bundle could then consist of both ISDN and asynchronous links. Bandwidth Allocation Protocol (BAP) dynamically determines which interfaces are applicable.
Examples
The following example configures a dialer interface for passive mode BAP and for both ISDN and asynchronous serial links:
interface dialer 1 ip unnumbered ethernet 0 encapsulation ppp ppp multilink bap ppp bap call accept ppp bap link types isdn analog dialer load threshold 30 ppp bap timeout pending 60
Related Commands
Command ppp bap callback show ppp bap
Description Enables PPP BAP callback and set callback parameters. Displays the configuration settings and run-time status for a multilink bundle.
Cisco IOS Dial Technologies Command Reference
DIA-544
November 2009
Dial Commands ppp bap max
ppp bap max
To set upper limits on the number of retransmissions for PPP Bandwidth Allocation Protocol (BAP), use the ppp bap max command in interface configuration mode. To remove any retry limit, use the no form of this command. ppp bap max {dial-attempts number | ind-retries number | req-retries number | dialers number} no ppp bap max {dial-attempts | ind-retries | req-retries | dialers number}
Syntax Description
dial-attempts number ind-retries number req-retries number dialers number
Maximum number of dial attempts to any destination number, in the range from 1 to 3. The default is one dial attempt. Maximum number of retries of a call status indication message, in the range from 1 to 10. The default is three indication retries. Maximum number of retries for a particular request, in the range from 1 to 5. The default is three request retries. Maximum number of free dialers logged, in the range from 1 to 10. The default is five free dialers.
Command Default
1 dial attempt 3 indication retries 3 request retries 5 searches for free dialers
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
In compliance with RFC 2125, the no form of this command explicitly removes any status indication retry limit and is displayed in the router configuration. The ppp bap max dialers command works in conjunction with the dialer rotor and dialer priority interface commands, which can be used to determine free dialers based upon the priority or the best available. Dialers include all interfaces that are configured under the dialer group leader (the dialer interface itself). The dialer group leader is displayed as the Master Interface in the show ppp bap group output. BAP bases its link type and phone number decisions upon the ordering of the interfaces. This decision is suited to a mixed media environment of both ISDN and analog interfaces, where it may be desirable to choose the ISDN link over the asynchronous or vice versa. Note that this decision also will limit the number of potential phone numbers that can be included in a CallResponse or CallbackRequest; the maximum number is limited to 20. For example, ten BRI interfaces with two numbers per interface.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-545
Dial Commands ppp bap max
Examples
The following partial example accepts the default number of attempts to dial a number and the default number of indication retries, but configures a limit of four times to send requests:
ppp bap max req-retries 4
Related Commands
Command dialer priority dialer rotor ppp bap drop
Description Sets the priority of an interface in a dialer rotary group. Specifies the method for identifying the outbound line to be used for ISDN or asynchronous DDR calls. Sets parameters for removing links from a multilink bundle.
ppp bap monitor load Validates peer requests to add or remove links against the current bundle load and the defined dialer load threshold. ppp bap timeout show ppp bap group Specifies nondefault timeout values for PPP BAP pending actions and responses. Displays the configuration settings and run-time status for a multilink bundle.
Cisco IOS Dial Technologies Command Reference
DIA-546
November 2009
Dial Commands ppp bap monitor load
ppp bap monitor load
To validate peer requests to add or remove links against the current bundle load and the defined dialer load threshold, use the ppp bap monitor load command in interface configuration mode. To specify that incoming link addition requests are not to be subject to the bundle load threshold, use the no form of this command. ppp bap monitor load no ppp bap monitor load
Syntax Description
This command has no arguments or keywords.
Command Default
Command is enabled.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
If the load is being monitored and the incoming peer requests that a link be dropped when the current traffic load is above the dialer load (that is, there is enough traffic to justify the current number of links), the router will not drop the link. In addition, when the traffic falls below the threshold, Bandwidth Allocation Protocol (BAP) tries to drop a link. The no form of this command indicates that incoming peer requests to add a link are not subject to the bundle load threshold. However, other criteria must be met before a favorable response is sent.
Examples
The following partial example configures BAP not to validate peer requests against the current bundle load and the configured dialer load threshold:
no ppp bap monitor load
Related Commands
Command dialer load-threshold
Description Configures bandwidth on demand by setting the maximum load before the dialer places another call to a destination.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-547
Dial Commands ppp bap number
ppp bap number
To specify a local telephone number that peers can dial to establish a multilink bundle, use the ppp bap number command in interface configuration mode. To remove a previously configured number, use the no form of this command. ppp bap number {default phone-number | secondary phone-number | prefix prefix-number | format {national | subscriber}} no ppp bap number {default phone-number | prefix prefix-number | format {national | subscriber}}
Syntax Description
default phone-number secondary phone-number
Primary (base) phone number for the interface and the number that can be used for incoming dial calls. Telephone number for the second B channel. Applies only to BRI interfaces that have a different number for each B channel or to dialer interfaces that are BRIs. Prefix number for the PPP phone number. Format for the primary phone number to be dialed should be either national or subscriber where the number of digits assigned to the number is as follows:
• •
prefix prefix-number format national | subscriber
Ten-digit number for a national format. Seven-digit number for a subscriber format.
Command Default
No base number is provided.
Command Modes
Interface configuration
Command History
Release 11.3 11.3T
Modification This command was introduced. The prefix and format keywords were added.
Usage Guidelines
Use this command to supply a local default number to be exchanged between peers in order to establish a multilink bundle. This command is applicable on both the dialer interface and the individual physical interfaces. If a peer requests that a number be supplied and no PPP Bandwidth Allocation Protocol (BAP) default number is defined, it might not be possible for the peer to access the interface. However, the peer can access the interface if it has the number already or the number it dialed originally is the same as the number for establishing a Multilink PPP (MLP) bundle.
Cisco IOS Dial Technologies Command Reference
DIA-548
November 2009
Dial Commands ppp bap number
Note
During BAP negotiations between peers, the called party indicates the number to call for BAP if it is different from the number the peer originally dialed. The called party responds with information about the phone number delta (the changes to be made in the right-most digits dialed). This information indicates the number of digits that are different from the number originally dialed and what those digits should be. For example, if the remote peer dialed 5550159876, and the ppp bap number command had the default number 5550159912, the local router would respond “3 | 912.” In the response, a vertical bar ( | ) is used to divide the number of digits to change from the number sequence to use instead. In the “3 | 912” response, the local router instructs the calling interface to replace the right-most three digits with “912” for BAP. This command is used by the client side for dialing instructions when communicating with the server. Use the prefix keyword on the Always On/Dynamic ISDN (AO/DI) client side to specify what will precede any number dialed to a multilink peer. For example, the client issues a call request to the server whereby the server issues a call response that includes the dialing number the client should use and the format this number should be in (national or subscriber). The client then dials the number supplied by the server, preceded by any prefix information contained in the ppp bap number prefix command. Figure 1 shows an overview about the information exchange between the client and the server.
Figure 1 Client and Server Response Sequence
Call request
Client
Call response
555-1234 Format subscriber
11718
Prefix 9
DID 9555-1234
Use the format keyword on the AO/DI server side to specify how many digits should be returned by BAP. BAP will return the numbers based on either a national or subscriber format. The value that is returned is preceded by the prefix before dialing occurs. For example, if the format national keywords are configured, then the national format (which is equivalent to ten digits) is returned (during BAP negotiation) from the server.
Note
The ppp bap number prefix and ppp bap number format keyword options cannot be combined to a single-string command line; they must be entered in two separate command strings.
Examples
In the following example, the AO/DI client uses a ppp bap prefix value of 9, which indicates that the dialed number of 5550134 will be preceded by a 9. The number that is actually dialed is 95550134. The AO/DI server uses a subscriber format, which indicates that when the client asks the server for the numbers to dial, BAP will return seven digits.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-549
Dial Commands ppp bap number
Client Router
interface dialer1 ppp bap number prefix 9
Server Router
interface dialer1 ppp bap number format subscriber ppp bap number default 5550134
In the following example, the AO/DI client uses a ppp bap prefix value of 1, which indicates that the dialed number of 5550178 will be preceded by a 1. The number that is actually dialed is 19195550178 because the server is using a national format, and BAP therefore, returns ten digits.
Client Router
interface dialer1 ppp bap number prefix 1
Server Router
interface dialer1 ppp bap number format national ppp bap number default 9195550178
The following example configures a physical interface with both a default number and a secondary number:
interface bri 0 ip unnumbered ethernet 0 dialer load-threshold 10 either dialer map ip 172.21.13.101 name bap-peer 14085550199 encapsulation ppp ppp multilink bap ppp bap call request ppp bap callback accept no ppp bap call accept no ppp bap drop accept ppp bap pending timeout 30 ppp bap number default 5550167 ppp bap number secondary 5550168
Related Commands
Command ppp bap callback show ppp bap
Description Enables PPP BAP callback and set callback parameters. Displays the configuration settings and run-time status for a multilink bundle.
Cisco IOS Dial Technologies Command Reference
DIA-550
November 2009
Dial Commands ppp bap timeout
ppp bap timeout
To specify nondefault timeout values for PPP Bandwidth Allocation Protocol (BAP) pending actions and responses, use the ppp bap timeout command in interface configuration mode. To reset the response timeout to the default value, or to remove a pending timeout entirely, use the no form of this command. ppp bap timeout {pending seconds | response seconds} no ppp bap timeout {pending | response}
Syntax Description
pending seconds response seconds
Number of seconds to wait before timing out pending actions, in the range from 2 to 180 seconds. The default is 20 seconds. Number of seconds to wait for a response before timing out, in the range from 2 to 120 seconds. The default is 3 seconds.
Command Default
Enabled pending: 20 seconds response: 3 seconds
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
The no ppp bap timeout response command resets the timer to the default value.The no ppp bap timeout pending command removes the pending-action timeout entirely (in compliance with the BAP specification).
Examples
The following example configures BAP to wait 45 seconds before timing out pending actions:
interface dialer 1 ip unnumbered ethernet 0 encapsulation ppp ppp multilink bap ppp bap call accept ppp bap link types isdn analog dialer load threshold 30 ppp bap timeout pending 45
Cisco IOS Dial Technologies Command Reference November 2009
DIA-551
Dial Commands ppp bap timeout
Related Commands
Command ppp bap callback ppp bap drop ppp bap max show ppp bap
Description Enables PPP BAP callback and set callback parameters. Sets parameters for removing links from a multilink bundle. Sets upper limits on the number of retransmission for PPP BAP. Displays the configuration settings and run-time status for a multilink bundle.
Cisco IOS Dial Technologies Command Reference
DIA-552
November 2009
Dial Commands ppp bridge appletalk
ppp bridge appletalk
To enable half-bridging of AppleTalk packets across a serial interface, use the ppp bridge appletalk command in interface configuration mode. To disable AppleTalk packet half-bridging, use the no form of this command. ppp bridge appletalk no ppp bridge appletalk
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
When you configure a serial or ISDN interface for half-bridging, you configure it to function as a node on an Ethernet subnetwork. It communicates with a bridge on the subnetwork by sending and receiving bridge packets. The serial or ISDN interface converts bridge packets to routed packets and forwards them, as needed. The serial interface must be configured with an AppleTalk address for communication on the Ethernet subnetwork, and the AppleTalk address must have the same AppleTalk cable range as the bridge. You cannot configure a serial interface for both half-bridging and for transparent bridging. No more than one half-bridge should be on any subnetwork.
Examples
The following example configures serial interface 0 for half-bridging of AppleTalk. The remote bridge and other Ethernet nodes must be on the same network.
interface serial 0 ppp bridge appletalk appletalk cable-range 301-301 appletalk zone remote-lan
Related Commands
Command appletalk zone ppp bridge ip ppp bridge ipx
Description Sets the zone name for the connected AppleTalk network. Enables half-bridging of IP packets across a serial interface. Enables half-bridging of IPX packets across a serial interface.
appletalk cable-range Enables an extended AppleTalk network.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-553
Dial Commands ppp bridge ip
ppp bridge ip
To enable half-bridging of IP packets across a serial interface, use the ppp bridge ip command in interface configuration mode. To disable IP packet half-bridging, use the no form of this command. ppp bridge ip no ppp bridge ip
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
When you configure a serial or ISDN interface for half-bridging, you configure it to function as a node on an Ethernet subnetwork. It communicates with a bridge on the subnetwork by sending and receiving bridge packets. The serial interface converts bridge packets to routed packets and forwards them, as needed. The interface must be configured with an IP address for communication on the Ethernet subnetwork, and the IP address must be on the same subnetwork as the bridge. You cannot configure a serial interface for both half-bridging and for transparent bridging. No more than one half-bridge should be on any subnetwork.
Examples
The following example configures serial interface 0 for half-bridging of IP. The remote bridge and other Ethernet nodes must be on the same subnetwork.
interface serial 0 ip address 172.19.5.8 ppp bridge ip
Related Commands
Command ip address ppp bridge appletalk ppp bridge ipx
Description Sets a primary or secondary IP address for an interface. Enables half-bridging of AppleTalk packets across a serial interfaces. Enables half-bridging of IPX packets across a serial interfaces.
Cisco IOS Dial Technologies Command Reference
DIA-554
November 2009
Dial Commands ppp bridge ipx
ppp bridge ipx
To enable half-bridging of Internetwork Packet Exchange (IPX) packets across a serial interface, use the ppp bridge ipx command in interface configuration mode. To return to the default Novell Ethernet_802.3 encapsulation, use the no form of this command. ppp bridge ipx [novell-ether | arpa | sap | snap] no ppp bridge ipx
Syntax Description
novell-ether arpa sap snap
(Optional) Novell Ethernet_802.3 encapsulation. This is the default. (Optional) Novell Ethernet_II encapsulation. (Optional) Novell Ethernet_802.2 encapsulation. (Optional) Novell Ethernet_Snap encapsulation.
Command Default
The default encapsulation is novell-ether.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
When you configure a serial interface for half-bridging, you configure it to function as a node on an Ethernet subnetwork. It communicates with a bridge on the subnetwork by sending and receiving bridge packets. The serial interface converts bridge packets to routed packets and forwards them, as needed. The serial interface must be configured with an IPX address for communication on the Ethernet subnetwork, and the IPX address must be on the same subnetwork as the bridge. You cannot configure a serial interface for both half-bridging and for transparent bridging. No more than one half-bridge should be on any subnetwork.
Examples
The following example configures serial interface 0 for half-bridging of IPX. The remote bridge and other Ethernet nodes must be on the same subnetwork.
interface serial 0 ppp bridge ipx ipx network 1800
Cisco IOS Dial Technologies Command Reference November 2009
DIA-555
Dial Commands ppp bridge ipx
Related Commands
Command ipx network ppp bridge appletalk ppp bridge ip
Description Enables IPX routing on a particular interface and optionally selects the type of encapsulation (framing). Enables half-bridging of AppleTalk packets across a serial interfaces. Enables half-bridging of IP packets across a serial interfaces.
Cisco IOS Dial Technologies Command Reference
DIA-556
November 2009
Dial Commands ppp callback (DDR)
ppp callback (DDR)
To enable a dialer interface to function either as a callback client that requests callback or as a callback server that accepts callback requests, use the ppp callback command in interface configuration mode. To disable a function, use the no form of this command. ppp callback {accept | permit | request} no ppp callback
Syntax Description
accept permit request
Dialer interface accepts PPP callback requests (and functions as the PPP callback server). Dialer interface permits PPP callback (and functions as the PPP callback client). Dialer interface requests PPP callback (and functions as the PPP callback client).
Command Default
Callback requests are neither accepted nor requested.
Command Modes
Interface configuration
Command History
Release 11.1
Modification This command was introduced.
Usage Guidelines
An interface can request PPP callback only if the interface is configured for PPP authentication with Challenge Handshake Authentication Protocol (CHAP) or Password Authentication Protocol (PAP). If an interface of the callback server is configured with ppp callback accept and the client attempts to cancel the callback and connect, Cisco IOS software will refuse the request and disconnect the client. If a client is allowed to cancel callbacks and connects, the ppp callback permit command must be used instead of the ppp callback accept command on the callback server interface.
Examples
The following example configures a previously defined dialer interface to accept PPP callback requests:
ppp callback accept
Related Commands
Command map-class dialer
Description Defines a class of shared configuration parameters associated with the dialer map command for outgoing calls from an ISDN interface and for PPP callback. Enables a PPP client to dial in to an asynchronous interface and request a callback.
dialer callback-secure Enables callback security.
ppp callback (PPP client)
Cisco IOS Dial Technologies Command Reference November 2009
DIA-557
Dial Commands ppp callback (PPP client)
ppp callback (PPP client)
To enable a PPP client to dial in to an asynchronous interface and request a callback, use the ppp callback command in interface configuration mode. To disable callback acceptance, use the no form of this command. ppp callback {accept | initiate} no ppp callback
Syntax Description
accept initiate
Accept callback requests from RFC 1570-compliant PPP clients on the interface. Initiate a callback to non-RFC 1570-compliant PPP clients dialing in to an asynchronous interface.
Command Default
Callback requests are not accepted on asynchronous interfaces.
Command Modes
Interface configuration
Command History
Release 11.0
Modification This command was introduced.
Usage Guidelines
PPP callback can be initiated only if the interface is configured for authentication using CHAP or PAP.
Examples
The following example accepts a callback request from an RFC-compliant PPP client:
ppp callback accept
The following example accepts a callback request from a non-RFC-compliant PPP client:
ppp callback initiate
Related Commands
Command arap callback autoselect ppp
Description Enables an ARA client to request a callback from an ARA client. Configures a line to start a SLIP session.
call progress tone country Forces the Cisco IOS software to wait before initiating a callback to a requesting client. ppp authentication Enables CHAP or PAP or both and specifies the order in which CHAP and PAP authentication are selected on the interface.
Cisco IOS Dial Technologies Command Reference
DIA-558
November 2009
Dial Commands ppp callback (PPP client)
Command ppp callback (DDR) username
Description Enables a dialer interface to function either as a callback client that requests callback or as a callback server that accepts callback requests. Establishes a username-based authentication system, such as PPP CHAP and PAP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-559
Dial Commands ppp caller name
ppp caller name
To set the caller option when no Calling Line Identification (CLID) is available, use the ppp caller name command in interface configuration mode. To remove the name, use the no form of this command. ppp caller name name no ppp caller name name
Syntax Description
name
Username string for this call.
Command Default
Command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
This command sets the username used when the CLID is not available. This username is used only in the case where the ppp dnis command is configured and the CLID is not available.
Examples
The following example shows how to configure a call to user1:
interface Serial0:15 description "PRI D channel" ip unnumbered Loopback0 encapsulation ppp no keepalive dialer pool-member 1 max-link 1 isdn switch-type primary-net5 isdn incoming-voice modem no fair-queue no cdp enable ppp caller name user1 ppp authentication pap chap callin USERS&TUNNELS ppp chap hostname osh
Related Commands
Command ppp dnis
Description Sets the DNIS string for a PPP call.
Cisco IOS Dial Technologies Command Reference
DIA-560
November 2009
Dial Commands ppp direction
ppp direction
To override the default direction of a PPP connection, use the ppp direction command in interface configuration mode. To disable an override setting, use the no form of this command. ppp direction {callin | callout | dedicated} no ppp direction {callin | callout | dedicated}
Syntax Description
callin callout dedicated
Treat the connection as a received call. Treat the connection as an initiated call. Treat the connection as a dedicated call.
Defaults
Disabled (no direction configured)
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
The ppp direction command is useful when a router is connected to an interface type where there is either no inherent call direction, such as with a back-to-back or leased-line connection, or where an external dial device such as a CSU/DSU or an ISDN terminal adapter is connected to the interface. The configured call direction will always override the automatically detected direction, even on dial interfaces where the true direction is known. The call direction is used mainly internally by PPP authentication, as follows:
•
If doing bidirectional authentication, PPP will wait to send its authentication credentials to the peer if the direction is call-in, and the no ppp chap wait, no ppp pap wait, or no ppp eap wait commands are not configured. PPP uses the call direction internally to detect spoofed Challenge Handshake Authentication Protocol (CHAP) sessions. If the direction is call-in, PPP requires that the remote names used in a peer’s CHAP challenge and CHAP response be the same.
• •
The call direction is also used for callback processing. Typically, you will not need to configure this command. If you do, you should configure the opposite of the command on the other side of the link, so one side is call-out and one side is call-in.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-561
Dial Commands ppp direction
Examples
The following example determines the call direction on a back-to-back serial connection:
interface Serial2/0 ip address 192.168.1.131 255.255.255.0 encapsulation ppp peer default ip address pool local local_pool serial restart-delay 0 ppp authentication chap ppp direction callin
Related Commands
Command ppp chap wait ppp eap wait ppp pap wait
Description Configures the router to delay the CHAP authentication until after the peer has authenticated itself to the router. Configures the router to delay the EAP authentication until after the peer has authenticated itself to the server. Configures the router to delay the PAP authentication until after the peer has authenticated itself to the router.
Cisco IOS Dial Technologies Command Reference
DIA-562
November 2009
Dial Commands ppp dnis
ppp dnis
To configure a set of dialed number identification service (DNIS) numbers to check an incoming call against to automatically authenticate and authorize a user, use the ppp dnis command in interface configuration mode. To remove the numbers, use the no form of this command. ppp dnis DNIS-number [DNIS-number] [DNIS-number...] no ppp dnis
Syntax Description
DNIS-number
Specifies the DNIS number that will be checked when a call comes in. Multiple DNIS numbers can be entered seperated by spaces.
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
This command enables a method of authenticating and authorizing a user based on the DNIS. The DNIS is the number dialed by the user. If the dialed number for this session matches one of the numbers configured in the ppp dnis command, the user is automatically authenticated and authorized for the session. Any other configured PPP authentication is not performed. In the case of DNIS authentication, the Calling Line Identification (CLID) is used as the username. If the CLID is unavailable, the username is the name configured with the ppp caller name command. If neither the CLID nor a caller name is configured, the username will automatically be set to “no-clid.”
Examples
The following example shows how to set the DNIS for a call:
interface Serial0:15 description "PRI D channel" ip unnumbered Loopback0 encapsulation ppp no keepalive dialer pool-member 1 max-link 1 isdn switch-type primary-net5 isdn incoming-voice modem no fair-queue no cdp enable ppp dnis 13693 132 ppp authentication pap chap callin USERS&TUNNELS ppp chap hostname osh
Cisco IOS Dial Technologies Command Reference November 2009
DIA-563
Dial Commands ppp dnis
Related Commands
Command ppp caller name
Description Sets the caller option when no CLID is available.
Cisco IOS Dial Technologies Command Reference
DIA-564
November 2009
Dial Commands ppp encrypt mppe
ppp encrypt mppe
To enable Microsoft Point-to-Point Encryption (MPPE) on the virtual template, use the ppp encrypt mppe command in interface configuration mode. To disable MPPE, use the no form of this command. ppp encrypt mppe {auto | 40 | 128} [passive | required] [stateful] no ppp encrypt mppe
Syntax Description
auto 40 128 passive required stateful
All available encryption strengths are allowed. Only 40-bit encryption is allowed. Only 128-bit encryption is allowed. (Optional) MPPE will not offer encryption, but will negotiate if the other tunnel endpoint requests encryption. (Optional) MPPE must be negotiated, or the connection will be terminated. (Optional) MPPE will negotiate only stateful encryption. If the stateful keyword is not used, MPPE will first attempt to negotiate stateless encryption, but will allow stateful mode if the other tunnel endpoint requests it.
Command Default
MPPE encryption is disabled.
Command Modes
Interface configuration
Command History
Release 12.0(5)XE5 12.1(5)T 12.4(5)
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.1(5)T. This command was modified to explicitly disallow interleaving.
Usage Guidelines
PPP encapsulation must be enabled before you can use the ppp encrypt mppe command. All of the configurable MPPE options must be identical on both tunnel endpoints. The auto keyword is offered only on 128-bit images.
Note
The ppp authentication ms-chap command must be added to the interface that will carry Point-to-Point Tunnel Protocol (PPTP)-MPPE traffic. All Windows clients using MPPE need the Microsoft Challenge Handshake Authentication Protocol (MS-CHAP) application. This is a Microsoft design requirement. Stateful encryption is not appropriate for links that have high loss rates because the state information is updated with each packet received, but cannot be updated correctly for packets that are not received. Losing a packet means loss of state (transmissions are no longer synchronous). Losing state triggers expensive resynchronization mechanisms, and more packets will be lost during the recovery period. Any link that experiences more than the occasional random drop is therefore unsuitable for stateful
Cisco IOS Dial Technologies Command Reference November 2009
DIA-565
Dial Commands ppp encrypt mppe
encryption mechanisms. The same is also true for stateful compressions. For this reason, stateful encryption may not be appropriate for lossy network environments such as Layer 2 tunnels on the Internet. The interleaving of packets among fragments of larger packets on a Multilink PPP (MLP) bundle (enabled with the ppp multilink interleave command) is not supported with this command.
Examples
The following example shows a virtual template configured to perform 40-bit MPPE encryption:
interface Virtual-Template1 ip unnumbered FastEthernet0/0 no ip directed-broadcast ip mroute-cache no keepalive ppp encrypt mppe 40 ppp authentication ms-chap
Related Commands
Command encryption mppe ppp authentication
Description Enables MPPE encryption on the ISA card. Enables CHAP, PAP, MS-CHAP, or a combination of methods and specifies the order in which the authentication methods are selected on the interface. Enables interleaving of packets among the fragments of larger packets on an MLP bundle.
interface virtual-template Creates a virtual template interface.
ppp multilink interleave
Cisco IOS Dial Technologies Command Reference
DIA-566
November 2009
Dial Commands ppp hold-queue
ppp hold-queue
To specify the maximum number of packets to be queued to the PPP process across all interfaces, use the ppp hold-queue command in global configuration mode. To restore the default values, use the no form of this command. ppp hold-queue length no ppp hold-queue
Syntax Description
length
The number of packets to be queued. Values are from 1 to 1000000.
Command Default
The default length depends on the platform. That is, the default length is twice the maximum number of PPP-supported interfaces on that platform.
Command Modes
Global configuration
Command History
Release 12.4(15)T
Modification This command was introduced.
Usage Guidelines
The exact value of the packets queued depends on the number of PPP sessions supported. The default value works in most cases. It is not recommended to set a different value unless your Cisco technical support representative directs you to do so for deployment-specific tuning purposes. The command specifies that only packets that are actually queued are counted; packets that are discarded at interrupt because they do not pass various checks are not counted. Preprocessed packets are also not counted. Any type of packet queued to the PPP process is counted.
Examples
The following example shows how to specify the maximum number of packets to be queued to the PPP process:
Router(config)# ppp hold-queue 64000
Cisco IOS Dial Technologies Command Reference November 2009
DIA-567
Dial Commands ppp ipcp
ppp ipcp
To configure PPP IP Control Protocol (IPCP) features such as the ability to provide primary and secondary Domain Name Server (DNS) and Windows Internet Naming Service (WINS) server addresses, and the ability to accept any address requested by a peer, use the ppp ipcp command in template or interface configuration mode. To disable a ppp ipcp feature, use the no form of this command. ppp ipcp {accept-address | address {accept | required | unique} | dns {primary-ip-address [secondary-ip-address] [aaa] [accept] | accept | reject | request [accept]} | header-compression ack | ignore-map | mask {subnet-mask | reject | request} | username unique | wins {primary-ip-address [secondary-ip-address] [aaa] [accept] | accept | reject | request [accept]}} no ppp ipcp {accept-address | address {accept | required | unique} | dns | header-compression ack | ignore-map | mask | predictive | username unique | wins}
Syntax Description
accept-address address
Accepts any nonzero IP address from the peer. Specifies IPCP IP address options:
• • •
accept—Accepts any nonzero IP address from the peer. required—Disconnects the peer if no IP address is negotiated. unique—Disconnects the peer if the IP address is already in use. primary-ip-address—IP address of the primary DNS server.
– secondary-ip-address—(Optional) IP address of the secondary DNS
dns
Specifies DNS options:
•
server.
– aaa—(Optional) Use DNS data from the AAA server. – accept—(Optional) Specifies that any nonzero DNS address will be
accepted.
• • •
accept—Specifies that any nonzero DNS address will be accepted. reject—Reject the IPCP option if received from the peer. request—Request the DNS address from the peer.
header-compression ack ignore-map mask
Enables IPCP header compression. Ignores dialer map when negotiating peer IP address. Specifies IP address mask options:
• • •
subnet-mask—Specifies the subnet mask to offer the peer. reject—Reject subnet mask negotiations. request—Request the subnet mask from the peer.
Cisco IOS Dial Technologies Command Reference
DIA-568
November 2009
Dial Commands ppp ipcp
username unique wins
Ignores a common username when providing an IP address to the peer. Specifies WINS options:
•
primary-ip-address—IP address of the primary WINS server.
– secondary-ip-address—(Optional) IP address of the secondary
WINS server.
– aaa—(Optional) Use WINS data from the AAA server. – accept—(Optional) Specifies that any nonzero WINS address will be
accepted.
• • •
accept—Specifies that any nonzero WINS address will be accepted. reject—Reject the IPCP option if received from the peer. request—Request the WINS address from the peer.
Command Default
No servers are configured, and no address request is made.
Command Modes
Template configuration Interface configuration
Command History
Release 12.0(6)T 12.1(5)T
Modification This command was introduced. The reject and accept keywords were added.
Examples
The following examples show use of the ppp ipcp command:
ppp ipcp accept-address ppp ipcp dns 10.1.1.3 ppp ipcp dns 10.1.1.3 10.1.1.4 ppp ipcp dns 10.1.1.1 10.1.1.2 accept ppp ipcp dns accept ppp ipcp dns reject ppp ipcp ignore-map ppp ipcp username unique ppp ipcp wins 10.1.1.1 10.1.1.2 ppp ipcp wins accept
The following examples show how to use the no form of the ppp ipcp command:
no ppp ipcp wins no ppp ipcp ignore-map
Cisco IOS Dial Technologies Command Reference November 2009
DIA-569
Dial Commands ppp ipcp
Related Commands
Command debug ppp show interfaces show ip interfaces
Description Displays information on traffic and exchanges in an internetwork implementing the PPP. Displays statistics for all interfaces configured on the router or access server. Displays the usability status of interfaces configured for IP.
Cisco IOS Dial Technologies Command Reference
DIA-570
November 2009
Dial Commands ppp ipcp default route
ppp ipcp default route
To configure a default route through a PPP virtual access interface, use the ppp ipcp default route command in interface configuration mode. To disable a default route for a PPP virtual access interface, use the no form of this command. ppp ipcp default route no ppp ipcp default route
Syntax Description
This command has no arguments or keywords.
Command Default
No default route
Command Modes
Interface configuration
Command History
Release 12.3(11)T
Modification This command was introduced.
Usage Guidelines
This command allows a PPP virtual template to dynamically add a default route pointing to the virtual access interface created by the virtual template. A customer premises equipment (CPE) router with PPP over an ATM or Frame Relay connection can access the Internet without turning on any other routing.
Examples
The following example shows how to configure the PPP default route on the virtual access interface:
interface virtual-template 1 ip address negotiated ppp ipcp default route
Related Commands
Command
Description
debug ppp negotiation Displays information on traffic and exchanges in an internetwork implementing PPP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-571
Dial Commands ppp ipcp predictive
ppp ipcp predictive
To set the PPP Internet Protocol Control Protocol (IPCP) to a predictive state that reduces negotiation time by predicting responses from peers and sending expected reply and request packets in advance, use the ppp ipcp predictive command in interface configuration mode. To disable the IPCP predictive state, use the no form of this command. ppp ipcp predictive no ppp ipcp predictive
Syntax Description
This command has no arguments or keywords.
Command Default
The PPP IPCP is not set to a predictive state.
Command Modes
Interface configuration
Command History
Release 12.2(4)T 12.2(11)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5300, Cisco AS5400 and Cisco AS5800.
Usage Guidelines
The ppp ipcp predictive command is useful in networks that accept connections from devices that require a reduction in the IPCP negotiation cycle time. This command reduces the amount of time needed for PPP to negotiate with the peer so that connections can be made in an acceptable amount of time. The following changes to the IPCP negotiation strategy make this time reduction possible:
• •
Send an IPCP Configure-Ack packet after sending an IPCP Configure-Nak packet. Send IPCP Configure-Nak and Configure-Ack packets after rejecting certain configuration options.
These changes can reduce connection delay by approximately 40 percent.
Note
Any Configure-Request packet received in the Open state is ignored until the software receives Configure-Request packets with identifying numbers greater than what was last acknowledged, in which case the software disables the predictive mode and processes the Configure-Request packet using normal IPCP negotiation operations. The ppp ipcp predictive command is configured on group asynchronous and dialer interfaces running PPP or Multilink PPP.
Cisco IOS Dial Technologies Command Reference
DIA-572
November 2009
Dial Commands ppp ipcp predictive
Examples
The following example sets the link control protocol (LCP) and IPCP to predictive states on a group asynchronous interface:
interface group-async 1 ip unnumbered loopback 0 encapsulation ppp no ip mroute-cache dialer in-band dialer pool-member 1 async dynamic address async dynamic routing async mode dedicated no fair-queue ppp lcp predictive ppp ipcp predictive group-range 1 48 hold-queue 75 in
Related Commands
Command interface dialer interface group-async ppp lcp predictive
Description Defines a dialer rotary group. Creates a group interface that will serve as master, to which asynchronous interfaces can be associated as members. Sets LCP to a predictive state that reduces negotiation time by predicting responses from peers and sending expected reply and request packets in advance.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-573
Dial Commands ppp iphc max-header
ppp iphc max-header
To set the maximum size of the largest IP header that may be compressed when configuring Internet Protocol Header Compression (IPHC) control options over PPP, use the ppp iphc max-header command in interface configuration mode. To change the configuration, use the no form of this command. ppp iphc max-header bytes no ppp iphc max-header bytes
Syntax Description
bytes
Maximum size, in bytes, of the largest IP header that may be compressed. The range is from 60 to 168 bytes, and the default is 168 bytes.
Command Default
168 bytes
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
There are two types of IP header compression used over PPP: Van Jacobsen header compression defined in RFC 1332 and enabled with the ip tcp header-compression command, and IPHC defined in RFC 2509 and enabled with the ip rtp header-compression command. The ppp iphc set of commands controls parameters that pertain to the form of IPHC described in RFC 2509. The IPHC specification allows low speed links to run more efficiently by reducing the size of the IP headers as transmitted on the link. IPHC supports compressed Real-Time Transport Protocol (cRTP), compressed User Datagram Protocol (cUDP), and compressed Transaction Control Protocol (cTCP). An IPHC-enabled interface sends only changes to the header instead of sending the entire header with every packet. At the beginning of a transmission, the transmitting end (the compressor) sends a full header packet to the receiving end (the decompressor). After the initial packet is sent, the compressor sends all other packets with headers that contain only the differences between them and the original full header. The decompressor maintains a copy of the original full header and reconstructs all the other packet headers by adding the changes to them. The header data that is different with each packet is referred to as the session state, and is identified by a session ID or connection ID. When the decompressor receives a compressed packet, it reconstructs the packet header by adding the difference to the saved uncompressed header. Typically, IPHC enables the header to be compressed to two bytes (four bytes if UDP checksums are used).
Cisco IOS Dial Technologies Command Reference
DIA-574
November 2009
Dial Commands ppp iphc max-header
The following fields in a packet header usually remain the same throughout a transmission:
• • •
IP source and destination addresses UDP and TCP source and destination ports RTP synchronization source (SSRC) fields IP packet ID Checksum Sequence number RTP time stamp The RTP marker bit
The following fields in a packet header usually change during a transmission:
• • • • •
Examples
The following example shows how to change the maximum size of the largest IP header that may be compressed from the default of 168 bytes to 114 bytes:
interface Multilink1 ip address 10.100.253.1 255.255.255.0 no ip directed-broadcast no ip route-cache ip tcp header-compression iphc-format no ip mroute-cache fair-queue 64 256 1000 no cdp enable ppp multilink ppp multilink fragment-delay 20 ppp multilink interleave multilink-group 1 ip rtp header-compression iphc-format ip rtp priority 16384 50 64 ppp iphc max-header 114 ppp iphc max-time 10 ppp iphc max-period 512
Related Commands
Command
Description
ip rtp header-compression Enables TCP, UDP, and RTP (RFC 2509) header compression. ip tcp header-compression Enables TCP (RFC 1332) header compression. ppp iphc max-period ppp iphc max-time Sets the maximum number of compressed packets that can be sent before a full header when configuring IPHC control options over PPP. Sets the maximum time allowed between full headers when configuring IPHC control options over PPP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-575
Dial Commands ppp lcp delay
ppp lcp delay
To configure the link control protocol (LCP) delay timer for initiating LCP negotiations after a link connects and to configure the router to discard incoming setup requests until the LCP delay timer expires, use the ppp lcp delay command in interface configuration mode. To disable the LCP delay timer, use the no form of this command. ppp lcp delay seconds [milliseconds] [random max-delay-seconds] [discard] no ppp lcp delay
Syntax Description
seconds milliseconds
Delay, in seconds, before initiating LCP negotiations. Valid values for the seconds argument range from 0 to 255. The default value is 2 seconds. (Optional) Delay, in milliseconds (ms), before initiating LCP negotiations. Valid values for the milliseconds argument range from 0 to 999. The default value is 0 ms. (Optional) Specifies that a random amount of additional time will be added to the configured LCP delay timer. The additional amount of time will not exceed the number of seconds specified with the max-delay-seconds argument. Valid values for max-delay-seconds range from 1 to 255. Random delay is disabled by default. (Optional) Specifies that incoming configuration requests (CONFREQs) will be discarded until the LCP delay timer has expired. CONFREQs are not discarded by default.
random max-delay-seconds
discard
Command Default
No LCP delay timer is configured.
Command Modes
Interface configuration (config-if)
Command History
Release 12.1 12.2(13)T 12.3(11)YS
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(13)T. The milliseconds argument was added. This command was integrated into Cisco IOS Release 12.3(11)YS. The random max-delay-seconds and discard keywords and argument were added. This command was integrated into Cisco IOS Release 12.2(33)SRE. This command was integrated into Cisco IOS Release 15.0(1)M.
12.2(33)SRE 15.0(1)M
Usage Guidelines
Configure an LCP delay timer to allow the peer device a short amount of time to send the first packet after the PPP link comes up. If the LCP delay timer expires before a CONFREQ is received from the peer, the router can initiate LCP negotiations.
Cisco IOS Dial Technologies Command Reference
DIA-576
November 2009
Dial Commands ppp lcp delay
The LCP delay timer is applied only to incoming connections. PPP does not delay for outbound connections or connections where PPP cannot determine a direction. Use the random max-delay-seconds keyword and argument combination to add a random amount of time to the LCP delay timer. Setting a random delay on the initiation of LCP negotiations prevents overload when many PPP links come up at the same time. Use the discard keyword to specify that incoming CONFREQs should be discarded until the configured delay has expired. LCP negotiations will not be initiated until the LCP delay timer has expired.
Examples
The following example shows how to configure an LCP delay timer of 4 seconds. If a CONFREQ is not received before the LCP delay timer expires, LCP negotiations can be initiated by either peer.
Router(config-if)# ppp lcp delay 4
The following example shows how to configure an LCP delay timer that will expire at a random time between 5 and 15 seconds after the link comes up. If a CONFREQ is not received before the LCP delay timer expires, LCP negotiations can be initiated by either peer.
Router(config-if)# ppp lcp delay 5 random 10
The following example shows how to configure an LCP delay timer of 3.25 seconds and specifies that incoming CONFREQs will be discarded until the LCP delay timer has expired. After 3.25 seconds, LCP negotiations can be initiated by either peer.
Router(config-if)# ppp lcp delay 3 250 discard
The following example shows how to configure an LCP delay timer that will expire at a random time between 10 and 15 seconds after the link comes up, and specifies that incoming CONFREQs will be discarded until the LCP delay timer has expired. After the LCP delay timer expires, negotiations can be initiated by either peer.
Router(config-if)# ppp lcp delay 10 random 5 discard
Related Commands
Command debug ppp multilink negotiation show ppp multilink
Description Displays information about events affecting multilink groups controlled by BACP. Displays bundle information for MLP bundles.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-577
Dial Commands ppp lcp delay
Cisco IOS Dial Technologies Command Reference
DIA-578
November 2009
Dial Commands ppp iphc max-period
ppp iphc max-period
To set the maximum number of compressed packets that can be sent before a full header when configuring Internet Protocol Header Compression (IPHC) control options over PPP, use the ppp iphc max-period command in interface configuration mode. To change the configuration, use the no form of this command. ppp iphc max-period packets no ppp iphc max-period packets
Syntax Description
packets
Maximum number of compressed packets that can be sent before a full header. The range is from 1 to 65,535 packets, and the default is 256 packets.
Command Default
256 packets
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
There are two types of IP header compression used over PPP: Van Jacobsen header compression, which is defined in RFC 1332, and a newer compression type described in RFC 2509. The ppp iphc set of commands controls parameters that pertain to the form of IPHC described in RFC 2509. The IPHC specification allows low speed links to run more efficiently when IP headers are extremely large. IPHC supports compressed Real-Time Transport Protocol (cRTP), compressed User Datagram Protocol (cUDP), and compressed Transaction Control Protocol (cTCP). An IPHC-enabled interface sends only changes to the header instead of sending the entire header with every packet. At the beginning of a transmission, the transmitting end (the compressor) sends a full header packet to the receiving end (the decompressor). After the initial packet is sent, the compressor sends all other packets with headers that contain only the differences between them and the original full header. The decompressor maintains a copy of the original full header and reconstructs all the other packet headers by adding the changes to them. The header data that is different with each packet is referred to as the session state, and is identified by a session ID or connection ID. When the decompressor receives a compressed packet, it reconstructs the packet header by adding the difference to the saved uncompressed header. Typically, IPHC enables the header to be compressed to two bytes (four bytes if UDP checksums are used).
Cisco IOS Dial Technologies Command Reference November 2009
DIA-579
Dial Commands ppp iphc max-period
The following fields in a packet header usually remain the same throughout a transmission:
• • •
IP source and destination addresses UDP and TCP source and destination ports RTP synchronization source (SSRC) fields IP packet ID Checksum Sequence number RTP time stamp RTP marker bit
The following fields in a packet header usually change during a transmission:
• • • • •
The ppp iphc max-period command is specifically related to an IPHC frame format known as compressed_non_TCP. The recovery of lost compressed_non_TCP frames on lossy links is much improved by allowing more full headers to flow and by configuring less compression.
Examples
The following example shows how to increase the maximum number of compressed packets that can be sent before a full header from 256 to 512 packets when configuring IPHC control options over PPP:
interface Multilink1 ip address 10.100.253.1 255.255.255.0 no ip directed-broadcast no ip route-cache ip tcp header-compression iphc-format no ip mroute-cache fair-queue 64 256 1000 no cdp enable ppp multilink ppp multilink fragment-delay 20 ppp multilink interleave multilink-group 1 ip rtp header-compression iphc-format ip rtp priority 16384 50 64 ppp iphc max-header 114 ppp iphc max-time 10 ppp iphc max-period 512
Related Commands
Command
Description
ip rtp header-compression Enables TCP, UDP, and RTP (RFC 2509) header compression. ip tcp header-compression Enables TCP (RFC 1332) header compression. ppp iphc max-header ppp iphc max-time Sets the maximum size of the largest IP header that may be compressed when configuring IPHC control options over PPP. Sets the maximum number of compressed packets that can be sent before a full header when configuring IPHC control options over PPP.
Cisco IOS Dial Technologies Command Reference
DIA-580
November 2009
Dial Commands ppp iphc max-time
ppp iphc max-time
To set the maximum time allowed between full headers when configuring Internet Protocol Header Compression (IPHC) control options over PPP, use the ppp iphc max-time command in interface configuration mode. To change the configuration, use the no form of this command. ppp iphc max-time seconds no ppp iphc max-time seconds
Syntax Description
seconds
Maximum time, in seconds, allowed between full headers. The range is from 1 to 255 seconds, and the default is 5 seconds.
Command Default
5 seconds
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
There are two forms of IP header compression used over PPP: Van Jacobsen header compression, which is defined in RFC 1332, and a newer form of compression described in RFC 2509. The ppp iphc set of commands controls parameters that pertain to the form of IPHC described in RFC 2509. The IPHC specification allows low speed links to run more efficiently by reducing the size of IP headers as transmitted on the link. IPHC supports compressed Real-Time Transport Protocol (cRTP), compressed User Datagram Protocol (cUDP), and compressed Transaction Control Protocol (cTCP). An IPHC-enabled interface sends only changes to the header instead of sending the entire header with every packet. At the beginning of a transmission, the transmitting end (the compressor) sends a full header packet to the receiving end (the decompressor). After the initial packet is sent, the compressor sends all other packets with headers that contain only the differences between them and the original full header. The decompressor maintains a copy of the original full header and reconstructs all the other packet headers by adding the changes to them. The header data that is different with each packet is referred to as the session state, and is identified by a session ID or connection ID. When the decompressor receives a compressed packet, it reconstructs the packet header by adding the difference to the saved uncompressed header. Typically, IPHC enables the header to be compressed to two bytes (four bytes if UDP checksums are used). The following fields in a packet header usually remain the same throughout a transmission:
• • •
IP source and destination addresses UDP and TCP source and destination ports RTP synchronization source (SSRC) fields
Cisco IOS Dial Technologies Command Reference November 2009
DIA-581
Dial Commands ppp iphc max-time
The following fields in a packet header usually change during a transmission:
• • • • •
IP packet ID Checksum Sequence number RTP time stamp RTP marker bit
The ppp iphc max-time command is specifically related to an IPHC frame format known as compressed_non_TCP. The recovery of lost compressed_non_TCP frames on lossy links is much improved by allowing more full headers to flow and by configuring less compression.
Examples
The following example shows how to change the number of compressed packets that can be sent before a full header from the default 5 seconds to 10 seconds:
interface Multilink1 ip address 10.100.253.1 255.255.255.0 no ip directed-broadcast no ip route-cache ip tcp header-compression iphc-format no ip mroute-cache fair-queue 64 256 1000 no cdp enable ppp multilink ppp multilink fragment-delay 20 ppp multilink interleave multilink-group 1 ip rtp header-compression iphc-format ip rtp priority 16384 50 64 ppp iphc max-header 114 ppp iphc max-time 10 ppp iphc max-period 512
Related Commands
Command
Description
ip rtp header-compression Enables TCP, UDP, and RTP (RFC 2509) header compression. ip tcp header-compression Enables TCP (RFC 1332) header compression. ppp iphc max-header ppp iphc max-period Sets the maximum size of the largest IP header that may be compressed when configuring IPHC control options over PPP. Sets the maximum number of compressed packets that can be sent before a full header when configuring IPHC control options over PPP.
Cisco IOS Dial Technologies Command Reference
DIA-582
November 2009
Dial Commands ppp lcp delay
ppp lcp delay
To configure the link control protocol (LCP) delay timer for initiating LCP negotiations after a link connects and to configure the router to discard incoming setup requests until the LCP delay timer expires, use the ppp lcp delay command in interface configuration mode. To disable the LCP delay timer, use the no form of this command. ppp lcp delay seconds [milliseconds] [random max-delay-seconds] [discard] no ppp lcp delay
Syntax Description
seconds milliseconds
Delay, in seconds, before initiating LCP negotiations. Valid values for the seconds argument range from 0 to 255. The default value is 2 seconds. (Optional) Delay, in milliseconds, before initiating LCP negotiations. Valid values for the milliseconds argument range from 0 to 999. The default value is 0 milliseconds. (Optional) Specifies that a random amount of additional time will be added to the configured LCP delay timer. The additional amount of time will not exceed the number of seconds specified with the max-delay-seconds argument. Valid values for max-delay-seconds range from 1 to 255. Random delay is disabled by default. (Optional) Specifies that incoming configuration requests (CONFREQs) will be discarded until the LCP delay timer has expired. CONFREQs are not discarded by default.
random max-delay-seconds
discard
Command Default
No LCP delay timer is configured.
Command Modes
Interface configuration
Command History
Release 12.1 12.2(13)T 12.3(11)YS
Modification This command was introduced. Support for the milliseconds argument was added to this command. Support for the random max-delay-seconds and discard keywords and argument was added to this command.
Usage Guidelines
Configure an LCP delay timer to allow the peer device a short amount of time to send the first packet after the PPP link comes up. If the LCP delay timer expires before a CONFREQ is received from the peer, the router can initiate LCP negotiations. The LCP delay timer is applied only to incoming connections. PPP does not delay for outbound connections or connections where PPP cannot determine a direction.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-583
Dial Commands ppp lcp delay
Use the random max-delay-seconds keyword and argument combination add a random amount of time to the LCP delay timer. Setting a random delay on the initiation of LCP negotiations prevents overload when many PPP links come up at the same time. Use the discard keyword to specify that incoming CONFREQs should be discarded until the configured delay has expired. LCP negotiations will not be initiated until the LCP delay timer has expired.
Examples
The following example configures an LCP delay timer of 4 seconds. If a CONFREQ is not received before the LCP delay timer expires, LCP negotiations can be initiated by either peer.
ppp lcp delay 4
The following example configures an LCP delay timer that will expire at a random time between 5 and 15 seconds after the link comes up. If a CONFREQ is not received before the LCP delay timer expires, LCP negotiations can be initiated by either peer.
ppp lcp delay 5 random 10
The following example configures an LCP delay timer of 3.25 seconds and specifies that incoming CONFREQs will be discarded until the LCP delay timer has expired. After 3.25 seconds, LCP negotiations can be initiated by either peer.
ppp lcp delay 3 250 discard
The following example configures an LCP delay timer that will expire at a random time between 10 and 15 seconds after the link comes up, and specifies that incoming CONFREQs will be discarded until the LCP delay timer has expired. After the LCP delay timer expires, negotiations can be initiated by either peer.
ppp lcp delay 10 random 5 discard
Cisco IOS Dial Technologies Command Reference
DIA-584
November 2009
Dial Commands ppp lcp fast-start
ppp lcp fast-start
To allow a PPP interface to respond immediately to incoming packets once a connection is established, use the ppp lcp fast-start command in interface configuration mode. To specify that PPP delay before responding, use the no form of this command. ppp lcp fast-start no ppp lcp fast-start
Syntax Description
This command has no arguments or keywords.
Command Default
Command is enabled by default.
Command Modes
Interface configuration
Command History
Release 11.3
Modification This command was introduced.
Usage Guidelines
Some systems, typically those with external modems, may have problems with slow or electrically noisy hardware. If the no ppp lcp fast-start command is specified, PPP starts a debounce timer and waits for it to expire before attempting to communicate with the peer system, thereby reducing the probability of a false start on the interface. If the no ppp lcp fast-start command is not specified, PPP will not use a debounce timer and will respond immediately to incoming packets once a connection is made. The default fast start enabled state should not be disabled unless there is a problem with slow or electronically noisy hardware. This setting prevents PPP from waiting for a debounce timer to expire before responding to inbound frames.
Examples
The following example disables fast start:
no ppp lcp fast-start
Cisco IOS Dial Technologies Command Reference November 2009
DIA-585
Dial Commands ppp lcp predictive
ppp lcp predictive
To set the PPP link control protocol (LCP) to a predictive state that reduces negotiation time by predicting responses from peers and sending expected reply and request packets in advance, use the ppp lcp predictive command in interface configuration mode. To disable the LCP predictive state, use the no form of this command. ppp lcp predictive no ppp lcp predictive
Syntax Description
This command has no arguments or keywords.
Command Default
The PPP LCP is not set to a predictive state.
Command Modes
Interface configuration
Command History
Release 12.2(4)T 12.2(11)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(11)T and support was added for the Cisco AS5300, Cisco AS5400 and Cisco AS5800.
Usage Guidelines
The ppp lcp predictive command is useful in networks that accept connections from devices that require a reduction in the LCP negotiation cycle time. This command reduces the amount of time needed for PPP to negotiate with the peer so that connections can be made in an acceptable amount of time. The following changes to the LCP negotiation strategy make this time reduction possible:
• •
Send an LCP Configure-Ack packet, then send the next-level LCP Configure-Request packet before receiving acknowledgment for the PPP Configure-Request packet. Send an LCP Configure-Ack packet after sending LCP Configure-Reject and Configure-Nak packets for certain configuration options.
These changes can reduce connection delay by approximately 40 percent. The ppp lcp predictive command is configured on group asynchronous and dialer interfaces running PPP or Multilink PPP.
Examples
The following example sets LCP and Internet Protocol Control Protocol (IPCP) to predictive states on a dialer interface:
! interface dialer 1 ip unnumbered loopback 0 encapsulation ppp dialer pool 1 dialer idle-timeout 120000
Cisco IOS Dial Technologies Command Reference
DIA-586
November 2009
Dial Commands ppp lcp predictive
dialer enable-timeout 6 dialer-group 1 peer default ip address pool LOCAL no cdp enable ppp lcp predictive ppp ipcp predictive ppp multilink
Related Commands
Command interface dialer interface group-async ppp ipcp predictive
Description Defines a dialer rotary group. Creates a group interface that will serve as master, to which asynchronous interfaces can be associated as members. Sets IPCP to a predictive state that reduces negotiation time by predicting responses from peers and sending expected reply and request packets in advance.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-587
Dial Commands ppp link reorders
ppp link reorders
To set an advisory flag that indicates the serial interface may receive packets in a different order than a peer system sent them, use the ppp link reorders command in interface configuration mode. To turn this flag off, use the no form of this command. ppp link reorders no ppp link reorders
Syntax Description
This command has no arguments or keywords.
Command Default
Command is disabled.
Command Modes
Interface configuration
Command History
Release 12.2
Modification This command was introduced.
Usage Guidelines
The ppp link reorders command indicates that a link can receive packets in a different order than the peer system sent them. This situation can be encountered with PPP tunneling mechanisms such as Layer 2 Forwarding (L2F) and the Layer 2 Transport Protocol (L2TP) that do not always enforce strictly serial delivery of frames from source to final destination. Such links can pose problems for PPP features that depend upon in-order delivery of packets, such as compression, encryption, network header compression, and Multilink PPP. Setting this option allows some PPP systems to compensate to an extent for the nonserial delivery of packets, although this compensation can incur a performance penalty. It is not normally necessary to configure the ppp link reorders command. PPP automatically recognizes that the condition exists for Virtual Private Network (VPN) tunnels, and the misdelivery situation will not occur on normal serial interfaces.
Examples
The following example sets the ppp link reorders command advisory flag:
ppp link reorders
Cisco IOS Dial Technologies Command Reference
DIA-588
November 2009
Dial Commands ppp loopback ignore
ppp loopback ignore
To disable PPP loopback detection, use the ppp loopback ignore command in interface configuration mode. To reenable PPP loopback detection (the default condition), use the no form of this command. ppp loopback ignore no ppp loopback ignore
Syntax Description
This command has no arguments or keywords.
Command Default
Loopback detection is enabled.
Command Modes
Interface configuration
Command History
Release 11.3 12.2(5)T
Modification This command was introduced as ppp ignore-loopback. The ppp loopback ignore command replaced the ppp ignore-loopback command.
Usage Guidelines
A circuit loopback normally indicates faulty external switching equipment or wiring errors. The PPP protocol includes a mechanism that detects when a circuit is looped back, that is, when the circuit is fed back upon itself such that the router is reading its own output on that link. A first phase of loopback detection occurs during Link Control Protocol (LCP) negotiation when the circuit is being established. A loopback condition that occurs after the connection is made (after LCP negotiation) can be detected if link keepalives are enabled. If keepalives are disabled on the link, the second phase of loopback detection is not available. The normal operation (default) is for PPP to check for a loopback condition and terminate the connection when a loopback is detected. There are, however, some situations where it is necessary to disable loopback detection, such as during certain testing situations, or when software detects problematic peers that do not implement the PPP protocol correctly. The ppp loopback ignore command disables normal operation; the no ppp loopback ignore command restores normal operation.
Note
Loopback detection depends upon successful negotiation of the LCP Magic Number option during link establishment. Some implementations may not support this option.
Examples
The following example shows PPP loopback detection being disabled:
interface Serial0:15 description "PRI D channel" ip unnumbered Loopback0 encapsulation ppp ppp loopback ignore
Cisco IOS Dial Technologies Command Reference November 2009
DIA-589
Dial Commands ppp loopback ignore
Related Commands
Command keepalive
Description Configures a keepalive packet that is sent at a certain time interval, and for a certain number of retries if there is no response, to keep an interface active.
Cisco IOS Dial Technologies Command Reference
DIA-590
November 2009
Dial Commands ppp max-bad-auth
ppp max-bad-auth
To configure a point-to-point interface not to reset itself immediately after an authentication failure but instead to allow a specified number of authentication retries, use the ppp max-bad-auth command in interface configuration mode. To reset to the default of immediate reset, use the no form of this command. ppp max-bad-auth retries no ppp max-bad-auth
Syntax Description
retries
Number of retries after which the interface is to reset itself. Default is 0.
Command Default
The default is 0.
Command Modes
Interface configuration
Command History
Release 11.2
Modification This command was introduced.
Usage Guidelines
This command applies to any serial interface (asynchronous serial, synchronous serial, or ISDN) on which PPP encapsulation is enabled.
Examples
The following example sets BRI interface 0 to allow two additional retries after an initial authentication failure (for a total of three failed authentication attempts):
interface bri 0 encapsulation ppp ppp authentication chap ppp max-bad-auth 3
Related Commands
Command exec
Description Allows an EXEC process on a line.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-591
Dial Commands ppp max-configure
ppp max-configure
To set the maximum number of attempts to send Configure-Request packets before it is assumed that the peer is unable to respond, use the ppp max-configure command in interface configuration mode. To return to the default, use the no form of this command. ppp max-configure attempts no ppp max-configure attempts
Syntax Description
attempts
Number of attempts allowed. Must be a number from 1 to 255. Default is 10 attempts with 1 packet sent per attempt.
Command Default
10 attempts (packets) and a default retry timeout period of 2 seconds
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
The ppp max-configure command sets the maximum number of Configure-Request packets that will be sent for any particular control protocol and that have gone unanswered before PPP will assume that the peer is unable to respond to the packets and will cease trying to negotiate that particular control protocol. There is generally no reason to adjust the default maximum number of Configure-Request packets sent (attempts). The number might need to be increased slightly in the unlikely event that you are connecting to a peer that is slow to start negotiations of some protocol. Because the default is 10 packets (attempts), and the default retry timeout period is 2 seconds, a slow peer would be one that takes more than 20 seconds to start protocol negotiation. For ordinary network control protocols (NCPs), the protocol will be put in a passive state whereby PPP will accept inbound negotiation packets, thereby giving the peer a chance to attempt negotiations later on. If the Link Control Protocol (LCP) is used, then failure to negotiate LCP implies that the link will be reset. On a dialup connection, this reset will disconnect the call. For a leased-line connection, the reset will merely result in PPP attempting to restart after a short delay.
Note
None of the supported PPP authentication protocols conform to RFC 1661-style control protocols, and the protocols are not affected by the ppp max-configure command. Rather, the authentication protocol commands have their own set of commands to fine-tune control.
Cisco IOS Dial Technologies Command Reference
DIA-592
November 2009
Dial Commands ppp max-configure
Examples
The following example returns the maximum number of attempts to send a Configure-Request packet to the default of 10:
interface Serial2/0 ip address 192.168.1.131 255.255.255.0 encapsulation ppp peer default ip address pool local local_pool serial restart-delay 0 no ppp max-configure
Related Commands
Command ppp max-failure ppp max-terminate
Description Sets the maximum number of attempts to send Configure-NAK packets before it is assumed the peer is not converging. Sets the maximum number of attempts to send a Terminate-Request packet before PPP gives up waiting for the Terminate-Ack packet and stops the protocol. Sets PPP timeout retry parameters.
ppp timeout retry
Cisco IOS Dial Technologies Command Reference November 2009
DIA-593
Dial Commands ppp max-failure
ppp max-failure
To set the maximum number of attempts to send Configure-NAK packets before it is assumed the peer is not converging, use the ppp max-failure command in interface configuration mode. To return to the default, use the no form of this command. ppp max-failure attempts no ppp max-failure attempts
Syntax Description
attempts
Number of attempts allowed. Must be a number from 1 to 255. Default is 5 attempts with one packet sent per attempt.
Command Default
5 attempts
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
Unless you have reason to believe that a control protocol that is slow to converge will actually converge if given more chances, there is no reason to increase the default value of this command. The ppp max-failure command sets the maximum number of successive Configure-NAK packets (attempts) that will be sent for any control protocol before PPP will assume that the peer is unwilling or incapable of converging (adapting to its own negotiation parameters), and that the negotiation parameters will never succeed. Once the maximum limit is reached, PPP will start sending Configure-Reject packets rather than Configure-NAK packets for the offending parameters. The peer’s response to this action should be to stop sending the offending parameters.
Note
None of the supported PPP authentication protocols conform to RFC 1661-style control protocols, and the protocols are not affected by the ppp max-failure command. Rather, the authentication protocol commands have their own set of commands to fine-tune control.
Examples
The following example returns the maximum number of attempts to send a Configure-NAK packet to the default of 5:
interface Serial2/0 ip address 192.168.1.131 255.255.255.0 encapsulation ppp peer default ip address pool local local_pool serial restart-delay 0 no ppp max-failure
Cisco IOS Dial Technologies Command Reference
DIA-594
November 2009
Dial Commands ppp max-failure
Related Commands
Command ppp max-configure ppp max-terminate
Description Sets the maximum number of attempts to send Configure-Request packets before it is assumed that the peer is unable to respond. Sets the maximum number of attempts to send a Terminate-Request packet before PPP gives up waiting for the Terminate-Ack packet and stops the protocol. Sets PPP timeout retry parameters.
ppp timeout retry
Cisco IOS Dial Technologies Command Reference November 2009
DIA-595
Dial Commands ppp max-terminate
ppp max-terminate
To set the maximum number of attempts to send Terminate-Request packets before PPP gives up waiting for the Terminate-Ack packet and stops the protocol, use the ppp max-terminate command in interface configuration mode. To return to the default, use the no form of this command. ppp max-terminate attempts no ppp max-terminate attempts
Syntax Description
attempts
Number of attempts allowed. Must be a number from 1 to 255. Default is 2 attempts with 1 packet sent per attempt.
Command Default
2 attempts
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
There is little reason to change the default value of the ppp max-terminate command. The action of PPP sending a Terminate-Request packet is mainly a courtesy to the peer system; the protocol itself will be terminated whether or not the peer acknowledges the request. Sending the Terminate-Request packet twice makes an allowance that a single instance could be lost in transit. When PPP wants to terminate a control protocol, it sends a Terminate-Request packet and waits for a limited time for the peer to respond with a Terminate-Ack packet. This command sets the maximum number of attempts that will be made, that is, the maximum number of Terminate-Request packets that will be sent, before PPP gives up waiting for the Terminate-Ack packet and automatically stops the protocol.
Note
None of the supported PPP authentication protocols conform to RFC 1661-style control protocols, and the protocols are not affected by the ppp max-terminate command. Rather, the authentication protocol commands have their own set of commands to fine-tune control.
Examples
The following example returns the maximum number of attempts to send a Terminate-Request packet to the default of 2:
interface Serial2/0 ip address 192.168.1.131 255.255.255.0 encapsulation ppp peer default ip address pool local local_pool serial restart-delay 0 no ppp max-terminate
Cisco IOS Dial Technologies Command Reference
DIA-596
November 2009
Dial Commands ppp max-terminate
Related Commands
Command ppp max-configure ppp max-failure ppp timeout retry
Description Sets the maximum number of attempts to send Configure-Request packets before it is assumed that the peer is unable to respond. Sets the maximum number of attempts to send Configure-NAK packets before it is assumed the peer is not converging. Sets PPP timeout retry parameters.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-597
Dial Commands ppp microcode
ppp microcode
To enable hardware (microcode) PPP framing on an asynchronous interface, use the ppp microcode command in interface configuration mode. To disable hardware PPP framing on an asynchronous interface, use the no form of this command. ppp microcode no ppp microcode
Syntax Description
This command has no arguments or keywords.
Command Default
Hardware PPP framing on an asynchronous interface is enabled.
Command Modes
Interface configuration (config-if)
Command History
Release 12.4
Modification This command was introduced.
Usage Guidelines
Do not use the no form of this command unless instructed to do so by Cisco Technical Assistance Center (TAC) or Cisco technical support.
Examples
The following example shows how to disable the ppp microcode command in interface configuration mode:
no ppp microcode
Related Commands
Command async mode dedicated
Description Places a line into dedicated asynchronous mode using SLIP or PPP encapsulation.
async mode interactive Returns a line that has been placed into dedicated asynchronous network mode to interactive mode, thereby enabling the slip and ppp EXEC commands. encapsulation ppp ppp multilink Sets PPP as the encapsulation method used on the specified interfaces. Enables MLP on an interface and, optionally, enables BACP and its BAP subset for dynamic bandwidth allocation.
Cisco IOS Dial Technologies Command Reference
DIA-598
November 2009
Dial Commands ppp mru match
ppp mru match
To trigger Link Control Protocol (LCP) renegotiation on a maximum receive unit (MRU) mismatch on a system acting as an L2TP network server (LNS) and thereby enforce strict matching, use the ppp mru match command in interface configuration mode. To remove this setting, use the no form of this command. ppp mru match no ppp mru match
Syntax Description
This command has no arguments or keywords.
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.2(12)T
Modification This command was introduced.
Usage Guidelines
This command is configured only on virtual template interfaces. By default, the LNS does not enforce matching of the MRU value advertised by the LAC with the MRU value that the LNS would advertise. Use the ppp mru match command to enforce strict matching of the MRU that is advertised by the Layer 2 Tunneling Protocol (L2TP) access concentrator (LAC) with the maximum transmission unit (MTU) of the relevant virtual template interface on the LNS. A mismatch can occur because the effective MRU size for a virtual access interface is not necessarily limited to the MTU size. This command can be useful to inform the client PPP stack of the true MRU, when that PPP implementation is capable of adapting its MTU based on LCP MRU negotiation.
Examples
The following example shows LCP renegotiation being triggered on an MRU mismatch:
interface Virtual-Template1 mtu 1454 ppp mru match ip unnumbered GigabitEthernet0/1 no keepalive peer default ip address pool mypool ppp authentication pap
Related Commands
Command ppp mtu adaptive
Description Defines autonegotiation of the MTU size for PPP.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-599
Dial Commands ppp ms-chap refuse
ppp ms-chap refuse
To refuse Microsoft Challenge Handshake Authentication Protocol (MS-CHAP) authentication from peers requesting it, use the ppp ms-chap refuse command in interface configuration mode. To allow MS-CHAP authentication, use the no form of this command. ppp ms-chap refuse [callin] no ppp ms-chap refuse [callin]
Syntax Description
callin
(Optional) Specifies that the router will refuse to answer MS-CHAP authentication challenges received from the peer, but will still require the peer to answer any MS-CHAP challenges the router sends.
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
This command specifies that MS-CHAP authentication is disabled for all calls, meaning that all attempts by the peer to force the user to authenticate using MS-CHAP will be refused. If the callin keyword is used, MS-CHAP authentication is disabled for incoming calls from the peer, but will still be performed on outgoing calls to the peer. If outbound Password Authentication Protocol (PAP) has been enabled (using the ppp pap sent-username command), PAP will be suggested as the authentication method in the refusal packet.
Examples
The following example shows how to disable MS-CHAP authentication if a peer calls in requesting MS-CHAP authentication. The method of encapsulation on interface ISDN BRI number 0 is PPP.
interface bri 0 encapsulation ppp ppp ms-chap refuse
Related Commands
Command aaa authentication ppp ppp authentication
Description Specifies one or more AAA authentication methods for use on serial interfaces running PPP. Enables CHAP or PAP or both and specifies the order in which CHAP and PAP authentication are selected on the interface.
Cisco IOS Dial Technologies Command Reference
DIA-600
November 2009
Dial Commands ppp ms-chap refuse
Command ppp authentication ms-chap-v2 ppp chap password
Description Creates a pool of dialup routers that all appear to be the same host when authenticating with CHAP. Enables a router calling a collection of routers that do not support this command (such as routers running older Cisco IOS software images) to configure a common CHAP secret password to use in response to challenges from an unknown peer. Specifies that the router will not authenticate to a peer requesting CHAP authentication until after the peer has authenticated itself to the router. Reenables remote PAP support for an interface and use the sent-username and password in the PAP authentication request packet to the peer.
ppp chap wait ppp pap sent-username
Cisco IOS Dial Technologies Command Reference November 2009
DIA-601
Dial Commands ppp ms-chap-v2 refuse
ppp ms-chap-v2 refuse
To refuse Microsoft Challenge Handshake Authentication Protocol (MS-CHAP) version 2 authentication from peers requesting it, use the ppp ms-chap-v2 refuse command in interface configuration mode. To allow MS-CHAP version 2 authentication, use the no form of this command. ppp ms-chap-v2 refuse [callin] no ppp ms-chap-v2 refuse [callin]
Syntax Description
callin
(Optional) Specifies that the router will refuse to answer MS-CHAP authentication challenges received from the peer, but will still require the peer to answer any MS-CHAP challenges the router sends.
Command Default
This command is disabled by default.
Command Modes
Interface configuration
Command History
Release 12.2T
Modification This command was introduced.
Usage Guidelines
This command specifies that MS-CHAP version 2 authentication is disabled for all calls, meaning that all attempts by the peer to force the user to authenticate using MS-CHAP version 2 will be refused. If the callin keyword is used, MS-CHAP version 2 authentication is disabled for incoming calls from the peer, but will still be performed on outgoing calls to the peer. If outbound Password Authentication Protocol (PAP) has been enabled (using the ppp pap sent-username command), PAP will be suggested as the authentication method in the refusal packet.
Examples
The following example shows how to disable MS-CHAP version 2 authentication if a peer calls in requesting MS-CHAP version 2 authentication. The method of encapsulation on interface ISDN BRI number 0 is PPP.
interface bri 0 encapsulation ppp ppp ms-chap-v2 refuse
Related Commands
Command aaa authentication ppp ppp authentication
Description Specifies one or more AAA authentication methods for use on serial interfaces running PPP. Enables CHAP or PAP or both and specifies the order in which CHAP and PAP authentication are selected on the interface.
Cisco IOS Dial Technologies Command Reference
DIA-602
November 2009
Dial Commands ppp ms-chap-v2 refuse
Command ppp authentication ms-chap-v2 ppp chap password
Description Creates a pool of dialup routers that all appear to be the same host when authenticating with CHAP. Enables a router calling a collection of routers that do not support this command (such as routers running older Cisco IOS software images) to configure a common CHAP secret password to use in response to challenges from an unknown peer. Specifies that the router will not authenticate to a peer requesting CHAP authentication until after the peer has authenticated itself to the router. Reenables remote PAP support for an interface and use the sent-username and password in the PAP authentication request packet to the peer.
ppp chap wait ppp pap sent-username
Cisco IOS Dial Technologies Command Reference November 2009
DIA-603
Dial Commands ppp mtu adaptive
ppp mtu adaptive
To allow the Layer 2 Network Server (LNS) to adapt to the Maximum Transmission Unit (MTU) size for PPP based on the value set by the customer premises equipment (CPE), use the ppp mtu adaptive command in interface configuration mode. To return to the default setting, use the no form of this command. ppp mtu adaptive [proxy] no ppp mtu adaptive [proxy]
Syntax Description
proxy
(Optional) Adapts the MTU to the proxy MRU, that is, the MRU negotiated by a system such as an L2TP access concentrator (LAC) that has performed Link Control Protocol (LCP) negotiation on behalf of the Cisco router and forwarded the negotiated LCP options, including the MRU.
Command Default
Automatic adaption of the MTU size for PPP is not enabled.
Command Modes
Interface configuration
Command History
Release 12.2(7) 12.2(13)T 12.3(14)T
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(13)T. The proxy keyword was added. This command was modified. Support was added for serial interfaces when the proxy keyword is not used.
Usage Guidelines
By default, the Cisco IOS software will not adapt the interface MTU to the peer or proxy MRU.
Note
By default, the LNS does not renegotiate Link Control Protocol (LCP). If the LNS has a different MTU defined, the call setup experiences a failure. Use the ppp mtu adaptive command to adjust the LNS MRU value to the CPE's negotiated value with the LAC. Use this command on interfaces where a number of peers with different MRU settings may connect. In Cisco IOS Release 12.2(7) and later releases, this command is configured on virtual template interfaces and dialer interfaces. In Cisco IOS Release 12.3(14)T and later releases, the ppp mtu adaptive command without the proxy keyword can be configured on serial interfaces.
Cisco IOS Dial Technologies Command Reference
DIA-604
November 2009
Dial Commands ppp mtu adaptive
The proxy keyword is not typically required. It is used only as a workaround when the client PPP stack cannot correctly advertise its MRU requirements.
Examples
The following example defines autonegotiation of the MTU size on a virtual template:
interface Virtual-Template1 no ip address no logging event link-status no snmp trap link-status ppp mtu adaptive ppp authentication chap callin
Related Commands
Command lcp renogtiation always ppp mtu match
Description Allows the LNS to renegotiate the PPP LCP on dial-in calls, using L2TP or L2F. Triggers LCP renegotiation on an MRU mismatch.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-605
Dial Commands ppp multilink
ppp multilink
To enable Multilink PPP (MLP) on an interface and, optionally, to enable Bandwidth Allocation Control Protocol (BACP) and its Bandwidth Allocation Protocol (BAP) subset for dynamic bandwidth allocation, use the ppp multilink command in interface configuration mode. To disable Multilink PPP or, optionally, to disable only dynamic bandwidth allocation, use the no form of this command. ppp multilink [bap] no ppp multilink [bap [required]]
Cisco 10000 Series Router
ppp multilink no ppp multilink
Syntax Description
bap required
(Optional) Specifies bandwidth allocation control negotiation and dynamic allocation of bandwidth on a link. (Optional) Enforces mandatory negotiation of BACP for the multilink bundle. The multilink bundle is disconnected if BACP is not negotiated.
Command Default
Command is disabled. When BACP is enabled, the defaults are to accept calls and to set the timeout pending at 30 seconds.
Command Modes
Interface configuration
Command History
Release 11.1 12.0(23)SX 12.2(16)BX 12.2(31)SB2
Modification This command was introduced. This command was implemented on the Cisco 10000 series router. This command was implemented on the ESR–PRE2. This command was integrated into Cisco IOS Release 12.2(31)SB2.
Usage Guidelines
This command applies only to interfaces that use PPP encapsulation. MLP and PPP reliable links do not work together. When the ppp multilink command is used, the first channel will negotiate the appropriate Network Control Protocol (NCP) layers (such as the IP Control Protocol and IPX Control Protocol), but subsequent links will negotiate only the link control protocol and MLP. NCP layers do not get negotiated on these links, and it is normal to see these layers in a closed state. This command with the bap keyword must be used before configuring any ppp bap commands and options. If the bap required option is configured and a reject of the options is received, the multilink bundle is torn down.
Cisco IOS Dial Technologies Command Reference
DIA-606
November 2009
Dial Commands ppp multilink
The no form of this command without the bap keyword disables both MLP and BACP on the interface. The dialer load-threshold command enables a rotary group to bring up additional links and to add them to a multilink bundle. Before Cisco IOS Release 11.1, the dialer-load threshold 1 command kept a multilink bundle of any number of links connected indefinitely, and the dialer-load threshold 2 command kept a multilink bundle of two links connected indefinitely. If you want a multilink bundle to be connected indefinitely, you must set a very high idle timer.
Cisco 10000 Series Router
The ppp multilink command has no arguments or keywords.
Examples
The following partial example configures a dialer for Multilink PPP:
interface Dialer0 ip address 10.0.0.2 255.0.0.0 encapsulation ppp dialer in-band dialer idle-timeout 500 dialer map ip 10.0.0.1 name name1 broadcast 81012345678901 dialer load-threshold 30 either dialer-group 1 ppp authentication chap ppp multilink
Related Commands
Command compress dialer-group dialer load-threshold encapsulation ppp ppp authentication ppp bap timeout ppp multilink fragment delay ppp multilink fragment disable ppp multilink fragmentation ppp multilink group ppp multilink interleave ppp multilink mrru
Description Configures compression for LAPB, PPP, and HDLC encapsulations. Controls access by configuring an interface to belong to a specific dialing group. Configures bandwidth on demand by setting the maximum load before the dialer places another call to a destination. Enables PPP encapsulation. Enables CHAP or PAP or both, and specifies the order in which CHAP and PAP authentication is selected on the interface. Specifies nondefault timeout values for PPP BAP pending actions and responses. Specifies a maximum time for the transmission of a packet fragment on a MLP bundle. Disables packet fragmentation. Sets the maximum number of fragments a packet will be segmented into before being sent over the bundle. Restricts a physical link to joining only a designated multilink-group interface. Enables MLP interleaving. Configures the MRRU value negotiated on an MLP bundle.
dialer fast-idle (interface) Specifies the idle time before the line is disconnected.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-607
Dial Commands ppp multilink
Command ppp multilink slippage show ppp bap
Description Defines the constraints that set the MLP reorder buffer size. Displays the configuration settings and run-time status for a multilink bundle.
Cisco IOS Dial Technologies Command Reference
DIA-608
November 2009
Dial Commands ppp multilink endpoint
ppp multilink endpoint
To override or change the default endpoint discriminator the system uses when negotiating the use of Multilink PPP (MLP) with the peer, use the ppp multilink endpoint command in interface configuration mode. To restore the default endpoint discriminator, use the no form of this command. ppp multilink endpoint {hostname | ip ip-address | mac lan-interface | none | phone telephone-number | string char-string} no ppp multilink endpoint
Syntax Description
hostname
Uses the host name configured for the router. This is useful when multiple routers are using the same username to authenticate, but have different host names. Uses the supplied IP address. Uses the specified LAN interface whose MAC address is to be used. Causes negotiation of the link control protocol without requesting the endpoint discriminator option. This is useful when the router is connected to a malfunctioning peer that does not handle the endpoint discriminator option properly. Uses the supplied telephone number, and accepts E.164-compliant, full international telephone numbers. Uses the supplied character string.
ip ip-address mac lan-interface none
phone telephone-number string char-string
Command Default
The default endpoint discriminator is the globally configured host name, or the Challenge Handshake Authentication Protocol (CHAP) host name or Password Authentication Protocol (PAP) sent-username configured on the interface. See the “Usage Guidelines” for additional information.
Command Modes
Interface configuration
Command History
Release 12.2 12.2(31)SB2
Modification This command was introduced. This command was integrated into Cisco IOS Release 12.2(31)SB2.
Usage Guidelines
By default, PPP uses the same string for the endpoint discriminator that it would provide for authentication to negotiate use of MLP with the peer. The string (username) is configured for the interface with the ppp chap hostname or ppp pap sent-username command, or defaults to the globally configured host name (or stack group name, if the interface is a Stack Group Bidding Protocol, or SGBP, group member). The keywords supplied with the ppp multilink endpoint command allow a different endpoint discriminator to be defined. You can reset the default condition by entering the no ppp multilink endpoint command.
Cisco IOS Dial Technologies Command Reference November 2009
DIA-609
Dial Commands p