Asa 95 General Config
Asa 95 General Config
Asa 95 General Config
Guide, 9.5
First Published: March 20, 2015
Last Modified: March 20, 2015
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
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.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
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 and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned 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. (1110R)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
iii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
iv
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
v
Contents
CHAPTER 4 Smart Software Licensing for the ASAv and ASA on the FXOS Chassis 101
Licenses Per Model 101
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
vi
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
vii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
viii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
ix
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
x
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xi
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xiii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xiv
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xv
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xvi
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xvii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xviii
Contents
Configure Connection Rebalancing and the Cluster TCP Replication Delay 367
Configure Cluster Flow Mobility 368
Become an Inactive Member 371
Inactivate a Member 372
Change the Primary Unit 373
Execute a Command Cluster-Wide 373
Monitoring the ASA Cluster on the FXOS chassis 374
Monitoring Cluster Status 374
Capturing Packets Cluster-Wide 375
Monitoring Cluster Resources 375
Monitoring Cluster Traffic 375
Monitoring Cluster Routing 377
Configuring Logging for Clustering 378
Debugging Clustering 378
History for ASA Clustering on the FXOS Chassis 379
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xix
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xx
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxi
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxiii
Contents
Recover Passwords on the ASA 5506-X, ASA 5508-X, and ASA 5516-X 479
Recover Passwords or Images on the ASAv 480
Disable Password Recovery 481
Set the Date and Time 482
Set the Time Zone and Daylight Savings Dates 482
Set the Date and Time Using an NTP Server 483
Set the Date and Time Manually 485
Configure the Master Passphrase 485
Add or Change the Master Passphrase 486
Disable the Master Passphrase 487
Remove the Master Passphrase 488
Configure the DNS Server 489
Configure the Hardware Bypass (Cisco ISA 3000) 490
Adjust ASP (Accelerated Security Path) Performance and Behavior 492
Choose a Rule Engine Transactional Commit Model 492
Enable ASP Load Balancing 493
Monitoring the DNS Cache 493
History for Basic Settings 494
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxiv
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxv
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxvi
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxvii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxviii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxix
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxx
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxi
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxiii
Contents
Authentication 743
Authorization 744
Accounting 744
Interaction Between Authentication, Authorization, and Accounting 744
AAA Servers 744
AAA Server Groups 744
About the Local Database 745
Fallback Support 745
How Fallback Works with Multiple Servers in a Group 746
Guidelines for the Local Database 746
Add a User Account to the Local Database 746
Generate a Shared Key 749
Monitoring the Local Database 751
History for the Local Database 751
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxiv
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxv
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxvi
Contents
Load an Image for the ASA 5500-X Series Using ROMMON 839
Load an Image for the ASASM Using ROMMON 840
Upgrade the ROMMON Image (ASA 5506-X, 5508-X, and 5516-X) 842
Recover and Load an Image for the ASA 5506W-X Wireless Access Point 843
Manage Files 843
View Files in Flash Memory 843
Delete Files from Flash Memory 844
Erase the Flash File System 844
Configure File Access 845
Configure the FTP Client Mode 845
Configure the ASA as a Secure Copy Server 845
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxvii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxviii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xxxix
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xl
Contents
Implementation Differences Between the ASA, ASA Services Module, and the Cisco
IOS Software 956
SNMP Syslog Messaging 957
Application Services and Third-Party Tools 957
Guidelines for SNMP 957
Configure SNMP 960
Enable the SNMP Agent and SNMP Server 960
Configure SNMP Traps 960
Configure a CPU Usage Threshold 962
Configure a Physical Interface Threshold 962
Configure Parameters for SNMP Version 1 or 2c 962
Configure Parameters for SNMP Version 3 964
Configure a Group of Users 966
Associate Users with a Network Object 967
Monitoring SNMP 967
Examples for SNMP 969
History for SNMP 969
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xli
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xlii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xliii
Contents
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xliv
About This Guide
The following topics explain how to use this guide.
Document Objectives
The purpose of this guide is to help you configure general operations for the Cisco ASA series using the
command-line interface. This guide does not cover every feature, but describes only the most common
configuration scenarios.
You can also configure and monitor the ASA by using the Adaptive Security Device Manager (ASDM), a
web-based GUI application. ASDM includes configuration wizards to guide you through some common
configuration scenarios, and online help for less common scenarios.
Throughout this guide, the term “ASA” applies generically to supported models, unless specified otherwise.
Related Documentation
For more information, see Navigating the Cisco ASA Series Documentation at http://www.cisco.com/go/
asadocs.
Document Conventions
This document adheres to the following text, display, and alert conventions.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xlv
About This Guide
Document Conventions
Text Conventions
Convention Indication
boldface Commands, keywords, button labels, field names, and user-entered text appear
in boldface. For menu-based commands, the full path to the command is shown.
italic Variables, for which you supply values, are presented in an italic typeface.
Italic type is also used for document titles, and for general emphasis.
monospace Terminal sessions and information that the system displays appear in monospace
type.
!, # An exclamation point (!) or a number sign (#) at the beginning of a line of code
indicates a comment line.
Reader Alerts
This document uses the following for reader alerts:
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the
manual.
Tip Means the following information will help you solve a problem.
Caution Means reader be careful. In this situation, you might do something that could result in equipment damage
or loss of data.
Timesaver Means the described action saves time. You can save time by performing the action described in the
paragraph.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xlvi
About This Guide
Obtaining Documentation and Submitting a Service Request
Warning Means reader be warned. In this situation, you might perform an action that could result in bodily
injury.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xlvii
About This Guide
Obtaining Documentation and Submitting a Service Request
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
xlviii
PART I
Getting Started with the ASA
• Introduction to the Cisco ASA, page 3
• Getting Started, page 19
• Product Authorization Key Licenses, page 45
• Smart Software Licensing for the ASAv and ASA on the FXOS Chassis, page 101
• Transparent or Routed Firewall Mode, page 127
CHAPTER 1
Introduction to the Cisco ASA
The Cisco ASA provides advanced stateful firewall and VPN concentrator functionality in one device as
well as integrated services with add-on modules. The ASA includes many advanced features, such as multiple
security contexts (similar to virtualized firewalls), clustering (combining multiple firewalls into a single
firewall), transparent (Layer 2) firewall or routed (Layer 3) firewall operation, advanced inspection engines,
IPsec VPN, SSL VPN, and clientless SSL VPN support, and many more features.
VPN Compatibility
See Supported VPN Platforms, Cisco ASA Series.
New Features
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
3
New Features
The following table lists the new features for ASAv Version 9.5(2.200).
Feature Description
Platform Features
Licensing Features
Permanent License Reservation for For highly secure environments where communication with the Cisco Smart Software Manager
the ASAv is not allowed, you can request a permanent license for the ASAv.
We introduced the following commands: license smart reservation, license smart reservation
cancel, license smart reservation install, license smart reservation request universal,
license smart reservation return
Smart Agent Upgrade to v1.6 The smart agent was upgraded from Version 1.1 to Version 1.6. This upgrade supports
permanent license reservation and also supports setting the Strong Encryption (3DES/AES)
license entitlement according to the permission set in your license account.
Note If you downgrade from Version 9.5(2.200), the ASAv does not retain the licensing
registration state. You need to re-register with the license smart register idtoken
id_token force command; obtain the ID token from the Smart Software Manager.
We introduced the following commands: show license status, show license summary, show
license udi, show license usage
We modified the following commands: show license all, show tech-support license
We deprecated the following commands: show license cert, show license entitlement, show
license pool, show license registration
Note This release supports only the ASA on the Firepower 9300.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
4
New Features
Feature Description
Platform Features
VPN support for the ASA on the With FXOS 1.1.3, you can now configure VPN features.
Firepower 9300
Firewall Features
Flow off-load for the ASA on the You can identify flows that should be off-loaded from the ASA and switched directly in the
Firepower 9300 NIC (on the Firepower 9300). This provides improved performance for large data flows in
data centers.
Also requires FXOS 1.1.3.
We added or modified the following commands: clear flow-offload, flow-offload enable,
set-connection advanced-options flow-offload, show conn detail, show flow-offload.
Inter-chassis clustering for 6 With FXOS 1.1.3, you can now enable inter-chassis, and by extension inter-site clustering.
modules, and inter-site clustering for You can include up to 6 modules in up to 6 chassis.
the ASA on the Firepower 9300 We did not modify any commands.
Licensing Features
Strong Encryption (3DES) license For regular Cisco Smart Software Manager users, the Strong Encryption license is automatically
automatically applied for the ASA enabled for qualified customers when you apply the registration token on the Firepower 9300.
on the Firepower 9300 Note If you are using the Smart Software Manager satellite deployment, to use ASDM
and other strong encryption features, after you deploy the ASA you must enable the
Strong Encryption (3DES) license using the ASA CLI.
This feature requires FXOS 1.1.3.
We removed the following command for non-satellite configurations: feature
strong-encryption
Feature Description
Platform Features
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
5
New Features
Feature Description
Cisco ISA 3000 Support The Cisco ISA 3000 is a DIN Rail mounted, ruggedized, industrial security appliance. It is
low-power, fan-less, with Gigabit Ethernet and a dedicated management port. This model
comes with the ASA Firepower module pre-installed. Special features for this model include
a customized transparent mode default configuration, as well as a hardware bypass function
to allow traffic to continue flowing through the appliance when there is a loss of power.
We introduced the following command: hardware-bypass, hardware-bypass manual,
hardware-bypass boot-delay
Also in Version 9.4(1.225).
Firewall Features
DCERPC inspection improvements DCERPC inspection now supports NAT for OxidResolver ServerAlive2 opnum5 messages.
and UUID filtering You can also now filter on DCERPC message universally unique identifiers (UUIDs) to reset
or log particular message types. There is a new DCERPC inspection class map for UUID
filtering.
We introduced the following command: match [not] uuid. We modified the following
command: class-map type inspect.
Diameter inspection You can now inspect Diameter traffic. Diameter inspection requires the Carrier license.
We introduced or modified the following commands: class-map type inspect diameter,
diameter, inspect diameter, match application-id, match avp, match command-code,
policy-map type inspect diameter, show conn detail, show diameter, show service-policy
inspect diameter, unsupported.
SCTP inspection and access control You can now use the SCTP protocol and port specifications in service objects, access control
lists (ACLs) and access rules, and inspect SCTP traffic. SCTP inspection and access control
requires the Carrier license.
We introduced the following commands: access-list extended , clear conn protocol sctp,
inspect sctp, match ppid, nat static (object), policy-map type inspect sctp, service-object,
service, set connection advanced-options sctp-state-bypass, show conn protocol sctp,
show local-host connection sctp, show service-policy inspect sctp, timeout sctp.
Carrier Grade NAT enhancements For carrier-grade or large-scale PAT, you can allocate a block of ports for each host, rather
now supported in failover and ASA than have NAT allocate one port translation at a time (see RFC 6888). This feature is now
clustering supported in failover and ASA cluster deployments.
We modified the following command: show local-host
Captive portal for active The captive portal feature is required to enable active authentication using identity policies
authentication on ASA FirePOWER starting with ASA FirePOWER 6.0.
6.0. We introduced or modified the following commands: captive-portal, clear configure
captive-portal, show running-config captive-portal.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
6
New Features
Feature Description
LISP Inspection for Inter-Site Flow Cisco Locator/ID Separation Protocol (LISP) architecture separates the device identity from
Mobility its location into two different numbering spaces, making server migration transparent to clients.
The ASA can inspect LISP traffic for location changes and then use this information for
seamless clustering operation; the ASA cluster members inspect LISP traffic passing between
the first hop router and the egress tunnel router (ETR) or ingress tunnel router (ITR), and then
change the flow owner to be at the new site.
We introduced or modified the following commands: allowed-eid, clear cluster info
flow-mobility counters, clear lisp eid, cluster flow-mobility lisp, debug cluster
flow-mobility, debug lisp eid-notify-intercept, flow-mobility lisp, inspect lisp, policy-map
type inspect lisp, site-id, show asp table classify domain inspect-lisp, show cluster info
flow-mobility counters, show conn, show lisp eid, show service-policy, validate-key
ASA 5516-X support for clustering The ASA 5516-X now supports 2-unit clusters. Clustering for 2 units is enabled by default
in the base license.
We did not modify any commands.
Configurable level for clustering By default, all levels of clustering events are included in the trace buffer, including many low
trace entries level events. To limit the trace to higher level events, you can set the minimum trace level for
the cluster.
We introduced the following command: trace-level
Interface Features
Support to map Secondary VLANs You can now configure one or more secondary VLANs for a subinterface. When the ASA
to a Primary VLAN receives traffic on the secondary VLANs, it maps the traffic to the primary VLAN.
We introduced or modified the following commands: vlan secondary, show vlan mapping
Routing Features
PIM Bootstrap Router (BSR) support The ASA currently supports configuring static RPs to route multicast traffic for different
for multicast routing groups. For large complex networks where multiple RPs could exist, the ASA now supports
dynamic RP selection using PIM BSR to support mobility of RPs.
We introduced the following commands: clear pim group-map, debug pim bsr, pim
bsr-border, pim bsr-candidate, show pim bsr-router, show pim group-map rp-timers
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
7
New Features
Feature Description
Support for Remote Access VPN in You can now use the following remote access features in multiple context mode:
multiple context mode
• AnyConnect 3.x and later (SSL VPN only; no IKEv2 support)
• Centralized AnyConnect image configuration
• AnyConnect image upgrade
• Context Resource Management for AnyConnect connections
Note The AnyConnect Apex license is required for multiple context mode; you cannot use
the default or legacy license.
We introduced the following commands: limit-resource vpn anyconnect, limit-resource
vpn burst anyconnect
Clientless SSL VPN offers SAML The ASA acts as a SAML Service Provider.
2.0-based Single Sign-On (SSO)
functionality
Clientless SSL VPN conditional You can debug logs by filtering, based on the filter condition sets, and can then better analyze
debugging them.
We introduced the following additions to the debug command:
• [no] debug webvpn condition user <user name>
• [no] debug webvpn condition group <group name>
• [no] debug webvpn condition p-ipaddress <ipv4> [subnet<mask>]
• [no] debug webvpn condition p-ipaddress <ipv6> [prefix<prefix>]
• debug webvpn condition reset
• show debug webvpn condition
• show webvpn debug-condition
Clientless SSL VPN cache disabled The clientless SSL VPN cache is now disabled by default. Disabling the clientless SSL VPN
by default cache provides better stability. If you want to enable the cache, you must manually enable it.
webvpn
cache
no disable
Licensing Features
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
8
New Features
Feature Description
Validation of the Smart Call Smart licensing uses the Smart Call Home infrastructure. When the ASA first configures
Home/Smart Licensing certificate if Smart Call Home anonymous reporting in the background, it automatically creates a trustpoint
the issuing hierarchy of the server containing the certificate of the CA that issued the Smart Call Home server certificate. The
certificate changes ASA now supports validation of the certificate if the issuing hierarchy of the server certificate
changes; you can enable the automatic update of the trustpool bundle at periodic intervals.
We introduced the following command: auto-import
New Carrier license The new Carrier license replaces the existing GTP/GPRS license, and also includes support
for SCTP and Diameter inspection. For the ASA on the Firepower 9300, the feature mobile-sp
command will automatically migrate to the feature carrier command.
We introduced or modified the following commands: feature carrier, show activation-key,
show license, show tech-support, show version
Monitoring Features
logging debug-trace persistence Formerly, when you enabled logging debug-trace to redirect debugs to a syslog server, if the
SSH connection were disconnected (due to network connectivity or timeout), then the debugs
were removed. Now, debugs persist for as long as the logging command is in effect.
We modified the following command: logging debug-trace
Feature Description
Platform Features
Support for ASA FirePOWER 6.0 The 6.0 software version for the ASA FirePOWER module is supported on all previously
supported device models.
Support for managing the ASA You can manage the ASA FirePOWER module using ASDM instead of using Firepower
FirePOWER module through ASDM Management Center (formerly FireSIGHT Management Center) when running version 6.0
for the 5512-X through 5585-X. on the module. You can still use ASDM to manage the module on the 5506-X, 5506H-X,
5506W-X, 5508-X, and 5516-X when running 6.0.
No new screens or commands were added.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
9
New Features
The following table lists the new features for ASAv Version 9.5(1.200).
Feature Description
Platform Features
Microsoft Hyper-V supervisor Extends the hypervisor portfolio for the ASAv.
support
ASAv5 low memory support The ASAv5 now only requires 1 GB RAM to operate. Formerly, it required 2 GB. For
already-deployed ASAv5s, you should reduce the allocated memory to 1 GB or you will see
an error that you are using more memory than is licensed.
Note This version does not support the Firepower 9300 ASA security module or the ISA 3000.
Feature Description
Firewall Features
GTPv2 inspection and improvements GTP inspection can now handle GTPv2. In addition, GTP inspection for all versions now
to GTPv0/1 inspection supports IPv6 addresses.
We modified the following commands: clear service-policy inspect gtp statistics, clear
service-policy inspect gtp pdpmcb, clear service-policy inspect gtp request, match message
id, show service-policy inspect gtp pdpmcb, show service-policy inspect gtp request,
show service-policy inspect gtp statistics, timeout endpoint
We deprecated the following command: timeout gsn
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
10
New Features
Feature Description
IP Options inspection improvements IP Options inspection now supports all possible IP options. You can tune the inspection to
allow, clear, or drop any standard or experimental options, including those not yet defined.
You can also set a default behavior for options not explicitly defined in an IP options inspection
map.
We introduced the following commands: basic-security, commercial-security, default,
exp-flow-control, exp-measure, extended-security, imi-traffic-description, quick-start,
record-route, timestamp
Carrier Grade NAT enhancements For carrier-grade or large-scale PAT, you can allocate a block of ports for each host, rather
than have NAT allocate one port translation at a time (see RFC 6888).
We introduced the following commands: xlate block-allocation size, xlate block-allocation
maximum-per-host. We added the block-allocation keyword to the nat command.
Inter-site clustering support for You can now use inter-site clustering for Spanned EtherChannels in routed mode. To avoid
Spanned EtherChannel in Routed MAC address flapping, configure a site ID for each cluster member so that a site-specific
firewall mode MAC address for each interface can be shared among a site’s units.
We introduced or modified the following commands: site-id, mac-address site-id, show
cluster info, show interface
ASA cluster customization of the You can now customize the auto-rejoin behavior when an interface or the cluster control link
auto-rejoin behavior when an fails.
interface or the cluster control link We introduced the following command: health-check auto-rejoin
fails
The ASA cluster supports GTPv1 The ASA cluster now supports GTPv1 and GTPv2 inspection.
and GTPv2 We did not modify any commands.
Cluster replication delay for TCP This feature helps eliminate the “unnecessary work” related to short-lived flows by delaying
connections the director/backup flow creation.
We introduced the following command: cluster replication delay
Also available for the Firepower 9300 ASA security module in Version 9.4(1.152).
Disable health monitoring of a By default when using clustering, the ASA monitors the health of an installed hardware module
hardware module in ASA clustering such as the ASA FirePOWER module. If you do not want a hardware module failure to trigger
failover, you can disable module monitoring.
We modified the following command: health-check monitor-interface service-module
Enable use of the Management 1/1 On the ASA 5506H only, you can now configure the Management 1/1 interface as the failover
interface as the failover link on the link. This feature lets you use all other interfaces on the device as data interfaces. Note that
ASA 5506H if you use this feature, you cannot use the ASA Firepower module, which requires the
Management 1/1 interface to remain as a regular management interface.
We modified the following commands: failover lan interface, failover link
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
11
New Features
Feature Description
Routing Features
Support for IPv6 in Policy Based IPv6 addresses are now supported for Policy Based Routing.
Routing We introduced the following commands: set ipv6 next-hop, set default ipv6-next hop, set
ipv6 dscp
VXLAN support for Policy Based You can now enable Policy Based Routing on a VNI interface.
Routing We did not modify any commands.
Policy Based Routing support for You can configure Identity Firewall and Cisco TrustSec and then use Identity Firewall and
Identity Firewall and Cisco Trustsec Cisco TrustSec ACLs in Policy Based Routing route maps.
We did not modify any commands.
Separate routing table for To segregate and isolate management traffic from data traffic, the ASA now supports a separate
management-only interfaces routing table for management-only interfaces.
We introduced or modified the following commands: backup, clear ipv6 route
management-only, clear route management-only, configure http, configure net, copy,
enrollment source, name-server, restore, show asp table route-management-only, show
ipv6 route management-only show route management-only
Protocol Independent Multicast The ASA now allows PIM-SSM packets to pass through when you enable multicast routing,
Source-Specific Multicast unless the ASA is the Last-Hop Router. This feature allows greater flexibility in choosing a
(PIM-SSM) pass-through support multicast group while also protecting against different attacks; hosts only receive traffic from
explicitly-requested sources.
We did not modify any commands.
IPv6 VLAN Mapping ASA VPN code has been enhanced to support full IPv6 capabilities. No configuration change
is necessary for the administrator.
Clientless SSL VPN SharePoint Added support and a predefined application template for this new SharePoint version.
2013 Support
VPN Banner Length Increase The overall banner length, which is displayed during post-login on the VPN remote client
portal, has increased from 500 to 4000.
We modified the following command: banner (group-policy).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
12
Firewall Functional Overview
Feature Description
Cisco Easy VPN client on the ASA This release supports Cisco Easy VPN on the ASA 5506-X series and for the ASA 5508-X.
5506-X, 5506W-X, 5506H-X, and The ASA acts as a VPN hardware client when connecting to the VPN headend. Any devices
5508-X (computers, printers, and so on) behind the ASA on the Easy VPN port can communicate
over the VPN; they do not have to run VPN clients individually. Note that only one ASA
interface can act as the Easy VPN port; to connect multiple devices to that port, you need to
place a Layer 2 switch on the port, and then connect your devices to the switch.
We introduced the following commands: vpnclient enable, vpnclient server, vpnclient
mode, vpnclient username, vpnclient ipsec-over-tcp, vpnclient management, vpnclient
vpngroup, vpnclient trustpoint, vpnclient nem-st-autoconnect, vpnclient mac-exempt
Monitoring Features
Show invalid usernames in syslog You can now show invalid usernames in syslog messages for unsuccessful login attempts.
messages The default setting is to hide usernames when the username is invalid or if the validity is
unknown. If a user accidentally types a password instead of a username, for example, then it
is more secure to hide the “username” in the resultant syslog message. You might want to
show invalid usernames to help with troubleshooting login issues.
We introduced the following command: no logging hide username
This feature is also available in 9.2(4) and 9.3(3).
REST API Version 1.2.1 We added support for the REST API Version 1.2.1.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
13
Firewall Functional Overview
Applying NAT
Some of the benefits of NAT include the following:
• You can use private addresses on your inside networks. Private addresses are not routable on the Internet.
• NAT hides the local addresses from other networks, so attackers cannot learn the real address of a host.
• NAT can resolve IP routing problems by supporting overlapping IP addresses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
14
Firewall Functional Overview
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
15
Firewall Functional Overview
Note The TCP state bypass feature allows you to customize the packet flow.
A stateful firewall like the ASA, however, takes into consideration the state of a packet:
• Is this a new connection?
If it is a new connection, the ASA has to check the packet against access lists and perform other tasks
to determine if the packet is allowed or denied. To perform this check, the first packet of the session
goes through the “session management path,” and depending on the type of traffic, it might also pass
through the “control plane path.”
The session management path is responsible for the following tasks:
◦Performing the access list checks
◦Performing route lookups
◦Allocating NAT translations (xlates)
◦Establishing sessions in the “fast path”
The ASA creates forward and reverse flows in the fast path for TCP traffic; the ASA also creates
connection state information for connectionless protocols like UDP, ICMP (when you enable ICMP
inspection), so that they can also use the fast path.
Note For other IP protocols, like SCTP, the ASA does not create reverse path flows. As a
result, ICMP error packets that refer to these connections are dropped.
Some packets that require Layer 7 inspection (the packet payload must be inspected or altered) are passed
on to the control plane path. Layer 7 inspection engines are required for protocols that have two or more
channels: a data channel, which uses well-known port numbers, and a control channel, which uses
different port numbers for each session. These protocols include FTP, H.323, and SNMP.
• Is this an established connection?
If the connection is already established, the ASA does not need to re-check packets; most matching
packets can go through the “fast” path in both directions. The fast path is responsible for the following
tasks:
◦IP checksum verification
◦Session lookup
◦TCP sequence number check
◦NAT translations based on existing sessions
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
16
VPN Functional Overview
Data packets for protocols that require Layer 7 inspection can also go through the fast path.
Some established session packets must continue to go through the session management path or the
control plane path. Packets that go through the session management path include HTTP packets that
require inspection or content filtering. Packets that go through the control plane path include the control
packets for protocols that require Layer 7 inspection.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
17
ASA Clustering Overview
The admin context is just like any other context, except that when a user logs into the admin context, then
that user has system administrator rights and can access the system and all other contexts.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
18
CHAPTER 2
Getting Started
This chapter describes how to get started with your Cisco ASA.
Note For ASAv console access, see the ASAv quick start guide.
Procedure
Step 1 Connect a computer to the console port using the provided console cable, and connect to the console using a
terminal emulator set for 9600 baud, 8 data bits, no parity, 1 stop bit, no flow control.
See the hardware guide for your ASA for more information about the console cable.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
19
Access the Console for Command-Line Interface
ciscoasa>
This prompt indicates that you are in user EXEC mode. Only basic commands are available from user EXEC
mode.
Password:
All non-configuration commands are available in privileged EXEC mode. You can also enter configuration
mode from privileged EXEC mode.
ciscoasa#
ciscoasa(config)#
You can begin to configure the ASA from global configuration mode. To exit global configuration mode,
enter the exit, quit, or end command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
20
Access the Console for Command-Line Interface
◦The connection is persistent across reloads and does not time out.
◦You can stay connected through ASASM reloads and view startup messages.
◦You can access ROMMON if the ASASM cannot load the image.
◦No initial password configuration is required.
Limitations include:
◦The connection is slow (9600 baud).
◦You can only have one console connection active at a time.
◦You cannot use this command in conjunction with a terminal server where Ctrl-Shift-6, x is the
escape sequence to return to the terminal server prompt. Ctrl-Shift-6, x is also the sequence to
escape the ASASM console and return to the switch prompt. Therefore, if you try to exit the
ASASM console in this situation, you instead exit all the way to the terminal server prompt. If you
reconnect the terminal server to the switch, the ASASM console session is still active; you can
never exit to the switch prompt. You must use a direct serial connection to return the console to
the switch prompt. In this case, either change the terminal server or switch escape character in
Cisco IOS software, or use the Telnet session command instead.
Note Because of the persistence of the console connection, if you do not properly log out of
the ASASM, the connection may exist longer than intended. If someone else wants to
log in, they will need to kill the existing connection.
• Telnet connection—Using the session command, you create a Telnet connection to the ASASM.
Note You cannot connect using this method for a new ASASM; this method requires you to
configure a Telnet login password on the ASASM (there is no default password). After
you set a password using the passwd command, you can use this method.
Benefits include:
◦You can have multiple sessions to the ASASM at the same time.
◦The Telnet session is a fast connection.
Limitations include:
◦The Telnet session is terminated when the ASASM reloads, and can time out.
◦You cannot access the ASASM until it completely loads; you cannot access ROMMON.
◦You must first set a Telnet login password; there is no default password.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
21
Access the Console for Command-Line Interface
If your system is already in multiple context mode, then accessing the ASASM from the switch places you
in the system execution space.
Later, you can configure remote access directly to the ASASM using Telnet or SSH.
Procedure
ciscoasa passwd:
Example:
Step 2 Access privileged EXEC mode, which is the highest privilege level:
enable
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
22
Access the Console for Command-Line Interface
Example:
ciscoasa> enable
Password:
ciscoasa#
Enter the enable password at the prompt. By default, the password is blank.
To exit privileged EXEC mode, enter the disable, exit, or quit command.
Related Topics
Set the Hostname, Domain Name, and the Enable and Telnet Passwords, on page 475
Procedure
asasm# [Ctrl-Shift-6, x]
Router#
Note Shift-6 on US and UK keyboards issues the caret (^) character. If you have a different keyboard and
cannot issue the caret (^) character as a standalone character, you can temporarily or permanently
change the escape character to a different character. Use the terminal escape-character ascii_number
command (to change for this session) or the default escape-character ascii_number command (to
change permanently). For example, to change the sequence for the current session to Ctrl-w, x, enter
terminal escape-character 23.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
23
Access the Console for Command-Line Interface
Procedure
Step 1 From the switch CLI, show the connected users using the show users command. A console user is called
“con”. The Host address shown is 127.0.0.slot0, where slot is the slot number of the module.
show users
For example, the following command output shows a user “con” on line 0 on a module in slot 2:
Step 2 To clear the line with the console connection, enter the following command:
clear line number
For example:
Procedure
To return to the switch CLI, type exit from the ASASM privileged or user EXEC mode. If you are in a
configuration mode, enter exit repeatedly until you exit the Telnet session.
You return to the switch prompt:
asasm# exit
Router#
Note You can alternatively escape the Telnet session using the escape sequence Ctrl-Shift-6, x; this escape
sequence lets you resume the Telnet session by pressing the Enter key at the switch prompt. To
disconnect your Telnet session from the switch, enter disconnect at the switch CLI. If you do not
disconnect the session, it will eventually time out according to the ASASM configuration.
Note You cannot access the hardware module CLI over the ASA backplane using the session command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
24
Configure ASDM Access
Procedure
Example:
ciscoasa# session sfr console
Opening console session with module sfr.
Connected to module sfr. Escape character sequence is 'CTRL-^X'.
Procedure
Example:
ciscoasa# session wlan console
opening console session with module wlan
connected to module wlan. Escape character sequence is ‘CTRL-^X’
ap>
Step 2 See the Cisco IOS Configuration Guide for Autonomous Aironet Access Points for information about the
access point CLI.
Use the Factory Default Configuration for ASDM Access (Appliances, ASAv)
With a factory default configuration, ASDM connectivity is pre-configured with default network settings.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
25
Configure ASDM Access
Note If you change to multiple context mode, you can access ASDM from the admin context using the
network settings above.
Related Topics
Factory Default Configurations, on page 32
Enable or Disable Multiple Context Mode, on page 167
Start ASDM, on page 31
For routed, single mode, for quick and easy ASDM access, we recommend applying the factory default
configuration with the option to set your own management IP address. Use the procedure in this section only
if you have special needs such as setting transparent or multiple context mode, or if you have other configuration
that you need to preserve.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
26
Configure ASDM Access
Note For the ASAv, you can configure transparent mode when you deploy, so this procedure is primarily useful
after you deploy if you need to clear your configuration, for example.
Procedure
interface interface_id
nameif name
security-level level
no shutdown
ip address ip_address mask
Example:
ciscoasa(config)# interface management 0/0
ciscoasa(config-if)# nameif management
ciscoasa(config-if)# security-level 100
ciscoasa(config-if)# no shutdown
ciscoasa(config-if)# ip address 192.168.1.1 255.255.255.0
The security-level is a number between 1 and 100, where 100 is the most secure.
Step 4 (For directly-connected management hosts) Set the DHCP pool for the management network:
Example:
ciscoasa(config)# dhcpd address 192.168.1.2-192.168.1.254 management
ciscoasa(config)# dhcpd enable management
Make sure you do not include the interface address in the range.
Step 5 (For remote management hosts) Configure a route to the management hosts:
route management_ifc management_host_ip mask gateway_ip 1
Example:
ciscoasa(config)# route management 10.1.1.0 255.255.255.0 192.168.1.50 1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
27
Configure ASDM Access
Example:
ciscoasa(config)# http 192.168.1.0 255.255.255.0 management
Examples
The following configuration converts the firewall mode to transparent mode, configures the Management 0/0
interface, and enables ASDM for a management host:
firewall transparent
interface management 0/0
Related Topics
Restore the Factory Default Configuration, on page 33
Set the Firewall Mode, on page 134
Access the Appliance Console, on page 19
Start ASDM, on page 31
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
28
Configure ASDM Access
Procedure
Step 3 Do one of the following to configure a management interface, depending on your mode:
• Routed mode—Configure an interface in routed mode:
Example:
The security-level is a number between 1 and 100, where 100 is the most secure.
• Transparent mode—Configure a bridge virtual interface and assigns a management VLAN to the bridge
group:
Example:
The security-level is a number between 1 and 100, where 100 is the most secure.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
29
Configure ASDM Access
Step 4 (For directly-connected management hosts) Enable DHCP for the management host on the management
interface network:
Example:
ciscoasa(config)# dhcpd address 192.168.1.2-192.168.1.254 inside
ciscoasa(config)# dhcpd enable inside
Make sure you do not include the management address in the range.
Step 5 (For remote management hosts) Configure a route to the management hosts:
route management_ifc management_host_ip mask gateway_ip 1
Example:
ciscoasa(config)# route management 10.1.1.0 255.255.255.0 192.168.1.50
Example:
ciscoasa(config)# http 192.168.1.0 255.255.255.0 management
Examples
The following routed mode configuration configures the VLAN 1 interface and enables ASDM for a
management host:
interface vlan 1
nameif inside
ip address 192.168.1.1 255.255.255.0
security-level 100
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
30
Start ASDM
The following configuration converts the firewall mode to transparent mode, configures the VLAN 1 interface
and assigns it to BVI 1, and enables ASDM for a management host:
firewall transparent
interface bvi 1
Related Topics
Access the ASA Services Module Console, on page 20
Set the Firewall Mode, on page 134
Start ASDM
You can start ASDM using two methods:
• ASDM-IDM Launcher—The Launcher is an application downloaded from the ASA using a web browser
that you can use to connect to any ASA IP address. You do not need to re-download the launcher if you
want to connect to other ASAs. The Launcher also lets you run a virtual ASDM in Demo mode using
files downloaded locally.
• Java Web Start—For each ASA that you manage, you need to connect with a web browser and then
save or launch the Java Web Start application. You can optionally save the shortcut to your computer;
however you need separate shortcuts for each ASA IP address.
Within ASDM, you can choose a different ASA IP address to manage; the difference between the Launcher
and Java Web Start functionality rests primarily in how you initially connect to the ASA and launch ASDM.
This section describes how to connect to ASDM initially, and then launch ASDM using the Launcher or the
Java Web Start.
Procedure
Step 1 On the computer that you specified as the ASDM client, enter the following URL:
https://asa_ip_address/admin
The ASDM launch page appears with the following buttons:
• Install ASDM Launcher and Run ASDM
• Run ASDM
• Run Startup Wizard
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
31
Factory Default Configurations
b) Leave the username and password fields empty (for a new installation), and click OK. With no HTTPS
authentication configured, you can gain access to ASDM with no username and the enable password,
which is blank by default. Note: If you enabled HTTPS authentication, enter your username and associated
password.
c) Save the installer to your computer, and then start the installer. The ASDM-IDM Launcher opens
automatically after installation is complete.
d) Enter the management IP address, leave the username and password blank (for a new installation), and
then click OK. Note: If you enabled HTTPS authentication, enter your username and associated password.
Step 3 To use Java Web Start:
a) Click Run ASDM or Run Startup Wizard.
b) Save the shortcut to your computer when prompted. You can optionally open it instead of saving it.
c) Start Java Web Start from the shortcut.
d) Accept any certificates according to the dialog boxes that appear. The Cisco ASDM-IDM Launcher appears.
e) Leave the username and password blank (for a new installation), and then click OK. Note: If you enabled
HTTPS authentication, enter your username and associated password.
For appliances and the Firepower 9300 ASA security module, the factory default configuration is available
only for routed firewall mode and single context mode. For the ASAv, you can choose transparent or routed
mode at deployment.
Note In addition to the image files and the (hidden) default configuration, the following folders and files are
standard in flash memory: log/, crypto_archive/, and coredumpinfo/coredump.cfg. The date on these files
may not match the date of the image files in flash memory. These files aid in potential troubleshooting;
they do not indicate that a failure has occurred.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
32
Factory Default Configurations
Note On the ASASM, restoring the factory default configuration simply erases the configuration; there is no
factory default configuration. On the Firepower 9300 ASA security module, restoring the factory default
configuration simply erases the configuration; to restore the default configuration, you must re-deploy the
ASA from the supervisor.
Procedure
Example:
ciscoasa(config)# configure factory-default 10.1.1.1 255.255.255.0
If you specify the ip_address, then you set the inside or management interface IP address, depending on your
model, instead of using the default IP address of 192.168.1.1. The http command uses the subnet you specify.
Similarly, the dhcpd address command range consists of addresses within the subnet that you specify.
This command also clears the boot system command, if present, along with the rest of the configuration. The
boot system command lets you boot from a specific image, including an image on the external flash memory
card. The next time you reload the ASA after restoring the factory configuration, it boots from the first image
in internal flash memory; if you do not have an image in internal flash memory, the ASA does not boot.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
33
Factory Default Configurations
Procedure
Step 2 Restore the deployment configuration after you reload. For failover, enter this command on the active unit:
write erase
Note The ASAv boots the current running image, so you are not reverted to the original boot image. To
use the original boot image, see the boot image command.
Do not save the configuration.
Step 3 Reload the ASAv and load the deployment configuration:
reload
interface Management1/1
management-only
no nameif
no security-level
no ip address
no shutdown
interface GigabitEthernet1/1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
34
Factory Default Configurations
nameif outside
security-level 0
ip address dhcp setroute
no shutdown
interface GigabitEthernet1/2
nameif inside
security-level 100
ip address 192.168.1.1 255.255.255.0
no shutdown
object network obj_any
subnet 0.0.0.0 0.0.0.0
nat (any,outside) dynamic interface
http server enable
http 192.168.1.0 255.255.255.0 inside
dhcpd auto_config outside
dhcpd address 192.168.1.5-192.168.1.254 inside
dhcpd enable inside
logging asdm informational
For the ASA 5506W-X, the following commands are also included:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
35
Factory Default Configurations
The configuration for a standalone unit consists of the following commands. For additional configuration for
clustered units, see Deploy the Cluster from the FXOS Chassis Supervisor, on page 362.
interface <management_ifc>
management-only
ip address <ip_address> <mask>
ipv6 address <ipv6_address>
ipv6 enable
nameif management
security-level 0
no shutdown
http server enable
http 0.0.0.0 0.0.0.0 management
http ::/0 management
route management 0.0.0.0 0.0.0.0 <gateway_ip> 1
ipv6 route management ::/0 <gateway_ipv6>
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
36
Factory Default Configurations
Note When the ISA 3000 loses power and goes into hardware bypass mode, only the above
interface pairs can communicate; inside1 and inside2, and outside1 and outside2 can no
longer communicate. Any existing connections between these interfaces will be lost.
When the power comes back on, there is a brief connection interruption as the ASA
takes over the flows.
• ASA Firepower module—All traffic is sent to the module in Inline Tap Monitor-Only Mode. This mode
sends a duplicate stream of traffic to the ASA Firepower module for monitoring purposes only.
firewall transparent
interface GigabitEthernet1/1
bridge-group 1
nameif outside1
security-level 0
no shutdown
interface GigabitEthernet1/2
bridge-group 1
nameif inside1
security-level 100
no shutdown
interface GigabitEthernet1/3
bridge-group 1
nameif outside2
security-level 0
no shutdown
interface GigabitEthernet1/4
bridge-group 1
nameif inside2
security-level 100
no shutdown
interface Management1/1
management-only
no shutdown
nameif management
security-level 100
ip address 192.168.1.1 255.255.255.0
interface BVI1
no ip address
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
37
Factory Default Configurations
Note For the ASAv on Microsoft Azure, the Management 0/0 interface allows through traffic,
so the Management-only setting is not enabled.
• Static route for the management host IP address (if it is not on the management subnet)
• HTTP server enabled or disabled
• HTTP access for the management host IP address
• (Optional) Failover link IP addresses for GigabitEthernet 0/8, and the Management 0/0 standby IP
address
• DNS server
• Smart licensing ID token
• Smart licensing Throughput Level and Standard Feature Tier
• (Optional) Smart Call Home HTTP Proxy URL and port
• (Optional) SSH management settings:
◦Client IP addresses
◦Local username and password
◦Authentication required for SSH using the LOCAL database
Note To successfully register the ASAv with the Cisco Licensing Authority, the ASAv requires Internet access.
You might need to perform additional configuration after deployment to achieve Internet access and
successful license registration.
interface Management0/0
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
38
Work with the Configuration
nameif management
security-level 0
ip address ip_address
management-only
no shutdown
http server enable
http managemment_host_IP mask management
route management management_host_IP mask gateway_ip 1
dns server-group DefaultDNS
name-server ip_address
call-home
http-proxy ip_address port port
license smart
feature tier standard
throughput level {100M | 1G | 2G}
license smart register idtoken id_token
aaa authentication ssh console LOCAL
username username password password
ssh source_IP_address mask management
rest-api image boot:/path
rest-api agent
See the following sample configuration for a primary unit in a failover pair:
nameif management
security-level 0
ip address ip_address standby standby_ip
management-only
no shutdown
route management management_host_IP mask gateway_ip 1
http server enable
http managemment_host_IP mask management
dns server-group DefaultDNS
name-server ip_address
call-home
http-proxy ip_address port port
license smart
feature tier standard
throughput level {100M | 1G | 2G}
license smart register idtoken id_token
aaa authentication ssh console LOCAL
username username password password
ssh source_IP_address mask management
rest-api image boot:/path
rest-api agent
failover
failover lan unit primary
failover lan interface fover gigabitethernet0/8
failover link fover gigabitethernet0/8
failover interface ip fover primary_ip mask standby standby_ip
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
39
Work with the Configuration
Procedure
Procedure
From within the context or the system, save the running configuration to the startup configuration:
write memory
For multiple context mode, context startup configurations can reside on external servers. In this case, the ASA
saves the configuration back to the server you identified in the context URL, except for an HTTP or HTTPS
URL, which do not let you save the configuration to the server.
Note The copy running-config startup-config command is equivalent to the write memory command.
Procedure
From the system execution space, save the running configuration to the startup configuration for all contexts
and the system configuration:
write memory all [/noconfirm]
If you do not enter the /noconfirm keyword, you see the following prompt:
After you enter Y, the ASA saves the system configuration and each context. Context startup configurations
can reside on external servers. In this case, the ASA saves the configuration back to the server you identified
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
40
Work with the Configuration
in the context URL, except for an HTTP or HTTPS URL, which do not let you save the configuration to the
server.
After the ASA saves each context, the following message appears:
Sometimes, a context is not saved because of an error. See the following information for errors:
• For contexts that are not saved because of low memory, the following message appears:
The context 'context a' could not be saved due to Unavailability of resources
• For contexts that are not saved because the remote destination is unreachable, the following message
appears:
The context 'context a' could not be saved due to non-reachability of destination
• For contexts that are not saved because the context is locked, the following message appears:
Unable to save the configuration for the following contexts as these contexts are
locked.
context ‘a’ , context ‘x’ , context ‘z’ .
A context is only locked if another user is already saving the configuration or in the process of deleting
the context.
• For contexts that are not saved because the startup configuration is read-only (for example, on an HTTP
server), the following message report is printed at the end of all other messages:
Unable to save the configuration for the following contexts as these contexts have
read-only config-urls:
context ‘a’ , context ‘b’ , context ‘c’ .
• For contexts that are not saved because of bad sectors in the flash memory, the following message
appears:
The context 'context a' could not be saved due to Unknown errors
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
41
Work with the Configuration
occur. If commands conflict or if commands affect the running of the context, then the effect of the
merge depends on the command. You might get errors, or you might have unexpected results.
• reload
Reloads the ASA, which loads the startup configuration and discards the running configuration.
• clear configure all and then copy startup-config running-config
Loads the startup configuration and discards the running configuration without requiring a reload.
To clear the configuration for only aaa authentication commands, enter the following command:
ciscoasa(config)# no access-list abc extended permit icmp any any object-group obj_icmp_1
• write erase
Erases the startup configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
42
Apply Configuration Changes to Connections
Note For the ASAv, this command restores the deployment configuration after a reload. To
erase the configuration completely, use the clear configure all command.
Note In multiple context mode, if you enter clear configure all from the system configuration,
you also remove all contexts and stop them from running. The context configuration
files are not erased, and remain in their original location.
This command also clears the boot system command, if present, along with the rest of
the configuration. The boot system command lets you boot from a specific image,
including an image on the external flash memory card. The next time you reload the
ASA, it boots from the first image in internal flash memory; if you do not have an image
in internal flash memory, the ASA does not boot.
ciscoasa(config)# context a
In the text configuration file you are not prompted to enter commands, so the prompt is omitted as follows:
context a
For additional information about formatting the file, see Using the Command-Line Interface, on page 999.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
43
Reload the ASA
To ensure that all connections use the new policy, you need to disconnect the current connections so that they
can reconnect using the new policy.
To disconnect connections, enter one of the following commands:
• clear local-host [ip_address] [all]
This command reinitializes per-client run-time states such as connection limits and embryonic limits.
As a result, this command removes any connection that uses those limits. See the show local-host all
command to view all current connections per host.
With no arguments, this command clears all affected through-the-box connections. To also clear to-the-box
connections (including your current management session), use the all keyword. To clear connections to
and from a particular IP address, use the ip_address argument.
• clear conn [all] [protocol {tcp | udp}] [address src_ip [-src_ip] [netmask mask]] [port src_port
[-src_port]] [address dest_ip [-dest_ip] [netmask mask]] [port dest_port [-dest_port]]
This command terminates connections in any state. See the show conn command to view all current
connections.
With no arguments, this command clears all through-the-box connections. To also clear to-the-box
connections (including your current management session), use the all keyword. To clear specific
connections based on the source IP address, destination IP address, port, and/or protocol, you can specify
the desired options.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
44
CHAPTER 3
Product Authorization Key Licenses
A license specifies the options that are enabled on a given Cisco ASA. This document describes product
authorization key (PAK) licenses for all physical ASAs. For the ASAv, see Smart Software Licensing for
the ASAv and ASA on the FXOS Chassis, on page 101.
Note Some features are incompatible with each other. See the individual feature chapters for compatibility
information.
If you have a No Payload Encryption model, then some of the features below are not supported. See No
Payload Encryption Models, on page 71 for a list of unsupported features.
For detailed information about licenses, see License Notes, on page 58.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
45
Supported Feature Licenses Per Model
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Disabled Optional AnyConnect Plus or
Apex license: 50 maximum Apex license: 50 maximum
General Licenses
Encryption Base (DES) Opt. lic.: Strong (3DES/AES) Base (DES) Opt. lic.: Strong (3DES/AES)
VLANs, Maximum 5 30
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
46
Supported Feature Licenses Per Model
Carrier No Support
VPN Licenses
General Licenses
Clustering No Support
VLANs, Maximum 30
Carrier No Support
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
47
Supported Feature Licenses Per Model
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 100 maximum
General Licenses
Clustering No Support
VLANs, Maximum 50
Botnet Traffic Filter Disabled Optional Time-based license: Disabled Optional Time-based license:
Available Available
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Disabled Optional AnyConnect Plus or
Apex license: 250 maximum Apex license: 250 maximum
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
48
Supported Feature Licenses Per Model
General Licenses
Encryption Base (DES) Opt. lic.: Strong (3DES/AES) Base (DES) Opt. lic.: Strong (3DES/AES)
Clustering No Support 2
IPS Module Disabled Optional license: Available Disabled Optional license: Available
Carrier No Support
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 250 maximum
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
49
Supported Feature Licenses Per Model
Clustering 2
Carrier No Support
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 300 maximum
General Licenses
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
50
Supported Feature Licenses Per Model
Clustering 2
Total UC Proxy Sessions 2 Optional licenses: 24 50 100 250 500 750 1000
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 750 maximum
General Licenses
Clustering 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
51
Supported Feature Licenses Per Model
Total UC Proxy Sessions 2 Optional licenses: 24 50 100 250 500 750 1000 2000
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 2500 maximum
General Licenses
Clustering 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
52
Supported Feature Licenses Per Model
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 5000 maximum
General Licenses
Clustering 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
53
Supported Feature Licenses Per Model
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 5000 maximum
General Licenses
10 GE I/O Base License: Disabled; fiber ifcs run at 1 GE Security Plus License: Enabled; fiber ifcs run at
10 GE
Note With the 10,000-session UC license, the total combined sessions can be 10,000, but the maximum number
of Phone Proxy sessions is 5000.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
54
Supported Feature Licenses Per Model
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 10,000 maximum
General Licenses
10 GE I/O Base License: Disabled; fiber ifcs run at 1 GE Security Plus License: Enabled; fiber ifcs run at
10 GE
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
55
Supported Feature Licenses Per Model
Note With the 10,000-session UC license, the total combined sessions can be 10,000, but the maximum number
of Phone Proxy sessions is 5000.
Firewall Conns, Concurrent 5585-X with SSP-40: 4,000,000 5585-X with SSP-60: 10,000,000
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 10,000 maximum
General Licenses
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
56
Supported Feature Licenses Per Model
Note With the 10,000-session UC license, the total combined sessions can be 10,000, but the maximum number
of Phone Proxy sessions is 5000.
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 10,000 maximum
General Licenses
5 10 20 50 100 250
Clustering No support
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
57
Supported Feature Licenses Per Model
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Disabled Optional AnyConnect Plus or
Apex license: 25 maximum Apex license: 25 maximum
General Licenses
Encryption Base (DES) Opt. lic.: Strong (3DES/AES) Base (DES) Opt. lic.: Strong (3DES/AES)
VLANs, Maximum 5 25
License Notes
The following table includes additional information about licenses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
58
Supported Feature Licenses Per Model
License Notes
Legacy VPN Licenses For pre-existing deployments, the legacy licenses are still supported, including the default license that
includes 2 AnyConnect premium sessions (4 sessions for the ASA 5506-X with Security Plus, 5508-X,
and 5516-X). However, you should upgrade to the AnyConnect Plus or Apex license for full
compatibility.
Note The AnyConnect Apex license is required for multiple context mode; you cannot use the
default or legacy license.
AnyConnect Essentials
The AnyConnect Essentials sessions include the following VPN types:
• SSL VPN
• IPsec remote access VPN using IKEv2
This license does not support browser-based (clientless) SSL VPN access or Cisco Secure Desktop.
For these features, activate an AnyConnect Premium license instead of the AnyConnect Essentials
license.
Note With the AnyConnect Essentials license, VPN users can use a web browser to log in, and
download and start (WebLaunch) the AnyConnect client.
The AnyConnect client software offers the same set of client features, whether it is enabled by this
license or an AnyConnect Premium license.
The AnyConnect Essentials license cannot be active at the same time as the following licenses on a
given ASA: AnyConnect Premium license (all types) or the Advanced Endpoint Assessment license.
You can, however, run AnyConnect Essentials and AnyConnect Premium licenses on different ASAs
in the same network.
You can disable this license to use other licenses by using the webvpn, and then the no
anyconnect-essentials command or in ASDM, using the Configuration > Remote Access VPN >
Network (Client) Access > Advanced > AnyConnect Essentials pane.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
59
Supported Feature Licenses Per Model
License Notes
AnyConnect for Mobile
This license provides access to the AnyConnect Client for touch-screen mobile devices running
Windows Mobile 5.0, 6.0, and 6.1. We recommend using this license if you want to support mobile
access to AnyConnect 2.3 and later versions. This license requires activation of one of the following
licenses to specify the total number of SSL VPN sessions permitted: AnyConnect Essentials or
AnyConnect Premium.
Mobile Posture Support
Enforcing remote access controls and gathering posture data from mobile devices requires an
AnyConnect Mobile license and either an AnyConnect Essentials or AnyConnect Premium license to
be installed on the ASA. Here is the functionality you receive based on the license you install.
• AnyConnect Premium License Functionality
◦Enforce DAP policies on supported mobile devices based on DAP attributes and any other
existing endpoint attributes. This includes allowing or denying remote access from a mobile
device.
AnyConnect Premium
AnyConnect Premium sessions include the following VPN types:
• SSL VPN
• Clientless SSL VPN
• IPsec remote access VPN using IKEv2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
60
Supported Feature Licenses Per Model
License Notes
AnyConnect Plus and Apex The AnyConnect Plus or Apex license is a multi-use license that you can apply to multiple ASAs, all
of which share a user pool as specified by the license. See http://www.cisco.com/go/license, and assign
the PAK separately to each ASA. When you apply the resulting activation key to an ASA, it toggles
on the VPN features to the maximum allowed, but the actual number of unique users across all ASAs
sharing the license should not exceed the license limit. For more information, see:
• Cisco AnyConnect Ordering Guide
• AnyConnect Licensing Frequently Asked Questions (FAQ)
Note The AnyConnect Apex license is required for multiple context mode.
Botnet Traffic Filter Requires a Strong Encryption (3DES/AES) License to download the dynamic database.
Encryption The DES license cannot be disabled. If you have the 3DES license installed, DES is still available. To
prevent the use of DES when you want to only use strong encryption, be sure to configure any relevant
commands to use only strong encryption.
Interfaces of all types, Max. The maximum number of combined interfaces; for example, VLANs, physical, redundant, bridge
group, and EtherChannel interfaces. Every interface command defined in the configuration counts
against this limit. For example, both of the following interfaces count even if the GigabitEthernet 0/0
interface is defined as part of port-channel 1:
and
interface port-channel 1
IPS module The IPS module license lets you run the IPS software module on the ASA. You also need the IPS
signature subscription on the IPS side.
See the following guidelines:
• To buy the IPS signature subscription you need to have the ASA with IPS pre-installed (the part
number must include “IPS”, for example ASA5515-IPS-K9); you cannot buy the IPS signature
subscription for a non-IPS part number ASA.
• For failover, you need the IPS signature subscription on both units; this subscription is not shared
in failover, because it is not an ASA license.
• For failover, the IPS signature subscription requires a unique IPS module license per unit. Like
other ASA licenses, the IPS module license is technically shared in the failover cluster license.
However, because of the IPS signature subscription requirements, you must buy a separate IPS
module license for each unit in failover.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
61
Supported Feature Licenses Per Model
License Notes
Other VPN Other VPN sessions include the following VPN types:
• IPsec remote access VPN using IKEv1
• IPsec site-to-site VPN using IKEv1
• IPsec site-to-site VPN using IKEv2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
62
Supported Feature Licenses Per Model
License Notes
Total UC Proxy Sessions Each TLS proxy session for Encrypted Voice Inspection is counted against the UC license limit.
Other applications that use TLS proxy sessions do not count toward the UC limit, for example, Mobility
Advantage Proxy (which does not require a license.
Some UC applications might use multiple sessions for a connection. For example, if you configure a
phone with a primary and backup Cisco Unified Communications Manager, there are 2 TLS proxy
connections, so 2 UC Proxy sessions are used.
You independently set the TLS proxy limit using the tls-proxy maximum-sessions command or in
ASDM, using the Configuration > Firewall > Unified Communications > TLS Proxy pane. To
view the limits of your model, enter the tls-proxy maximum-sessions ? command. When you apply
a UC license that is higher than the default TLS proxy limit, the ASA automatically sets the TLS proxy
limit to match the UC limit. The TLS proxy limit takes precedence over the UC license limit; if you
set the TLS proxy limit to be less than the UC license, then you cannot use all of the sessions in your
UC license.
Note For license part numbers ending in “K8” (for example, licenses under 250 users), TLS proxy
sessions are limited to 1000. For license part numbers ending in “K9” (for example, licenses
250 users or larger), the TLS proxy limit depends on the configuration, up to the model limit.
K8 and K9 refer to whether the license is restricted for export: K8 is unrestricted, and K9 is
restricted.
If you clear the configuration (using the clear configure all command, for example), then
the TLS proxy limit is set to the default for your model; if this default is lower than the UC
license limit, then you see an error message to use the tls-proxy maximum-sessions command
to raise the limit again (in ASDM, use the TLS Proxy pane). If you use failover and enter
the write standby command or in ASDM, use File > Save Running Configuration to
Standby Unit on the primary unit to force a configuration synchronization, the clear configure
all command is generated on the secondary unit automatically, so you may see the warning
message on the secondary unit. Because the configuration synchronization restores the TLS
proxy limit set on the primary unit, you can ignore the warning.
You might also use SRTP encryption sessions for your connections:
• For K8 licenses, SRTP sessions are limited to 250.
• For K9 licenses, there is not limit.
Note Only calls that require encryption/decryption for media are counted toward the SRTP limit;
if passthrough is set for the call, even if both legs are SRTP, they do not count toward the
limit.
Virtual CPU You must install a model license on the ASAv that sets the appropriate number of vCPUs. Until you
install a license, throughput is limited to 100 Kbps so that you can perform preliminary connectivity
tests. A model license is required for regular operation.
VLANs, Maximum For an interface to count against the VLAN limit, you must assign a VLAN to it. For example:
VPN Load Balancing VPN load balancing requires a Strong Encryption (3DES/AES) License.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
63
About PAK Licenses
Preinstalled License
By default, your ASA ships with a license already installed. This license might be the Base License, to which
you want to add more licenses, or it might already have all of your licenses installed, depending on what you
ordered and what your vendor installed for you.
Related Topics
Monitoring PAK Licenses, on page 83
Permanent License
You can have one permanent activation key installed. The permanent activation key includes all licensed
features in a single key. If you also install time-based licenses, the ASA combines the permanent and time-based
licenses into a running license.
Related Topics
How Permanent and Time-Based Licenses Combine, on page 65
Time-Based Licenses
In addition to permanent licenses, you can purchase time-based licenses or receive an evaluation license that
has a time-limit. For example, you might buy a time-based AnyConnect Premium license to handle short-term
surges in the number of concurrent SSL VPN users, or you might order a Botnet Traffic Filter time-based
license that is valid for 1 year.
Note The ASA 5506-X and ASA 5506W-X do not support time-based licenses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
64
About PAK Licenses
Note Even when the permanent license is used, if the time-based license is active, it continues to count down.
Unified Communications The time-based license sessions are added to the permanent sessions, up to
Proxy Sessions the platform limit. For example, if the permanent license is 2500 sessions,
and the time-based license is 1000 sessions, then 3500 sessions are enabled
for as long as the time-based license is active.
Security Contexts The time-based license contexts are added to the permanent contexts, up to
the platform limit. For example, if the permanent license is 10 contexts, and
the time-based license is 20 contexts, then 30 contexts are enabled for as
long as the time-based license is active.
Botnet Traffic Filter There is no permanent Botnet Traffic Filter license available; the time-based
license is used.
All Others The higher value is used, either time-based or permanent. For licenses that
have a status of enabled or disabled, then the license with the enabled status
is used. For licenses with numerical tiers, the higher value is used. Typically,
you will not install a time-based license that has less capability than the
permanent license, but if you do so, then the permanent license is used.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
65
About PAK Licenses
Related Topics
Monitoring PAK Licenses, on page 83
Similarly:
1 You install an 8-week 1000-session AnyConnect Premium license, and use it for 2 weeks (6 weeks remain).
2 You then install another 8-week 1000-session license, and the licenses combine to be 1000-sessions for
14 weeks (8 weeks plus 6 weeks).
If the licenses are not identical (for example, a 1000-session AnyConnect Premium license vs. a 2500-session
license), then the licenses are not combined. Because only one time-based license per feature can be active,
only one of the licenses can be active.
Although non-identical licenses do not combine, when the current license expires, the ASA automatically
activates an installed license of the same feature if available.
Related Topics
Activate or Deactivate Keys, on page 75
Time-Based License Expiration, on page 66
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
66
About PAK Licenses
Related Topics
Activate or Deactivate Keys, on page 75
Note The shared license feature on the ASA is not supported with AnyConnect 4 and later licensing. AnyConnect
licenses are shared and no longer require a shared server or participant license.
A shared license lets you purchase a large number of AnyConnect Premium sessions and share the sessions
as needed among a group of ASAs by configuring one of the ASAs as a shared licensing server, and the rest
as shared licensing participants.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
67
About PAK Licenses
Note Each unit must have the same encryption license; each unit must have the same IPS module license.
You also need the IPS signature subscription on the IPS side for both units. See the following
guidelines:
• To buy the IPS signature subscription you need to have the ASA with IPS pre-installed (the
part number must include “IPS”, for example ASA5515-IPS-K9); you cannot buy the IPS
signature subscription for a non-IPS part number ASA.
• You need the IPS signature subscription on both units; this subscription is not shared in
failover, because it is not an ASA license.
• The IPS signature subscription requires a unique IPS module license per unit. Like other
ASA licenses, the IPS module license is technically shared in the failover cluster license.
However, because of the IPS signature subscription requirements, you must buy a separate
IPS module license for each unit in.
ASAv
• Active/Standby—Standard License.
• Active/Active—No Support.
Note The standby unit requires the same model license as the primary unit; Each unit must have the
same encryption license.
All other models Base License or Standard License.
Note Each unit must have the same encryption
license.
Note A valid permanent key is required; in rare instances, your PAK authentication key can be removed. If
your key consists of all 0’s, then you need to reinstall a valid authentication key before failover can be
enabled.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
68
About PAK Licenses
ASA on the Firepower See ASA Cluster for the FXOS Chassis, on page 339.
9300
Note In the above example, if the AnyConnect Premium licenses are time-based, you might
want to disable one of the licenses so that you do not “waste” a 500 session license from
which you can only use 250 sessions because of the platform limit.
◦You have two ASA 5545-X ASAs, one with 20 contexts and the other with 10 contexts; the
combined license allows 30 contexts. For Active/Active failover, the contexts are divided between
the two units. One unit can use 18 contexts and the other unit can use 12 contexts, for example,
for a total of 30.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
69
About PAK Licenses
• For licenses that have a status of enabled or disabled, then the license with the enabled status is used.
• For time-based licenses that are enabled or disabled (and do not have numerical tiers), the duration is
the combined duration of all licenses. The primary/master unit counts down its license first, and when
it expires, the secondary/slave unit(s) start counting down its license, and so on. This rule also applies
to Active/Active failover and ASA clustering, even though all units are actively operating.
For example, if you have 48 weeks left on the Botnet Traffic Filter license on two units, then the combined
duration is 96 weeks.
Related Topics
Monitoring PAK Licenses, on page 83
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
70
About PAK Licenses
• After 30 days—The time elapsed is subtracted from both units. In this case, communication is restored
after 6 weeks. Therefore, 6 weeks are subtracted from both the primary/master and secondary/slave
licenses, leaving 84 weeks combined (36 weeks on the primary/master, and 46 weeks on the
secondary/slave).
Related Topics
Activate or Deactivate Keys, on page 75
You can still install the Strong Encryption (3DES/AES) license for use with management connections. For
example, you can use ASDM HTTPS/SSL, SSHv2, Telnet and SNMPv3. You can also download the dynamic
database for the Botnet Traffic Filter (which uses SSL).
When you view the license, VPN and Unified Communications licenses will not be listed.
Related Topics
Monitoring PAK Licenses, on page 83
Licenses FAQ
Can I activate multiple time-based licenses, for example, AnyConnect Premium and Botnet Traffic
Filter?
Yes. You can use one time-based license per feature at a time.
Can I “stack” time-based licenses so that when the time limit runs out, it will automatically use the
next license?
Yes. For identical licenses, the time limit is combined when you install multiple time-based licenses.
For non-identical licenses (for example, a 1000-session AnyConnect Premium license and a 2500-session
license), the ASA automatically activates the next time-based license it finds for the feature.
Can I install a new permanent license while maintaining an active time-based license?
Yes. Activating a permanent license does not affect time-based licenses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
71
Guidelines for PAK Licenses
For failover, can I use a shared licensing server as the primary unit, and the shared licensing backup
server as the secondary unit?
No. The secondary unit has the same running license as the primary unit; in the case of the shared
licensing server, they require a server license. The backup server requires a participant license. The
backup server can be in a separate failover pair of two backup servers.
Do I need to buy the same licenses for the secondary unit in a failover pair?
No. Starting with Version 8.3(1), you do not have to have matching licenses on both units. Typically,
you buy a license only for the primary unit; the secondary unit inherits the primary license when it
becomes active. In the case where you also have a separate license on the secondary unit (for example,
if you purchased matching licenses for pre-8.3 software), the licenses are combined into a running
failover cluster license, up to the model limits.
Can I use a time-based or permanent AnyConnect Premium license in addition to a shared AnyConnect
Premium license?
Yes. The shared license is used only after the sessions from the locally installed license (time-based or
permanent) are used up.
Note On the shared licensing server, the permanent AnyConnect Premium license
is not used; you can however use a time-based license at the same time as the
shared licensing server license. In this case, the time-based license sessions
are available for local AnyConnect Premium sessions only; they cannot be
added to the shared licensing pool for use by participants.
Failover Guidelines
See Failover or ASA Cluster Licenses, on page 67.
Model Guidelines
• Smart Licensing is supported on the ASAv only.
• Shared licenses are not supported on the ASAv, ASA 5506-X, ASA 5508-X, and ASA 5516-X.
• The ASA 5506-X and ASA 5506W-X do not support time-based licenses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
72
Guidelines for PAK Licenses
• Downgrading to Version 8.1 or earlier—After you upgrade, if you activate additional feature licenses
that were introduced before 8.2, then the activation key continues to be compatible with earlier versions
if you downgrade. However if you activate feature licenses that were introduced in 8.2 or later, then the
activation key is not backwards compatible. If you have an incompatible license key, then see the
following guidelines:
◦If you previously entered an activation key in an earlier version, then the ASA uses that key (without
any of the new licenses you activated in Version 8.2 or later).
◦If you have a new system and do not have an earlier activation key, then you need to request a new
activation key compatible with the earlier version.
• Downgrading to Version 8.2 or earlier—Version 8.3 introduced more robust time-based key usage as
well as failover license changes:
◦If you have more than one time-based activation key active, when you downgrade, only the most
recently activated time-based key can be active. Any other keys are made inactive. If the last
time-based license is for a feature introduced in 8.3, then that license still remains the active license
even though it cannot be used in earlier versions. Reenter the permanent key or a valid time-based
key.
◦If you have mismatched licenses on a failover pair, then downgrading will disable failover. Even
if the keys are matching, the license used will no longer be a combined license.
◦If you have one time-based license installed, but it is for a feature introduced in 8.3, then after you
downgrade, that time-based license remains active. You need to reenter the permanent key to
disable the time-based license.
Additional Guidelines
• The activation key is not stored in your configuration file; it is stored as a hidden file in flash memory.
• The activation key is tied to the serial number of the device. Feature licenses cannot be transferred
between devices (except in the case of a hardware failure). If you have to replace your device due to a
hardware failure, and it is covered by Cisco TAC, contact the Cisco Licensing Team to have your existing
license transferred to the new serial number. The Cisco Licensing Team will ask for the Product
Authorization Key reference number and existing serial number.
• The serial number used for licensing is the one seen in the show version output. This serial number is
different from the chassis serial number printed on the outside of your hardware. The chassis serial
number is used for technical support, but not for licensing.
• Once purchased, you cannot return a license for a refund or for an upgraded license.
• On a single unit, you cannot add two separate licenses for the same feature together; for example, if you
purchase a 25-session SSL VPN license, and later purchase a 50-session license, you cannot use 75
sessions; you can use a maximum of 50 sessions. (You may be able to purchase a larger license at an
upgrade price, for example from 25 sessions to 75 sessions; this kind of upgrade should be distinguished
from adding two separate licenses together).
• Although you can activate all license types, some features are incompatible with each other. In the case
of the AnyConnect Essentials license, the license is incompatible with the following licenses: AnyConnect
Premium license, shared AnyConnect Premium license, and Advanced Endpoint Assessment license.
By default, if you install the AnyConnect Essentials license (if it is available for your model), it is used
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
73
Configure PAK Licenses
instead of the above licenses. You can disable the AnyConnect Essentials license in the configuration
to restore use of the other licenses using the webvpn, and then the no anyconnect-essentials command.
Procedure
Step 1 Obtain the serial number for your ASA by entering the following command.
ciscoasa# show version | grep Serial
Step 2 If you are not already registered with Cisco.com, create an account.
Step 3 Go to the following licensing website:
http://www.cisco.com/go/license
An activation key is automatically generated and sent to the e-mail address that you provide. This key includes
all features you have registered so far for permanent licenses. For time-based licenses, each license has a
separate activation key.
Step 5 If you have additional Product Authorization Keys, repeat the process for each Product Authorization Key.
After you enter all of the Product Authorization Keys, the final activation key provided includes all of the
permanent features you registered.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
74
Configure PAK Licenses
Procedure
Example:
ciscoasa# activation-key 0xd11b3d48 0xa80a4c0a 0x48e0fd1c 0xb0443480 0x843fc490
The key is a five-element hexadecimal string with one space between each element. The leading 0x specifier
is optional; all values are assumed to be hexadecimal.
You can install one permanent key, and multiple time-based keys. If you enter a new permanent key, it
overwrites the already installed one.
The activate and deactivate keywords are available for time-based keys only. If you do not enter any value,
activate is the default. The last time-based key that you activate for a given feature is the active one. To
deactivate any active time-based key, enter the deactivate keyword. If you enter a key for the first time, and
specify deactivate, then the key is installed on the ASA in an inactive state.
WARNING: The running activation key was not updated with the requested key.
The flash activation key was updated with the requested key, and will become
active after the next reload.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
75
Configure a Shared License (AnyConnect 3 and Earlier)
Related Topics
Time-Based Licenses, on page 64
Note The shared license feature on the ASA is not supported with AnyConnect 4 and later licensing. AnyConnect
licenses are shared and no longer require a shared server or participant license.
This section describes how to configure the shared licensing server and participants.
Note The shared licensing backup server only needs a participant license.
4 Configure a shared secret on the shared licensing server; any participants with the shared secret can use
the shared license.
5 When you configure the ASA as a participant, it registers with the shared licensing server by sending
information about itself, including the local license and model information.
Note The participant needs to be able to communicate with the server over the IP network; it does not have to
be on the same subnet.
6 The shared licensing server responds with information about how often the participant should poll the
server.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
76
Configure a Shared License (AnyConnect 3 and Earlier)
7 When a participant uses up the sessions of the local license, it sends a request to the shared licensing server
for additional sessions in 50-session increments.
8 The shared licensing server responds with a shared license. The total sessions used by a participant cannot
exceed the maximum sessions for the platform model.
Note The shared licensing server can also participate in the shared license pool. It does not need a participant
license as well as the server license to participate.
a If there are not enough sessions left in the shared license pool for the participant, then the server
responds with as many sessions as available.
b The participant continues to send refresh messages requesting more sessions until the server can
adequately fulfill the request.
9 When the load is reduced on a participant, it sends a message to the server to release the shared sessions.
Note The ASA uses SSL between the server and participant to encrypt all communications.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
77
Configure a Shared License (AnyConnect 3 and Earlier)
When the main server comes back up, it syncs with the backup server, and then takes over server operation.
When the backup server is not active, it acts as a regular participant of the main shared licensing server.
Note When you first launch the main shared licensing server, the backup server can only operate independently
for 5 days. The operational limit increases day-by-day, until 30 days is reached. Also, if the main server
later goes down for any length of time, the backup server operational limit decrements day-by-day. When
the main server comes back up, the backup server starts to increment again day-by-day. For example, if
the main server is down for 20 days, with the backup server active during that time, then the backup server
will only have a 10-day limit left over. The backup server “recharges” up to the maximum 30 days after
20 more days as an inactive backup. This recharging function is implemented to discourage misuse of the
shared license.
Note The backup server mechanism is separate from, but compatible with, failover.
Shared licenses are supported only in single context mode, so Active/Active failover is not supported.
For Active/Standby failover, the primary unit acts as the main shared licensing server, and the standby unit
acts as the main shared licensing server after failover. The standby unit does not act as the backup shared
licensing server. Instead, you can have a second pair of units acting as the backup server, if desired.
For example, you have a network with 2 failover pairs. Pair #1 includes the main licensing server. Pair #2
includes the backup server. When the primary unit from Pair #1 goes down, the standby unit immediately
becomes the new main licensing server. The backup server from Pair #2 never gets used. Only if both units
in Pair #1 go down does the backup server in Pair #2 come into use as the shared licensing server. If Pair #1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
78
Configure a Shared License (AnyConnect 3 and Earlier)
remains down, and the primary unit in Pair #2 goes down, then the standby unit in Pair #2 comes into use as
the shared licensing server (see the following figure).
The standby backup server shares the same operating limits as the primary backup server; if the standby unit
becomes active, it continues counting down where the primary unit left off.
Related Topics
About the Shared Licensing Backup Server, on page 77
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
79
Configure a Shared License (AnyConnect 3 and Earlier)
Procedure
Example:
ciscoasa(config)# license-server secret farscape
The secret is a string between 4 and 128 ASCII characters. Any participant with this secret can use the licensing
server.
Example:
ciscoasa(config)# license-server refresh-interval 100
The interval is between 10 and 300 seconds; this value is provided to participants to set how often they should
communicate with the server. The default is 30 seconds.
Step 3 (Optional) Set the port on which the server listens for SSL connections from participants:
license-server port port
Example:
ciscoasa(config)# license-server port 40000
The port is between 1 and 65535. The default is TCP port 50554.
Step 4 (Optional) Identify the backup server IP address and serial number:
license-server backup address backup-id serial_number [ha-backup-id ha_serial_number]
Example:
ciscoasa(config)# license-server backup 10.1.1.2 backup-id JMX0916L0Z4 ha-backup-id
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
80
Configure a Shared License (AnyConnect 3 and Earlier)
JMX1378N0W3
If the backup server is part of a failover pair, identify the standby unit serial number as well. You can only
identify 1 backup server and its optional standby unit.
Example:
ciscoasa(config)# license-server enable inside
Specify the interface on which participants contact the server. You can repeat this command for as many
interfaces as desired.
Examples
The following example sets the shared secret, changes the refresh interval and port, configures a backup server,
and enables this unit as the shared licensing server on the inside interface and dmz interface:
Procedure
Step 1 Identify the shared licensing server IP address and shared secret:
license-server address address secret secret [port port]
Example:
ciscoasa(config)# license-server address 10.1.1.1 secret farscape
If you changed the default port in the server configuration, set the port for the backup server to match.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
81
Configure a Shared License (AnyConnect 3 and Earlier)
Example:
ciscoasa(config)# license-server backup enable inside
Specify the interface on which participants contact the server. You can repeat this command for as many
interfaces as desired.
Examples
The following example identifies the license server and shared secret, and enables this unit as the backup
shared license server on the inside interface and dmz interface:
Procedure
Step 1 Identify the shared licensing server IP address and shared secret:
license-server address address secret secret [port port]
Example:
ciscoasa(config)# license-server address 10.1.1.1 secret farscape
If you changed the default port in the server configuration, set the port for the participant to match.
Step 2 (Optional) If you configured a backup server, enter the backup server address:
license-server backup address address
Example:
ciscoasa(config)# license-server backup address 10.1.1.2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
82
Monitoring PAK Licenses
Examples
The following example sets the license server IP address and shared secret, as well as the backup license
server IP address:
Procedure
Show the permanent license, active time-based licenses, and the running license, which is a combination of
the permanent license and active time-based licenses:
show activation-key [detail]
The detail keyword also shows inactive time-based licenses.
For failover or cluster units, this command also shows the “cluster” license, which is the combined keys of all
units.
Examples
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
83
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
84
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
Example 3: Primary Unit Output in a Failover Pair for show activation-key detail
The following is sample output from the show activation-key detail command for the primary failover unit
that shows:
• The primary unit license (the combined permanent license and time-based licenses).
• The “Failover Cluster” license, which is the combined licenses from the primary and secondary units.
This is the license that is actually running on the ASA. The values in this license that reflect the
combination of the primary and secondary licenses are in bold.
• The primary unit permanent license.
• The primary unit installed time-based licenses (active and inactive).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
85
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
Example 4: Secondary Unit Output in a Failover Pair for show activation-key detail
The following is sample output from the show activation-key detail command for the secondary failover
unit that shows:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
86
Monitoring PAK Licenses
• The secondary unit license (the combined permanent license and time-based licenses).
• The “Failover Cluster” license, which is the combined licenses from the primary and secondary units.
This is the license that is actually running on the ASA. The values in this license that reflect the
combination of the primary and secondary licenses are in bold.
• The secondary unit permanent license.
• The secondary installed time-based licenses (active and inactive). This unit does not have any time-based
licenses, so none display in this sample output.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
87
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
Example 5: Standalone Unit Output for the ASAv without a License for show activation-key
The following output for a deployed 1 vCPU ASAv shows a blank activation key, an Unlicensed status, and
a message to install a 1 vCPU license.
Note The command output shows, “This platform has an ASAv VPN Premium license.” This message specifies
that the ASAv can perform payload encryption; it does not refer to the ASAv Standard vs. Premium
licenses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
88
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
Example 6: Standalone Unit Output for the ASAv with a 4 vCPU Standard License for show activation-key
Note The command output shows, “This platform has an ASAv VPN Premium license.” This message specifies
that the ASAv can perform payload encryption; it does not refer to the ASAv Standard vs. Premium
licenses.
The flash permanent activation key is the SAME as the running permanent key.
Example 7: Standalone Unit Output for the ASAv with a 4 vCPU Premium License for show activation-key
Note The command output shows, “This platform has an ASAv VPN Premium license.” This message specifies
that the ASAv can perform payload encryption; it does not refer to the ASAv Standard vs. Premium
licenses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
89
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
ciscoasa#
Example 8: Primary Unit Output for the ASA Services Module in a Failover Pair for show activation-key
The following is sample output from the show activation-key command for the primary failover unit that
shows:
• The primary unit license (the combined permanent license and time-based licenses).
• The “Failover Cluster” license, which is the combined licenses from the primary and secondary units.
This is the license that is actually running on the ASA. The values in this license that reflect the
combination of the primary and secondary licenses are in bold.
• The primary unit installed time-based licenses (active and inactive).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
90
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
Example 9: Secondary Unit Output for the ASA Services Module in a Failover Pair for show activation-key
The following is sample output from the show activation-key command for the secondary failover unit that
shows:
• The secondary unit license (the combined permanent license and time-based licenses).
• The “Failover Cluster” license, which is the combined licenses from the primary and secondary units.
This is the license that is actually running on the ASA. The values in this license that reflect the
combination of the primary and secondary licenses are in bold.
• The secondary installed time-based licenses (active and inactive). This unit does not have any time-based
licenses, so none display in this sample output.
The flash permanent activation key is the SAME as the running permanent key.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
91
Monitoring PAK Licenses
The flash permanent activation key is the SAME as the running permanent key.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
92
Monitoring PAK Licenses
Available : 5000
Utilized : 0
This device:
Platform limit : 250
Current usage : 0
High usage : 0
Messages Tx/Rx/Error:
Registration : 0 / 0 / 0
Get : 0 / 0 / 0
Release : 0 / 0 / 0
Transfer : 0 / 0 / 0
The following is sample output from the show shared license detail command on the license server:
Device ID : ABCD
Address : 10.1.1.2
Registered : NO
HA peer ID : EFGH
Registered : NO
Messages Tx/Rx/Error:
Hello : 0 / 0 / 0
Sync : 0 / 0 / 0
Update : 0 / 0 / 0
Client Info:
Hostname : 5540-A
Device ID : XXXXXXXXXXX
SSLVPN:
Current usage : 0
High : 0
Messages Tx/Rx/Error:
Registration : 1 / 1 / 0
Get : 0 / 0 / 0
Release : 0 / 0 / 0
Transfer : 0 / 0 / 0
...
• show activation-key
Shows the licenses installed on the ASA. The show version command also shows license information.
• show vpn-sessiondb
Shows license information about VPN sessions.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
93
History for PAK Licenses
Increased SSL VPN Licenses 7.2(1) A 5000-user SSL VPN license was introduced for the ASA
5550 and above.
Increased interfaces for the Base license on the 7.2(2) For the Base license on the ASA 5510, the maximum number
ASA 5510 of interfaces was increased from 3 plus a management interface
to unlimited interfaces.
Increased VLANs 7.2(2) The maximum number of VLANs for the Security Plus license
on the ASA 5505 was increased from 5 (3 fully functional; 1
failover; one restricted to a backup interface) to 20 fully
functional interfaces. In addition, the number of trunk ports
was increased from 1 to 8. Now there are 20 fully functional
interfaces, you do not need to use the backup interface command
to cripple a backup ISP interface; you can use a fully functional
interface for it. The backup interface command is still useful
for an Easy VPN configuration.
VLAN limits were also increased for the ASA 5510 (from 10
to 50 for the Base license, and from 25 to 100 for the Security
Plus license), the ASA 5520 (from 100 to 150), the ASA 5550
(from 200 to 250).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
94
History for PAK Licenses
Advanced Endpoint Assessment License 8.0(2) The Advanced Endpoint Assessment license was introduced.
As a condition for the completion of a Cisco AnyConnect or
clientless SSL VPN connections, the remote computer scans
for a greatly expanded collection of antivirus and antispyware
applications, firewalls, operating systems, and associated
updates. It also scans for any registry entries, filenames, and
process names that you specify. It sends the scan results to the
ASA. The ASA uses both the user login credentials and the
computer scan results to assign a Dynamic Access Policy
(DAP).
With an Advanced Endpoint Assessment License, you can
enhance Host Scan by configuring an attempt to update
noncompliant computers to meet version requirements.
Cisco can provide timely updates to the list of applications and
versions that Host Scan supports in a package that is separate
from Cisco Secure Desktop.
VPN Load Balancing for the ASA 5510 8.0(2) VPN load balancing is now supported on the ASA 5510 Security
Plus license.
AnyConnect for Mobile License 8.0(3) The AnyConnect for Mobile license was introduced. It lets
Windows mobile devices connect to the ASA using the
AnyConnect client.
Increased VLANs for the ASA 5580 8.1(2) The number of VLANs supported on the ASA 5580 are
increased from 100 to 250.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
95
History for PAK Licenses
Botnet Traffic Filter License 8.2(1) The Botnet Traffic Filter license was introduced. The Botnet
Traffic Filter protects against malware network activity by
tracking connections to known bad domains and IP addresses.
AnyConnect Essentials License 8.2(1) The AnyConnect Essentials License was introduced. This
license enables AnyConnect VPN client access to the ASA.
This license does not support browser-based SSL VPN access
or Cisco Secure Desktop. For these features, activate an
AnyConnect Premium license instead of the AnyConnect
Essentials license.
Note With the AnyConnect Essentials license, VPN users
can use a Web browser to log in, and download and
start (WebLaunch) the AnyConnect client.
The AnyConnect client software offers the same set of client
features, whether it is enabled by this license or an AnyConnect
Premium license.
The AnyConnect Essentials license cannot be active at the same
time as the following licenses on a given ASA: AnyConnect
Premium license (all types) or the Advanced Endpoint
Assessment license. You can, however, run AnyConnect
Essentials and AnyConnect Premium licenses on different ASAs
in the same network.
By default, the ASA uses the AnyConnect Essentials license,
but you can disable it to use other licenses by using the webvpn,
and then the no anyconnect-essentials command.
SSL VPN license changed to AnyConnect Premium 8.2(1) The SSL VPN license name was changed to the AnyConnect
SSL VPN Edition license Premium SSL VPN Edition license.
Shared Licenses for SSL VPN 8.2(1) Shared licenses for SSL VPN were introduced. Multiple ASAs
can share a pool of SSL VPN sessions on an as-needed basis.
Mobility Proxy application no longer requires 8.2(2) The Mobility Proxy no longer requires the UC Proxy license.
Unified Communications Proxy license
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
96
History for PAK Licenses
Stackable time-based licenses 8.3(1) Time-based licenses are now stackable. In many cases, you
might need to renew your time-based license and have a
seamless transition from the old license to the new one. For
features that are only available with a time-based license, it is
especially important that the license not expire before you can
apply the new license. The ASA allows you to stack time-based
licenses so that you do not have to worry about the license
expiring or about losing time on your licenses because you
installed the new one early.
Intercompany Media Engine License 8.3(1) The IME license was introduced.
Multiple time-based licenses active at the same 8.3(1) You can now install multiple time-based licenses, and have one
time license per feature active at a time.
We modified the following commands: show activation-key
and show version.
Discrete activation and deactivation of time-based 8.3(1) You can now activate or deactivate time-based licenses using
licenses. a command.
We modified the following commands: activation-key [activate
| deactivate].
AnyConnect Premium SSL VPN Edition license 8.3(1) The AnyConnect Premium SSL VPN Edition license name was
changed to AnyConnect Premium SSL VPN license changed to the AnyConnect Premium SSL VPN license.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
97
History for PAK Licenses
Increased VLANs for the ASA 5580 and 5585-X 8.4(1) For the ASA 5580 and 5585-X, the maximum VLANs was
increased from 250 to 1024.
Increased connections for the ASA 5580 and 8.4(1) We increased the firewall connection limits:
5585-X
• ASA 5580-20—1,000,000 to 2,000,000.
• ASA 5580-40—2,000,000 to 4,000,000.
• ASA 5585-X with SSP-10: 750,000 to 1,000,000.
• ASA 5585-X with SSP-20: 1,000,000 to 2,000,000.
• ASA 5585-X with SSP-40: 2,000,000 to 4,000,000.
• ASA 5585-X with SSP-60: 2,000,000 to 10,000,000.
AnyConnect Premium SSL VPN license changed 8.4(1) The AnyConnect Premium SSL VPN license name was changed
to AnyConnect Premium license to the AnyConnect Premium license. The license information
display was changed from “SSL VPN Peers” to “AnyConnect
Premium Peers.”
Increased AnyConnect VPN sessions for the ASA 8.4(1) The AnyConnect VPN session limit was increased from 5,000
5580 to 10,000.
Increased Other VPN sessions for the ASA 5580 8.4(1) The other VPN session limit was increased from 5,000 to
10,000.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
98
History for PAK Licenses
No Payload Encryption hardware for export 8.4(1) For models available with No Payload Encryption (for example,
the ASA 5585-X), the ASA software disables Unified
Communications and VPN features, making the ASA available
for export to certain countries.
Dual SSPs for SSP-20 and SSP-40 8.4(2) For SSP-40 and SSP-60, you can use two SSPs of the same
level in the same chassis. Mixed-level SSPs are not supported
(for example, an SSP-40 with an SSP-60 is not supported).
Each SSP acts as an independent device, with separate
configurations and management. You can use the two SSPs as
a failover pair if desired. When using two SSPs in the chassis,
VPN is not supported; note, however, that VPN has not been
disabled.
IPS Module license for the ASA 5512-X through 8.6(1) The IPS SSP software module on the ASA 5512-X, ASA
ASA 5555-X 5515-X, ASA 5525-X, ASA 5545-X, and ASA 5555-X requires
the IPS module license.
Clustering license for the ASA 5580 and ASA 9.0(1) A clustering license was added for the ASA 5580 and ASA
5585-X. 5585-X.
Support for VPN on the ASASM 9.0(1) The ASASM now supports all VPN features.
Unified communications support on the ASASM 9.0(1) The ASASM now supports all Unified Communications
features.
ASA 5585-X Dual SSP support for the SSP-10 and 9.0(1) The ASA 5585-X now supports dual SSPs using all SSP models
SSP-20 (in addition to the SSP-40 and SSP-60); (you can use two SSPs of the same level in the same chassis).
VPN support for Dual SSPs VPN is now supported when using dual SSPs.
ASA 5500-X support for clustering 9.1(4) The ASA 5512-X, ASA 5515-X, ASA 5525-X, ASA 5545-X,
and ASA 5555-X now support 2-unit clusters. Clustering for 2
units is enabled by default in the base license; for the ASA
5512-X, you need the Security Plus license.
Support for 16 cluster members for the ASA 9.2(1) The ASA 5585-X now supports 16-unit clusters.
5585-X
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
99
History for PAK Licenses
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
100
CHAPTER 4
Smart Software Licensing for the ASAv and ASA
on the FXOS Chassis
Cisco Smart Software Licensing lets you purchase and manage a pool of licenses centrally. Unlike product
authorization key (PAK) licenses, smart licenses are not tied to a specific serial number. You can easily
deploy or retire ASAs without having to manage each unit’s license key. Smart Software Licensing also lets
you see your license usage and needs at a glance.
Note Smart Software Licensing is only supported on the ASAv and the Firepower ASA application. Other
models use PAK licenses. See Product Authorization Key Licenses, on page 45.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
101
Licenses Per Model
Carrier Enabled
VPN Licenses
General Licenses
Encryption Base (DES) or Strong (3DES/AES), depending on the account's export compliance setting
Failover Active/Standby
Clustering No support
VLANs, Maximum 25
ASAv10
The following table shows the licensed features for the ASAv10.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
102
Licenses Per Model
VPN Licenses
AnyConnect peers Disabled Optional AnyConnect Plus or Apex license: 250 maximum
General Licenses
Encryption Base (DES) or Strong (3DES/AES), depending on the account's export compliance setting
Failover Active/Standby
Clustering No support
VLANs, Maximum 50
ASAv30
The following table shows the licensed features for the ASAv30.
Carrier Enabled
VPN Licenses
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
103
Licenses Per Model
General Licenses
Encryption Base (DES) or Strong (3DES/AES), depending on the account's export compliance setting
Failover Active/Standby
Clustering No support
VPN Licenses
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
104
Licenses Per Model
General Licenses
Encryption Base (DES) or Strong (3DES/AES), depending on the account's export compliance setting
Clustering Enabled
License Notes
The following table includes additional information about licenses.
License Notes
AnyConnect Plus and Apex The AnyConnect Plus or Apex license is a multi-use license that you can apply to multiple ASAs, all
of which share a user pool as specified by the license. For more information, see:
• Cisco AnyConnect Ordering Guide
• AnyConnect Licensing Frequently Asked Questions (FAQ)
Note The AnyConnect Apex license is required for multiple context mode.
Botnet Traffic Filter Requires a Strong Encryption (3DES/AES) License to download the dynamic database.
Encryption The DES license cannot be disabled. Although the 3DES license is installed, DES is still available.
To prevent the use of DES when you want to only use strong encryption, be sure to configure any
relevant commands to use only strong encryption.
Interfaces of all types, Max. The maximum number of combined interfaces; for example, VLANs, physical, redundant, bridge
group, and EtherChannel interfaces. Every interface command defined in the configuration counts
against this limit. For example, both of the following interfaces count even if the GigabitEthernet 0/0
interface is defined as part of port-channel 1:
and
interface port-channel 1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
105
About Smart Software Licensing
License Notes
Carrier The Carrier license enables the following inspection features:
• Diameter
• GTP/GPRS
• SCTP
Other VPN Other VPN sessions include the following VPN types:
• IPsec remote access VPN using IKEv1
• IPsec site-to-site VPN using IKEv1
• IPsec site-to-site VPN using IKEv2
VLANs, Maximum For an interface to count against the VLAN limit, you must assign a VLAN to it. For example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
106
About Smart Software Licensing
Note If you do not yet have an account, click the link to set up a new account. The Smart Software Manager
lets you create a master account for your organization.
By default, your licenses are assigned to the Default Virtual Account under your master account. As the
account administrator, you can optionally create additional virtual accounts; for example, you can create
accounts for regions, departments, or subsidiaries. Multiple virtual accounts let you more easily manage large
numbers of licenses and devices.
If you later want to change the model level of a unit, you will have to return the current license and request a
new license at the correct model level.
If you stop using a license, you must return the license by generating a return code on the ASAv, and then
entering that code into the Smart Software Manager. Make sure you follow the return process correctly so
you do not pay for unused licenses.
Permanent license reservation is not supported for Amazon Web Services or Azure hypervisors.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
107
About Smart Software Licensing
needs to connect periodically to the main License Authority to sync your license usage. You can sync on a
schedule or you can sync manually.
See the FXOS chassis configuration guide for more information about using a satellite.
Note You cannot receive an evaluation license for Strong Encryption (3DES/AES); only
permanent licenses support this entitlement.
Note Device registration is configured in the FXOS chassis supervisor, not on the ASA security module.
At startup after deployment, or after you manually configure these parameters on an existing device, the device
registers with the Cisco License Authority. When the device registers with the token, the License Authority
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
108
About Smart Software Licensing
issues an ID certificate for communication between the device and the License Authority. This certificate is
valid for 1 year, although it will be renewed every 6 months.
Out-of-Compliance State
The device can become out of compliance in the following situations:
• Over-utilization—When the device uses unavailable licenses.
• License expiration—When a time-based license expires.
• Lack of communication—When the device cannot reach the Licensing Authority for re-authorization.
To verify whether your account is in, or approaching, an Out-of-Compliance state, you must compare the
entitlements currently in use by your FXOS chassis against those in your Smart Account.
After 90 days of reauthorization attempts, the device will be limited in some way, depending on the application.
• ASAv—The ASAv will be severely rate-limited until you are able to successfully reauthorize.
• ASA on the FXOS chassis—You will not be able to make configuration changes to features requiring
special licenses, but operation is otherwise unaffected.
Note For the FXOS chassis, Smart Call Home for licensing is configured in the FXOS chassis supervisor, not
on the ASA.
You cannot disable Smart Call Home for Smart Software Licensing. For example, even if you disable Smart
Call Home using the no service call-home command, Smart Software Licensing is not disabled.
Other Smart Call Home functions are not turned on unless you specifically configure them.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
109
About Smart Software Licensing
ASA on the FXOS chassis Each unit must have the same encryption license.
ASA Cluster License Requirements and Exceptions (ASA on the FXOS Chassis Only)
When you configure smart licensing on the primary unit, the license configuration for the Standard license
and the Context license are replicated to the secondary units, and then cached. Only the primary unit requests
these entitlements; each secondary unit caches the configuration in case it becomes the primary unit in the
future, and then needs to activate the licenses. Other entitlements, including the Carrier license and the Strong
Encryption (3DES) license (for a Cisco Smart Software Manager satellite deployment), are per-unit entitlements
that are replicated to the secondary units, and in this case, each secondary unit requests its own licenses from
the server.
If a new primary unit is elected, you should refrain from making configuration changes until the license
requests are completely processed. If a unit leaves the cluster, the cached configuration is removed, while the
per-unit entitlements are retained. In particular, you would need to re-request the Context license on non-cluster
units.
For Smart Software Manager satellite deployments, to use ASDM and other strong encryption features, after
you deploy the cluster you must enable the Strong Encryption (3DES) license on the primary unit using the
ASA CLI. This license is replicated to the secondary units. For regular Smart Software Manager users, the
Strong Encryption license is automatically enabled for qualified customers when you apply the registration
token on the FXOS chassis. The Strong Encryption (3DES) license is not available with any type of evaluation
license.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
110
Prerequisites for Smart Software Licensing
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
111
Guidelines for Smart Software Licensing
call-home
profile License
destination address http
https://tools.cisco.com/its/service/oddce/services/DDCEService
• When you deploy the ASAv, you set the feature tier and throughput level. Only the standard level is
available at this time. For permanent license reservation, you do not need to set these parameters. When
you enable permanent license reservation, these command are removed from the configuration.
license smart
feature tier standard
throughput level {100M | 1G | 2G}
call-home
http-proxy ip_address port port
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
112
Configure Smart Software Licensing
Note For ASAv permanent license reservation, see ASAv: Configure Permanent License Reservation, on page
115.
For the ASA on the FXOS chassis, see ASA on the FXOS Chassis: Configure Smart Software Licensing,
on page 118.
Procedure
Step 1 (Optional) Configure the HTTP Proxy on the ASAv, on page 113.
Step 2 Set the ASAv Smart License Entitlement, on page 113.
Step 3 Register the ASAv with the License Authority, on page 114.
Procedure
Example:
ciscoasa(config)# call-home
ciscoasa(cfg-call-home)# http-proxy 10.1.1.1 port 443
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
113
Configure Smart Software Licensing
Example:
ciscoasa(config)# license smart
ciscoasa(config-smart-lic)#
Example:
ciscoasa(config-smart-lic)# throughput level 2G
Example:
ciscoasa(config-smart-lic)# exit
ciscoasa(config)#
Your changes do not take effect until you exit the license smart configuration mode, either by explicitly exiting
the mode (exit or end) or by entering any command that takes you to a different mode.
Procedure
Step 1 In the Smart Software Manager, request and copy a registration token for the virtual account to which you
want to add this ASAv.
Step 2 Enter the registration token on the ASAv:
license smart register idtoken id_token [force]
Example:
ciscoasa# license smart register idtoken YjE3Njc5MzYtMGQzMi00OTA4
LWJhODItNzBhMGQ5NGRlYjUxLTE0MTQ5NDAy%0AODQzNzl8NXk2bzV3SDE0ZkgwQk
dYRmZ1NTNCNGlvRnBHUFpjcm02WTB4TU4w%0Ac2NnMD0%3D%0A
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
114
Configure Smart Software Licensing
Use the force keyword to register an ASAv that is already registered, but that might be out of sync with the
License Authority. For example, use force if the ASAv was accidentally removed from the Smart Software
Manager.
The ASAv attempts to register with the License Authority and request authorization for the configured license
entitlements.
Procedure
Procedure
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
115
Configure Smart Software Licensing
Note For permanent license reservation, you must return the license before you decommission the ASAv. If
you do not officially return the license, the license remains in a used state and cannot be reused for a new
ASAv. See (Optional) Return the ASAv Permanent License, on page 117.
Procedure
Example:
ciscoasa (config)# license smart reservation
ciscoasa (config)#
license smart
feature tier standard
throughput level {100M | 1G | 2G}
To use regular smart licensing, use the no form of this command, and re-enter the above commands. Other
Smart Call Home configuration remains intact but unused, so you do not need to re-enter those commands.
Step 2 Request the license code to enter in the Smart Software Manager:
license smart reservation request universal
Example:
ciscoasa# license smart reservation request universal
Enter this request code in the Cisco Smart Software Manager portal:
ABP:ASAv,S:9AU5ET6UQHD{A8ug5/1jRDaSp3w8uGlfeQ{53C13E
ciscoasa#
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
116
Configure Smart Software Licensing
Step 3 Go to the Smart Software Manager Inventory screen, and click the Licenses tab:
https://software.cisco.com/#SmartLicensing-Inventory
The Licenses tab displays all existing licenses related to your account, both regular and permanent.
Step 4 Click License Reservation, and type the ASAv code into the box. Click Reserve License.
The Smart Software Manager generates an authorization code. You can download the code or copy it to the
clipboard. At this point, the license is now in use according to the Smart Software Manager.
If you do not see the License Reservation button, then your account is not authorized for permanent license
reservation. In this case, you should disable permanent license reservation and re-enter the regular smart
license commands.
Example:
ciscoasa# license smart reservation install AAu3431rGRS00Ig5HQl2vpzg{MEYCIQCBw$
ciscoasa#
Procedure
Example:
ciscoasa# license smart reservation return
Enter this return code in the Cisco Smart Software Manager portal:
Au3431rGRS00Ig5HQl2vpcg{uXiTRfVrp7M/zDpirLwYCaq8oSv60yZJuFDVBS2QliQ=
The ASAv immediately becomes unlicensed and moves to the Evaluation state. If you need to view this code
again, re-enter this command. Note that if you request a new permanent license (license smart reservation
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
117
Configure Smart Software Licensing
request universal) or change the ASAv model level (by powering down and changing the vCPUs/RAM),
then you cannot re-display this code. Be sure to capture the code to complete the return.
Step 2 View the ASAv universal device identifier (UDI) so you can find this ASAv instance in the Smart Software
Manager:
show license udi
Example:
ciscoasa# show license udi
UDI: PID:ASAv,SN:9AHV3KJBEKE
ciscoasa#
Step 3 Go to the Smart Software Manager Inventory screen, and click the Product Instances tab:
https://software.cisco.com/#SmartLicensing-Inventory
The Product Instances tab displays all licensed products by the UDI.
Step 4 Find the ASAv you want to unlicense, choose Actions > Remove, and type the ASAv return code into the
box. Click Remove Product Instance.
The permanent license is returned to the available pool.
Note For Smart Software Manager satellite users: The Strong Encryption (3DES/AES) license is not enabled
by default so you cannot use ASDM to configure your ASA until you request the Strong Encryption license
using the ASA CLI. Other strong encryption features are also not available until you do so, including
VPN.
Note For the ASAv, see ASAv: Configure Regular Smart Software Licensing, on page 113.
Procedure
Step 1 For CLI users and for satellite server ASDM users: Connect to the FXOS chassis CLI (console or SSH), and
then session to the ASA:
connect module slot console connect asa
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
118
Configure Smart Software Licensing
Example:
Firepower> connect module 1 console
Firepower-module1> connect asa
asa>
The next time you connect to the ASA console, you go directly to the ASA; you do not need to enter connect
asa again.
For an ASA cluster, you only need to access the master unit for license configuration and other configuration.
Typically, the master unit is in slot 1, so you should connect to that module first.
Step 2 At the ASA CLI, enter global configuration mode. By default, the enable password is blank.
enable configure terminal
Example:
asa> enable
Password:
asa# configure terminal
asa(config)#
Step 3 If required, for an ASA cluster confirm that this unit is the primary unit:
show cluster info
Example:
asa(config)# show cluster info
Cluster stbu: On
This is "unit-1-1" in state SLAVE
ID : 0
Version : 9.5(2)
Serial No.: P3000000025
CCL IP : 127.2.1.1
CCL MAC : 000b.fcf8.c192
Last join : 17:08:59 UTC Sep 26 2015
Last leave: N/A
Other members in the cluster:
Unit "unit-1-2" in state SLAVE
ID : 1
Version : 9.5(2)
Serial No.: P3000000001
CCL IP : 127.2.1.2
CCL MAC : 000b.fcf8.c162
Last join : 19:13:11 UTC Sep 23 2015
Last leave: N/A
Unit "unit-1-3" in state MASTER
ID : 2
Version : 9.5(2)
Serial No.: JAB0815R0JY
CCL IP : 127.2.1.3
CCL MAC : 000f.f775.541e
Last join : 19:13:20 UTC Sep 23 2015
Last leave: N/A
If a different unit is the primary unit, exit the connection and connect to the correct unit. See below for
information about exiting the connection.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
119
Monitoring Smart Software Licensing
Example:
ciscoasa(config)# license smart
ciscoasa(config-smart-lic)#
Example:
ciscoasa(config-smart-lic)# feature carrier
ciscoasa(config-smart-lic)# feature context 50
Step 7 To exit the ASA console, enter ~ at the prompt to exit to the Telnet application. Enter quit to exit back to the
supervisor CLI.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
120
Monitoring Smart Software Licensing
Registration:
Status: REGISTERED
Smart Account: ASA
Virtual Account: ASAv Internal Users
Export-Controlled Functionality: Not Allowed
Initial Registration: SUCCEEDED on Sep 21 20:26:29 2015 UTC
Last Renewal Attempt: None
Next Renewal Attempt: Mar 19 20:26:28 2016 UTC
Registration Expires: Sep 20 20:23:25 2016 UTC
License Authorization:
Status: AUTHORIZED on Sep 21 21:17:35 2015 UTC
Last Communication Attempt: SUCCEEDED on Sep 21 21:17:35 2015 UTC
Next Communication Attempt: Sep 24 00:44:10 2015 UTC
Communication Deadline: Dec 20 21:14:33 2015 UTC
License Usage
==============
regid.2014-08.com.cisco.ASAv-STD-1G,1.0_4fd3bdbd-29ae-4cce-ad82-45ad3db1070c
(ASAv-STD-1G):
Description: This entitlement tag was created via Alpha Extension application
Count: 1
Version: 1.0
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
121
Monitoring Smart Software Licensing
Status: AUTHORIZED
Product Information
===================
UDI: PID:ASAv,SN:9AHV3KJBEKE
Agent Version
=============
Smart Agent for Licensing: 1.6_reservation/36
Registration:
Status: REGISTERED
Smart Account: ASA
Virtual Account: ASAv Internal Users
Export-Controlled Functionality: Not Allowed
Initial Registration: SUCCEEDED on Sep 21 20:26:29 2015 UTC
Last Renewal Attempt: None
Next Renewal Attempt: Mar 19 20:26:28 2016 UTC
Registration Expires: Sep 20 20:23:25 2016 UTC
License Authorization:
Status: AUTHORIZED on Sep 23 01:41:26 2015 UTC
Last Communication Attempt: SUCCEEDED on Sep 23 01:41:26 2015 UTC
Next Communication Attempt: Oct 23 01:41:26 2015 UTC
Communication Deadline: Dec 22 01:38:25 2015 UTC
The following example shows the status for an ASAv using permanent license reservation:
Registration:
Status: REGISTERED - UNIVERSAL LICENSE RESERVATION
Export-Controlled Functionality: Allowed
Initial Registration: SUCCEEDED on Jan 28 16:42:45 2016 UTC
License Authorization:
Status: AUTHORIZED - RESERVED on Jan 28 16:42:45 2016 UTC
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
122
Monitoring Smart Software Licensing
Registration:
Status: REGISTERED
Smart Account: ASA
Virtual Account: ASAv Internal Users
Export-Controlled Functionality: Not Allowed
Last Renewal Attempt: None
Next Renewal Attempt: Mar 19 20:26:29 2016 UTC
License Authorization:
Status: AUTHORIZED
Last Communication Attempt: SUCCEEDED
Next Communication Attempt: Oct 23 01:41:26 2015 UTC
License Usage:
License Entitlement tag Count Status
-----------------------------------------------------------------------------
regid.2014-08.com.ci... (ASAv-STD-1G) 1 AUTHORIZED
The following example shows the summary for an ASAv using permanent license reservation:
Registration:
Status: REGISTERED - UNIVERSAL LICENSE RESERVATION
Export-Controlled Functionality: Allowed
License Authorization:
Status: AUTHORIZED - RESERVED
License Authorization:
Status: AUTHORIZED on Sep 23 01:41:26 2015 UTC
regid.2014-08.com.cisco.ASAv-STD-1G,1.0_4fd3bdbd-29ae-4cce-ad82-45ad3db1070c
(ASAv-STD-1G):
Description: This entitlement tag was created via Alpha Extension application
Count: 1
Version: 1.0
Status: AUTHORIZED
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
123
History for Smart Software Licensing
Cisco Smart Software Licensing for the ASA on 9.4(1.150) We introduced Smart Software Licensing for the ASA on the
the Firepower 9300 Firepower 9300.
We introduced the following commands: feature
strong-encryption, feature mobile-sp, feature context
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
124
History for Smart Software Licensing
New Carrier license 9.5(2) The new Carrier license replaces the existing GTP/GPRS
license, and also includes support for SCTP and Diameter
inspection. For the ASA on the Firepower 9300, the feature
mobile-sp command will automatically migrate to the feature
carrier command.
We introduced or modified the following commands: feature
carrier, show activation-key, show license, show
tech-support, show version
Strong Encryption (3DES) license automatically 9.5(2.1) For regular Cisco Smart Software Manager users, the Strong
applied for the ASA on the Firepower 9300 Encryption license is automatically enabled for qualified
customers when you apply the registration token on the
Firepower 9300.
Note If you are using the Smart Software Manager satellite
deployment, to use ASDM and other strong encryption
features, after you deploy the ASA you must enable
the Strong Encryption (3DES) license using the ASA
CLI.
This feature requires FXOS 1.1.3.
We removed the following command for non-satellite
configurations: feature strong-encryption
Permanent License Reservation for the ASAv 9.5(2.200) For highly secure environments where communication with the
Cisco Smart Software Manager is not allowed, you can request
a permanent license for the ASAv.
We introduced the following commands: license smart
reservation, license smart reservation cancel, license smart
reservation install, license smart reservation request
universal, license smart reservation return
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
125
History for Smart Software Licensing
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
126
CHAPTER 5
Transparent or Routed Firewall Mode
This chapter describes how to set the firewall mode to routed or transparent, as well as how the firewall
works in each firewall mode. This chapter also includes information about customizing the transparent
firewall operation.
You can set the firewall mode independently for each context in multiple context mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
127
About the Firewall Mode
Bridge Groups
The inside and outside interfaces for the transparent firewall are grouped together into a bridge group. You
can create multiple bridge groups for separate networks. Bridge group traffic is isolated from other bridge
groups; traffic is not routed to another bridge group within the ASA, and traffic must exit the ASA before it
is routed by an external router back to another bridge group in the ASA. Although the bridging functions are
separate for each bridge group, many other functions are shared between all bridge groups. For example, all
bridge groups share a syslog server or AAA server configuration. For complete security policy separation,
use security contexts with one bridge group in each context.
You can include multiple interfaces per bridge group. See Guidelines for Firewall Mode, on page 133 for the
exact number of bridge groups and interfaces supported. If you use more than 2 interfaces per bridge group,
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
128
About the Firewall Mode
you can control communication between multiple segments on the same network, and not just between inside
and outside. For example, if you have three inside segments that you do not want to communicate with each
other, you can put each segment on a separate interface, and only allow them to communicate with the outside
interface. Or you can customize the access rules between interfaces to allow only as much access as desired.
The following figure shows two networks connected to the ASA, which has two bridge groups.
Note Each bridge group requires a management IP address that you assign to the BVI interface. The ASA uses
this IP address as the source address for packets originating from the bridge group. The management IP
address must be on the same subnet as the connected network. For another method of management, see
Management Interface, on page 129.
The ASA does not support traffic on secondary networks; only traffic on the same network as the
management IP address is supported.
Management Interface
In addition to each bridge group management IP address, you can add a separate Management slot/port
interface that is not part of any bridge group, and that allows only management traffic to the ASA. For more
information, see Management Interface, on page 384.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
129
About the Firewall Mode
• For Layer 3 traffic traveling from a low to a high security interface, an access rule is required on the
low security interface.
• ARPs are allowed through the transparent firewall in both directions without an access rule. ARP traffic
can be controlled by ARP inspection.
• IPv6 neighbor discovery and router solicitation packets can be passed using access rules.
• Broadcast and multicast traffic can be passed using access rules.
Note The transparent mode firewall does not pass CDP packets packets, or any packets that do not have a valid
EtherType greater than or equal to 0x600. An exception is made for BPDUs and IS-IS, which are supported.
BPDU Handling
To prevent loops using the Spanning Tree Protocol, BPDUs are passed by default.To block BPDUs, you need
to configure an EtherType rule to deny them. If you are using failover, you might want to block BPDUs to
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
130
About the Firewall Mode
prevent the switch port from going into a blocking state when the topology changes. See Transparent Firewall
Mode Requirements for Failover, on page 209 for more information.
ARP Inspection
By default, all ARP packets are allowed through the ASA when running in transparent mode. You can control
the flow of ARP packets by enabling ARP inspection.
ARP inspection prevents malicious users from impersonating other hosts or routers (known as ARP spoofing).
ARP spoofing can enable a “man-in-the-middle” attack. For example, a host sends an ARP request to the
gateway router; the gateway router responds with the gateway router MAC address. The attacker, however,
sends another ARP response to the host with the attacker MAC address instead of the router MAC address.
The attacker can now intercept all the host traffic before forwarding it on to the router.
ARP inspection ensures that an attacker cannot send an ARP response with the attacker MAC address, so
long as the correct MAC address and the associated IP address are in the static ARP table.
When you enable ARP inspection, the ASA compares the MAC address, IP address, and source interface in
all ARP packets to static entries in the ARP table, and takes the following actions:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
131
Default Settings
• If the IP address, MAC address, and source interface match an ARP entry, the packet is passed through.
• If there is a mismatch between the MAC address, the IP address, or the interface, then the ASA drops
the packet.
• If the ARP packet does not match any entries in the static ARP table, then you can set the ASA to either
forward the packet out all interfaces (flood), or to drop the packet.
Note The dedicated Management interface never floods packets even if this parameter is set
to flood.
Default Settings
Default Mode
The default mode is routed mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
132
Guidelines for Firewall Mode
See Guidelines for Routed and Transparent Mode Interfaces, on page 434 for more guidelines.
IPv6 Guidelines
Supports IPv6.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
133
Set the Firewall Mode
Feature Description
Dynamic DNS —
DHCP relay The transparent firewall can act as a DHCP server, but it does not support
the DHCP relay commands. DHCP relay is not required because you can
allow DHCP traffic to pass through using two extended ACLs: one that
allows DCHP requests from the inside interface to the outside, and one
that allows the replies from the server in the other direction.
Dynamic routing protocols You can, however, add static routes for traffic originating on the ASA.
You can also allow dynamic routing protocols through the ASA using an
extended ACL.
Multicast IP routing You can allow multicast traffic through the ASA by allowing it in an
extended ACL.
QoS —
VPN termination for through The transparent firewall supports site-to-site VPN tunnels for management
traffic connections only. It does not terminate VPN connections for traffic through
the ASA. You can pass VPN traffic through the ASA using an extended
ACL, but it does not terminate non-management connections. Clientless
SSL VPN is also not supported.
Unified Communications —
Note We recommend that you set the firewall mode before you perform any other configuration because changing
the firewall mode clears the running configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
134
Configure ARP Inspection for the Transparent Firewall
• Use the CLI at the console port to change the mode. If you use any other type of session, including the
ASDM Command Line Interface tool or SSH, you will be disconnected when the configuration is cleared,
and you will have to reconnect to the ASA using the console port in any case.
• Set the mode within the context.
Note To set the firewall mode to transparent and also configure ASDM management access after the configuration
is cleared, see Configure ASDM Access, on page 25.
Procedure
Example:
ciscoasa(config)# firewall transparent
Procedure
Step 1 Add static ARP entries according to Add a Static ARP Entry, on page 135. ARP inspection compares ARP
packets with static ARP entries in the ARP table, so static ARP entries are required for this feature.
Step 2 Enable ARP inspection according to Enable ARP Inspection, on page 136.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
135
Customize the MAC Address Table for the Transparent Firewall
on the network, and if an entry is not used for a period of time, it times out. If an entry is incorrect (for example,
the MAC address changes for a given IP address), the entry needs to time out before it can be updated with
the new information.
For transparent mode, the ASA only uses dynamic ARP entries in the ARP table for traffic to and from the
ASA, such as management traffic.
Procedure
Example:
ciscoasa(config)# arp outside 10.1.1.1 0009.7cbe.2100
This allows ARP responses from the router at 10.1.1.1 with the MAC address 0009.7cbe.2100 on the outside
interface.
Procedure
Example:
ciscoasa(config)# arp-inspection outside enable no-flood
The flood keyword forwards non-matching ARP packets out all interfaces, and no-flood drops non-matching
packets.
The default setting is to flood non-matching packets. To restrict ARP through the ASA to only static entries,
then set this command to no-flood.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
136
Customize the MAC Address Table for the Transparent Firewall
the traffic and generates a system message. When you add a static ARP entry (see Add a Static ARP Entry,
on page 135), a static MAC address entry is automatically added to the MAC address table.
To add a static MAC address to the MAC address table,perform the following steps.
Procedure
Example:
ciscoasa(config)# mac-address-table static inside 0009.7cbe.2100
Procedure
Example:
ciscoasa(config)# mac-address-table aging-time 10
The timeout_value (in minutes) is between 5 and 720 (12 hours). 5 minutes is the default.
Procedure
Example:
ciscoasa(config)# mac-learn inside disable
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
137
Monitoring the Transparent Firewall
The clear configure mac-learn command reenables MAC address learning on all interfaces.
The following is sample output from the show mac-address-table command that shows the table for
the inside interface:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
138
Examples for Firewall Mode
The following steps describe how data moves through the ASA:
1 The user on the inside network requests a web page from www.example.com.
2 The ASA receives the packet and because it is a new session, it verifies that the packet is allowed according
to the terms of the security policy.
For multiple context mode, the ASA first classifies the packet to a context.
3 The ASA translates the real address (10.1.2.27) to the mapped address 209.165.201.10, which is on the
outside interface subnet.
The mapped address could be on any subnet, but routing is simplified when it is on the outside interface
subnet.
4 The ASA then records that a session is established and forwards the packet from the outside interface.
5 When www.example.com responds to the request, the packet goes through the ASA, and because the
session is already established, the packet bypasses the many lookups associated with a new connection.
The ASA performs NAT by untranslating the global destination address to the local user address, 10.1.2.27.
6 The ASA forwards the packet to the inside user.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
139
Examples for Firewall Mode
The following steps describe how data moves through the ASA:
1 A user on the outside network requests a web page from the DMZ web server using the mapped address
of 209.165.201.3, which is on the outside interface subnet.
2 The ASA receives the packet and untranslates the mapped address to the real address 10.1.1.3.
3 Because it is a new session, the ASA verifies that the packet is allowed according to the terms of the
security policy.
For multiple context mode, the ASA first classifies the packet to a context.
4 The ASA then adds a session entry to the fast path and forwards the packet from the DMZ interface.
5 When the DMZ web server responds to the request, the packet goes through the ASA and because the
session is already established, the packet bypasses the many lookups associated with a new connection.
The ASA performs NAT by translating the real address to 209.165.201.3.
6 The ASA forwards the packet to the outside user.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
140
Examples for Firewall Mode
The following steps describe how data moves through the ASA:
1 A user on the inside network requests a web page from the DMZ web server using the destination address
of 10.1.1.3.
2 The ASA receives the packet and because it is a new session, the ASA verifies that the packet is allowed
according to the terms of the security policy.
For multiple context mode, the ASA first classifies the packet to a context.
3 The ASA then records that a session is established and forwards the packet out of the DMZ interface.
4 When the DMZ web server responds to the request, the packet goes through the fast path, which lets the
packet bypass the many lookups associated with a new connection.
5 The ASA forwards the packet to the inside user.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
141
Examples for Firewall Mode
The following steps describe how data moves through the ASA:
1 A user on the outside network attempts to reach an inside host (assuming the host has a routable IP address).
If the inside network uses private addresses, no outside user can reach the inside network without NAT.
The outside user might attempt to reach an inside user by using an existing NAT session.
2 The ASA receives the packet and because it is a new session, it verifies if the packet is allowed according
to the security policy.
3 The packet is denied, and the ASA drops the packet and logs the connection attempt.
If the outside user is attempting to attack the inside network, the ASA employs many technologies to
determine if a packet is valid for an already established session.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
142
Examples for Firewall Mode
The following steps describe how data moves through the ASA:
1 A user on the DMZ network attempts to reach an inside host. Because the DMZ does not have to route
the traffic on the Internet, the private addressing scheme does not prevent routing.
2 The ASA receives the packet and because it is a new session, it verifies if the packet is allowed according
to the security policy.
The packet is denied, and the ASA drops the packet and logs the connection attempt.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
143
Examples for Firewall Mode
The following sections describe how data moves through the ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
144
Examples for Firewall Mode
The following steps describe how data moves through the ASA:
1 The user on the inside network requests a web page from www.example.com.
2 The ASA receives the packet and adds the source MAC address to the MAC address table, if required.
Because it is a new session, it verifies that the packet is allowed according to the terms of the security
policy.
For multiple context mode, the ASA first classifies the packet to a context.
3 The ASA records that a session is established.
4 If the destination MAC address is in its table, the ASA forwards the packet out of the outside interface.
The destination MAC address is that of the upstream router, 209.165.201.2.
If the destination MAC address is not in the ASA table, it attempts to discover the MAC address by sending
an ARP request or a ping. The first packet is dropped.
5 The web server responds to the request; because the session is already established, the packet bypasses
the many lookups associated with a new connection.
6 The ASA forwards the packet to the inside user.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
145
Examples for Firewall Mode
The following steps describe how data moves through the ASA:
1 The user on the inside network requests a web page from www.example.com.
2 The ASA receives the packet and adds the source MAC address to the MAC address table, if required.
Because it is a new session, it verifies that the packet is allowed according to the terms of the security
policy.
For multiple context mode, the ASA first classifies the packet according to a unique interface.
3 The ASA translates the real address (10.1.2.27) to the mapped address 209.165.201.10.
Because the mapped address is not on the same network as the outside interface, then be sure the upstream
router has a static route to the mapped network that points to the ASA.
4 The ASA then records that a session is established and forwards the packet from the outside interface.
5 If the destination MAC address is in its table, the ASA forwards the packet out of the outside interface.
The destination MAC address is that of the upstream router, 10.1.2.1.
If the destination MAC address is not in the ASA table, then it attempts to discover the MAC address by
sending an ARP request and a ping. The first packet is dropped.
6 The web server responds to the request; because the session is already established, the packet bypasses
the many lookups associated with a new connection.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
146
Examples for Firewall Mode
7 The ASA performs NAT by untranslating the mapped address to the real address, 10.1.2.27.
The following steps describe how data moves through the ASA:
1 A user on the outside network requests a web page from the inside web server.
2 The ASA receives the packet and adds the source MAC address to the MAC address table, if required.
Because it is a new session, it verifies that the packet is allowed according to the terms of the security
policy.
For multiple context mode, the ASA first classifies the packet to a context.
3 The ASA records that a session is established.
4 If the destination MAC address is in its table, the ASA forwards the packet out of the inside interface. The
destination MAC address is that of the downstream router, 209.165.201.1.
If the destination MAC address is not in the ASA table, then it attempts to discover the MAC address by
sending an ARP request and a ping. The first packet is dropped.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
147
Examples for Firewall Mode
5 The web server responds to the request; because the session is already established, the packet bypasses
the many lookups associated with a new connection.
6 The ASA forwards the packet to the outside user.
The following steps describe how data moves through the ASA:
1 A user on the outside network attempts to reach an inside host.
2 The ASA receives the packet and adds the source MAC address to the MAC address table, if required.
Because it is a new session, it verifies if the packet is allowed according to the terms of the security policy.
For multiple context mode, the ASA first classifies the packet to a context.
3 The packet is denied because there is no access rule permitting the outside host, and the ASA drops the
packet.
4 If the outside user is attempting to attack the inside network, the ASA employs many technologies to
determine if a packet is valid for an already established session.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
148
History for the Firewall Mode
ARP inspection 7.0(1) ARP inspection compares the MAC address, IP address, and
source interface in all ARP packets to static entries in the ARP
table.
We introduced the following commands: arp, arp-inspection,
and show arp-inspection.
MAC address table 7.0(1) Transparent firewall mode uses a MAC address table.
We introduced the following commands: mac-address-table
static, mac-address-table aging-time, mac-learn disable, and
show mac-address-table.
Transparent firewall bridge groups 8.4(1) If you do not want the overhead of security contexts, or want
to maximize your use of security contexts, you can group
interfaces together in a bridge group, and then configure
multiple bridge groups, one for each network. Bridge group
traffic is isolated from other bridge groups. You can configure
up to 8 bridge groups in single mode or per context in multiple
mode, with 4 interfaces maximum per bridge group.
Note Although you can configure multiple bridge groups
on the ASA 5505, the restriction of 2 data interfaces
in transparent mode on the ASA 5505 means you can
only effectively use 1 bridge group.
We introduced the following commands: interface bvi,
bridge-group, show bridge-group.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
149
History for the Firewall Mode
Mixed firewall mode support in multiple context 8.5(1)/9.0(1) You can set the firewall mode independently for each security
mode context in multiple context mode, so some can run in transparent
mode while others run in routed mode.
We modified the following command: firewall transparent.
Transparent mode bridge group maximum 9.3(1) The bridge group maximum was increased from 8 to 250 bridge
increased to 250 groups. You can configure up to 250 bridge groups in single
mode or per context in multiple mode, with 4 interfaces
maximum per bridge group.
We modified the following commands: interface bvi,
bridge-group.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
150
PART II
High Availability and Scalability
• Multiple Context Mode, page 153
• Failover for High Availability, page 195
• ASA Cluster, page 247
• ASA Cluster for the FXOS Chassis, page 339
CHAPTER 6
Multiple Context Mode
This chapter describes how to configure multiple security contexts on the Cisco ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
153
About Security Contexts
• You are a large enterprise or a college campus and want to keep departments completely separate.
• You are an enterprise that wants to provide distinct security policies to different departments.
• You have any network that requires more than one ASA.
Context Configurations
For each context, the ASA includes a configuration that identifies the security policy, interfaces, and all the
options you can configure on a standalone device. You can store context configurations in flash memory, or
you can download them from a TFTP, FTP, or HTTP(S) server.
System Configuration
The system administrator adds and manages contexts by configuring each context configuration location,
allocated interfaces, and other context operating parameters in the system configuration, which, like a single
mode configuration, is the startup configuration. The system configuration identifies basic settings for the
ASA. The system configuration does not include any network interfaces or network settings for itself; rather,
when the system needs to access network resources (such as downloading the contexts from the server), it
uses one of the contexts that is designated as the admin context. The system configuration does include a
specialized failover interface for failover traffic only.
Note If the destination MAC address is a multicast or broadcast MAC address, the packet is duplicated and
delivered to each context.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
154
About Security Contexts
Note For management traffic destined for an interface, the interface IP address is used for classification.
The routing table is not used for packet classification.
Unique Interfaces
If only one context is associated with the ingress interface, the ASA classifies the packet into that context. In
transparent firewall mode, unique interfaces for contexts are required, so this method is used to classify packets
at all times.
NAT Configuration
If you do not enable use of unique MAC addresses, then the ASA uses the mapped addresses in your NAT
configuration to classify packets. We recommend using MAC addresses instead of NAT, so that traffic
classification can occur regardless of the completeness of the NAT configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
155
About Security Contexts
Classification Examples
The following figure shows multiple contexts sharing an outside interface. The classifier assigns the packet
to Context B because Context B includes the MAC address to which the router sends the packet.
Figure 14: Packet Classification with a Shared Interface Using MAC Addresses
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
156
About Security Contexts
Note that all new incoming traffic must be classified, even from inside networks. The following figure shows
a host on the Context B inside network accessing the Internet. The classifier assigns the packet to Context B
because the ingress interface is Gigabit Ethernet 0/1.3, which is assigned to Context B.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
157
About Security Contexts
For transparent firewalls, you must use unique interfaces. The following figure shows a packet destined to a
host on the Context B inside network from the Internet. The classifier assigns the packet to Context B because
the ingress interface is Gigabit Ethernet 1/0.3, which is assigned to Context B.
Note Cascading contexts requires unique MAC addresses for each context interface. Because of the limitations
of classifying packets on shared interfaces without MAC addresses, we do not recommend using cascading
contexts without unique MAC addresses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
158
About Security Contexts
The following figure shows a gateway context with two contexts behind the gateway.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
159
About Security Contexts
username is altered to enable_15, so you must log in again as “admin” by entering the login command. When
you change to context B, you must again enter the login command to log in as “admin.”
The system execution space does not support any AAA commands, but you can configure its own enable
password, as well as usernames in the local database to provide individual logins.
Resource Classes
The ASA manages resources by assigning contexts to resource classes. Each context uses the resource limits
set by the class. To use the settings of a class, assign the context to the class when you define the context. All
contexts belong to the default class if they are not assigned to another class; you do not have to actively assign
a context to default. You can only assign a context to one resource class. The exception to this rule is that
limits that are undefined in the member class are inherited from the default class; so in effect, a context could
be a member of default plus another class.
Resource Limits
You can set the limit for individual resources as a percentage (if there is a hard system limit) or as an absolute
value.
For most resources, the ASA does not set aside a portion of the resources for each context assigned to the
class; rather, the ASA sets the maximum limit for a context. If you oversubscribe resources, or allow some
resources to be unlimited, a few contexts can “use up” those resources, potentially affecting service to other
contexts. The exception is VPN resource types, which you cannot oversubscribe, so the resources assigned
to each context are guaranteed. To accommodate temporary bursts of VPN sessions beyond the amount
assigned, the ASA supports a “burst” VPN resource type, which is equal to the remaining unassigned VPN
sessions. The burst sessions can be oversubscribed, and are available to contexts on a first-come, first-served
basis.
Default Class
All contexts belong to the default class if they are not assigned to another class; you do not have to actively
assign a context to the default class.
If a context belongs to a class other than the default class, those class settings always override the default class
settings. However, if the other class has any settings that are not defined, then the member context uses the
default class for those limits. For example, if you create a class with a 2 percent limit for all concurrent
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
160
About Security Contexts
connections, but no other limits, then all other limits are inherited from the default class. Conversely, if you
create a class with a limit for all resources, the class uses no settings from the default class.
For most resources, the default class provides unlimited access to resources for all contexts, except for the
following limits:
• Telnet sessions—5 sessions. (The maximum per context.)
• SSH sessions—5 sessions. (The maximum per context.)
• IPsec sessions—5 sessions. (The maximum per context.)
• MAC addresses—65,535 entries. (The maximum per context.)
• AnyConnect peers—0 sessions. (You must manually configure the class to allow any AnyConnect peers.)
• VPN site-to-site tunnels—0 sessions. (You must manually configure the class to allow any VPN sessions.)
The following figure shows the relationship between the default class and other classes. Contexts A and C
belong to classes with some limits set; other limits are inherited from the default class. Context B inherits no
limits from default because all limits are set in its class, the Gold class. Context D was not assigned to a class,
and is by default a member of the default class.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
161
About Security Contexts
to 20 percent per context, and then assign 10 contexts to the class for a total of 200 percent. If contexts
concurrently use more than the system limit, then each context gets less than the 20 percent you intended.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
162
About Security Contexts
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
163
Licensing for Multiple Context Mode
A24D.00zz.zzzz
For a prefix of 1009 (03F1), the MAC address is:
A2F1.03zz.zzzz
Note The MAC address format without a prefix is a legacy version not supported on newer ASA versions. See
the mac-address auto command in the command reference for more information about the legacy format.
ASA 5512-X
• Base License: No support.
• Security Plus License: 2 contexts.
Optional license: 5 contexts.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
164
Prerequisites for Multiple Context Mode
ASAv No support.
Note The AnyConnect Apex license is required for multiple context mode; you cannot use the default or legacy
license.
IPv6
Cross-context IPv6 routing is not supported.
Unsupported Features
Multiple context mode does not support the following features:
• RIP
• OSPFv3. (OSPFv2 is supported.)
• Multicast routing
• Threat Detection
• Unified Communications
• QoS
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
165
Defaults for Multiple Context Mode
Multiple context mode does not currently support the following features for remote access VPN:
• IKEv2, IKEv1
• Stateful failover
• Flash virtualization
• AnyConnect image configuration per context
• WebLaunch
• Client profile download
• DAP and CoA
• CSD/HostScan
• VPN load balancing
• Username-from-certificate and prefill-username
• Customization/Localization
Additional Guidelines
• The context mode (single or multiple) is not stored in the configuration file, even though it does endure
reboots. If you need to copy your configuration to another device, set the mode on the new device to
match.
• If you store context configurations in the root directory of flash memory, on some models you might
run out of room in that directory, even though there is available memory. In this case, create a subdirectory
for your configuration files. Background: some models, such as the ASA 5585-X, use the FAT 16 file
system for internal flash memory, and if you do not use 8.3-compliant short names, or use uppercase
characters, then fewer than 512 files and folders can be stored because the file system uses up slots to
store long file names (see http://support.microsoft.com/kb/120138/en-us).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
166
Configure Multiple Contexts
Procedure
Example:
ciscoasa(config)# mode multiple
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
167
Configure Multiple Contexts
Procedure
Step 1 Copy the backup version of your original running configuration to the current startup configuration:
copy disk0:old_running.cfg startup-config
Example:
ciscoasa(config)# copy disk0:old_running.cfg startup-config
Example:
ciscoasa(config)# mode single
Minimum and
Maximum
Rate or Number per
Resource Name Concurrent Context System LimitFootnote. Description
asdm Concurrent 1 minimum 32 ASDM management sessions.
5 maximum ASDM sessions use two HTTPS
connections: one for monitoring that
is always present, and one for making
configuration changes that is present
only when you make changes. For
example, the system limit of 32
ASDM sessions represents a limit of
64 HTTPS sessions.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
168
Configure Multiple Contexts
Minimum and
Maximum
Rate or Number per
Resource Name Concurrent Context System LimitFootnote. Description
conns Concurrent or N/A Concurrent connections: TCP or UDP connections between any
Rate See Supported Feature two hosts, including connections
Footnote.
Licenses Per Model, on between one host and multiple other
page 45 for the connection hosts.
limit available for your
model.
Rate: N/A
hosts Concurrent N/A N/A Hosts that can connect through the
ASA.
vpn burst Concurrent N/A The AnyConnect Premium The number of AnyConnect sessions
anyconnect Peers for your model minus allowed beyond the amount assigned
the sum of the sessions to a context with vpn anyconnect.
assigned to all contexts for For example, if your model supports
vpn anyconnect. 5000 peers, and you assign 4000 peers
across all contexts with vpn
anyconnect, then the remaining 1000
sessions are available for vpn burst
anyconnect. Unlike vpn anyconnect,
which guarantees the sessions to the
context, vpn burst anyconnect can
be oversubscribed; the burst pool is
available to all contexts on a
first-come, first-served basis.
vpn anyconnect Concurrent N/A See Supported Feature AnyConnect peers. You cannot
Licenses Per Model, on oversubscribe this resource; all
page 45 for the context assignments combined cannot
AnyConnect Premium Peers exceed the model limit. The peers you
available for your model. assign for this resource are guaranteed
to the context.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
169
Configure Multiple Contexts
Minimum and
Maximum
Rate or Number per
Resource Name Concurrent Context System LimitFootnote. Description
vpn burst other Concurrent N/A The Other VPN session The number of site-to-site VPN
amount for your model sessions allowed beyond the amount
minus the sum of the assigned to a context with vpn other.
sessions assigned to all For example, if your model supports
contexts for vpn other. 5000 sessions, and you assign 4000
sessions across all contexts with vpn
other, then the remaining 1000
sessions are available for vpn burst
other. Unlike vpn other, which
guarantees the sessions to the context,
vpn burst other can be
oversubscribed; the burst pool is
available to all contexts on a
first-come, first-served basis.
vpn other Concurrent N/A See Supported Feature Site-to-site VPN sessions. You cannot
Licenses Per Model, on oversubscribe this resource; all
page 45 for the Other VPN context assignments combined cannot
sessions available for your exceed the model limit. The sessions
model. you assign for this resource are
guaranteed to the context.
12
1 (1) If this column value is N/A, then you cannot set a percentage of the resource because there is no hard system limit for the resource.
2 (2) Syslog messages are generated for whichever limit is lower, xlates or conns. For example, if you set the xlates limit to 7 and the conns to 9, then the ASA
only generates syslog message 321001 (“Resource 'xlates' limit of 7 reached for context 'ctx1'”) and not 321002 (“Resource 'conn rate' limit of 5 reached for
context 'ctx1'”).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
170
Configure Multiple Contexts
Procedure
Step 1 Specify the class name and enter the class configuration mode:
class name
Example:
ciscoasa(config)# class gold
The name is a string up to 20 characters long. To set the limits for the default class, enter default for the name.
Example:
ciscoasa(config-class)# limit-resource rate inspects 10
• See the preceding table for a list of resource types. If you specify all, then all resources are configured
with the same value. If you also specify a value for a particular resource, the limit overrides the limit
set for all.
• Enter the rate argument to set the rate per second for certain resources.
• For most resources, specify 0 for the number to set the resource to be unlimited or to be the system limit,
if available. For VPN resources, 0 sets the limit to none.
• For resources that do not have a system limit, you cannot set the percentage (%); you can only set an
absolute value.
Example
For example, to set the default class limit for conns to 10 percent instead of unlimited, and to allow 5 site-to-site
VPN tunnels with 2 tunnels allowed for VPN burst, enter the following commands:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
171
Configure Multiple Contexts
Procedure
Example:
ciscoasa(config)# context administrator
The name is a string up to 32 characters long. This name is case sensitive, so you can have two contexts named
“customerA” and “CustomerA,” for example. You can use letters, digits, or hyphens, but you cannot start or
end the name with a hyphen.
Note “System” or “Null” (in upper or lower case letters) are reserved names, and cannot be
used.
Step 2 (Optional) Add a description for this context:
description text
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
172
Configure Multiple Contexts
Example:
ciscoasa(config-ctx)# description Administrator Context
Example:
ciscoasa(config-ctx)# allocate-interface gigabitethernet0/1.100 int1
ciscoasa(config-ctx)# allocate-interface gigabitethernet0/1.200 int2
ciscoasa(config-ctx)# allocate-interface gigabitethernet0/2.300-gigabitethernet0/2.305
int3-int8
Note Do not include a space between the interface type and the port number.
• Enter these commands multiple times to specify different ranges. If you remove an allocation with the
no form of this command, then any context commands that include this interface are removed from the
running configuration.
• Transparent firewall mode allows a limited number of interfaces to pass through traffic; however, you
can use a dedicated management interface, Management slot/port (physical, subinterface, redundant, or
EtherChannel), as an additional interface for management traffic. A separate management interface is
not available for the ASASM.
• You can assign the same interfaces to multiple contexts in routed mode, if desired. Transparent mode
does not allow shared interfaces.
• The mapped_name is an alphanumeric alias for the interface that can be used within the context instead
of the interface ID. If you do not specify a mapped name, the interface ID is used within the context.
For security purposes, you might not want the context administrator to know which interfaces the context
is using. A mapped name must start with a letter, end with a letter or digit, and have as interior characters
only letters, digits, or an underscore. For example, you can use the following names: int0, inta, int_0.
• If you specify a range of subinterfaces, you can specify a matching range of mapped names. Follow
these guidelines for ranges:
◦The mapped name must consist of an alphabetic portion followed by a numeric portion. The
alphabetic portion of the mapped name must match for both ends of the range. For example, enter
the following range: int0-int10. If you enter gig0/1.1-gig0/1.5 happy1-sad5, for example, the
command fails.
◦The numeric portion of the mapped name must include the same quantity of numbers as the
subinterface range. For example, both ranges include 100
interfaces:gigabitethernet0/0.100-gigabitethernet0/0.199 int1-int100. If you enter
gig0/0.100-gig0/0.199 int1-int15, for example, the command fails.
• Specify visible to see the real interface ID in the show interface command if you set a mapped name.
The default invisible keyword shows only the mapped name.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
173
Configure Multiple Contexts
Step 4 Identify the URL from which the system downloads the context configuration:
config-url url
Example:
ciscoasa(config-ctx)# config-url ftp://user1:[email protected]/configlets/test.cfg
Example:
ciscoasa(config-ctx)# member gold
Step 6 (Optional) Assign an IPS virtual sensor to this context if you have the IPS module installed:
allocate-ips sensor_name [mapped_name] [default]
Example:
ciscoasa(config-ctx)# allocate-ips sensor1 highsec
See the IPS quick start guide for detailed information about virtual sensors.
• When you add a context URL, the system immediately loads the context so that it is running, if the
configuration is available.
• Enter the allocate-interface commands before you enter the config-url command. If you enter the
config-url command first, the ASA loads the context configuration immediately. If the context contains
any commands that refer to (not yet configured) interfaces, those commands fail.
• The filename does not require a file extension, although we recommend using “.cfg”. The server must
be accessible from the admin context. If the configuration file is not available, you see the following
warning message:
• For non-HTTP(S) URL locations, after you specify the URL, you can then change to the context,
configure it at the CLI, and enter the write memory command to write the file to the URL location.
(HTTP(S) is read only).
• The admin context file must be stored on the internal flash memory.
• Available URL types include: disknumber (for flash memory), ftp, http, https, or tftp.
• To change the URL, reenter the config-url command with a new URL.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
174
Configure Multiple Contexts
Example:
ciscoasa(config-ctx)# join-failover-group 2
By default, contexts are in group 1. The admin context must always be in group 1.
Example:
ciscoasa(config-ctx)# scansafe
If you do not specify a license, the context uses the license configured in the system configuration. The ASA
sends the authentication key to the Cloud Web Security proxy servers to indicate from which organization
the request comes. The authentication key is a 16-byte hexidecimal number.
See the firewall configuration guide for detailed information about ScanSafe.
Example
The following example sets the admin context to be “administrator,” creates a context called “administrator”
on the internal flash memory, and then adds two contexts from an FTP server:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
175
Change Between Contexts and the System Execution Space
generated for all interfaces immediately after you enable it. If you disable this feature, the MAC address
for each interface reverts to the default MAC address. For example, subinterfaces of GigabitEthernet
0/1 revert to using the MAC address of GigabitEthernet 0/1.
• In the rare circumstance that the generated MAC address conflicts with another private MAC address
in your network, you can manually set the MAC address for the interface within the context.
Procedure
Example:
ciscoasa(config)# mac-address auto prefix 19
If you do not enter a prefix, then the ASA autogenerates the prefix based on the last two bytes of the interface
(ASA 5500-X) or backplane (ASASM) MAC address.
If you manually enter a prefix, then the prefix is a decimal value between 0 and 65535. This prefix is converted
to a four-digit hexadecimal number, and used as part of the MAC address.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
176
Manage Security Contexts
Note If you use failover, there is a delay between when you remove the context on the active unit and when the
context is removed on the standby unit. You might see an error message indicating that the number of
interfaces on the active and standby units are not consistent; this error is temporary and can be ignored.
Procedure
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
177
Manage Security Contexts
admin-context context_name
Example:
ciscoasa(config)# admin-context administrator
Any remote management sessions, such as Telnet, SSH, or HTTPS, that are connected to the admin context
are terminated. You must reconnect to the new admin context.
A few system configuration commands, including ntp server, identify an interface name that belongs to the
admin context. If you change the admin context, and that interface name does not exist in the new admin
context, be sure to update any system commands that refer to the interface.
• If you do not want to merge the configurations, you can clear the running configuration, which disrupts
any communications through the context, and then reload the configuration from the new URL.
• Perform this procedure in the system execution space.
Procedure
Step 1 (Optional, if you do not want to perform a merge) Change to the context and clear configuration:
changeto context name
clear configure all
Example:
ciscoasa(config)# changeto context ctx1
ciscoasa/ctx1(config)# clear configure all
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
178
Manage Security Contexts
changeto system
Example:
ciscoasa/ctx1(config)# changeto system
ciscoasa(config)#
Step 3 Enter the context configuration mode for the context you want to change.
context name
Example:
ciscoasa(config)# context ctx1
Step 4 Enter the new URL. The system immediately loads the context so that it is running.
config-url new_url
Example:
ciscoasa(config)# config-url ftp://user1:[email protected]/configlets/ctx1.cfg
Procedure
Example:
ciscoasa(config)# changeto context ctx1
ciscoasa/ctx1(comfig)#
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
179
Monitoring Security Contexts
Example:
ciscoasa/ctx1(config)# copy startup-config running-config
The ASA copies the configuration from the URL specified in the system configuration. You cannot change
the URL from within a context.
Procedure
Step 1 Remove a Security Context, on page 177. Also delete config URL file from the disk
Step 2 Configure a Security Context, on page 172
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
180
Monitoring Security Contexts
The following is sample output from the show context command. The following sample output shows three
contexts:
Field Description
Context Name Lists all context names. The context name with the asterisk (*) is the admin context.
URL The URL from which the ASA loads the context configuration.
The following is sample output from the show context detail command:
Context "admin", has been created, but initial ACL rules not complete
Config URL: disk0:/admin.cfg
Real Interfaces: Management0/0
Mapped Interfaces: Management0/0
Flags: 0x00000013, ID: 1
Context "ctx", has been created, but initial ACL rules not complete
Config URL: ctx.cfg
Real Interfaces: GigabitEthernet0/0.10, GigabitEthernet0/1.20,
GigabitEthernet0/2.30
Mapped Interfaces: int1, int2, int3
Flags: 0x00000011, ID: 2
See the command reference for more information about the detail output.
The following is sample output from the show context count command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
181
Monitoring Security Contexts
Procedure
The following sample output shows the total allocation of each resource as an absolute value and as a percentage
of the available system resources:
Field Description
Resource The name of the resource that you can limit.
Total The total amount of the resource that is allocated across all contexts. The amount is an
absolute number of concurrent instances or instances per second. If you specified a
percentage in the class definition, the ASA converts the percentage to an absolute number
for this display.
% of Avail The percentage of the total system resources that is allocated across all contexts, if the
resource has a hard system limit. If a resource does not have a system limit, this column
shows N/A.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
182
Monitoring Security Contexts
The following is sample output from the show resource allocation detail command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
183
Monitoring Security Contexts
Field Description
Resource The name of the resource that you can limit.
Limit The limit of the resource per context, as an absolute number. If you specified a percentage
in the class definition, the ASA converts the percentage to an absolute number for this
display.
Total The total amount of the resource that is allocated across all contexts in the class. The
amount is an absolute number of concurrent instances or instances per second. If the
resource is unlimited, this display is blank.
% of Avail The percentage of the total system resources that is allocated across all contexts in the
class. If the resource is unlimited, this display is blank. If the resource does not have a
system limit, then this column shows N/A.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
184
Monitoring Security Contexts
• The count_threshold sets the number above which resources are shown. The default is 1. If the usage
of the resource is below the number you set, then the resource is not shown. If you specify all for the
counter name, then the count_threshold applies to the current usage.
• To show all resources, set the count_threshold to 0.
Examples
The following is sample output from the show resource usage context command, which shows the resource
usage for the admin context:
The following is sample output from the show resource usage summary command, which shows the resource
usage for all contexts and all resources. This sample shows the limits for six contexts.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
185
Monitoring Security Contexts
S = System: Combined context limits exceed the system limit; the system limit is shown.
The following is sample output from the show resource usage summary command, which shows the limits
for 25 contexts. Because the context limit for Telnet and SSH connections is 5 per context, then the combined
limit is 125. The system limit is only 100, so the system limit is shown.
The following is sample output from the show resource usage system command, which shows the resource
usage for all contexts, but it shows the system limit instead of the combined context limits. The counter all
0 option is used to show resources that are not currently in use. The Denied statistics indicate how many times
the resource was denied due to the system limit, if available.
Procedure
Step 2 Monitor the amount of resources being used by TCP intercept for individual contexts:
show resource usage detail
Step 3 Monitor the resources being used by TCP intercept for the entire system:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
186
Monitoring Security Contexts
Examples
The following is sample output from the show perfmon command that shows the rate of TCP intercepts for
a context called admin.
Context:admin
PERFMON STATS: Current Average
Xlates 0/s 0/s
Connections 0/s 0/s
TCP Conns 0/s 0/s
UDP Conns 0/s 0/s
URL Access 0/s 0/s
URL Server Req 0/s 0/s
WebSns Req 0/s 0/s
TCP Fixup 0/s 0/s
HTTP Fixup 0/s 0/s
FTP Fixup 0/s 0/s
AAA Authen 0/s 0/s
AAA Author 0/s 0/s
AAA Account 0/s 0/s
TCP Intercept 322779/s 322779/s
The following is sample output from the show resource usage detail command that shows the amount of
resources being used by TCP Intercept for individual contexts. (Sample text in bold shows the TCP intercept
information.)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
187
Monitoring Security Contexts
nats 1 1 unlimited 0 c1
ace-rules 2 2 unlimited 0 c1
console-access-rul 2 2 unlimited 0 c1
fixup-rules 14 15 unlimited 0 c1
memory 232695716 232020648 unlimited 0 system
chunk:channels 17 20 unlimited 0 system
chunk:dbgtrace 3 3 unlimited 0 system
chunk:fixup 15 15 unlimited 0 system
chunk:ip-users 4 4 unlimited 0 system
chunk:list-elem 1014 1014 unlimited 0 system
chunk:list-hdr 1 1 unlimited 0 system
chunk:route 1 1 unlimited 0 system
block:16384 510 885 unlimited 0 system
block:2048 32 34 unlimited 0 system
The following sample output shows the resources being used by TCP intercept for the entire system. (Sample
text in bold shows the TCP intercept information.)
Procedure
Show the assigned MAC addresses from the system execution space:
show running-config all context [name]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
188
Monitoring Security Contexts
The all option is required to view the assigned MAC addresses. Although the mac-address auto command
is user-configurable in global configuration mode only, the command appears as a read-only entry in context
configuration mode along with the assigned MAC address. Only allocated interfaces that are configured with
a nameif command within the context have a MAC address assigned.
Examples
The following output from the show running-config all context admin command shows the primary and
standby MAC address assigned to the Management0/0 interface:
context admin
allocate-interface Management0/0
mac-address auto Management0/0 a24d.0000.1440 a24d.0000.1441
config-url disk0:/admin.cfg
The following output from the show running-config all context command shows all the MAC addresses
(primary and standby) for all context interfaces. Note that because the GigabitEthernet0/0 and
GigabitEthernet0/1 main interfaces are not configured with a nameif command inside the contexts, no MAC
addresses have been generated for them.
admin-context admin
context admin
allocate-interface Management0/0
mac-address auto Management0/0 a2d2.0400.125a a2d2.0400.125b
config-url disk0:/admin.cfg
!
context CTX1
allocate-interface GigabitEthernet0/0
allocate-interface GigabitEthernet0/0.1-GigabitEthernet0/0.5
mac-address auto GigabitEthernet0/0.1 a2d2.0400.11bc a2d2.0400.11bd
mac-address auto GigabitEthernet0/0.2 a2d2.0400.11c0 a2d2.0400.11c1
mac-address auto GigabitEthernet0/0.3 a2d2.0400.11c4 a2d2.0400.11c5
mac-address auto GigabitEthernet0/0.4 a2d2.0400.11c8 a2d2.0400.11c9
mac-address auto GigabitEthernet0/0.5 a2d2.0400.11cc a2d2.0400.11cd
allocate-interface GigabitEthernet0/1
allocate-interface GigabitEthernet0/1.1-GigabitEthernet0/1.3
mac-address auto GigabitEthernet0/1.1 a2d2.0400.120c a2d2.0400.120d
mac-address auto GigabitEthernet0/1.2 a2d2.0400.1210 a2d2.0400.1211
mac-address auto GigabitEthernet0/1.3 a2d2.0400.1214 a2d2.0400.1215
config-url disk0:/CTX1.cfg
!
context CTX2
allocate-interface GigabitEthernet0/0
allocate-interface GigabitEthernet0/0.1-GigabitEthernet0/0.5
mac-address auto GigabitEthernet0/0.1 a2d2.0400.11ba a2d2.0400.11bb
mac-address auto GigabitEthernet0/0.2 a2d2.0400.11be a2d2.0400.11bf
mac-address auto GigabitEthernet0/0.3 a2d2.0400.11c2 a2d2.0400.11c3
mac-address auto GigabitEthernet0/0.4 a2d2.0400.11c6 a2d2.0400.11c7
mac-address auto GigabitEthernet0/0.5 a2d2.0400.11ca a2d2.0400.11cb
allocate-interface GigabitEthernet0/1
allocate-interface GigabitEthernet0/1.1-GigabitEthernet0/1.3
mac-address auto GigabitEthernet0/1.1 a2d2.0400.120a a2d2.0400.120b
mac-address auto GigabitEthernet0/1.2 a2d2.0400.120e a2d2.0400.120f
mac-address auto GigabitEthernet0/1.3 a2d2.0400.1212 a2d2.0400.1213
config-url disk0:/CTX2.cfg
!
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
189
Examples for Multiple Context Mode
Procedure
Show the MAC address in use by each interface within the context:
show interface | include (Interface)|(MAC)
For example:
Note The show interface command shows the MAC address in use; if you manually assign a MAC address
and also have auto-generation enabled, then you can only view the unused auto-generated address from
within the system configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
190
History for Multiple Context Mode
Automatic MAC address assignment 7.2(1) Automatic assignment of MAC address to context interfaces
was introduced.
We introduced the following command: mac-address auto.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
191
History for Multiple Context Mode
Automatic MAC address assignment enhancements 8.0(5)/8.2(2) The MAC address format was changed to use a prefix, to use
a fixed starting value (A2), and to use a different scheme for
the primary and secondary unit MAC addresses in a failover
pair. The MAC addresses are also now persistent across reloads.
The command parser now checks if auto-generation is enabled;
if you want to also manually assign a MAC address, you cannot
start the manual MAC address with A2.
We modified the following command: mac-address auto
prefix.
Maximum contexts increased for the ASA 5550 8.4(1) The maximum security contexts for the ASA 5550 was
and 5580 increased from 50 to 100. The maximum for the ASA 5580
was increased from 50 to 250.
Automatic MAC address assignment enabled by 8.5(1) Automatic MAC address assignment is now enabled by default.
default We modified the following command: mac-address auto.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
192
History for Multiple Context Mode
Automatic MAC address assignment disabled by 9.0(1) Automatic MAC address assignment is now disabled by default
default on all models except for the ASASM except for the ASASM.
We modified the following command: mac-address auto.
Dynamic routing in Security Contexts 9.0(1) EIGRP and OSPFv2 dynamic routing protocols are now
supported in multiple context mode. OSPFv3, RIP, and
multicast routing are not supported.
New resource type for routing table entries 9.0(1) A new resource type, routes, was created to set the maximum
number of routing table entries in each context.
We modified the following commands: limit-resource, show
resource types, show resource usage, show resource
allocation.
Site-to-Site VPN in multiple context mode 9.0(1) Site-to-site VPN tunnels are now supported in multiple context
mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
193
History for Multiple Context Mode
New resource type for IKEv1 SA negotiations 9.1(2) New resource type, ikev1 in-negotiation, was created to set the
maximum percentage of IKEv1 SA negotiations in each context
to prevent overwhelming the CPU and crypto engines. Under
certain conditions (large certificates, CRL checking), you might
want to restrict this resource.
We modified the following commands: limit-resource, show
resource types, show resource usage, show resource
allocation.
Support for Remote Access VPN in multiple 9.5(2) You can now use the following remote access features in
context mode multiple context mode:
• AnyConnect 3.x and later (SSL VPN only; no IKEv2
support)
• Centralized AnyConnect image configuration
• AnyConnect image upgrade
• Context Resource Management for AnyConnect
connections
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
194
CHAPTER 7
Failover for High Availability
This chapter describes how to configure Active/Standby or Active/Active failover to accomplish high
availability of the Cisco ASA.
About Failover
Configuring failover requires two identical ASAs connected to each other through a dedicated failover link
and, optionally, a state link. The health of the active units and interfaces is monitored to determine if specific
failover conditions are met. If those conditions are met, failover occurs.
Failover Modes
The ASA supports two failover modes, Active/Active failover and Active/Standby failover. Each failover
mode has its own method for determining and performing failover.
• In Active/Standby failover, one unit is the active unit. It passes traffic. The standby unit does not actively
pass traffic. When a failover occurs, the active unit fails over to the standby unit, which then becomes
active. You can use Active/Standby failover for ASAs in single or multiple context mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
195
About Failover
• In an Active/Active failover configuration, both ASAs can pass network traffic. Active/Active failover
is only available to ASAs in multiple context mode. In Active/Active failover, you divide the security
contexts on the ASA into 2 failover groups. A failover group is simply a logical group of one or more
security contexts. One group is assigned to be active on the primary ASA, and the other group is assigned
to be active on the secondary ASA. When a failover occurs, it occurs at the failover group level.
Hardware Requirements
The two units in a Failover configuration must:
• Be the same model.
• Have the same number and types of interfaces.
• Have the same modules installed (if any)
• Have the same RAM installed.
If you are using units with different flash memory sizes in your Failover configuration, make sure the unit
with the smaller flash memory has enough space to accommodate the software image files and the configuration
files. If it does not, configuration synchronization from the unit with the larger flash memory to the unit with
the smaller flash memory will fail.
Software Requirements
The two units in a Failover configuration must:
• Be in the same firewall mode (routed or transparent).
• Be in the same context mode (single or multiple).
• Have the same major (first number) and minor (second number) software version. However, you can
temporarily use different versions of the software during an upgrade process; for example, you can
upgrade one unit from Version 8.3(1) to Version 8.3(2) and have failover remain active. We recommend
upgrading both units to the same version to ensure long-term compatibility.
• Have the same AnyConnect images. If the failover pair has mismatched images when a hitless upgrade
is performed, then the clientless SSL VPN connection terminates in the final reboot step of the upgrade
process, the database shows an orphaned session, and the IP pool shows that the IP address assigned to
the client is “in use.”
Related Topics
Upgrade a Failover Pair or ASA Cluster, on page 832
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
196
About Failover
License Requirements
The two units in a failover configuration do not need to have identical licenses; the licenses combine to make
a failover cluster license.
Related Topics
Failover or ASA Cluster Licenses, on page 67
Caution All information sent over the failover and state links is sent in clear text unless you secure the
communication with an IPsec tunnel or a failover key. If the ASA is used to terminate VPN tunnels, this
information includes any usernames, passwords and preshared keys used for establishing the tunnels.
Transmitting this sensitive data in clear text could pose a significant security risk. We recommend securing
the failover communication with an IPsec tunnel or a failover key if you are using the ASA to terminate
VPN tunnels.
Failover Link
The two units in a failover pair constantly communicate over a failover link to determine the operating status
of each unit.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
197
About Failover
• 5506H-X—You can use the Management 1/1 interface as the failover link. If you configure it for failover,
you must reload the device for the change to take effect. In this case, you cannot also use the ASA
Firepower module, because it requires the Management interface for management purposes.
• 5585-X—Do not use the Management 0/0 interface, even though it can be used as a data interface. It
does not support the necessary performance for this use.
• Firepower 9300 ASA security module—You can use either a management type or data type interface
as the failover link. To conserve interfaces and to share a failover link between modules in the same
chassis, use a management type interface. For example, you have 2 chassis, each with 3 ASA security
modules. You can create 3 failover pairs between the chassis. You can use a single 10 GigabitEthernet
management interface between the chassis to act as the failover link. Just configure a unique VLAN
subinterface within each module.
• All models—1 GB interface is large enough for a combined failover and state link.
For a redundant interface used as the failover link, see the following benefits for added redundancy:
• When a failover unit boots up, it alternates between the member interfaces to detect an active unit.
• If a failover unit stops receiving keepalive messages from its peer on one of the member interfaces, it
switches to the other member interface.
For an EtherChannel used as the failover link, to prevent out-of-order packets, only one interface in the
EtherChannel is used. If that interface fails, then the next interface in the EtherChannel is used. You cannot
alter the EtherChannel configuration while it is in use as a failover link.
If you do not use a switch between the units, if the interface fails, the link is brought down on both peers. This
condition may hamper troubleshooting efforts because you cannot easily determine which unit has the failed
interface and caused the link to come down.
The ASA supports Auto-MDI/MDIX on its copper Ethernet ports, so you can either use a crossover cable or
a straight-through cable. If you use a straight-through cable, the interface automatically detects the cable and
swaps one of the transmit/receive pairs to MDIX.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
198
About Failover
Dedicated Interface
You can use a dedicated data interface (physical, redundant, or EtherChannel) for the state link. For an
EtherChannel used as the state link, to prevent out-of-order packets, only one interface in the EtherChannel
is used. If that interface fails, then the next interface in the EtherChannel is used.
Connect a dedicated state link in one of the following two ways:
• Using a switch, with no other device on the same network segment (broadcast domain or VLAN) as the
failover interfaces of the ASA device.
• Using an Ethernet cable to connect the appliances directly, without the need for an external switch.
If you do not use a switch between the units, if the interface fails, the link is brought down on both peers.
This condition may hamper troubleshooting efforts because you cannot easily determine which unit has
the failed interface and caused the link to come down.
The ASA supports Auto-MDI/MDIX on its copper Ethernet ports, so you can either use a crossover
cable or a straight-through cable. If you use a straight-through cable, the interface automatically detects
the cable and swaps one of the transmit/receive pairs to MDIX.
For optimum performance when using long distance failover, the latency for the state link should be less than
10 milliseconds and no more than 250 milliseconds. If latency is more than 10 milliseconds, some performance
degradation occurs due to retransmission of failover messages.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
199
About Failover
Scenario 2—Recommended
We recommend that failover links NOT use the same switch as the data interfaces. Instead, use a different
switch or use a direct cable to connect the failover link, as shown in the following figures.
Scenario 3—Recommended
If the ASA data interfaces are connected to more than one set of switches, then a failover link can be connected
to one of the switches, preferably the switch on the secure (inside) side of network, as shown in the following
figure.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
200
About Failover
Scenario 4—Recommended
The most reliable failover configurations use a redundant interface on the failover link, as shown in the
following figures.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
201
About Failover
1 When the primary unit or failover group fails over, the secondary unit assumes the IP addresses and MAC
addresses of the primary unit and begins passing traffic.
2 The unit that is now in standby state takes over the standby IP addresses and MAC addresses.
Because network devices see no change in the MAC to IP address pairing, no ARP entries change or time out
anywhere on the network.
If the secondary unit boots without detecting the primary unit, the secondary unit becomes the active unit and
uses its own MAC addresses, because it does not know the primary unit MAC addresses. However, when the
primary unit becomes available, the secondary (active) unit changes the MAC addresses to those of the primary
unit, which can cause an interruption in your network traffic. Similarly, if you swap out the primary unit with
new hardware, a new MAC address is used.
Virtual MAC addresses guard against this disruption because the active MAC addresses are known to the
secondary unit at startup, and remain the same in the case of new primary unit hardware. In multiple context
mode, you can configure the ASA to generate virtual active and standby MAC addresses automatically. In
single context mode, you can manually configure virtual MAC addresses.
If you do not configure virtual MAC addresses, you might need to clear the ARP tables on connected routers
to restore traffic flow. The ASA does not send gratuitous ARPs for static NAT addresses when the MAC
address changes, so connected routers do not learn of the MAC address change for these addresses.
The IP address and MAC address for the state link do not change at failover; the only exception is if the state
link is configured on a regular data interface.
Related Topics
About MAC Addresses, on page 163
Configure Active/Active Failover, on page 224
Intra- and Inter-Chassis Module Placement for the ASA Services Module
You can place the primary and secondary ASASMs within the same switch or in two separate switches.
Intra-Chassis Failover
If you install the secondary ASASM in the same switch as the primary ASASM, you protect against
module-level failure.
Even though both ASASMs are assigned the same VLANs, only the active module takes part in networking.
The standby module does not pass any traffic.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
202
About Failover
Inter-Chassis Failover
To protect against switch-level failure, you can install the secondary ASASM in a separate switch. The ASASM
does not coordinate failover directly with the switch, but it works harmoniously with the switch failover
operation. See the switch documentation to configure failover for the switch.
For the best reliability of failover communications between ASASMs, we recommend that you configure an
EtherChannel trunk port between the two switches to carry the failover and state VLANs.
For other VLANs, you must ensure that both switches have access to all firewall VLANs, and that monitored
VLANs can successfully pass hello packets between both switches.
The following figure shows a typical switch and ASASM redundancy configuration. The trunk between the
two switches carries the failover ASASM VLANs (VLANs 10 and 11).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
203
About Failover
Note ASASM failover is independent of the switch failover operation; however, ASASM works in any switch
failover scenario.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
204
About Failover
If the primary ASASM fails, then the secondary ASASM becomes active and successfully passes the firewall
VLANs.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
205
About Failover
If the entire switch fails, as well as the ASASM (such as in a power failure), then both the switch and the
ASASM fail over to their secondary units.
Note Some configuration elements for clientless SSL VPN (such as bookmarks and customization) use the VPN
failover subsystem, which is part of Stateful Failover. You must use Stateful Failover to synchronize these
elements between the members of the failover pair. Stateless failover is not recommended for clientless
SSL VPN.
Stateless Failover
When a failover occurs, all active connections are dropped. Clients need to reestablish connections when the
new active unit takes over.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
206
About Failover
Note Some configuration elements for clientless SSL VPN (such as bookmarks and customization) use the VPN
failover subsystem, which is part of Stateful Failover. You must use Stateful Failover to synchronize these
elements between the members of the failover pair. Stateless (regular) failover is not recommended for
clientless SSL VPN.
Stateful Failover
When Stateful Failover is enabled, the active unit continually passes per-connection state information to the
standby unit, or in Active/Active failover, between the active and standby failover groups. After a failover
occurs, the same connection information is available at the new active unit. Supported end-user applications
are not required to reconnect to keep the same communication session.
Supported Features
The following state information is passed to the standby ASA when Stateful Failover is enabled:
• NAT translation table
• TCP connection states
• UDP connection states
• The ARP table
• The Layer 2 bridge table (when running in transparent firewall mode)
• The HTTP connection states (if HTTP replication is enabled)—By default, the ASA does not replicate
HTTP session information when Stateful Failover is enabled. Because HTTP sessions are typically
short-lived, and because HTTP clients typically retry failed connection attempts, not replicating HTTP
sessions increases system performance without causing serious data or connection loss.
• The ISAKMP and IPsec SA table
• GTP PDP connection database
• SIP signalling sessions
• ICMP connection state—ICMP connection replication is enabled only if the respective interface is
assigned to an asymmetric routing group.
• Dynamic Routing Protocols—Stateful Failover participates in dynamic routing protocols, like OSPF
and EIGRP, so routes that are learned through dynamic routing protocols on the active unit are maintained
in a Routing Information Base (RIB) table on the standby unit. Upon a failover event, packets travel
normally with minimal disruption to traffic because the active secondary ASA initially has rules that
mirror the primary ASA. Immediately after failover, the re-convergence timer starts on the newly Active
unit. Then the epoch number for the RIB table increments. During re-convergence, OSPF and EIGRP
routes become updated with a new epoch number. Once the timer is expired, stale route entries (determined
by the epoch number) are removed from the table. The RIB then contains the newest routing protocol
forwarding information on the newly Active unit.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
207
About Failover
Note Routes are synchronized only for link-up or link-down events on an active unit. If the
link goes up or down on the standby unit, dynamic routes sent from the active unit may
be lost. This is normal, expected behavior.
• Cisco IP SoftPhone sessions—If a failover occurs during an active Cisco IP SoftPhone session, the call
remains active because the call session state information is replicated to the standby unit. When the call
is terminated, the IP SoftPhone client loses connection with the Cisco Call Manager. This connection
loss occurs because there is no session information for the CTIQBE hangup message on the standby
unit. When the IP SoftPhone client does not receive a response back from the Call Manager within a
certain time period, it considers the Call Manager unreachable and unregisters itself.
• VPN—VPN end-users do not have to reauthenticate or reconnect the VPN session after a failover.
However, applications operating over the VPN connection could lose packets during the failover process
and not recover from the packet loss.
Unsupported Features
The following state information is not passed to the standby ASA when Stateful Failover is enabled:
• The HTTP connection table (unless HTTP replication is enabled)
• The user authentication (uauth) table
• Application inspections that are subject to advanced TCP-state tracking—The TCP state of these
connections is not automatically replicated. While these connections are replicated to the standby unit,
there is a best-effort attempt to re-establish a TCP state.
• TCP state bypass connections
• DHCP client
• DHCP server address leases
• Multicast routing
• State information for modules, such as the ASA FirePOWER module.
• Phone proxy connections—When the active unit goes down, the call fails, media stops flowing, and the
phone should unregister from the failed unit and reregister with the active unit. The call must be
re-established.
• Selected clientless SSL VPN features:
◦Smart Tunnels
◦Port Forwarding
◦Plugins
◦Java Applets
◦IPv6 clientless or Anyconnect sessions
◦Citrix authentication (Citrix users must reauthenticate after failover)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
208
About Failover
interface interface_id
spanning-tree portfast
The PortFast feature immediately transitions the port into STP forwarding mode upon linkup. The port
still participates in STP. So if the port is to be a part of the loop, the port eventually transitions into STP
blocking mode.
• Trunk mode—Block BPDUs on the ASA on both the inside and outside interfaces with an EtherType
access rule.
Blocking BPDUs disables STP on the switch. Be sure not to have any loops involving the ASA in your
network layout.
If neither of the above options are possible, then you can use one of the following less desirable workarounds
that impacts failover functionality or STP stability:
• Disable interface monitoring.
• Increase interface holdtime to a high value that will allow STP to converge before the ASAs fail over.
• Decrease STP timers to allow STP to converge faster than the interface holdtime.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
209
About Failover
The spanning tree protocol can break such loops if there is a timely exchange of BPDUs. To break the loop,
BPDUs sent between VLAN 200 and VLAN 201 need to be bridged.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
210
About Failover
Interface Monitoring
You can monitor up to 250 interfaces (in multiple mode, divided between all contexts). You should monitor
important interfaces. For example in multiple mode, you might configure one context to monitor a shared
interface: because the interface is shared, all contexts benefit from the monitoring.
When a unit does not receive hello messages on a monitored interface for 2 polling periods, it runs interface
tests. If all interface tests fail for an interface, but this same interface on the other unit continues to successfully
pass traffic, then the interface is considered to be failed. If the threshold for failed interfaces is met, then a
failover occurs. If the other unit interface also fails all the network tests, then both interfaces go into the
“Unknown” state and do not count towards the failover limit.
An interface becomes operational again if it receives any traffic. A failed ASA returns to standby mode if the
interface failure threshold is no longer met.
If you have a services module, such as the ASA FirePOWER SSP, then the ASA also monitors the health of
the module over the backplane interface. Failure of the module is considered a unit failure and will trigger
failover. This setting is configurable.
If an interface has IPv4 and IPv6 addresses configured on it, the ASA uses the IPv4 addresses to perform the
health monitoring.
If an interface has only IPv6 addresses configured on it, then the ASA uses IPv6 neighbor discovery instead
of ARP to perform the health monitoring tests. For the broadcast ping test, the ASA uses the IPv6 all nodes
address (FE02::1).
Note If a failed unit does not recover and you believe it should not be failed, you can reset the state by entering
the failover reset command. If the failover condition persists, however, the unit will fail again.
Interface Tests
The ASA uses the following interface tests:
1 Link Up/Down test—A test of the interface status. If the Link Up/Down test indicates that the interface
is down, then the ASA considers it failed. If the status is Up, then the ASA performs the Network Activity
test.
2 Network Activity test—A received network activity test. The purpose of this test is to generate network
traffic using LANTEST messages to determine which (if either) unit has failed. At the start of the test,
each unit clears its received packet count for its interfaces. As soon as a unit receives any packets during
the test (up to 5 seconds), then the interface is considered operational. If one unit receives traffic and the
other unit does not, then the unit that received no traffic is considered failed. If neither unit received traffic,
then the ASA starts the ARP test.
3 ARP test—A reading of the unit ARP cache for the 10 most recently acquired entries. One at a time, the
unit sends ARP requests to these machines, attempting to stimulate network traffic. After each request,
the unit counts all received traffic for up to 5 seconds. If traffic is received, the interface is considered
operational. If no traffic is received, an ARP request is sent to the next machine. If at the end of the list
no traffic has been received, the ASA starts the ping test.
4 Broadcast Ping test—A ping test that consists of sending out a broadcast ping request. The unit then counts
all received packets for up to 5 seconds. If any packets are received at any time during this interval, the
interface is considered operational and testing stops. If no traffic is received, the testing starts over again
with the ARP test.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
211
About Failover
Interface Status
Monitored interfaces can have the following status:
• Unknown—Initial status. This status can also mean the status cannot be determined.
• Normal—The interface is receiving traffic.
• Testing—Hello messages are not heard on the interface for five poll times.
• Link Down—The interface or VLAN is administratively down.
• No Link—The physical link for the interface is down.
• Failed—No traffic is received on the interface, yet traffic is heard on the peer interface.
Failover Times
The following table shows the minimum, default, and maximum failover times.
Active unit main board interface link down. 500 milliseconds 5 seconds 15 seconds
Active unit 4GE module interface link down. 2 seconds 5 seconds 15 seconds
Configuration Synchronization
Failover includes various types of configuration synchronization.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
212
About Failover
Note During replication, commands entered on the active unit may not replicate properly to the standby unit,
and commands entered on the standby unit may be overwritten by the configuration being replicated from
the active unit. Avoid entering commands on either unit during the configuration replication process.
Note The crypto ca server command and related sub commands are not synchronized to the failover peer.
File Replication
Configuration syncing does not replicate the following files and configuration components, so you must copy
these files manually so they match:
• AnyConnect images
• CSD images
• AnyConnect profiles
The ASA uses a cached file for the AnyConnect client profile stored in cache:/stc/profiles, and not the
file stored in the flash file system. To replicate the AnyConnect client profile to the standby unit, perform
one of the following:
◦Enter the write standby command on the active unit.
◦Reapply the profile on the active unit.
◦Reload the standby unit.
Command Replication
After startup, commands that you enter on the active unit are immediately replicated to the standby unit. You
do not have to save the active configuration to flash memory to replicate the commands.
In Active/Active failover, commands entered in the system execution space are replicated from the unit on
which failover group 1 is in the active state.
Failure to enter the commands on the appropriate unit for command replication to occur causes the
configurations to be out of synchronization. Those changes may be lost the next time the initial configuration
synchronization occurs.
The following commands are replicated to the standby ASA:
• All configuration commands except for mode, firewall, and failover lan unit
• copy running-config startup-config
• delete
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
213
About Failover
• mkdir
• rename
• rmdir
• write memory
Note For multiple context mode, the ASA can fail over the entire unit (including all contexts) but cannot fail
over individual contexts separately.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
214
About Failover
• If both units boot simultaneously, then the primary unit becomes the active unit, and the secondary unit
becomes the standby unit.
Failover Events
In Active/Standby failover, failover occurs on a unit basis. Even on systems running in multiple context mode,
you cannot fail over individual or groups of contexts.
The following table shows the failover action for each failure event. For each failure event, the table shows
the failover policy (failover or no failover), the action taken by the active unit, the action taken by the standby
unit, and any special notes about the failover condition and actions.
Standby Group
Failure Event Policy Active Group Action Action Notes
Active unit failed (power or Failover n/a Become active No hello messages are received on
hardware) Mark active as failed any monitored interface or the
failover link.
Standby unit failed (power or No failover Mark standby as n/a When the standby unit is marked as
hardware) failed failed, then the active unit does not
attempt to fail over, even if the
interface failure threshold is
surpassed.
Failover link failed during No failover Mark failover link as Mark failover link as You should restore the failover link
operation failed failed as soon as possible because the unit
cannot fail over to the standby unit
while the failover link is down.
Failover link failed at startup No failover Mark failover link as Become active If the failover link is down at startup,
failed both units become active.
State link failed No failover No action No action State information becomes out of
date, and sessions are terminated if a
failover occurs.
Interface failure on active unit Failover Mark active as failed Become active None.
above threshold
Interface failure on standby unit No failover No action Mark standby as When the standby unit is marked as
above threshold failed failed, then the active unit does not
attempt to fail over even if the
interface failure threshold is
surpassed.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
215
About Failover
Note When configuring Active/Active failover, make sure that the combined traffic for both units is within the
capacity of each unit.
Note You can assign both failover groups to one ASA if desired, but then you are not taking advantage of having
two active ASAs.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
216
About Failover
◦A failover occurs.
◦You manually force a failover.
◦You configured preemption for the failover group, which causes the failover group to automatically
become active on the preferred unit when the unit becomes available.
• When both units boot at the same time, each failover group becomes active on its preferred unit after
the configurations have been synchronized.
Failover Events
In an Active/Active failover configuration, failover occurs on a failover group basis, not a system basis. For
example, if you designate both failover groups as active on the primary unit, and failover group 1 fails, then
failover group 2 remains active on the primary unit while failover group 1 becomes active on the secondary
unit.
Because a failover group can contain multiple contexts, and each context can contain multiple interfaces, it
is possible for all interfaces in a single context to fail without causing the associated failover group to fail.
The following table shows the failover action for each failure event. For each failure event, the policy (whether
or not failover occurs), actions for the active failover group, and actions for the standby failover group are
given.
Interface failure on active failover group Failover Mark active Become active None.
above threshold group as failed
Interface failure on standby failover No failover No action Mark standby When the standby failover group is
group above threshold group as failed marked as failed, the active failover
group does not attempt to fail over,
even if the interface failure threshold
is surpassed.
Formerly active failover group recovers No failover No action No action Unless failover group preemption is
configured, the failover groups remain
active on their current unit.
Failover link failed at startup No failover Become active Become active If the failover link is down at startup,
both failover groups on both units
become active.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
217
Licensing for Failover
Failover link failed during operation No failover n/a n/a Each unit marks the failover link as
failed. You should restore the failover
link as soon as possible because the
unit cannot fail over to the standby
unit while the failover link is down.
Note Each unit must have the same encryption license; each unit must have the same IPS module license.
You also need the IPS signature subscription on the IPS side for both units. See the following
guidelines:
• To buy the IPS signature subscription you need to have the ASA with IPS pre-installed (the
part number must include “IPS”, for example ASA5515-IPS-K9); you cannot buy the IPS
signature subscription for a non-IPS part number ASA.
• You need the IPS signature subscription on both units; this subscription is not shared in
failover, because it is not an ASA license.
• The IPS signature subscription requires a unique IPS module license per unit. Like other
ASA licenses, the IPS module license is technically shared in the failover cluster license.
However, because of the IPS signature subscription requirements, you must buy a separate
IPS module license for each unit in.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
218
Guidelines for Failover
Note The standby unit requires the same model license as the primary unit; Each unit must have the
same encryption license.
All other models Base License or Standard License.
Note Each unit must have the same encryption
license.
Note A valid permanent key is required; in rare instances, your PAK authentication key can be removed. If
your key consists of all 0’s, then you need to reinstall a valid authentication key before failover can be
enabled.
Model Support
• ASA 5506W-X—You must disable interface monitoring for the internal GigabitEthernet 1/9 interface.
These interfaces will not be able to communicate to perform the default interface monitoring checks,
resulting in a switch from active to standby and back again because of expected interface communication
failures.
• ASA on the Firepower 9300—We recommend that you use inter-chasss failover for the best redundancy.
Additional Guidelines
• Configuring port security on the switch(es) connected to an ASA failover pair can cause communication
problems when a failover event occurs. This problem occurs when a secure MAC address configured
or learned on one secure port moves to another secure port, a violation is flagged by the switch port
security feature.
• You can monitor up to 250 interfaces on a unit, across all contexts.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
219
Defaults for Failover
• For Active/Active failover, no two interfaces in the same context should be configured in the same ASR
group.
• For Active/Active failover, you can define a maximum of two failover groups.
• For Active/Active failover, when removing failover groups, you must remove failover group 1 last.
Failover group1 always contains the admin context. Any context not assigned to a failover group defaults
to failover group 1. You cannot remove a failover group that has contexts explicitly assigned to it.
Related Topics
Auto Update Server Support in Failover Configurations, on page 869
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
220
Configure Active/Standby Failover
Procedure
Example:
ciscoasa(config)# failover lan interface folink gigabitethernet0/3
This interface cannot be used for any other purpose (except, optionally, the state link).
The if_name argument assigns a name to the interface.
The interface_id argument can be a data physical interface, subinterface, redundant interface, or EtherChannel
interface ID. On the ASASM, the interface_id specifies a VLAN ID. For the ASA 5506H-X only, you can
specify the Management 1/1 interface as the failover link. If you do so, you must save the configuration with
write memory, and then reload the device. You then cannot use this interface for failover and also use the
ASA Firepower module; the module requires the interface for management, and you can only use it for one
function. For the Firepower 9300 ASA security module, you can use any data or management type interface.
Step 3 Assign the active and standby IP addresses to the failover link:
failover interface ip failover_if_name {ip_address mask | ipv6_address / prefix} standby ip_address
Example:
ciscoasa(config)# failover interface ip folink 172.27.48.1 255.255.255.0 standby 172.27.48.2
Or:
Example:
ciscoasa(config)# interface gigabitethernet 0/3
ciscoasa(config-if)# no shutdown
Step 5 (Optional) Specify the interface you want to use as the state link:
failover link if_name interface_id
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
221
Configure Active/Standby Failover
Example:
ciscoasa(config)# failover link folink gigabitethernet0/3
Step 6 If you specified a separate state link, assign the active and standby IP addresses to the state link:
failover interface ip state_if_name {ip_address mask | ipv6_address/prefix} standby ip_address
Example:
ciscoasa(config)# failover interface ip statelink 172.27.49.1 255.255.255.0 standby
172.27.49.2
Or:
This address should be on an unused subnet, different from the failover link.
The standby IP address must be in the same subnet as the active IP address.
Skip this step if you are sharing the state link.
Step 7 If you specified a separate state link, enable the state link.
interface state_interface_id
no shutdown
Example:
ciscoasa(config)# interface gigabitethernet 0/4
ciscoasa(config-if)# no shutdown
Step 8 (Optional) Do one of the following to encrypt communications on the failover and state links:
• (Preferred) Establish IPsec LAN-to-LAN tunnels on the failover and state links between the units to
encrypt all failover communications:
failover ipsec pre-shared-key [0 | 8] key
Example:
The key can be up to 128 characters in length. Identify the same key on both units. The key is used by
IKEv2 to establish the tunnels.
If you use a master passphrase (see Configure the Master Passphrase, on page 485), then the key is
encrypted in the configuration. If you are copying from the configuration (for example, from more
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
222
Configure Active/Standby Failover
system:running-config output), specify that the key is encrypted by using the 8 keyword. 0 is used by
default, specifying an unencrypted password.
The failover ipsec pre-shared-key shows as ***** in show running-config output; this obscured key
is not copyable.
If you do not configure failover and state link encryption, failover communication, including any
passwords or keys in the configuration that are sent during command replication, will be in clear text.
You cannot use both IPsec encryption and the legacy failover key encryption. If you configure both
methods, IPsec is used. However, if you use the master passphrase, you must first remove the failover
key using the no failover key command before you configure IPsec encryption.
Failover LAN-to-LAN tunnels do not count against the IPsec (Other VPN) license.
• (Optional) Encrypt failover communication on the failover and state links:
failover key [0 | 8] {hex key | shared_secret}
Example:
Use a shared_secret from 1 to 63 characters or a 32-character hex key. For the shared_secret, you can
use any combination of numbers, letters, or punctuation. The shared secret or hex key is used to generate
the encryption key. Identify the same key on both units.
If you use a master passphrase (see Configure the Master Passphrase, on page 485), then the shared
secret or hex key is encrypted in the configuration. If you are copying from the configuration (for
example, from more system:running-config output), specify that the shared secret or hex key is encrypted
by using the 8 keyword. 0 is used by default, specifying an unencrypted password.
The failover key shared secret shows as ***** in show running-config output; this obscured key is
not copyable.
If you do not configure failover and state link encryption, failover communication, including any
passwords or keys in the configuration that are sent during command replication, will be in clear text.
Examples
The following example configures the failover parameters for the primary unit:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
223
Configure Active/Active Failover
Procedure
Step 1 Re-enter the exact same commands as on the primary unit except for the failover lan unit primary command.
You can optionally replace it with the failover lan unit secondary command, but it is not necessary because
secondary is the default setting. See Configure the Primary Unit for Active/Standby Failover, on page 220.
For example:
Step 2 After the failover configuration syncs, save the configuration to flash memory:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
224
Configure Active/Active Failover
• Configure standby IP addresses for all interfaces except for the failover and state links according to
Routed and Transparent Mode Interfaces, on page 431.
• Do not configure a nameif for the failover and state links.
• Complete this procedure in the system execution space. To change from the context to the system
execution space, enter the changeto system command.
Procedure
Example:
ciscoasa(config)# failover lan interface folink gigabitethernet0/3
This interface cannot be used for any other purpose (except, optionally, the state link).
The if_name argument assigns a name to the interface.
The interface_id argument can be a physical interface, subinterface, redundant interface, or EtherChannel
interface ID. On the ASASM, the interface_id specifies a VLAN ID.
Step 3 Assign the active and standby IP addresses to the failover link:
standby failover interface ip if_name {ip_address mask | ipv6_address/prefix } standby ip_address
Example:
ciscoasa(config)# failover interface ip folink 172.27.48.1 255.255.255.0 standby 172.27.48.2
Or:
Example:
ciscoasa(config)# interface gigabitethernet 0/3
ciscoasa(config-if)# no shutdown
Step 5 (Optional) Specify the interface you want to use as the state link:
failover link if_name interface_id
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
225
Configure Active/Active Failover
Example:
ciscoasa(config)# failover link statelink gigabitethernet0/4
We recommend specifying a separate interface from the failover link or data interfaces.
The if_name argument assigns a name to the interface.
The interface_id argument can be a physical interface, subinterface, redundant interface, or EtherChannel
interface ID. On the ASASM, the interface_id specifies a VLAN ID.
Step 6 If you specified a separate state link, assign the active and standby IP addresses to the state link:
This address should be on an unused subnet, different from the failover link.
The standby IP address must be in the same subnet as the active IP address.
Skip this step if you are sharing the state link.
failover interface ip state if_name {ip_address mask | ipv6_address/prefix} standby ip_address
Example:
ciscoasa(config)# failover interface ip statelink 172.27.49.1 255.255.255.0 standby
172.27.49.2
Or:
Step 7 If you specified a separate state link, enable the state link:
interface state_interface_id
no shutdown
Example:
ciscoasa(config)# interface gigabitethernet 0/4
ciscoasa(config-if)# no shutdown
Step 8 (Optional) Do one of the following to encrypt communications on the failover and state links:
• (Preferred) Establish IPsec LAN-to-LAN tunnels on the failover and state links between the units to
encrypt all failover communications:
failover ipsec pre-shared-key [0 | 8] key
The key can be up to 128 characters in length. Identify the same key on both units. The key is used by
IKEv2 to establish the tunnels.
If you use a master passphrase (see Configure the Master Passphrase, on page 485), then the key is
encrypted in the configuration. If you are copying from the configuration (for example, from more
system:running-config output), specify that the key is encrypted by using the 8 keyword. 0 is used by
default, specifying an unencrypted password.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
226
Configure Active/Active Failover
The failover ipsec pre-shared-key shows as ***** in show running-config output; this obscured key
is not copyable.
If you do not configure failover and state link encryption, failover communication, including any
passwords or keys in the configuration that are sent during command replication, will be in clear text.
You cannot use both IPsec encryption and the legacy failover key encryption. If you configure both
methods, IPsec is used. However, if you use the master passphrase, you must first remove the failover
key using the no failover key command before you configure IPsec encryption.
Failover LAN-to-LAN tunnels do not count against the IPsec (Other VPN) license.
• (Optional) Encrypt failover communication on the failover and state links:
failover key [0 | 8] {hex key | shared_secret}
Step 11 Enter the context configuration mode for a given context, and assign the context to a failover group:
context name
join-failover-group {1 | 2}
Example:
ciscoasa(config)# context Eng
ciscoasa(config-ctx)# join-failover-group 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
227
Configure Active/Active Failover
Any unassigned contexts are automatically assigned to failover group 1. The admin context is always a member
of failover group 1; you cannot assign it to group 2.
Examples
The following example configures the failover parameters for the primary unit:
Procedure
Step 1 Re-enter the exact same commands as on the primary unit except for the failover lan unit primary command.
You can optionally replace it with the failover lan unit secondary command, but it is not necessary because
secondary is the default setting. You also do not need to enter the failover group and join-failover-group
commands, as they are replicated from the primary unit. See Configure the Primary Unit for Active/Active
Failover, on page 224.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
228
Configure Optional Failover Parameters
For example:
Step 2 After the failover configuration syncs from the primary unit, save the configuration to flash memory:
ciscoasa(config)# write memory
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
229
Configure Optional Failover Parameters
Example:
ciscoasa(config)# failover polltime unit msec 200 holdtime msec 800
Example:
ciscoasa(config)# failover replication rate 20000
Step 3 Disable the ability to make any configuration changes directly on the standby unit or context:
By default, configurations on the standby unit/context are allowed with a warning message.
failover standby config-lock
Step 4 (Active/Active mode only) Specify the failover group you want to customize:
failover group {1 | 2}
Example:
ciscoasa(config)# failover group 1
ciscoasa(config-fover-group)#
Step 5 (Active/Active mode only) Configure failover group preemption for failover group 1:
preempt [delay]
Example:
ciscoasa(config-fover-group)# preempt 1200
If one unit boots before the other, then both failover groups become active on that unit, despite the primary
or secondary setting. This command causes the failover group to become active on the designated unit
automatically when that unit becomes available.
You can enter an optional delay value, which specifies the number of seconds the failover group remains
active on the current unit before automatically becoming active on the designated unit. Valid values are from
1 to 1200.
If Stateful Failover is enabled, the preemption is delayed until the connections are replicated from the unit on
which the failover group is currently active.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
230
Configure Optional Failover Parameters
To allow HTTP connections to be included in the state information replication, you need to enable HTTP
replication. Because HTTP connections are typically short-lived, and because HTTP clients typically retry
failed connection attempts, HTTP connections are not automatically included in the replicated state information.
Valid values for poll time are from 1 to 15 seconds or, if the optional msec keyword is used, from 500 to 999
milliseconds. The hold time determines how long it takes from the time a hello packet is missed to when the
interface is marked as failed. Valid values for the hold time are from 5 to 75 seconds. You cannot enter a hold
time that is less than 5 times the poll time.
If the interface link is down, interface testing is not conducted and the standby unit could become active in
just one interface polling period if the number of failed interfaces meets or exceeds the configured failover
criteria.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
231
Configure Optional Failover Parameters
The phy_if argument is the physical name of the interface, such as gigabitethernet0/1.
The active_mac and standby_mac arguments are MAC addresses in H.H.H format, where H is a 16-bit
hexadecimal digit. For example, the MAC address 00-0C-F1-42-4C-DE would be entered as 000C.F142.4CDE.
The active_mac address is associated with the active IP address for the interface, and the standby_mac is
associated with the standby IP address for the interface.
You can also set the MAC address using other commands or methods, but we recommend using only one
method. If you set the MAC address using multiple methods, the MAC address used depends on many variables,
and might not be predictable.
Use the show interface command to display the MAC address used by an interface.
Step 10 (Active/Active mode only) Repeat this procedure for the other failover group, if desired.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
232
Configure Optional Failover Parameters
Example:
ciscoasa(config)# monitor-interface inside
ciscoasa(config)# no monitor-interface eng1
If you do not want a hardware or software module failure, such as the ASA FirePOWER module, to trigger
failover, you can disable module monitoring using the no monitor-interface service-module command. Note
that for the ASA 5585-X, if you disable monitoring of the service module, you may also want to disable
monitoring of the interfaces on the module, which are monitored separately.
Note This feature does not provide asymmetric routing; it restores asymmetrically routed packets to the correct
interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
233
Configure Optional Failover Parameters
1 An outbound session passes through the ASA with the active SecAppA context. It exits interface outside
ISP-A (192.168.1.1).
2 Because of asymmetric routing configured somewhere upstream, the return traffic comes back through
the interface outsideISP-B (192.168.2.2) on the ASA with the active SecAppB context.
3 Normally the return traffic would be dropped because there is no session information for the traffic on
interface 192.168.2.2. However, the interface is configured as part of ASR group 1. The unit looks for the
session on any other interface configured with the same ASR group ID.
4 The session information is found on interface outsideISP-A (192.168.1.2), which is in the standby state
on the unit with SecAppB. Stateful Failover replicated the session information from SecAppA to SecAppB.
5 Instead of being dropped, the layer 2 header is rewritten with information for interface 192.168.1.1 and
the traffic is redirected out of the interface 192.168.1.2, where it can then return through the interface on
the unit from which it originated (192.168.1.1 on SecAppA). This forwarding continues as needed until
the session ends.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
234
Configure Optional Failover Parameters
• Perform this procedure within each active context on the primary and secondary units.
• You cannot configure both ASR groups and traffic zones within a context. If you configure a zone in a
context, none of the context interfaces can be part of an ASR group.
Procedure
Step 1 On the primary unit, specify the interface for which you want to allow asymmetrically routed packets:
interface phy_if
Example:
primary/admin(config)# interface gigabitethernet 0/0
Example:
primary/admin(config-ifc)# asr-group 1
Step 3 On the secondary unit, specify the similar interface for which you want to allow asymmetrically routed packets:
interface phy_if
Example:
secondary/ctx1(config)# interface gigabitethernet 0/1
Step 4 Set the ASR group number for the interface to match the primary unit interface:
asr-group num
Example:
secondary/ctx1(config-ifc)# asr-group 1
Examples
The two units have the following configuration (configurations show only the relevant commands). The device
labeled SecAppA in the diagram is the primary unit in the failover pair.
Primary Unit System Configuration
interface GigabitEthernet0/1
description LAN/STATE Failover Interface
interface GigabitEthernet0/2
no shutdown
interface GigabitEthernet0/3
no shutdown
interface GigabitEthernet0/4
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
235
Manage Failover
no shutdown
interface GigabitEthernet0/5
no shutdown
failover
failover lan unit primary
failover lan interface folink GigabitEthernet0/1
failover link folink
failover interface ip folink 10.0.4.1 255.255.255.0 standby 10.0.4.11
failover group 1
primary
failover group 2
secondary
admin-context SecAppA
context admin
allocate-interface GigabitEthernet0/2
allocate-interface GigabitEthernet0/3
config-url flash:/admin.cfg
join-failover-group 1
context SecAppB
allocate-interface GigabitEthernet0/4
allocate-interface GigabitEthernet0/5
config-url flash:/ctx1.cfg
join-failover-group 2
interface GigabitEthernet0/2
nameif outsideISP-A
security-level 0
ip address 192.168.1.1 255.255.255.0 standby 192.168.1.2
asr-group 1
interface GigabitEthernet0/3
nameif inside
security-level 100
ip address 10.1.0.1 255.255.255.0 standby 10.1.0.11
monitor-interface outside
interface GigabitEthernet0/4
nameif outsideISP-B
security-level 0
ip address 192.168.2.2 255.255.255.0 standby 192.168.2.1
asr-group 1
interface GigabitEthernet0/5
nameif inside
security-level 100
ip address 10.2.20.1 255.255.255.0 standby 10.2.20.11
Manage Failover
This section describes how to manage failover units after you enable failover, including how to change the
failover setup and how to force failover from one unit to another.
Related Topics
Configure Optional Failover Parameters, on page 229
Force Failover
To force the standby unit to become active, perform the following procedure.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
236
Manage Failover
Procedure
Step 1 Force a failover when entered on the standby unit. The standby unit becomes the active unit.
If you specify the group group_id, then this command forces a failover when entered on the standby unit for
the specified Active/Active failover group. The standby unit becomes the active unit for the failover group.
• For Active/Standby mode on the standby unit:
failover active
• For Active/Active mode on the standby unit:
failover active [group group_id]
Example:
Step 2 Force a failover when entered on the active unit. The active unit becomes the standby unit.
If you specify the group group_id, then this command forces a failover when entered on the active unit for
the specified failover group. The active unit becomes the standby unit for the failover group.
• For Active/Standby mode on the active unit:
no failover active
• For Active/Active mode on the active unit:
no failover active [group group_id]
Example:
Step 3 (Active/Active mode only) To force failover at the failover group level:
a) In the System choose Monitoring > Failover > Failover Group #, where # is the number of the failover
group you want to control.
b) Click one of the following buttons
• Click Make Active to make the failover group active on this unit.
• Click Make Standby to make the failover group active on the other unit.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
237
Manage Failover
Disable Failover
Disabling failover on one or both units causes the active and standby state of each unit to be maintained until
you reload. For an Active/Active failover pair, the failover groups remain in the active state on whichever
unit they are active, no matter which unit they are configured to prefer.
See the following characteristics when you disable failover:
• The standby unit/context remains in standby mode so that both units do not start passing traffic (this is
called a pseudo-standby state).
• The standby unit/context continues to use its standby IP addresses even though it is no longer connected
to an active unit/context.
• The standby unit/context continues to listen for a connection on the failover link. If failover is re-enabled
on the active unit/context, then the standby unit/context resumes ordinary standby status after
re-synchronizing the rest of its configuration.
• To truly disable failover, save the no failover configuration to the startup configuration, and then reload.
Procedure
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
238
Manage Failover
Restoring a failed unit to an unfailed state does not automatically make it active; restored units remain in the
standby state until made active by failover (forced or natural). An exception is a failover group (Active/Active
mode only) configured with failover preemption. If previously active, a failover group becomes active if it is
configured with preemption and if the unit on which it failed is the preferred unit.
If you specify the group group_id, this command restores a failed Active/Active failover group to an unfailed
state.
Step 2 (Active/Active mode only) To reset failover at the failover group level:
a) In the System choose Monitoring > Failover > Failover Group #, where # is the number of the failover
group you want to control.
b) Click Reset Failover.
Procedure
Step 1 Test that your active unit is passing traffic as expected by using FTP (for example) to send a file between
hosts on different interfaces.
Step 2 Force a failover by entering the following command on the active unit:
Active/Standby mode:
ciscoasa(config)# no failover active
Active/Active mode:
ciscoasa(config)# no failover active group group_id
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
239
Manage Failover
Step 3 Use FTP to send another file between the same two hosts.
Step 4 If the test was not successful, enter the show failover command to check the failover status.
Step 5 When you are finished, you can restore the unit to active status by enter the following command on the newly
active unit:
Active/Standby mode:
ciscoasa(config)# no failover active
Active/Active mode:
ciscoasa(config)# failover active group group_id
Note When an ASA interface goes down, for failover it is still considered to be a unit issue. If the ASA
detects that an interface is down, failover occurs immediately, without waiting for the interface
holdtime. The interface holdtime is only useful when the ASA considers its status to be OK, although
it is not receiving hello packets from the peer. To simulate interface holdtime, shut down the VLAN
on the switch to prevent peers from receiving hello packets from each other.
Send a Command
Because configuration commands are replicated from the active unit or context to the standby unit or context,
you can use the failover exec command to enter configuration commands on the correct unit, no matter which
unit you are logged in to. For example, if you are logged in to the standby unit, you can use the failover exec
active command to send configuration changes to the active unit. Those changes are then replicated to the
standby unit. Do not use the failover exec command to send configuration commands to the standby unit or
context; those configuration changes are not replicated to the active unit and the two configurations will no
longer be synchronized.
Output from configuration, exec, and show commands is displayed in the current terminal session, so you
can use the failover exec command to issue show commands on a peer unit and view the results in the current
terminal.
You must have sufficient privileges to execute a command on the local unit to execute the command on the
peer unit.
Procedure
Step 1 If you are in multiple context mode, use the changeto contextname command to change to the context you
want to configure. You cannot change contexts on the failover peer with the failover exec command.
Step 2 Use the following command to send commands to he specified failover unit:
ciscoasa(config)# failover exec {active | mate | standby}
Use the active or standby keyword to cause the command to be executed on the specified unit, even if that
unit is the current unit. Use the mate keyword to cause the command to be executed on the failover peer.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
240
Manage Failover
Commands that cause a command mode change do not change the prompt for the current session. You must
use the show failover exec command to display the command mode the command is executed in. See Change
Command Modes for more information.
Changing commands modes for your current session to the device does not affect the command mode used
by the failover exec command. For example, if you are in interface configuration mode on the active unit,
and you have not changed the failover exec command mode, the following command would be executed in
global configuration mode. The result would be that your session to the device remains in interface configuration
mode, while commands entered using failover exec active are sent to router configuration mode for the
specified routing process.
Use the show failover exec command to display the command mode on the specified device in which commands
sent with the failover exec command are executed. The show failover exec command takes the same keywords
as the failover exec command: active, mate, or standby. The failover exec mode for each device is tracked
separately.
For example, the following is sample output from the show failover exec command entered on the standby
unit:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
241
Monitoring Failover
Security Considerations
The failover exec command uses the failover link to send commands to and receive the output of the command
execution from the peer unit. You should enable encryption on the failover link to prevent eavesdropping or
man-in-the-middle attacks.
• If the standby unit is in the failed state, it can still receive commands from the failover exec command
if the failure is due to a service card failure; otherwise, the remote command execution will fail.
• You cannot use the failover exec command to switch from privileged EXEC mode to global configuration
mode on the failover peer. For example, if the current unit is in privileged EXEC mode, and you enter
failover exec mate configure terminal, the show failover exec mate output will show that the failover
exec session is in global configuration mode. However, entering configuration commands for the peer
unit using failover exec will fail until you enter global configuration mode on the current unit.
• You cannot enter recursive failover exec commands, such as failover exec mate failover exec mate
command.
• Commands that require user input or confirmation must use the /nonconfirm option.
Monitoring Failover
This section lets you monitor the failover status.
Failover Messages
When a failover occurs, both ASAs send out system messages.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
242
Monitoring Failover
Note During a fail over, failover logically shuts down and then bring up interfaces, generating syslog messages
411001 and 411002. This is normal activity.
Note Because debugging output is assigned high priority in the CPU process, it can drastically affect system
performance. For this reason, use the debug fover commands only to troubleshoot specific problems or
during troubleshooting sessions with Cisco TAC.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
243
History for Failover
Support for a hex value for the failover key 7.0(4) You can now specify a hex value for failover link encryption.
We modified the following command: failover key hex.
Support for the master passphrase for the failover 8.3(1) The failover key now supports the master passphrase, which
key encrypts the shared key in the running and startup configuration.
If you are copying the shared secret from one ASA to another,
for example from the more system:running-config command,
you can successfully copy and paste the encrypted shared key.
Note The failover key shared secret shows as ***** in show
running-config output; this obscured key is not
copyable.
We modified the following command: failover key [0 | 8].
IPv6 support for failover added. 8.2(2) We modified the following commands: failover interface ip,
show failover, ipv6 address, show monitor-interface.
Support for IPsec LAN-to-LAN tunnels to encrypt 9.1(2) Instead of using the proprietary encryption for the failover key
failover and state link communications (the failover key command), you can now use an IPsec
LAN-to-LAN tunnel for failover and state link encryption.
Note Failover LAN-to-LAN tunnels do not count against
the IPsec (Other VPN) license.
We introduced or modified the following commands: failover
ipsec pre-shared-key, show vpn-sessiondb.
Disable health monitoring of a hardware module 9.3(1) By default, the ASA monitors the health of an installed
hardware module such as the ASA FirePOWER module. If you
do not want a hardware module failure to trigger failover, you
can disable module monitoring.
We modified the following command: monitor-interface
service-module
Lock configuration changes on the standby unit or 9.3(2) You can now lock configuration changes on the standby unit
standby context in a failover pair (Active/Standby failover) or the standby context (Active/Active
failover) so you cannot make changes on the standby unit
outside normal configuration syncing.
We introduced the following command: failover standby
config-lock
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
244
History for Failover
Carrier Grade NAT enhancements now supported 9.5(2) For carrier-grade or large-scale PAT, you can allocate a block
in failover and ASA clustering of ports for each host, rather than have NAT allocate one port
translation at a time (see RFC 6888). This feature is now
supported in failover and ASA cluster deployments.
We modified the following command: show local-host
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
245
History for Failover
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
246
CHAPTER 8
ASA Cluster
Clustering lets you group multiple ASAs together as a single logical device. A cluster provides all the
convenience of a single device (management, integration into a network) while achieving the increased
throughput and redundancy of multiple devices.
Note Some features are not supported when using clustering. See Unsupported Features with Clustering, on
page 274.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
247
About ASA Clustering
• Isolated, high-speed backplane network for intra-cluster communication, known as the cluster control
link.
• Management access to each ASA for configuration and monitoring.
When you place the cluster in your network, the upstream and downstream routers need to be able to
load-balance the data coming to and from the cluster using one of the following methods:
• Spanned EtherChannel (Recommended)—Interfaces on multiple members of the cluster are grouped
into a single EtherChannel; the EtherChannel performs load balancing between units.
• Policy-Based Routing (Routed firewall mode only)—The upstream and downstream routers perform
load balancing between units using route maps and ACLs.
• Equal-Cost Multi-Path Routing (Routed firewall mode only)—The upstream and downstream routers
perform load balancing between units using equal cost static or dynamic routes.
Related Topics
Licensing for ASA Clustering, on page 281
Cluster Control Link, on page 251
ASA Cluster Management, on page 256
Spanned EtherChannel (Recommended), on page 250
Policy-Based Routing (Routed Firewall Mode Only), on page 262
Equal-Cost Multi-Path Routing (Routed Firewall Mode Only), on page 263
For example, for throughput, the ASA 5585-X with SSP-40 can handle approximately 10 Gbps of real world
firewall traffic when running alone. For a cluster of 8 units, the maximum combined throughput will be
approximately 70% of 80 Gbps (8 units x 10 Gbps): 56 Gbps.
Cluster Members
Cluster members work together to accomplish the sharing of the security policy and traffic flows. This section
describes the nature of each member role.
Bootstrap Configuration
On each device, you configure a minimal bootstrap configuration including the cluster name, cluster control
link interface, and other cluster settings. The first unit on which you enable clustering typically becomes the
primary unit. When you enable clustering on subsequent units, they join the cluster as secondaries.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
248
About ASA Clustering
Related Topics
Centralized Features for Clustering, on page 274
Note If multiple units tie for the highest priority, the cluster unit name and then the serial number is used to
determine the primary.
4 If a unit later joins the cluster with a higher priority, it does not automatically become the primary unit;
the existing primary unit always remains as the primary unless it stops responding, at which point a new
primary unit is elected.
Note You can manually force a unit to become the primary. For centralized features, if you force a primary unit
change, then all connections are dropped, and you have to re-establish the connections on the new primary
unit.
Related Topics
Centralized Features for Clustering, on page 274
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
249
About ASA Clustering
Cluster Interfaces
You can configure data interfaces as either Spanned EtherChannels or as Individual interfaces. All data
interfaces in the cluster must be one type only.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
250
About ASA Clustering
cluster continues seamlessly. Load balancing, however, must be configured separately on the upstream switch
in this case.
Note We recommend Spanned EtherChannels instead of Individual interfaces because Individual interfaces
rely on routing protocols to load-balance traffic, and routing protocols often have slow convergence during
a link failure.
Related Topics
Load Balancing Methods, on page 258
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
251
About ASA Clustering
• Health monitoring.
Related Topics
Cluster Members, on page 248
Configuration Replication, on page 256
Unit Health Monitoring, on page 254
Data Path Connection State Replication, on page 256
Rebalancing New TCP Connections Across the Cluster, on page 273
Related Topics
Cluster Control Link Redundancy, on page 253
Size the Cluster Control Link, on page 252
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
252
About ASA Clustering
Cluster control link traffic is comprised mainly of state update and forwarded packets. The amount of traffic
at any given time on the cluster control link varies. The amount of forwarded traffic depends on the
load-balancing efficacy or whether there is a lot of traffic for centralized features. For example:
• NAT results in poor load balancing of connections, and the need to rebalance all returning traffic to the
correct units.
• AAA for network access is a centralized feature, so all traffic is forwarded to the primary unit.
• When membership changes, the cluster needs to rebalance a large number of connections, thus temporarily
using a large amount of cluster control link bandwidth.
A higher-bandwidth cluster control link helps the cluster to converge faster when there are membership changes
and prevents throughput bottlenecks.
Note If your cluster has large amounts of asymmetric (rebalanced) traffic, then you should increase the cluster
control link size.
Related Topics
Inter-Site Clustering, on page 263
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
253
About ASA Clustering
The cluster control link must be reliable, with no out-of-order or dropped packets; for example, for inter-site
deployment, you should use a dedicated link.
Note When the ASA becomes inactive, all data interfaces are shut down; only the management-only interface
can send and receive traffic. The management interface remains up using the IP address the unit received
from the cluster IP pool. However if you reload, and the unit is still inactive in the cluster, the management
interface is not accessible (because it then uses the Main IP address, which is the same as the primary
unit). You must use the console port for any further configuration.
Related Topics
Rejoining the Cluster, on page 255
Interface Monitoring
Each unit monitors the link status of all named hardware interfaces in use, and reports status changes to the
primary unit.
• Spanned EtherChannel—Uses cluster Link Aggregation Control Protocol (cLACP). Each unit monitors
the link status and the cLACP protocol messages to determine if the port is still active in the EtherChannel.
The status is reported to the primary unit.
• Individual interfaces (Routed mode only)—Each unit self-monitors its interfaces and reports interface
status to the primary unit.
When you enable health monitoring, all physical interfaces (including the main EtherChannel and redundant
interface types) are monitored by default; you can optionally disable monitoring per interface. Only named
interfaces can be monitored. For example, the named EtherChannel must fail to be considered failed, which
means all member ports of an EtherChannel must fail to trigger cluster removal (depending on your minimum
port bundling setting).
A unit is removed from the cluster if its monitored interfaces fail. The amount of time before the ASA removes
a member from the cluster depends on the type of interface and whether the unit is an established member or
is joining the cluster. For EtherChannels (spanned or not), if the interface is down on an established member,
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
254
About ASA Clustering
then the ASA removes the member after 9 seconds. The ASA does not monitor interfaces for the first 90
seconds that a unit joins the cluster. Interface status changes during this time will not cause the ASA to be
removed from the cluster. For non-EtherChannels, the unit is removed after 500 ms, regardless of the member
state.
Note When the ASA becomes inactive and fails to automatically rejoin the cluster, all data interfaces are shut
down; only the management-only interface can send and receive traffic. The management interface remains
up using the IP address the unit received from the cluster IP pool. However if you reload, and the unit is
still inactive in the cluster, the management interface is disabled. You must use the console port for any
further configuration.
Related Topics
Rejoining the Cluster, on page 255
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
255
About ASA Clustering
User Identity Yes Includes AAA rules (uauth) and identity firewall.
SNMP Engine ID No —
Configuration Replication
All units in the cluster share a single configuration. You can only make configuration changes on the primary
unit, and changes are automatically synced to all other units in the cluster.
Management Network
We recommend connecting all units to a single management network. This network is separate from the cluster
control link.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
256
About ASA Clustering
Management Interface
For the management interface, we recommend using one of the dedicated management interfaces. You can
configure the management interfaces as Individual interfaces (for both routed and transparent modes) or as a
Spanned EtherChannel interface.
We recommend using Individual interfaces for management, even if you use Spanned EtherChannels for your
data interfaces. Individual interfaces let you connect directly to each unit if necessary, while a Spanned
EtherChannel interface only allows remote connection to the current primary unit.
Note If you use Spanned EtherChannel interface mode, and configure the management interface as an Individual
interface, you cannot enable dynamic routing for the management interface. You must use a static route.
For an Individual interface, the Main cluster IP address is a fixed address for the cluster that always belongs
to the current primary unit. For each interface, you also configure a range of addresses so that each unit,
including the current primary, can use a Local address from the range. The Main cluster IP address provides
consistent management access to an address; when a primary unit changes, the Main cluster IP address moves
to the new primary unit, so management of the cluster continues seamlessly. The Local IP address is used for
routing, and is also useful for troubleshooting.
For example, you can manage the cluster by connecting to the Main cluster IP address, which is always
attached to the current primary unit. To manage an individual member, you can connect to the Local IP address.
For outbound management traffic such as TFTP or syslog, each unit, including the primary unit, uses the
Local IP address to connect to the server.
For a Spanned EtherChannel interface, you can only configure one IP address, and that IP address is always
attached to the primary unit. You cannot connect directly to a secondary unit using the EtherChannel interface;
we recommend configuring the management interface as an Individual interface so that you can connect to
each unit. Note that you can use a device-local EtherChannel for management.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
257
About ASA Clustering
unit uses the same key for SSH connections, so that you do not need to update the cached SSH host key when
you reconnect to the new primary unit.
Related Topics
EtherChannels, on page 396
Load Balancing
The EtherChannel link is selected using a proprietary hash algorithm, based on source or destination IP
addresses and TCP and UDP port numbers.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
258
About ASA Clustering
Note On the ASA, do not change the load-balancing algorithm from the default. On the switch, we recommend
that you use one of the following algorithms: source-dest-ip or source-dest-ip-port (see the Cisco Nexus
OS or Cisco IOS port-channel load-balance command). Do not use a vlan keyword in the load-balance
algorithm because it can cause unevenly distributed traffic to the ASAs in a cluster.
Related Topics
Customize the EtherChannel, on page 405
NAT and Clustering, on page 277
EtherChannel Redundancy
The EtherChannel has built-in redundancy. It monitors the line protocol status of all links. If one link fails,
traffic is re-balanced between remaining links. If all links in the EtherChannel fail on a particular unit, but
other units are still active, then the unit is removed from the cluster.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
259
About ASA Clustering
The following figure shows a 16 active link spanned EtherChannel in a 4-ASA cluster and an 8-ASA cluster.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
260
About ASA Clustering
The following figure shows a traditional 8 active/8 standby link spanned EtherChannel in a 4-ASA cluster
and an 8-ASA cluster. The active links are shown as solid lines, while the inactive links are dotted. cLACP
load-balancing can automatically choose the best 8 links to be active in the EtherChannel. As shown, cLACP
helps achieve load balancing at the link level.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
261
About ASA Clustering
Note If you use this method of load-balancing, you can use a device-local EtherChannel as an Individual
interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
262
About ASA Clustering
Note If you use this method of load-balancing, you can use a device-local EtherChannel as an Individual
interface.
Inter-Site Clustering
For inter-site installations, you can take advantage of ASA clustering as long as you follow these guidelines.
If the number of members differs at each site, use the larger number for your calculation. The minimum
bandwidth for the DCI should not be less than the size of the cluster control link for one member.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
263
About ASA Clustering
For example:
• For 4 members at 2 sites:
◦4 cluster members total
◦2 members at each site
◦5 Gbps cluster control link per member
Reserved DCI bandwidth = 10 Gbps (1/2 x 10 Gbps = 5 Gbps; but the minimum bandwidth should not
be less than the size of the cluster control link (10 Gbps)).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
264
About ASA Clustering
About LISP
Data center virtual machine mobility such as VMware VMotion enables servers to migrate between data
centers while maintaining connections to clients. To support such data center server mobility, routers need to
be able to update the ingress route towards the server when it moves. Cisco Locator/ID Separation Protocol
(LISP) architecture separates the device identity, or endpoint identifier (EID), from its location, or routing
locator (RLOC), into two different numbering spaces, making server migration transparent to clients. For
example, when a server moves to a new site and a client sends traffic to the server, the router redirects traffic
to the new location.
LISP requires routers and servers in certain roles, such as the LISP egress tunnel router (ETR), ingress tunnel
router (ITR), first hop routers, map resolver (MR), and map server (MS). When the first hop router for the
server senses that the server is connected to a different router, it updates all of the other routers and databases
so that the ITR connected to the client can intercept, encapsulate, and send traffic to the new server location.
LISP Guidelines
• The ASA cluster members must reside between the first hop router and the ITR or ETR for the site. The
ASA cluster itself cannot be the first hop router for an extended segment.
• Only fully-distributed flows are supported; centralized flows, semi-distributed flows, or flows belonging
to individual units are not moved to new owners. Semi-distributed flows include applications, such as
SIP, where all child flows are owned by the same ASA that owns the parent flow.
• The cluster only moves Layer 3 and 4 flow states; some application data might be lost.
• For short-lived flows or non-business-critical flows, moving the owner may not be worthwhile. You
can control the types of traffic that are supported with this feature when you configure the inspection
policy, and should limit flow mobility to essential traffic.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
265
About ASA Clustering
3 Service Policy to enable flow mobility on specified traffic—You should enable flow mobility on
business-critical traffic. For example, you can limit flow mobility to only HTTPS traffic, and/or to traffic
to specific servers.
4 Site IDs—The ASA uses the site ID for each cluster unit to determine the new owner.
5 Cluster-level configuration to enable flow mobility—You must also enable flow mobility at the cluster
level. This on/off toggle lets you easily enable or disable flow mobility for a particular class of traffic or
applications.
• For individual interface mode, when using ECMP towards a multicast Rendezvous Point (RP), we
recommend that you use a static route for the RP IP address using the Main cluster IP address as the
next hop. This static route prevents sending unicast PIM register packets to secondary units. If a secondary
unit receives a PIM register packet, then the packet is dropped, and the multicast stream cannot be
registered.
• The cluster control link latency must be less than 20 ms round-trip time (RTT).
• The cluster control link must be reliable, with no out-of-order or dropped packets; for example, you
should use a dedicated link.
• Do not configure connection rebalancing; you do not want connections rebalanced to cluster members
at a different site.
• The cluster implementation does not differentiate between members at multiple sites for incoming
connections; therefore, connection roles for a given connection may span across sites. This is expected
behavior.
• For transparent mode, if the cluster is placed between a pair of inside and outside routers (AKA
North-South insertion), you must ensure that both inside routers share a MAC address, and also that
both outside routers share a MAC address. When a cluster member at site 1 forwards a connection to a
member at site 2, the destination MAC address is preserved. The packet will only reach the router at site
2 if the MAC address is the same as the router at site 1.
• For transparent mode, if the cluster is placed between data networks and the gateway router at each site
for firewalling between internal networks (AKA East-West insertion), then each gateway router should
use a First Hop Redundancy Protocol (FHRP) such as HSRP to provide identical virtual IP and MAC
address destinations at each site. The data VLANs are extended across the sites using Overlay Transport
Virtualization (OTV), or something similar. You need to create filters to prevent traffic that is destined
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
266
About ASA Clustering
to the local gateway router from being sent over the DCI to the other site. If the gateway router becomes
unreachable at one site, you need to remove any filters so traffic can successfully reach the other site’s
gateway.
• For routed mode using Spanned EtherChannel, configure site-specific MAC addresses. Extend the data
VLANs across the sites using OTV, or something similar. You need to create filters to prevent traffic
that is destined to the global MAC address from being sent over the DCI to the other site. If the cluster
becomes unreachable at one site, you need to remove any filters so traffic can successfully reach the
other site’s cluster units. Dynamic routing is not supported when an inter-site cluster acts as the first hop
router for an extended segment.
Related Topics
Rebalancing New TCP Connections Across the Cluster, on page 273
Connection Roles, on page 271
Inter-Site Examples
The following examples show supported cluster deployments.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
267
About ASA Clustering
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
268
About ASA Clustering
For a sample OTV configuration and best practices, see OTV Configuration for Routed Mode Inter-Site
Clustering, on page 332.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
269
About ASA Clustering
• Local VSS/vPC at each site—For better switch redundancy, you can install 2 separate VSS/vPC pairs
at each site. In this case, although the cluster units still have a spanned EtherChannel with Data Center
1 chassis connected only to both local switches, and Data Center 2 chassis connected to those local
switches, the spanned EtherChannel is essentially “split.” Each local VSS/vPC sees the spanned
EtherChannel as a site-local EtherChannel.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
270
About ASA Clustering
See Spanned EtherChannel Transparent Mode North-South Inter-Site Example, on page 269 for information
about vPC/VSS options.
Connection Roles
There are 3 different roles defined for each connection:
• Owner—The unit that initially receives the connection. The owner maintains the TCP state and processes
packets. A connection has only one owner.
• Director—The unit that handles owner lookup requests from forwarders and also maintains the connection
state to serve as a backup if the owner fails. When the owner receives a new connection, it chooses a
director based on a hash of the source/destination IP address and TCP ports, and sends a message to the
director to register the new connection. If packets arrive at any unit other than the owner, the unit queries
the director about which unit is the owner so it can forward the packets. A connection has only one
director.
• Forwarder—A unit that forwards packets to the owner. If a forwarder receives a packet for a connection
it does not own, it queries the director for the owner, and then establishes a flow to the owner for any
other packets it receives for this connection. The director can also be a forwarder. Note that if a forwarder
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
271
About ASA Clustering
receives the SYN-ACK packet, it can derive the owner directly from a SYN cookie in the packet, so it
does not need to query the director. (If you disable TCP sequence randomization, the SYN cookie is not
used; a query to the director is required.) For short-lived flows such as DNS and ICMP, instead of
querying, the forwarder immediately sends the packet to the director, which then sends them to the
owner. A connection can have multiple forwarders; the most efficient throughput is achieved by a good
load-balancing method where there are no forwarders and all packets of a connection are received by
the owner.
When a connection uses Port Address Translation (PAT), then the PAT type (per-session or multi-session)
influences which member of the cluster becomes the owner of a new connection:
• Per-session PAT—The owner is the unit that receives the initial packet in the connection.
By default, TCP and DNS UDP traffic use per-session PAT.
• Multi-session PAT—The owner is always the primary unit. If a multi-session PAT connection is initially
received by a secondary unit, then the secondary unit forwards the connection to the primary unit.
By default, UDP (except for DNS UDP) and ICMP traffic use multi-session PAT, so these connections
are always owned by the primary unit.
You can change the per-session PAT defaults for TCP and UDP so connections for these protocols are handled
per-session or multi-session depending on the configuration. For ICMP, you cannot change from the default
multi-session PAT. For more information about per-session PAT, see the firewall configuration guide.
Related Topics
Load Balancing Methods, on page 258
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
272
About ASA Clustering
1 The SYN packet originates from the client and is delivered to one ASA (based on the load balancing
method), which becomes the owner. The owner creates a flow, encodes owner information into a SYN
cookie, and forwards the packet to the server.
2 The SYN-ACK packet originates from the server and is delivered to a different ASA (based on the load
balancing method). This ASA is the forwarder.
3 Because the forwarder does not own the connection, it decodes owner information from the SYN cookie,
creates a forwarding flow to the owner, and forwards the SYN-ACK to the owner.
4 The owner sends a state update to the director, and forwards the SYN-ACK to the client.
5 The director receives the state update from the owner, creates a flow to the owner, and records the TCP
state information as well as the owner. The director acts as the backup owner for the connection.
6 Any subsequent packets delivered to the forwarder will be forwarded to the owner.
7 If packets are delivered to any additional units, it will query the director for the owner and establish a flow.
8 Any state change for the flow results in a state update from the owner to the director.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
273
About ASA Clustering
Note Traffic for centralized features is forwarded from member units to the primary unit over the cluster control
link.
If you use the rebalancing feature, traffic for centralized features may be rebalanced to non-primary units
before the traffic is classified as a centralized feature; if this occurs, the traffic is then sent back to the
primary unit.
For centralized features, if the primary unit fails, all connections are dropped, and you have to re-establish
the connections on the new primary unit.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
274
About ASA Clustering
• Site-to-site VPN
• The following application inspections:
◦DCERPC
◦NetBIOS
◦PPTP
◦RADIUS
◦RSH
◦SUNRPC
◦TFTP
◦XDMCP
Related Topics
Size the Cluster Control Link, on page 252
Rebalancing New TCP Connections Across the Cluster, on page 273
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
275
About ASA Clustering
• ASA Firepower module—There is no configuration sync or state sharing between ASA Firepower
modules. You are responsible for maintaining consistent policies on the ASA Firepower modules in the
cluster using Firepower Management Center. Do not use different ASA-interface-based zone definitions
for devices in the cluster.
• ASA IPS module—There is no configuration sync or state sharing between IPS modules. Some IPS
signatures require IPS to keep the state across multiple connections. For example, the port scanning
signature is used when the IPS module detects that someone is opening many connections to one server
but with different ports. In clustering, those connections will be balanced between multiple ASA devices,
each of which has its own IPS module. Because these IPS modules do not share state information, the
cluster may not be able to detect port scanning as a result.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
276
About ASA Clustering
• No PAT with Port Block Allocation—This feature is not supported for the cluster.
• PAT with Port Block Allocation—See the following guidelines for this feature:
◦Maximum-per-host limit is not a cluster-wide limit, and is enforced on each unit individually.
Thus, in a 3-node cluster with the maximum-per-host limit configured as 1, if the traffic from a
host is load-balanced across all 3 units, then it can get allocated 3 blocks with 1 in each unit.
◦Port blocks created on the backup unit from the backup pools are not accounted for when enforcing
the maximum-per-host limit.
◦When a PAT IP address owner goes down, the backup unit will own the PAT IP address,
corresponding port blocks, and xlates. But it will not use these blocks to service new requests. As
the connections eventually time out, the blocks get freed.
◦On-the-fly PAT rule modifications, where the PAT pool is modified with a completely new range
of IP addresses, will result in xlate backup creation failures for the xlate backup requests that were
still in transit while the new pool became effective. This behavior is not specific to the port block
allocation feature, and is a transient PAT pool issue seen only in cluster deployments where the
pool is distributed and traffic is load-balanced across the cluster units.
• NAT pool address distribution for dynamic PAT—The primary unit evenly pre-distributes addresses
across the cluster. If a member receives a connection and they have no addresses left, the connection is
dropped, even if other members still have addresses available. Make sure to include at least as many
NAT addresses as there are units in the cluster to ensure that each unit receives an address. Use the show
nat pool cluster command to see the address allocations.
• No round-robin—Round-robin for a PAT pool is not supported with clustering.
• Dynamic NAT xlates managed by the primary unit—The primary unit maintains and replicates the xlate
table to secondary units. When a secondary unit receives a connection that requires dynamic NAT, and
the xlate is not in the table, it requests the xlate from the primary unit. The secondary unit owns the
connection.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
277
About ASA Clustering
• Per-session PAT feature—Although not exclusive to clustering, the per-session PAT feature improves
the scalability of PAT and, for clustering, allows each secondary unit to own PAT connections; by
contrast, multi-session PAT connections have to be forwarded to and owned by the primary unit. By
default, all TCP traffic and UDP DNS traffic use a per-session PAT xlate, whereas ICMP and all other
UDP traffic uses multi-session. You can configure per-session NAT rules to change these defaults for
TCP and UDP, but you cannot configure per-session PAT for ICMP. For traffic that benefits from
multi-session PAT, such as H.323, SIP, or Skinny, you can disable per-session PAT for the associated
TCP ports (the UDP ports for those H.323 and SIP are already multi-session by default). For more
information about per-session PAT, see the firewall configuration guide.
• No static PAT for the following inspections—
◦FTP
◦PPTP
◦RSH
◦SQLNET
◦TFTP
◦XDMCP
◦SIP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
278
About ASA Clustering
After the secondary members learn the routes from the primary unit, each unit makes forwarding decisions
independently.
The OSPF LSA database is not synchronized from the primary unit to secondary units. If there is a primary
unit switchover, the neighboring router will detect a restart; the switchover is not transparent. The OSPF
process picks an IP address as its router ID. Although not required, you can assign a static router ID to ensure
a consistent router ID is used across the cluster. See the OSPF Non-Stop Forwarding feature to address the
interruption.
In the above diagram, Router A learns that there are 4 equal-cost paths to Router B, each through an ASA.
ECMP is used to load balance traffic between the 4 paths. Each ASA picks a different router ID when talking
to external routers.
You must configure a cluster pool for the router ID so that each unit has a separate router ID.
You can use the following SCTP features with clustering enabled:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
279
About ASA Clustering
• SCTP protocol/port specifications in access rules, extended ACLs, and service objects and groups.
• SCTP application layer inspection, including payload protocol identifier (PPID) filtering.
Related Topics
Include the Device ID in Non-EMBLEM Format Syslog Messages, on page 926
VPN functionality is limited to the primary unit and does not take advantage of the cluster high availability
capabilities. If the primary unit fails, all existing VPN connections are lost, and VPN users will see a disruption
in service. When a new primary is elected, you must reestablish the VPN connections.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
280
Licensing for ASA Clustering
When you connect a VPN tunnel to a Spanned EtherChannel address, connections are automatically forwarded
to the primary unit. For connections to an Individual interface when using PBR or ECMP, you must always
connect to the Main cluster IP address, not a Local address.
VPN-related keys and certificates are replicated to all units.
ASA on the Firepower See ASA Cluster for the FXOS Chassis, on page 339.
9300
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
281
Guidelines for ASA Clustering
• (Single context mode) Must be in the same firewall mode, routed or transparent.
• New cluster members must use the same SSL encryption setting (the ssl encryption command) as the
primary unit for initial cluster control link communication before configuration replication.
• Must have the same cluster, encryption and, for the ASA 5585-X, 10 GE I/O licenses.
Switch Prerequisites
• Be sure to complete the switch configuration before you configure clustering on the ASAs.
• For a list of supported switches, see Cisco ASA Compatibility.
ASA Prerequisites
• Provide each unit with a unique IP address before you join them to the management network.
◦See the Getting Started chapter for more information about connecting to the ASA and setting the
management IP address.
◦Except for the IP address used by the primary unit (typically the first unit you add to the cluster),
these management IP addresses are for temporary use only.
◦After a secondary joins the cluster, its management interface configuration is replaced by the one
replicated from the primary unit.
• To use jumbo frames on the cluster control link (recommended), you must enable Jumbo Frame
Reservation before you enable clustering.
Other Prerequisites
We recommend using a terminal server to access all cluster member unit console ports. For initial setup, and
ongoing management (for example, when a unit goes down), a terminal server is useful for remote management.
Related Topics
Guidelines for ASA Clustering, on page 282
Enable Jumbo Frame Support, on page 391
Bootstrap Configuration, on page 248
Firewall Mode
For single mode, the firewall mode must match on all units.
Failover
Failover is not supported with clustering.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
282
Guidelines for ASA Clustering
IPv6
The cluster control link is only supported using IPv4.
Models
Supported on:
• ASA 5585-X
For the ASA 5585-X with SSP-10 and SSP-20, which include two Ten Gigabit Ethernet interfaces, we
recommend using one interface for the cluster control link, and the other for data (you can use
subinterfaces for data). Although this setup does not accommodate redundancy for the cluster control
link, it does satisfy the need to size the cluster control link to match the size of the data interfaces.
• ASA 5516-X
• ASA 5512-X, ASA 5515-X, ASA 5525-X, ASA 5545-X, and ASA 5555-X
Switches
• For the ASR 9006, if you want to set a non-default MTU, set the ASR interface MTU to be 14 bytes
higher than the ASA MTU. Otherwise, OSPF adjacency peering attempts may fail unless the mtu-ignore
option is used. Note that the ASA MTU should match the ASR IPv4 MTU.
• On the switch(es) for the cluster control link interfaces, you can optionally enable Spanning Tree PortFast
on the switch ports connected to the cluster unit to speed up the join process for new units.
• When you see slow bundling of a Spanned EtherChannel on the switch, you can enable LACP rate fast
for an Individual interface on the switch.
• On the switch, we recommend that you use one of the following EtherChannel load-balancing algorithms:
source-dest-ip or source-dest-ip-port (see the Cisco Nexus OS and Cisco IOS port-channel
load-balance command). Do not use a vlan keyword in the load-balance algorithm because it can cause
unevenly distributed traffic to the ASAs in a cluster. Do not change the load-balancing algorithm from
the default on the ASA (in the port-channel load-balance command).
• If you change the load-balancing algorithm of the EtherChannel on the switch, the EtherChannel interface
on the switch temporarily stops forwarding traffic, and the Spanning Tree Protocol restarts. There will
be a delay before traffic starts flowing again.
• You should disable the LACP Graceful Convergence feature on all cluster-facing EtherChannel interfaces
for Cisco Nexus switches.
• Some switches do not support dynamic port priority with LACP (active and standby links). You can
disable dynamic port priority to provide better compatibility with spanned EtherChannels.
• Network elements on the cluster control link path should not verify the L4 checksum. Redirected traffic
over the cluster control link does not have a correct L4 checksum. Switches that verify the L4 checksum
could cause traffic to be dropped.
• Port-channel bundling downtime should not exceed the configured keepalive interval.
• On Supervisor 2T EtherChannels, the default hash distribution algorithm is adaptive. To avoid asymmetric
traffic in a VSS design, change the hash algorithm on the port-channel connected to the ASA to fixed:
router(config)# port-channel id hash-distribution fixed
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
283
Guidelines for ASA Clustering
Do not change the algorithm globally; you may want to take advantage of the adaptive algorithm for the
VSS peer link.
EtherChannels
• In Catalyst 3750-X Cisco IOS software versions earlier than 15.1(1)S2, the cluster unit did not support
connecting an EtherChannel to a switch stack. With default switch settings, if the cluster unit EtherChannel
is connected cross stack, and if the master switch is powered down, then the EtherChannel connected
to the remaining switch will not come up. To improve compatibility, set the stack-mac persistent timer
command to a large enough value to account for reload time; for example, 8 minutes or 0 for indefinite.
Or, you can upgrade to more a more stable switch software version, such as 15.1(1)S2.
• Spanned vs. Device-Local EtherChannel Configuration—Be sure to configure the switch appropriately
for Spanned EtherChannels vs. Device-local EtherChannels.
◦Spanned EtherChannels—For cluster unit Spanned EtherChannels, which span across all members
of the cluster, the interfaces are combined into a single EtherChannel on the switch. Make sure
each interface is in the same channel group on the switch.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
284
Guidelines for ASA Clustering
on the switch; do not combine multiple cluster unit EtherChannels into one EtherChannel on the
switch.
Additional Guidelines
• When significant topology changes occur (such as adding or removing an EtherChannel interface,
enabling or disabling an interface on the ASA or the switch, adding an additional switch to form a VSS
or vPC) you should disable the health check feature. When the topology change is complete, and the
configuration change is synced to all units, you can re-enable the health check feature.
• When adding a unit to an existing cluster, or when reloading a unit, there will be a temporary, limited
packet/connection drop; this is expected behavior. In some cases, the dropped packets can hang your
connection; for example, dropping a FIN/ACK packet for an FTP connection will make the FTP client
hang. In this case, you need to reestablish the FTP connection.
• If you use a Windows 2003 server connected to a Spanned EtherChannel, when the syslog server port
is down and the server does not throttle ICMP error messages, then large numbers of ICMP messages
are sent back to the ASA cluster. These messages can result in some units of the ASA cluster experiencing
high CPU, which can affect performance. We recommend that you throttle ICMP error messages.
• We do not support VXLAN in Individual Interface mode. Only Spanned EtherChannel mode supports
VXLAN.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
285
Defaults for ASA Clustering
Related Topics
Size the Cluster Control Link, on page 252
Bootstrap Configuration, on page 248
Unsupported Features with Clustering, on page 274
Configure an EtherChannel, on page 403
Guidelines for EtherChannels and Redundant Interfaces, on page 399
Note To enable or disable clustering, you must use a console connection (for CLI) or an ASDM connection.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
286
Configure ASA Clustering
Procedure
Step 1 Complete all pre-configuration on the switches and ASAs according to Prerequisites for ASA Clustering, on
page 281 and Guidelines for ASA Clustering, on page 282.
Step 2 Cable the Cluster Units and Configure Upstream and Downstream Equipment, on page 287.
Step 3 Configure the Cluster Interface Mode on Each Unit, on page 289. You can only configure one type of interface
for clustering: Spanned EtherChannels or Individual interfaces.
Step 4 Configure Interfaces on the Primary Unit, on page 290. You cannot enable clustering if the interfaces are not
cluster-ready.
Step 5 Configure the Primary Unit Bootstrap Settings, on page 297.
Step 6 Configure Secondary Unit Bootstrap Settings, on page 301.
Step 7 (Optional) Customize the Clustering Operation, on page 304
Step 8 Configure the security policy on the primary unit. See the chapters in this guide to configure supported features
on the primary unit. The configuration is replicated to the secondary units.
Cable the Cluster Units and Configure Upstream and Downstream Equipment
Before configuring clustering, cable the cluster control link network, management network, and data networks.
Note At a minimum, an active cluster control link network is required before you configure the units to join
the cluster.
You should also configure the upstream and downstream equipment. For example, if you use EtherChannels,
then you should configure the upstream and downstream equipment for the EtherChannels.
Examples
Note This example uses EtherChannels for load-balancing. If you are using PBR or ECMP, your switch
configuration will differ.
You have one switch for both the inside and outside networks.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
287
Configure ASA Clustering
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
288
Configure ASA Clustering
Related Topics
Leave the Cluster, on page 311
Configure Spanned EtherChannels, on page 292
Cluster Interfaces, on page 250
Procedure
Step 1 Show any incompatible configuration so that you can force the interface mode and fix your configuration
later; the mode is not changed with this command:
cluster interface-mode {individual | spanned} check-details
Example:
ciscoasa(config)# cluster interface-mode spanned check-details
Example:
ciscoasa(config)# cluster interface-mode spanned force
There is no default setting; you must explicitly choose the mode. If you have not set the mode, you cannot
enable clustering.
The force option changes the mode without checking your configuration for incompatible settings. You need
to manually fix any configuration issues after you change the mode. Because any interface configuration can
only be fixed after you set the mode, we recommend using the force option so that you can at least start from
the existing configuration. You can re-run the check-details option after you set the mode for more guidance.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
289
Configure ASA Clustering
Without the force option, if there is any incompatible configuration, you are prompted to clear your
configuration and reload, thus requiring you to connect to the console port to reconfigure your management
access. If your configuration is compatible (rare), the mode is changed and the configuration is preserved. If
you do not want to clear your configuration, you can exit the command by typing n.
To remove the interface mode, enter the no cluster interface-mode command.
Procedure
Step 1 Configure a pool of Local IP addresses (IPv4 and/or IPv6), one of which will be assigned to each cluster unit
for the interface:
(IPv4)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
290
Configure ASA Clustering
Example:
ciscoasa(config)# ip local pool ins 192.168.1.2-192.168.1.9
ciscoasa(config-if)# ipv6 local pool insipv6 2001:DB8::1002/32 8
Include at least as many addresses as there are units in the cluster. If you plan to expand the cluster, include
additional addresses. The Main cluster IP address that belongs to the current primary unit is not a part of this
pool; be sure to reserve an IP address on the same network for the Main cluster IP address.
You cannot determine the exact Local address assigned to each unit in advance; to see the address used on
each unit, enter the show ip[v6] local pool poolname command. Each cluster member is assigned a member
ID when it joins the cluster. The ID determines the Local IP used from the pool.
Example:
ciscoasa(config)# interface tengigabitethernet 0/8
Step 3 (Management interface only) Set an interface to management-only mode so that it does not pass through
traffic:
management-only
By default, Management type interfaces are configured as management-only. In transparent mode, this
command is always enabled for a Management type interface.
This setting is required if the cluster interface mode is Spanned.
Example:
ciscoasa(config-if)# nameif inside
The name is a text string up to 48 characters, and is not case-sensitive. You can change the name by reentering
this command with a new value.
Step 5 Set the Main cluster IP address and identify the cluster pool:
(IPv4)
ip address ip_address [mask] cluster-pool poolname
(IPv6)
ipv6 address ipv6-address/prefix-length cluster-pool poolname
Example:
ciscoasa(config-if)# ip address 192.168.1.1 255.255.255.0 cluster-pool ins
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
291
Configure ASA Clustering
This IP address must be on the same network as the cluster pool addresses, but not be part of the pool. You
can configure an IPv4 and/or an IPv6 address.
DHCP, PPPoE, and IPv6 autoconfiguration are not supported; you must manually configure the IP addresses.
Step 6 Set the security level, where number is an integer between 0 (lowest) and 100 (highest):
security-level number
Example:
ciscoasa(config-if)# security-level 100
Examples
The following example configures the Management 0/0 and Management 0/1 interfaces as a device-local
EtherChannel, and then configures the EtherChannel as an Individual interface:
interface port-channel 1
nameif management
ip address 10.1.1.1 255.255.255.0 cluster-pool mgmt
ipv6 address 2001:DB8:45:1001/64 cluster-pool mgmtipv6
security-level 100
management-only
Related Topics
Management Interface, on page 257
Cable the Cluster Units and Configure Upstream and Downstream Equipment, on page 287
Load Balancing Methods, on page 258
Configure an EtherChannel, on page 403
Enable Jumbo Frame Support, on page 391
Configure Spanned EtherChannels, on page 292
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
292
Configure ASA Clustering
• Do not change the load-balancing algorithm from the default (see the port-channel load-balance
command). On the switch, we recommend that you use one of the following algorithms: source-dest-ip
or source-dest-ip-port (see the Cisco Nexus OS and Cisco IOS port-channel load-balance command).
Do not use a vlan keyword in the load-balance algorithm because it can cause unevenly distributed
traffic to the ASAs in a cluster.
• The lacp port-priority and lacp system-priority commands are not used for a Spanned EtherChannel.
• When using Spanned EtherChannels, the port-channel interface will not come up until clustering is fully
enabled. This requirement prevents traffic from being forwarded to a unit that is not an active unit in
the cluster.
Procedure
Step 1 Specify the interface you want to add to the channel group:
interface physical_interface
Example:
ciscoasa(config)# interface gigabitethernet 0/0
The physical_interface ID includes the type, slot, and port number as type slot/port. This first interface in the
channel group determines the type and speed for all other interfaces in the group.
Example:
ciscoasa(config-if)# channel-group 1 mode active
The channel_id is between 1 and 48. If the port-channel interface for this channel ID does not yet exist in the
configuration, one will be added automatically:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
293
Configure ASA Clustering
Step 4 (Optional) Add additional interfaces to the EtherChannel by repeating the process.
Example:
ciscoasa(config)# interface gigabitethernet 0/1
ciscoasa(config-if)# channel-group 1 mode active
ciscoasa(config-if)# no shutdown
Multiple interfaces in the EtherChannel per unit are useful for connecting to switches in a VSS or vPC. Keep
in mind that by default, a spanned EtherChannel can have only 8 active interfaces out of 16 maximum across
all members in the cluster; the remaining 8 interfaces are on standby in case of link failure. To use more than
8 active interfaces (but no standby interfaces), disable dynamic port priority using the clacp static-port-priority
command. When you disable dynamic port priority, you can use up to 32 active links across the cluster. For
example, for a cluster of 16 ASAs, you can use a maximum of 2 interfaces on each ASA, for a total of 32
interfaces in the spanned EtherChannel.
Example:
ciscoasa(config)# interface port-channel 1
This interface was created automatically when you added an interface to the channel group.
Example:
ciscoasa(config-if)# port-channel span-cluster
If you are connecting the ASA to two switches in a VSS or vPC, then you should enable VSS load balancing
by using the vss-load-balance keyword. This feature ensures that the physical link connections between the
ASAs to the VSS (or vPC) pair are balanced. You must configure the vss-id keyword in the channel-group
command for each member interface before enabling load balancing (see Step 2).
Step 7 (Optional) You can set the Ethernet properties for the port-channel interface to override the properties set on
the Individual interfaces.
This method provides a shortcut to set these parameters because these parameters must match for all interfaces
in the channel group.
Step 8 (Optional) If you are creating VLAN subinterfaces on this EtherChannel, do so now.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
294
Configure ASA Clustering
Example:
ciscoasa(config)# interface port-channel 1.10
ciscoasa(config-if)# vlan 10
Step 9 (Multiple Context Mode) Allocate the interface to a context. Then enter:
changeto context name
interface port-channel channel_id
Example:
ciscoasa(config)# context admin
ciscoasa(config)# allocate-interface port-channel1
ciscoasa(config)# changeto context admin
ciscoasa(config-if)# interface port-channel 1
For multiple context mode, the rest of the interface configuration occurs within each context.
Example:
ciscoasa(config-if)# nameif inside
The name is a text string up to 48 characters, and is not case-sensitive. You can change the name by reentering
this command with a new value.
ciscoasa(config-if)# bridge-group 1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
295
Configure ASA Clustering
Where number is an integer between 1 and 100. You can assign up to four interfaces to a bridge group.
You cannot assign the same interface to more than one bridge group. Note that the BVI configuration
includes the IP address.
Example:
ciscoasa(config-if)# security-level 50
Step 13 Configure a global MAC address for a Spanned EtherChannel to avoid potential network connectivity problems:
mac-address mac_address
Example:
ciscoasa(config-if)# mac-address 000C.F142.4CDE
With a manually-configured MAC address, the MAC address stays with the current primary unit. In multiple
context mode, if you share an interface between contexts, you should enable auto-generation of MAC addresses
so that you only need to set the MAC address manually for a shared interface if you disable auto-generation.
Note that you must manually configure the MAC address for non-shared interfaces.
The mac_address is in H.H.H format, where H is a 16-bit hexadecimal digit. For example, the MAC address
00-0C-F1-42-4C-DE is entered as 000C.F142.4CDE.
The first two bytes of a manual MAC address cannot be A2 if you also want to use auto-generated MAC
addresses.
Step 14 (Routed mode) For inter-site clustering, configure a site-specific MAC address for each site:
mac-address mac_address site-id number
Example:
ciscoasa(config-if)# mac-address aaaa.1111.1234
ciscoasa(config-if)# mac-address aaaa.1111.aaaa site-id 1
ciscoasa(config-if)# mac-address aaaa.1111.bbbb site-id 2
ciscoasa(config-if)# mac-address aaaa.1111.cccc site-id 3
ciscoasa(config-if)# mac-address aaaa.1111.dddd site-id 4
The site-specific MAC address used by a unit depends on the site ID you specify in each unit’s bootstrap
configuration.
Related Topics
Configure the Cluster Interface Mode on Each Unit, on page 289
Configure Bridge Groups, on page 439
Configure an EtherChannel, on page 403
Guidelines for EtherChannels and Redundant Interfaces, on page 399
Connecting to a VSS or vPC, on page 259
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
296
Configure ASA Clustering
Enable the Physical Interface and Configure Ethernet Parameters, on page 389
Configure a Security Context, on page 172
Procedure
Step 1 Enable the cluster control link interface before you join the cluster.
You will later identify this interface as the cluster control link when you enable clustering.
We recommend that you combine multiple cluster control link interfaces into an EtherChannel if you have
enough interfaces. The EtherChannel is local to the ASA, and is not a Spanned EtherChannel.
The cluster control link interface configuration is not replicated from the primary unit to secondary units;
however, you must use the same configuration on each unit. Because this configuration is not replicated, you
must configure the cluster control link interfaces separately on each unit.
• You cannot use a VLAN subinterface as the cluster control link.
• You cannot use a Management x/x interface as the cluster control link, either alone or as an EtherChannel.
• For the ASA 5585-X with an ASA IPS module, you cannot use the module interfaces for the cluster
control link.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
297
Configure ASA Clustering
Example:
ciscoasa(config)# interface tengigabitethernet 0/6
Example:
ciscoasa(config-if)# channel-group 1 mode on
The channel_id is between 1 and 48. If the port-channel interface for this channel ID does not yet exist in
the configuration, one will be added automatically:
interface port-channel channel_id
We recommend using the On mode for cluster control link member interfaces to reduce unnecessary traffic
on the cluster control link. The cluster control link does not need the overhead of LACP traffic because it
is an isolated, stable network. Note: We recommend setting data EtherChannels to Active mode.
c) Enable the interface:
no shutdown
You only need to enable the interface; do not configure a name for the interface, or any other parameters.
d) (For an EtherChannel) Repeat for each additional interface you want to add to the EtherChannel:
Example:
ciscoasa(config)# interface tengigabitethernet 0/7
ciscoasa(config-if)# channel-group 1 mode on
ciscoasa(config-if)# no shutdown
Step 2 (Optional) Specify the maximum transmission unit for the cluster control link interface:
mtu cluster bytes
Example:
ciscoasa(config)# mtu cluster 9000
Set the MTU between 64 and 9198 bytes. The default MTU is 1500 bytes.
We suggest setting the MTU to 1600 bytes or greater, which requires you to enable jumbo frame reservation
before continuing with this procedure. Jumbo frame reservation requires a reload of the ASA.
This command is a global configuration command, but is also part of the bootstrap configuration that is not
replicated between units.
Example:
ciscoasa(config)# cluster group pod1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
298
Configure ASA Clustering
The name must be an ASCII string from 1 to 38 characters. You can only configure one cluster group per
unit. All members of the cluster must use the same name.
Example:
ciscoasa(cfg-cluster)# local-unit unit1
Example:
ciscoasa(cfg-cluster)# cluster-interface port-channel2 ip 192.168.1.1 255.255.255.0
INFO: Non-cluster interface config is cleared on Port-Channel2
Step 6 If you use inter-site clustering, set the site ID for this unit so it uses a site-specific MAC address:
site-id number
Example:
ciscoasa(cfg-cluster)# site-id 1
Step 7 Set the priority of this unit for primary unit elections:
priority priority_number
Example:
ciscoasa(cfg-cluster)# priority 1
Step 8 (Optional) Set an authentication key for control traffic on the cluster control link:
key shared_secret
Example:
ciscoasa(cfg-cluster)# key chuntheunavoidable
The shared secret is an ASCII string from 1 to 63 characters. The shared secret is used to generate the key.
This command does not affect datapath traffic, including connection state update and forwarded packets,
which are always sent in the clear.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
299
Configure ASA Clustering
Step 10 (Optional) Manually specify the cLACP system ID and system priority:
clacp system-mac {mac_address | auto} [system-priority number]
Example:
ciscoasa(cfg-cluster)# clacp system-mac 000a.0000.aaaa
When using Spanned EtherChannels, the ASA uses cLACP to negotiate the EtherChannel with the neighbor
switch. ASAs in a cluster collaborate in cLACP negotiation so that they appear as a single (virtual) device to
the switch. One parameter in cLACP negotiation is a system ID, which is in the format of a MAC address.
All ASAs in the cluster use the same system ID: auto-generated by the primary unit (the default) and replicated
to all secondaries; or manually specified in this command in the form H.H.H, where H is a 16-bit hexadecimal
digit. (For example, the MAC address 00-0A-00-00-AA-AA is entered as 000A.0000.AAAA.) You might
want to manually configure the MAC address for troubleshooting purposes, for example, so that you can use
an easily identified MAC address. Typically, you would use the auto-generated MAC address.
The system priority, between 1 and 65535, is used to decide which unit is in charge of making a bundling
decision. By default, the ASA uses priority 1, which is the highest priority. The priority needs to be higher
than the priority on the switch.
This command is not part of the bootstrap configuration, and is replicated from the primary unit to the secondary
units. However, you cannot change this value after you enable clustering.
Example:
ciscoasa(cfg-cluster)# enable
INFO: Clustering is not compatible with following commands:
policy-map global_policy
class inspection_default
inspect skinny
policy-map global_policy
class inspection_default
inspect sip
Would you like to remove these commands? [Y]es/[N]o:Y
When you enter the enable command, the ASA scans the running configuration for incompatible commands
for features that are not supported with clustering, including commands that may be present in the default
configuration. You are prompted to delete the incompatible commands. If you respond No, then clustering is
not enabled. Use the noconfirm keyword to bypass the confirmation and delete incompatible commands
automatically.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
300
Configure ASA Clustering
For the first unit enabled, a primary unit election occurs. Because the first unit should be the only member of
the cluster so far, it will become the primary unit. Do not perform any configuration changes during this
period.
To disable clustering, enter the no enable command.
Note If you disable clustering, all data interfaces are shut down, and only the management-only interface
is active.
Examples
The following example configures a management interface, configures a device-local EtherChannel for the
cluster control link, and then enables clustering for the ASA called “unit1,” which will become the primary
unit because it is added to the cluster first:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
301
Configure ASA Clustering
• When you add a unit to a running cluster, you may see temporary, limited packet/connection drops; this
is expected behavior.
Procedure
Step 1 Configure the same cluster control link interface as you configured for the primary unit.
Example:
ciscoasa(config)# interface tengigabitethernet 0/6
ciscoasa(config-if)# channel-group 1 mode on
ciscoasa(config-if)# no shutdown
ciscoasa(config)# interface tengigabitethernet 0/7
ciscoasa(config-if)# channel-group 1 mode on
ciscoasa(config-if)# no shutdown
Step 2 Specify the same MTU that you configured for the primary unit:
Example:
ciscoasa(config)# mtu cluster 9000
Step 3 Identify the same cluster name that you configured for the primary unit:
Example:
ciscoasa(config)# cluster group pod1
Example:
ciscoasa(cfg-cluster)# local-unit unit2
Step 5 Specify the same cluster control link interface that you configured for the primary unit, but specify a different
IP address on the same network for each unit:
cluster-interface interface_id ip ip_address mask
Example:
ciscoasa(cfg-cluster)# cluster-interface port-channel2 ip 192.168.1.2 255.255.255.0
INFO: Non-cluster interface config is cleared on Port-Channel2
Specify an IPv4 address for the IP address; IPv6 is not supported for this interface. This interface cannot have
a nameif configured.
Each unit must have a unique name. A unit with a duplicated name will not be allowed in the cluster.
Step 6 If you use inter-site clustering, set the site ID for this unit so it uses a site-specific MAC address:
site-id number
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
302
Configure ASA Clustering
Example:
ciscoasa(cfg-cluster)# site-id 1
Step 7 Set the priority of this unit for primary unit elections, typically to a higher value than the primary unit:
priority priority_number
Example:
ciscoasa(cfg-cluster)# priority 2
Set the priority between 1 and 100, where 1 is the highest priority.
Step 8 Set the same authentication key that you set for the primary unit:
Example:
ciscoasa(cfg-cluster)# key chuntheunavoidable
Examples
The following example includes the configuration for a secondary unit, unit2:
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
local-unit unit2
cluster-interface port-channel1 ip 192.168.1.2 255.255.255.0
priority 2
key chuntheunavoidable
enable as-slave
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
303
Configure ASA Clustering
Procedure
Step 2 (Optional) Enable console replication from secondary units to the primary unit:
console-replicate
This feature is disabled by default. The ASA prints out some messages directly to the console for certain
critical events. If you enable console replication, secondary units send the console messages to the primary
unit so that you only need to monitor one console port for the cluster.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
304
Configure ASA Clustering
Procedure
Step 1 Customize the cluster health check feature, which includes unit health monitoring and interface health
monitoring:
health-check [holdtime timeout] [vss-enabled]
Example:
ciscoasa(cfg-cluster)# health-check holdtime 5
The holdime determines the amount of time between unit keepalive status messages, between .8 and 45
seconds; The default is 3 seconds. Note that the holdtime value only affects the unit health check; for interface
health, the ASA uses the interface status (up or down).
To determine unit health, the ASA cluster units send keepalive messages on the cluster control link to other
units. If a unit does not receive any keepalive messages from a peer unit within the holdtime period, the peer
unit is considered unresponsive or dead. If you configure the cluster control link as an EtherChannel
(recommended), and it is connected to a VSS or vPC pair, then you might need to enable the vss-enabled
option. For some switches, when one unit in the VSS/vPC is shutting down or booting up, EtherChannel
member interfaces connected to that switch may appear to be Up to the ASA, but they are not passing traffic
on the switch side. The ASA can be erroneously removed from the cluster if you set the ASA holdtime timeout
to a low value (such as .8 seconds), and the ASA sends keepalive messages on one of these EtherChannel
interfaces. When you enable vss-enabled, the ASA floods the keepalive messages on all EtherChannel
interfaces in the cluster control link to ensure that at least one of the switches can receive them.
The interface health check monitors for link failures. If all physical ports for a given logical interface fail on
a particular unit, but there are active ports under the same logical interface on other units, then the unit is
removed from the cluster. The amount of time before the ASA removes a member from the cluster depends
on the type of interface and whether the unit is an established member or is joining the cluster.
Health check is enabled by default for all interfaces. You can disable it using the no form of this command.
To disable monitoring per interface, see the no health-check monitor-interface command.
When any topology changes occur (such as adding or removing a data interface, enabling or disabling an
interface on the ASA or the switch, or adding an additional switch to form a VSS or vPC) you should disable
the health check feature. When the topology change is complete, and the configuration change is synced to
all units, you can re-enable the health check feature.
Step 2 Customize the auto-rejoin cluster settings after a health check failure:
health-check {data-interface | cluster-interface} auto-rejoin [unlimited | auto_rejoin_max]
auto_rejoin_interval auto_rejoin_interval_variation
Example:
ciscoasa(cfg-cluster)# health-check data-interface auto-rejoin 10 3 3
Define the number of attempts at rejoining the cluster by setting unlimited or the auto-rejoin-max between
0 and 65535. 0 disables auto-rejoining. The default value is unlimited for the cluster-interface and 3 for the
data-interface.
Define the interval duration in minutes between rejoin attempts by setting the auto_rejoin_interval between
2 and 60. The default value is 5 minutes. The maximum total time that the unit attempts to rejoin the cluster
is limited to 14400 minutes (10 days) from the time of last failure.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
305
Configure ASA Clustering
Define if the interval duration increases by setting the auto_rejoin_interval_variation between 1 and 3: 1 (no
change); 2 (2 x the previous duration), or 3 (3 x the previous duration). For example, if you set the interval
duration to 5 minutes, and set the variation to 2, then the first attempt is after 5 minutes; the 2nd attempt is
10 minutes (2 x 5); the 3rd attempt 20 minutes (2 x 10), and so on. The default value is 1 for the cluster-interface
and 2 for the data-interface.
Example:
ciscoasa(cfg-cluster)# no health-check monitor-interface management0/0
You might want to disable health monitoring of non-essential interfaces, for example, the management
interface. You can specify any port-channel ID, redundant ID, or single physical interface ID, or the
service-module keyword for a hardware or software module, such as the ASA Firepower module. Note that
for the ASA 5585-X, if you disable monitoring of the service module, you may also want to disable monitoring
of the interfaces on the module, which are monitored separately.. Health monitoring is not performed on
VLAN subinterfaces or virtual interfaces such as VNIs or BVIs. You cannot configure monitoring for the
cluster control link; it is always monitored.
Procedure
Example:
ciscoasa(cfg-cluster)# conn-rebalance frequency 60
This command is disabled by default. If enabled, ASAs exchange load information periodically, and offload
new connections from more loaded devices to less loaded devices. The frequency, between 1 and 360 seconds,
specifies how often the load information is exchanged. The default is 5 seconds.
Do not configure connection rebalancing for inter-site topologies; you do not want connections rebalanced
to cluster members at a different site.
Example:
ciscoasa(config)# cluster replication delay 15 match tcp any any eq ftp
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
306
Configure ASA Clustering
Set the seconds between 1 and 15. The http delay is enabled by default for 5 seconds.
Procedure
Step 1 (Optional) Configure a LISP inspection map to limit inspected EIDs based on IP address, and to configure
the LISP pre-shared key:
a) Create an extended ACL; only the destination IP address is matched to the EID embedded address:
access list eid_acl_name extended permit ip source_address mask destination_address mask
Both IPv4 and IPv6 ACLs are accepted. See the command reference for exact access-list extended syntax.
b) Create the LISP inspection map, and enter parameters mode:
policy-map type inspect lisp inspect_map_name
parameters
c) Define the allowed EIDs by identifying the ACL you created:
allowed-eid access-list eid_acl_name
The first hop router or ITR/ETR might send EID-notify messages for hosts or networks that the ASA
cluster is not involved with, so you can limit the EIDs to only those servers or networks relevant to your
cluster. For example, if the cluster is only involved with 2 sites, but LISP is running on 3 sites, you should
only include EIDs for the 2 sites involved with the cluster.
d) If necessary, enter the pre-shared key:
validate-key key
Example:
ciscoasa(config)# access-list TRACKED_EID_LISP extended permit ip any 10.10.10.0 255.255.255.0
ciscoasa(config)# policy-map type inspect lisp LISP_EID_INSPECT
ciscoasa(config-pmap)# parameters
ciscoasa(config-pmap-p)# allowed-eid access-list TRACKED_EID_LISP
ciscoasa(config-pmap-p)# validate-key MadMaxShinyandChrome
Step 2 Configure LISP inspection for UDP traffic between the first hop router and the ITR or ETR on port 4342:
a) Configure the extended ACL to identify LISP traffic:
access list inspect_acl_name extended permit udp source_address mask destination_address mask eq
4342
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
307
Configure ASA Clustering
You must specify UDP port 4342. Both IPv4 and IPv6 ACLs are accepted. See the command reference
for exact access-list extended syntax.
b) Create a class map for the ACL:
class-map inspect_class_name
match access-list inspect_acl_name
c) Specify the policy map, the class map, enable inspection using the optional LISP inspection map, and
apply the service policy to an interface (if new):
policy-map policy_map_name
class inspect_class_name
inspect lisp [inspect_map_name]
service-policy policy_map_name {global | interface ifc_name}
If you have an existing service policy, specify the existing policy map name. By default, the ASA includes
a global policy called global_policy, so for a global policy, specify that name. You can also create one
service policy per interface if you do not want to apply the policy globally. LISP inspection is applied to
traffic bidirectionally so you do not need to apply the service policy on both the source and destination
interfaces; all traffic that enters or exits the interface to which you apply the policy map is affected if the
traffic matches the class map for both directions.
Example:
ciscoasa(config)# access-list LISP_ACL extended permit udp host 192.168.50.89 host
192.168.10.8 eq 4342
ciscoasa(config)# class-map LISP_CLASS
ciscoasa(config-cmap)# match access-list LISP_ACL
ciscoasa(config-cmap)# policy-map INSIDE_POLICY
ciscoasa(config-pmap)# class LISP_CLASS
ciscoasa(config-pmap-c)# inspect lisp LISP_EID_INSPECT
ciscoasa(config)# service-policy INSIDE_POLICY interface inside
The ASA inspects LISP traffic for the EID-notify message sent between the first hop router and the ITR or
ETR. The ASA maintains an EID table that correlates the EID and the site ID.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
308
Manage ASA Cluster Members
Example:
ciscoasa(config)# access-list IMPORTANT-FLOWS extended permit tcp any 10.10.10.0 255.255.255.0
eq https
ciscoasa(config)# class-map IMPORTANT-FLOWS-MAP
ciscoasa(config)# match access-list IMPORTANT-FLOWS
ciscoasa(config-cmap)# policy-map INSIDE_POLICY
ciscoasa(config-pmap)# class IMPORTANT-FLOWS-MAP
ciscoasa(config-pmap-c)# cluster flow-mobility lisp
Step 4 Enter cluster group configuration mode, and enable flow mobility for the cluster:
cluster group name
flow-mobility lisp
This on/off toggle lets you easily enable or disable flow mobility.
Examples
The following example:
• Limits EIDs to those on the 10.10.10.0/24 network
• Inspects LISP traffic (UDP 4342) between a LISP router at 192.168.50.89 (on inside) and an ITR or
ETR router (on another ASA interface) at 192.168.10.8
• Enables flow mobility for all inside traffic going to a server on 10.10.10.0/24 using HTTPS.
• Enables flow mobility for the cluster.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
309
Manage ASA Cluster Members
Note When an ASA becomes inactive (either manually or through a health check failure), all data interfaces
are shut down; only the management-only interface can send and receive traffic. To resume traffic flow,
re-enable clustering; or you can remove the unit altogether from the cluster. The management interface
remains up using the IP address the unit received from the cluster IP pool. However if you reload, and the
unit is still inactive in the cluster, the management interface is disabled. You must use the console port
for any further configuration.
Procedure
Example:
ciscoasa(config)# cluster group pod1
Related Topics
Leave the Cluster, on page 311
Inactivate a Member
To inactivate a member from any unit, perform the following steps.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
310
Manage ASA Cluster Members
Note When an ASA becomes inactive, all data interfaces are shut down; only the management-only interface
can send and receive traffic. To resume traffic flow, re-enable clustering; or you can remove the unit
altogether from the cluster. The management interface remains up using the IP address the unit received
from the cluster IP pool. However if you reload, and the unit is still inactive in the cluster, the management
interface is disabled. You must use the console port for any further configuration.
Procedure
Example:
ciscoasa(config)# cluster remove unit ?
The bootstrap configuration remains intact, as well as the last configuration synched from the primary unit,
so that you can later re-add the unit without losing your configuration. If you enter this command on a secondary
unit to remove the primary unit, a new primary unit is elected.
To view member names, enter cluster remove unit ?, or enter the show cluster info command.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
311
Manage ASA Cluster Members
Example:
ciscoasa(config)# cluster group cluster1
ciscoasa(cfg-cluster)# no enable
You cannot make configuration changes while clustering is enabled on a secondary unit.
Step 4 If you have a backup configuration, copy the backup configuration to the running configuration:
copy backup_cfg running-config
Example:
ciscoasa(config)# copy backup_cluster.cfg running-config
Step 6 If you do not have a backup configuration, reconfigure management access. Be sure to change the interface
IP addresses, and restore the correct hostname, for example.
Caution The best method to change the primary unit is to disable clustering on the primary unit, waiting for a new
primary election, and then re-enabling clustering. If you must specify the exact unit you want to become
the primary, use the procedure in this section. Note, however, that for centralized features, if you force a
primary unit change using this procedure, then all connections are dropped, and you have to re-establish
the connections on the new primary unit.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
312
Manage ASA Cluster Members
Procedure
Example:
ciscoasa(config)# cluster master unit asa2
Related Topics
Become an Inactive Member, on page 310
Centralized Features for Clustering, on page 274
Procedure
Send a command to all members, or if you specify the unit name, a specific member:
cluster exec [unit unit_name] command
Example:
ciscoasa# cluster exec show xlate
To view member names, enter cluster exec unit ? (to see all names except the current unit), or enter the show
cluster info command.
Examples
To copy the same capture file from all units in the cluster at the same time to a TFTP server, enter the following
command on the primary unit:
Multiple PCAP files, one from each unit, are copied to the TFTP server. The destination capture file name is
automatically attached with the unit name, such as capture1_asa1.pcap, capture1_asa2.pcap, and so on. In
this example, asa1 and asa2 are cluster unit names.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
313
Monitoring the ASA Cluster
The following sample output for the cluster exec show port-channel summary command shows EtherChannel
information for each member in the cluster:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
314
Monitoring the ASA Cluster
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
315
Monitoring the ASA Cluster
To troubleshoot the connection flow, first see connections on all units by entering the cluster exec show
conn command on any unit. Look for flows that have the following flags: director (Y), backup (y), and
forwarder (z). The following example shows an SSH connection from 172.18.124.187:22 to
192.168.103.131:44727 on all three ASAs; ASA 1 has the z flag showing it is a forwarder for the
connection, ASA3 has the Y flag showing it is the director for the connection, and ASA2 has no special
flags showing it is the owner. In the outbound direction, the packets for this connection enter the inside
interface on ASA2 and exit the outside interface. In the inbound direction, the packets for this connection
enter the outside interface on ASA 1 and ASA3, are forwarded over the cluster control link to ASA2,
and then exit the inside interface on ASA2.
ASA2:*****************************************************************
12 in use, 13 most used
Cluster stub connections: 0 in use, 46 most used
TCP outside 172.18.124.187:22 inside 192.168.103.131:44727, idle 0:00:00, bytes
37240828, flags UIO
ASA3:*****************************************************************
10 in use, 12 most used
Cluster stub connections: 2 in use, 29 most used
TCP outside 172.18.124.187:22 inside 192.168.103.131:44727, idle 0:00:03, bytes 0,
flags Y
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
316
Monitoring the ASA Cluster
The show cluster info flow-mobility counters command shows EID movement and flow owner
movement information. See the following output for show cluster info flow-mobility counters:
To display the aggregated count of in-use connections for all units, enter:
cl1:******************************************************************
100 in use, 100 most used
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
317
Monitoring the ASA Cluster
Related Topics
Include the Device ID in Non-EMBLEM Format Syslog Messages, on page 926
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
318
Examples for ASA Clustering
Debugging Clustering
See the following commands for debugging clustering:
• debug cluster [ccp | datapath | fsm | general | hc | license | rpc | transport]
Shows debug messages for clustering.
• debug cluster flow-mobility
Shows events related to clustering flow mobility.
• debug lisp eid-notify-intercept
Shows events when the eid-notify message is intercepted.
• show cluster info trace
The show cluster info trace command shows the debug information for further troubleshooting.
See the following output for the show cluster info trace command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
319
Examples for ASA Clustering
ASA Configuration
interface GigabitEthernet0/0
channel-group 1 mode on
no shutdown
!
interface GigabitEthernet0/1
channel-group 1 mode on
no shutdown
!
interface Port-channel1
description Clustering Interface
!
cluster group Moya
local-unit A
cluster-interface Port-channel1 ip 10.0.0.1 255.255.255.0
priority 10
key emphyri0
enable noconfirm
interface GigabitEthernet0/0
channel-group 1 mode on
no shutdown
!
interface GigabitEthernet0/1
channel-group 1 mode on
no shutdown
!
interface Port-channel1
description Clustering Interface
!
cluster group Moya
local-unit B
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
320
Examples for ASA Clustering
interface GigabitEthernet0/2
channel-group 10 mode active
no shutdown
!
interface GigabitEthernet0/3
channel-group 10 mode active
no shutdown
!
interface GigabitEthernet0/4
channel-group 11 mode active
no shutdown
!
interface GigabitEthernet0/5
channel-group 11 mode active
no shutdown
!
interface Management0/0
management-only
nameif management
ip address 10.53.195.230 cluster-pool mgmt-pool
security-level 100
no shutdown
!
interface Port-channel10
port-channel span-cluster
mac-address aaaa.bbbb.cccc
nameif inside
security-level 100
ip address 209.165.200.225 255.255.255.224
!
interface Port-channel11
port-channel span-cluster
mac-address aaaa.dddd.cccc
nameif outside
security-level 0
ip address 209.165.201.1 255.255.255.224
interface GigabitEthernet1/0/15
switchport access vlan 201
switchport mode access
spanning-tree portfast
channel-group 10 mode active
!
interface GigabitEthernet1/0/16
switchport access vlan 201
switchport mode access
spanning-tree portfast
channel-group 10 mode active
!
interface GigabitEthernet1/0/17
switchport access vlan 401
switchport mode access
spanning-tree portfast
channel-group 11 mode active
!
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
321
Examples for ASA Clustering
interface GigabitEthernet1/0/18
switchport access vlan 401
switchport mode access
spanning-tree portfast
channel-group 11 mode active
interface Port-channel10
switchport access vlan 201
switchport mode access
interface Port-channel11
switchport access vlan 401
switchport mode access
Firewall on a Stick
Data traffic from different security domains are associated with different VLANs, for example, VLAN 10 for
the inside network and VLAN 20 for the outside network. Each ASA has a single physical port connected to
the external switch or router. Trunking is enabled so that all packets on the physical link are 802.1q
encapsulated. The ASA is the firewall between VLAN 10 and VLAN 20.
When using Spanned EtherChannels, all data links are grouped into one EtherChannel on the switch side. If
an ASA becomes unavailable, the switch will rebalance traffic between the remaining units.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
322
Examples for ASA Clustering
no shutdown
description CCL
local-unit asa1
cluster-interface tengigabitethernet0/8 ip 192.168.1.1 255.255.255.0
priority 1
key chuntheunavoidable
enable noconfirm
no shutdown
description CCL
local-unit asa2
cluster-interface tengigabitethernet0/8 ip 192.168.1.2 255.255.255.0
priority 2
key chuntheunavoidable
enable as-slave
no shutdown
description CCL
local-unit asa3
cluster-interface tengigabitethernet0/8 ip 192.168.1.3 255.255.255.0
priority 3
key chuntheunavoidable
enable as-slave
nameif management
ip address 10.1.1.1 255.255.255.0 cluster-pool mgmt
ipv6 address 2001:DB8::1001/32 cluster-pool mgmtipv6
security-level 100
management-only
no shutdown
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
323
Examples for ASA Clustering
Traffic Segregation
You may prefer physical separation of traffic between the inside and outside network.
As shown in the diagram above, there is one Spanned EtherChannel on the left side that connects to the inside
switch, and the other on the right side to outside switch. You can also create VLAN subinterfaces on each
EtherChannel if desired.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
324
Examples for ASA Clustering
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
interface port-channel 1
description CCL
local-unit asa1
cluster-interface port-channel1 ip 192.168.1.1 255.255.255.0
priority 1
key chuntheunavoidable
enable noconfirm
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
interface port-channel 1
description CCL
local-unit asa2
cluster-interface port-channel1 ip 192.168.1.2 255.255.255.0
priority 2
key chuntheunavoidable
enable as-slave
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
interface port-channel 1
description CCL
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
325
Examples for ASA Clustering
local-unit asa3
cluster-interface port-channel1 ip 192.168.1.3 255.255.255.0
priority 3
key chuntheunavoidable
enable as-slave
nameif management
ip address 10.1.1.1 255.255.255.0 cluster-pool mgmt
ipv6 address 2001:DB8::1001/32 cluster-pool mgmtipv6
security-level 100
management-only
no shutdown
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
326
Examples for ASA Clustering
The principle is to first maximize the number of active ports in the channel, and secondly keep the number
of active primary ports and the number of active secondary ports in balance. Note that when a 5th unit joins
the cluster, traffic is not balanced evenly between all units.
Link or device failure is handled with the same principle. You may end up with a less-than-perfect load
balancing situation. The following figure shows a 4-unit cluster with a single link failure on one of the units.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
327
Examples for ASA Clustering
There could be multiple EtherChannels configured in the network. The following diagram shows an
EtherChannel on the inside and one on the outside. An ASA is removed from the cluster if both primary and
secondary links in one EtherChannel fail. This prevents the ASA from receiving traffic from the outside
network when it has already lost connectivity to the inside network.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
328
Examples for ASA Clustering
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
329
Examples for ASA Clustering
interface port-channel 1
description CCL
local-unit asa1
cluster-interface port-channel1 ip 192.168.1.1 255.255.255.0
priority 1
key chuntheunavoidable
enable noconfirm
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
interface port-channel 1
description CCL
local-unit asa2
cluster-interface port-channel1 ip 192.168.1.2 255.255.255.0
priority 2
key chuntheunavoidable
enable as-slave
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
interface port-channel 1
description CCL
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
330
Examples for ASA Clustering
local-unit asa3
cluster-interface port-channel1 ip 192.168.1.3 255.255.255.0
priority 3
key chuntheunavoidable
enable as-slave
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
channel-group 1 mode on
no shutdown
interface port-channel 1
description CCL
local-unit asa4
cluster-interface port-channel1 ip 192.168.1.4 255.255.255.0
priority 4
key chuntheunavoidable
enable as-slave
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
331
Examples for ASA Clustering
interface port-channel 3
port-channel span-cluster vss-load-balance
nameif inside
ip address 10.10.10.5 255.255.255.0
mac-address 000C.F142.4CDE
feature ospf
feature otv
interface Overlay1
otv join-interface Ethernet8/1
otv control-group 239.1.1.1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
332
Examples for ASA Clustering
interface Ethernet8/1
description uplink_to_OTV_cloud
mtu 9198
ip address 10.4.0.18/24
ip igmp version 3
no shutdown
interface Ethernet8/2
interface Ethernet8/3
description back_to_default_vdc_e6/39
switchport
switchport mode trunk
switchport trunk allowed vlan 202,2222,3151-3152
mac packet-classify
no shutdown
otv-isis default
vpn Overlay1
redistribute filter route-map stop-GMAC
otv site-identifier 0x2
otv flood mac 0050.56A8.3D22 vlan 3151
otv-isis default
vpn Overlay1
redistribute filter route-map a-GMAC
When the other site is restored, you need to add the filters back again and remove this static entry on the OTV.
It is very important to clear the dynamic MAC address table on both the OTVs to clear the overlay entry for
the global MAC address.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
333
History for ASA Clustering
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
334
History for ASA Clustering
Improved VSS and vPC 9.1(4) If you configure the cluster control link as an EtherChannel (recommended), and it is connected
support for health check to a VSS or vPC pair, you can now increase stability with health check monitoring. For some
monitoring switches, such as the Cisco Nexus 5000, when one unit in the VSS/vPC is shutting down or
booting up, EtherChannel member interfaces connected to that switch may appear to be Up to
the ASA, but they are not passing traffic on the switch side. The ASA can be erroneously
removed from the cluster if you set the ASA holdtime timeout to a low value (such as .8
seconds), and the ASA sends keepalive messages on one of these EtherChannel interfaces.
When you enable the VSS/vPC health check feature, the ASA floods the keepalive messages
on all EtherChannel interfaces in the cluster control link to ensure that at least one of the
switches can receive them.
We modified the following command: health-check [vss-enabled].
Support for cluster 9.1(4) You can now place cluster members at different geographical locations when using Individual
members at different Interface mode.
geographical locations We did not modify any commands.
(inter-site); Individual
Interface mode only
Support for cluster 9.2(1) You can now place cluster members at different geographical locations when using Spanned
members at different EtherChannel mode in transparent firewall mode. Inter-site clustering with spanned
geographical locations EtherChannels in routed firewall mode is not supported.
(inter-site) for We did not modify any commands.
transparent mode
Static LACP port 9.2(1) Some switches do not support dynamic port priority with LACP (active and standby links).
priority support for You can now disable dynamic port priority to provide better compatibility with spanned
clustering EtherChannels. You should also follow these guidelines:
• Network elements on the cluster control link path should not verify the L4 checksum.
Redirected traffic over the cluster control link does not have a correct L4 checksum.
Switches that verify the L4 checksum could cause traffic to be dropped.
• Port-channel bundling downtime should not exceed the configured keepalive interval.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
335
History for ASA Clustering
Support for 16 cluster 9.2(1) The ASA 5585-X now supports 16-unit clusters.
members for the ASA We did not modify any commands.
5585-X
BGP support for ASA 9.3(1) We added support for BGP with ASA clustering.
clustering We introduced the following command: bgp router-id clusterpool.
Inter-site deployment in 9.3(2) You can now deploy a cluster in transparent mode between inside networks and the gateway
transparent mode with router at each site (AKA East-West insertion), and extend the inside VLANs between sites.
the ASA cluster We recommend using Overlay Transport Virtualization (OTV), but you can use any method
firewalling between that ensures that the overlapping MAC Addresses and IP addresses of the gateway router do
inside networks not leak between sites. Use a First Hop Redundancy Protocol (FHRP) such as HSRP to provide
the same virtual MAC and IP addresses to the gateway routers.
Enable and disable ASA 9.4(1) You can now enable or disable health monitoring per interface. Health monitoring is enabled
cluster health monitoring by default on all port-channel, redundant, and single physical interfaces. Health monitoring is
per interface not performed on VLAN subinterfaces or virtual interfaces such as VNIs or BVIs. You cannot
configure monitoring for the cluster control link; it is always monitored. You might want to
disable health monitoring of non-essential interfaces, for example, the management interface.
We introduced the following command: health-check monitor-interface.
ASA clustering support 9.4(1) You can now configure DHCP relay on the ASA cluster. Client DHCP requests are
for DHCP relay load-balanced to the cluster members using a hash of the client MAC address. DHCP client
and server functions are still not supported.
We did not modify any commands.
SIP inspection support 9.4(1) You can now configure SIP inspection on the ASA cluster. A control flow can be created on
in ASA clustering any unit (due to load balancing), but its child data flows must reside on the same unit. TLS
Proxy configuration is not supported.
We introduced the following command: show cluster service-policy.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
336
History for ASA Clustering
ASA cluster 9.5(1) You can now customize the auto-rejoin behavior when an interface or the cluster control link
customization of the fails.
auto-rejoin behavior We introduced the following command: health-check auto-rejoin
when an interface or the
cluster control link fails
The ASA cluster 9.5(1) The ASA cluster now supports GTPv1 and GTPv2 inspection.
supports GTPv1 and We did not modify any commands.
GTPv2
Disable health 9.5(1) By default when using clustering, the ASA monitors the health of an installed hardware module
monitoring of a such as the ASA FirePOWER module. If you do not want a hardware module failure to trigger
hardware module in failover, you can disable module monitoring.
ASA clustering We modified the following command: health-check monitor-interface service-module
Cluster replication delay 9.5(1) This feature helps eliminate the “unnecessary work” related to short-lived flows by delaying
for TCP connections the director/backup flow creation.
We introduced the following command: cluster replication delay
ASA 5516-X support for 9.5(2) The ASA 5516-X now supports 2-unit clusters. Clustering for 2 units is enabled by default in
clustering the base license.
We did not modify any commands.
LISP Inspection for 9.5(2) Cisco Locator/ID Separation Protocol (LISP) architecture separates the device identity from
Inter-Site Flow Mobility its location into two different numbering spaces, making server migration transparent to clients.
The ASA can inspect LISP traffic for location changes and then use this information for
seamless clustering operation; the ASA cluster members inspect LISP traffic passing between
the first hop router and the egress tunnel router (ETR) or ingress tunnel router (ITR), and then
change the flow owner to be at the new site.
We introduced or modified the following commands: allowed-eid, clear cluster info
flow-mobility counters, clear lisp eid, cluster flow-mobility lisp, debug cluster
flow-mobility, debug lisp eid-notify-intercept, flow-mobility lisp, inspect lisp, policy-map
type inspect lisp, site-id, show asp table classify domain inspect-lisp, show cluster info
flow-mobility counters, show conn, show lisp eid, show service-policy, validate-key
Carrier Grade NAT 9.5(2) For carrier-grade or large-scale PAT, you can allocate a block of ports for each host, rather
enhancements now than have NAT allocate one port translation at a time (see RFC 6888). This feature is now
supported in failover and supported in failover and ASA cluster deployments.
ASA clustering We modified the following command: show local-host
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
337
History for ASA Clustering
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
338
CHAPTER 9
ASA Cluster for the FXOS Chassis
Clustering lets you group multiple FXOS chassis ASAs together as a single logical device. The FXOS chassis
series includes the Firepower 9300. A cluster provides all the convenience of a single device (management,
integration into a network) while achieving the increased throughput and redundancy of multiple devices.
Note Some features are not supported when using clustering. See Unsupported Features with Clustering, on
page 353.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
339
About Clustering on the FXOS Chassis
parts of the bootstrap configuration may be user-configurable within the application if you want to
customize your clustering environment.
• Assigns data interfaces to the cluster as Spanned interfaces.
For intra-chassis clustering, spanned interfaces are not limited to EtherChannels, like it is for inter-chassis
clustering.The Firepower 9300 supervisor uses EtherChannel technology internally to load-balance
traffic to multiple modules on a shared interface, so any data interface type works for Spanned mode.
For inter-chassis clustering, you must use Spanned EtherChannels for all data interfaces.
Note Individual interfaces are not supported, with the exception of a management interface.
The following sections provide more detail about clustering concepts and implementation.
Bootstrap Configuration
When you deploy the cluster, the FXOS chassis supervisor pushes a minimal bootstrap configuration to each
unit that includes the cluster name, cluster control link interface, and other cluster settings. Some parts of the
bootstrap configuration are user-configurable if you want to customize your clustering environment.
Cluster Members
Cluster members work together to accomplish the sharing of the security policy and traffic flows. This section
describes the nature of each member role.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
340
About Clustering on the FXOS Chassis
Note You can manually force a unit to become the primary. For centralized features, if you force a primary unit
change, then all connections are dropped, and you have to re-establish the connections on the new primary
unit.
Cluster Interfaces
For intra-chassis clustering, you can assign both physical interfaces or EtherChannels (also known as port
channels) to the cluster. Interfaces assigned to the cluster are Spanned interfaces that load-balance traffic
across all members of the cluster.
For inter-chassis clustering, you can only assign data EtherChannels to the cluster. These Spanned
EtherChannels include the same member interfaces on each chassis; on the upstream switch, all of these
interfaces are included in a single EtherChannel, so the switch does not know that it is connected to multiple
devices.
Individual interfaces are not supported, with the exception of a management interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
341
About Clustering on the FXOS Chassis
• Health monitoring.
Chassis-Application Monitoring
Chassis-application health monitoring is always enabled. The FXOS chassis supervisor checks the ASA
application periodically (every second). If the ASA is up and cannot communicate with the FXOS chassis
supervisor for 3 seconds, the ASA generates a syslog message and leaves the cluster.
If the FXOS chassis supervisor cannot communicate with the application after 45 seconds, it reloads the ASA.
If the ASA cannot communicate with the supervisor, it removes itself from the cluster.
Interface Monitoring
Each unit monitors the link status of all hardware interfaces in use, and reports status changes to the primary
unit. For inter-chassis clustering, Spanned EtherChannels use the cluster Link Aggregation Control Protocol
(cLACP). Each chassis monitors the link status and the cLACP protocol messages to determine if the port is
still active in the EtherChannel, and informs the ASA application if the interface is down. When you enable
health monitoring, all physical interfaces are monitored by default (including the main EtherChannel). Only
named interfaces that are up can be monitored. For example, the named EtherChannel must fail to be considered
failed, which means all member ports of an EtherChannel must fail to trigger cluster removal (depending on
your minimum port bundling setting). You can optionally disable monitoring per interface.
If a monitored interface fails on a particular unit, but it is active on other units, then the unit is removed from
the cluster. The amount of time before the ASA removes a member from the cluster depends on whether the
unit is an established member or is joining the cluster. The ASA does not monitor interfaces for the first 90
seconds that a unit joins the cluster. Interface status changes during this time will not cause the ASA to be
removed from the cluster. For an established member, the unit is removed after 500 ms.
For inter-chassis clustering, if you add or delete an EtherChannel from the cluster, interface health-monitoring
is suspended for 95 seconds to ensure that you have time to make the changes on each chassis.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
342
About Clustering on the FXOS Chassis
If the primary unit fails, then another member of the cluster with the highest priority (lowest number) becomes
the primary.
The ASA automatically tries to rejoin the cluster, depending on the failure event.
Note When the ASA becomes inactive and fails to automatically rejoin the cluster, all data interfaces are shut
down; only the management-only interface can send and receive traffic. The management interface remains
up using the IP address the unit received from the cluster IP pool. However if you reload, and the unit is
still inactive in the cluster, the management interface is disabled. You must use the console port for any
further configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
343
About Clustering on the FXOS Chassis
User Identity Yes Includes AAA rules (uauth) and identity firewall.
SNMP Engine ID No —
Configuration Replication
All units in the cluster share a single configuration. You can only make configuration changes on the primary
unit, and changes are automatically synced to all other units in the cluster.
Management Interface
You must assign a Management type interface to the cluster. This interface is a special individual interface
as opposed to a Spanned interface. The management interface lets you connect directly to each unit.
The Main cluster IP address is a fixed address for the cluster that always belongs to the current primary unit.
You also configure a range of addresses so that each unit, including the current primary, can use a Local
address from the range. The Main cluster IP address provides consistent management access to an address;
when a primary unit changes, the Main cluster IP address moves to the new primary unit, so management of
the cluster continues seamlessly.
For example, you can manage the cluster by connecting to the Main cluster IP address, which is always
attached to the current primary unit. To manage an individual member, you can connect to the Local IP address.
For outbound management traffic such as TFTP or syslog, each unit, including the primary unit, uses the
Local IP address to connect to the server.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
344
About Clustering on the FXOS Chassis
Inter-Site Clustering
For inter-site installations, you can take advantage of ASA clustering as long as you follow these guidelines.
If the number of members differs at each site, use the larger number for your calculation. The minimum
bandwidth for the DCI should not be less than the size of the cluster control link for one member.
For example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
345
About Clustering on the FXOS Chassis
Reserved DCI bandwidth = 10 Gbps (1/2 x 10 Gbps = 5 Gbps; but the minimum bandwidth should not
be less than the size of the cluster control link (10 Gbps)).
About LISP
Data center virtual machine mobility such as VMware VMotion enables servers to migrate between data
centers while maintaining connections to clients. To support such data center server mobility, routers need to
be able to update the ingress route towards the server when it moves. Cisco Locator/ID Separation Protocol
(LISP) architecture separates the device identity, or endpoint identifier (EID), from its location, or routing
locator (RLOC), into two different numbering spaces, making server migration transparent to clients. For
example, when a server moves to a new site and a client sends traffic to the server, the router redirects traffic
to the new location.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
346
About Clustering on the FXOS Chassis
LISP requires routers and servers in certain roles, such as the LISP egress tunnel router (ETR), ingress tunnel
router (ITR), first hop routers, map resolver (MR), and map server (MS). When the first hop router for the
server senses that the server is connected to a different router, it updates all of the other routers and databases
so that the ITR connected to the client can intercept, encapsulate, and send traffic to the new server location.
LISP Guidelines
• The ASA cluster members must reside between the first hop router and the ITR or ETR for the site. The
ASA cluster itself cannot be the first hop router for an extended segment.
• Only fully-distributed flows are supported; centralized flows, semi-distributed flows, or flows belonging
to individual units are not moved to new owners. Semi-distributed flows include applications, such as
SIP, where all child flows are owned by the same ASA that owns the parent flow.
• The cluster only moves Layer 3 and 4 flow states; some application data might be lost.
• For short-lived flows or non-business-critical flows, moving the owner may not be worthwhile. You
can control the types of traffic that are supported with this feature when you configure the inspection
policy, and should limit flow mobility to essential traffic.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
347
About Clustering on the FXOS Chassis
Inter-Site Examples
The following examples show supported cluster deployments.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
348
About Clustering on the FXOS Chassis
The cluster acts as the gateway for the inside networks. The global virtual MAC, which is shared across all
cluster units, is used only to receive packets. Outgoing packets use a site-specific MAC address from each
DC cluster. This feature prevents the switches from learning the same global MAC address from both sites
on two different ports, which causes MAC flapping; instead, they only learn the site MAC address.
In this scenario:
• All egress packets sent from the cluster use the site MAC address and are localized at the data center.
• All ingress packets to the cluster are sent using the global MAC address, so they can be received by any
of the units at both sites; filters at the OTV localize the traffic within the data center.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
349
About Clustering on the FXOS Chassis
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
350
About Clustering on the FXOS Chassis
interface and cause problems. The data VLANs are extended between the sites using Overlay Transport
Virtualization (OTV) (or something similar). You must add filters to prevent traffic from traversing the DCI
to the other site when the traffic is destined for the gateway router. If the gateway router at one site becomes
unreachable, you must remove the filters so traffic can be sent to the other site’s gateway router.
See Spanned EtherChannel Transparent Mode North-South Inter-Site Example, on page 269 for information
about vPC/VSS options.
Connection Roles
There are 3 different roles defined for each connection:
• Owner—The unit that initially receives the connection. The owner maintains the TCP state and processes
packets. A connection has only one owner.
• Director—The unit that handles owner lookup requests from forwarders and also maintains the connection
state to serve as a backup if the owner fails. When the owner receives a new connection, it chooses a
director based on a hash of the source/destination IP address and TCP ports, and sends a message to the
director to register the new connection. If packets arrive at any unit other than the owner, the unit queries
the director about which unit is the owner so it can forward the packets. A connection has only one
director.
• Forwarder—A unit that forwards packets to the owner. If a forwarder receives a packet for a connection
it does not own, it queries the director for the owner, and then establishes a flow to the owner for any
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
351
About Clustering on the FXOS Chassis
other packets it receives for this connection. The director can also be a forwarder. Note that if a forwarder
receives the SYN-ACK packet, it can derive the owner directly from a SYN cookie in the packet, so it
does not need to query the director. (If you disable TCP sequence randomization, the SYN cookie is not
used; a query to the director is required.) For short-lived flows such as DNS and ICMP, instead of
querying, the forwarder immediately sends the packet to the director, which then sends them to the
owner. A connection can have multiple forwarders; the most efficient throughput is achieved by a good
load-balancing method where there are no forwarders and all packets of a connection are received by
the owner.
When a connection uses Port Address Translation (PAT), then the PAT type (per-session or multi-session)
influences which member of the cluster becomes the owner of a new connection:
• Per-session PAT—The owner is the unit that receives the initial packet in the connection.
By default, TCP and DNS UDP traffic use per-session PAT.
• Multi-session PAT—The owner is always the primary unit. If a multi-session PAT connection is initially
received by a secondary unit, then the secondary unit forwards the connection to the primary unit.
By default, UDP (except for DNS UDP) and ICMP traffic use multi-session PAT, so these connections
are always owned by the primary unit.
You can change the per-session PAT defaults for TCP and UDP so connections for these protocols are handled
per-session or multi-session depending on the configuration. For ICMP, you cannot change from the default
multi-session PAT. For more information about per-session PAT, see the firewall configuration guide.
For inter-chassis clustering, if the director for a flow is in the same chassis as the owner, then an additional
director is chosen on a different chassis to act as the director's backup in case the owner's chassis fails. If the
director is already on a different chassis, then no additional directors are required.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
352
About Clustering on the FXOS Chassis
1 The SYN packet originates from the client and is delivered to one ASA (based on the load balancing
method), which becomes the owner. The owner creates a flow, encodes owner information into a SYN
cookie, and forwards the packet to the server.
2 The SYN-ACK packet originates from the server and is delivered to a different ASA (based on the load
balancing method). This ASA is the forwarder.
3 Because the forwarder does not own the connection, it decodes owner information from the SYN cookie,
creates a forwarding flow to the owner, and forwards the SYN-ACK to the owner.
4 The owner sends a state update to the director, and forwards the SYN-ACK to the client.
5 The director receives the state update from the owner, creates a flow to the owner, and records the TCP
state information as well as the owner. The director acts as the backup owner for the connection.
6 Any subsequent packets delivered to the forwarder will be forwarded to the owner.
7 If packets are delivered to any additional units, it will query the director for the owner and establish a flow.
8 Any state change for the flow results in a state update from the owner to the director.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
353
About Clustering on the FXOS Chassis
◦CTIQBE
◦H323, H225, and RAS
◦IPsec passthrough
◦MGCP
◦MMP
◦RTSP
◦SCCP (Skinny)
◦WAAS
◦WCCP
Note Traffic for centralized features is forwarded from member units to the primary unit over the cluster control
link.
If you use the rebalancing feature, traffic for centralized features may be rebalanced to non-primary units
before the traffic is classified as a centralized feature; if this occurs, the traffic is then sent back to the
primary unit.
For centralized features, if the primary unit fails, all connections are dropped, and you have to re-establish
the connections on the new primary unit.
• Site-to-site VPN
• The following application inspections:
◦DCERPC
◦NetBIOS
◦PPTP
◦RADIUS
◦RSH
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
354
About Clustering on the FXOS Chassis
◦SUNRPC
◦TFTP
◦XDMCP
• Dynamic routing
• Static route monitoring
• IGMP multicast control plane protocol processing (data plane forwarding is distributed across the cluster)
• PIM multicast control plane protocol processing (data plane forwarding is distributed across the cluster)
• Authentication and Authorization for network access. Accounting is decentralized.
• Filtering Services
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
355
About Clustering on the FXOS Chassis
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
356
About Clustering on the FXOS Chassis
• NAT pool address distribution for dynamic PAT—The primary unit evenly pre-distributes addresses
across the cluster. If a member receives a connection and they have no addresses left, the connection is
dropped, even if other members still have addresses available. Make sure to include at least as many
NAT addresses as there are units in the cluster to ensure that each unit receives an address. Use the show
nat pool cluster command to see the address allocations.
• No round-robin—Round-robin for a PAT pool is not supported with clustering.
• Dynamic NAT xlates managed by the primary unit—The primary unit maintains and replicates the xlate
table to secondary units. When a secondary unit receives a connection that requires dynamic NAT, and
the xlate is not in the table, it requests the xlate from the primary unit. The secondary unit owns the
connection.
• Per-session PAT feature—Although not exclusive to clustering, the per-session PAT feature improves
the scalability of PAT and, for clustering, allows each secondary unit to own PAT connections; by
contrast, multi-session PAT connections have to be forwarded to and owned by the primary unit. By
default, all TCP traffic and UDP DNS traffic use a per-session PAT xlate, whereas ICMP and all other
UDP traffic uses multi-session. You can configure per-session NAT rules to change these defaults for
TCP and UDP, but you cannot configure per-session PAT for ICMP. For traffic that benefits from
multi-session PAT, such as H.323, SIP, or Skinny, you can disable per-session PAT for the associated
TCP ports (the UDP ports for those H.323 and SIP are already multi-session by default). For more
information about per-session PAT, see the firewall configuration guide.
• No static PAT for the following inspections—
◦FTP
◦PPTP
◦RSH
◦SQLNET
◦TFTP
◦XDMCP
◦SIP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
357
About Clustering on the FXOS Chassis
After the secondary members learn the routes from the primary unit, each unit makes forwarding decisions
independently.
The OSPF LSA database is not synchronized from the primary unit to secondary units. If there is a primary
unit switchover, the neighboring router will detect a restart; the switchover is not transparent. The OSPF
process picks an IP address as its router ID. Although not required, you can assign a static router ID to ensure
a consistent router ID is used across the cluster. See the OSPF Non-Stop Forwarding feature to address the
interruption.
You can use the following SCTP features with clustering enabled:
• SCTP protocol/port specifications in access rules, extended ACLs, and service objects and groups.
• SCTP application layer inspection, including payload protocol identifier (PPID) filtering.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
358
About Clustering on the FXOS Chassis
VPN functionality is limited to the primary unit and does not take advantage of the cluster high availability
capabilities. If the primary unit fails, all existing VPN connections are lost, and VPN users will see a disruption
in service. When a new primary is elected, you must reestablish the VPN connections.
When you connect a VPN tunnel to a Spanned interface address, connections are automatically forwarded to
the primary unit.
VPN-related keys and certificates are replicated to all units.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
359
Licensing for Clustering on the FXOS Chassis
Switch Prerequisites
• Be sure to complete the switch configuration before you configure clustering on the ASA.
• For a list of supported switches, see Cisco FXOS Compatibility.
Additional Guidelines
• You can include up to 6 modules in the cluster in up to 6 chassis.
• When significant topology changes occur (such as adding or removing an EtherChannel interface,
enabling or disabling an interface on the FXOS chassis or the switch, adding an additional switch to
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
360
Defaults for Clustering on the FXOS Chassis
form a VSS or vPC) you should disable the health check feature. When the topology change is complete,
and the configuration change is synced to all units, you can re-enable the health check feature.
• When adding a unit to an existing cluster, or when reloading a unit, there will be a temporary, limited
packet/connection drop; this is expected behavior. In some cases, the dropped packets can hang your
connection; for example, dropping a FIN/ACK packet for an FTP connection will make the FTP client
hang. In this case, you need to reestablish the FTP connection.
• If you use a Windows 2003 server connected to a Spanned interface, when the syslog server port is down
and the server does not throttle ICMP error messages, then large numbers of ICMP messages are sent
back to the cluster. These messages can result in some units of the cluster experiencing high CPU, which
can affect performance. We recommend that you throttle ICMP error messages.
Procedure
Step 1 Deploy the Cluster from the FXOS Chassis Supervisor, on page 362
Step 2 Customize the Cluster Configuration in the ASA, on page 362
Step 3 Become an Inactive Member, on page 371
Step 4 Inactivate a Member, on page 372
Step 5 Change the Primary Unit, on page 373
Step 6 Execute a Command Cluster-Wide, on page 373
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
361
Configure Clustering on the FXOS Chassis
interface <management_ifc>
management-only individual
nameif management
ip address <ip_address> <mask> cluster-pool cluster_ipv4_pool
security-level 0
no shutdown
Note The local-unit name can only be changed if you disable clustering.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
362
Configure Clustering on the FXOS Chassis
• For multiple context mode, perform this procedure in the system execution space. If you are not already
in the System configuration mode, enter the changeto system command.
Procedure
Step 1 Access the ASA console on one of the units in the cluster.
Step 2 Check the cluster name and application status; we suggest that you change the site ID on each secondary unit
and then lastly on the primary unit to limit the primary re-election to a single instance.
show cluster info
Example:
If this device is the primary unit, exit the connection and connect to the correct slot number.
Example:
ciscoasa(config)# cluster group cluster1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
363
Configure Clustering on the FXOS Chassis
ciscoasa(cfg-cluster)# no enable
Example:
ciscoasa(cfg-cluster)# site-id 1
Step 7 Repeat for all secondary units, and then finally for the primary unit.
Step 8 (Routed mode only) On the primary unit, set the site-specific MAC addresses:
a) Specify the port-channel interface:
interface port-channel channel_id
Example:
ciscoasa(config)# interface port-channel 1
Example:
ciscoasa(config-if)# mac-address aaaa.1111.1234
ciscoasa(config-if)# mac-address aaaa.1111.aaaa site-id 1
ciscoasa(config-if)# mac-address aaaa.1111.bbbb site-id 2
ciscoasa(config-if)# mac-address aaaa.1111.cccc site-id 3
ciscoasa(config-if)# mac-address aaaa.1111.dddd site-id 4
The site-specific MAC address used by a unit depends on the site ID you specify in each unit’s bootstrap
configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
364
Configure Clustering on the FXOS Chassis
Procedure
Example:
If a different module is the primary unit, exit the connection and connect to the correct module. See the
Firepower 9300 ASA Security Module Quick Start Guide for information about accessing the ASA console.
Step 2 Specify the maximum transmission unit for the cluster control link interface:
mtu cluster bytes
Example:
ciscoasa(config)# mtu cluster 9000
Step 4 (Optional) Enable console replication from secondary units to the primary unit:
console-replicate
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
365
Configure Clustering on the FXOS Chassis
This feature is disabled by default. The ASA prints out some messages directly to the console for certain
critical events. If you enable console replication, secondary units send the console messages to the primary
unit so that you only need to monitor one console port for the cluster.
Procedure
Step 1 Customize the cluster health check feature, which includes unit health monitoring and interface health
monitoring:
health-check [holdtime timeout]
Example:
ciscoasa(cfg-cluster)# health-check holdtime 5
The holdime determines the amount of time between unit keepalive status messages, between .8 and 45
seconds; The default is 3 seconds. Note that the holdtime value only affects the unit health check; for interface
health, the ASA uses the interface status (up or down).
To determine unit health, the ASA cluster units send keepalive messages on the cluster control link to other
units. If a unit does not receive any keepalive messages from a peer unit within the holdtime period, the peer
unit is considered unresponsive or dead.
The interface health check monitors for link failures. If all physical ports for a given logical interface fail on
a particular unit, but there are active ports under the same logical interface on other units, then the unit is
removed from the cluster. The amount of time before the ASA removes a member from the cluster depends
on the type of interface and whether the unit is an established member or is joining the cluster.
Health check is enabled by default for all interfaces. You can disable it using the no form of this command.
To disable monitoring per interface, see the no health-check monitor-interface command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
366
Configure Clustering on the FXOS Chassis
When any topology changes occur (such as adding or removing a data interface, enabling or disabling an
interface on the ASA, FXOS chassis, or the switch, or adding an additional switch to form a VSS or vPC)
you should disable the health check feature. When the topology change is complete, and the configuration
change is synced to all units, you can re-enable the health check feature.
Step 2 Customize the auto-rejoin cluster settings after a health check failure:
health-check {data-interface | cluster-interface} auto-rejoin [unlimited | auto_rejoin_max]
auto_rejoin_interval auto_rejoin_interval_variation
Example:
ciscoasa(cfg-cluster)# health-check data-interface auto-rejoin 10 3 3
Define the number of attempts at rejoining the cluster by setting unlimited or the auto-rejoin-max between
0 and 65535. 0 disables auto-rejoining. The default value is unlimited for the cluster-interface and 3 for the
data-interface.
Define the interval duration in minutes between rejoin attempts by setting the auto_rejoin_interval between
2 and 60. The default value is 5 minutes. The maximum total time that the unit attempts to rejoin the cluster
is limited to 14400 minutes (10 days) from the time of last failure.
Define if the interval duration increases by setting the auto_rejoin_interval_variation between 1 and 3: 1 (no
change); 2 (2 x the previous duration), or 3 (3 x the previous duration). For example, if you set the interval
duration to 5 minutes, and set the variation to 2, then the first attempt is after 5 minutes; the 2nd attempt is
10 minutes (2 x 5); the 3rd attempt 20 minutes (2 x 10), and so on. The default value is 1 for the cluster-interface
and 2 for the data-interface.
Example:
ciscoasa(cfg-cluster)# no health-check monitor-interface port-channel1
You might want to disable health monitoring of non-essential interfaces, for example, the management
interface. Health monitoring is not performed on VLAN subinterfaces or virtual interfaces such as VNIs or
BVIs. You cannot configure monitoring for the cluster control link; it is always monitored.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
367
Configure Clustering on the FXOS Chassis
Example:
ciscoasa(cfg-cluster)# conn-rebalance frequency 60
This command is disabled by default. If enabled, ASAs exchange load information periodically, and offload
new connections from more loaded devices to less loaded devices. The frequency, between 1 and 360 seconds,
specifies how often the load information is exchanged. The default is 5 seconds.
Do not configure connection rebalancing for inter-site topologies; you do not want connections rebalanced
to cluster members at a different site.
Example:
ciscoasa(config)# cluster replication delay 15 match tcp any any eq ftp
ciscoasa(config)# cluster replication delay 15 http
Set the seconds between 1 and 15. The http delay is enabled by default for 5 seconds.
Procedure
Step 1 (Optional) Configure a LISP inspection map to limit inspected EIDs based on IP address, and to configure
the LISP pre-shared key:
a) Create an extended ACL; only the destination IP address is matched to the EID embedded address:
access list eid_acl_name extended permit ip source_address mask destination_address mask
Both IPv4 and IPv6 ACLs are accepted. See the command reference for exact access-list extended syntax.
b) Create the LISP inspection map, and enter parameters mode:
policy-map type inspect lisp inspect_map_name
parameters
c) Define the allowed EIDs by identifying the ACL you created:
allowed-eid access-list eid_acl_name
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
368
Configure Clustering on the FXOS Chassis
The first hop router or ITR/ETR might send EID-notify messages for hosts or networks the ASA cluster
is not involved with, so you can limit the EIDs to only those servers or networks relevant to your cluster.
For example, if the cluster is only involved with 2 sites, but LISP is running on 3 sites, you should only
include EIDs for the 2 sites involved with the cluster.
d) If necessary, enter the pre-shared key:
validate-key key
Example:
ciscoasa(config)# access-list TRACKED_EID_LISP extended permit ip any 10.10.10.0 255.255.255.0
ciscoasa(config)# policy-map type inspect lisp LISP_EID_INSPECT
ciscoasa(config-pmap)# parameters
ciscoasa(config-pmap-p)# allowed-eid access-list TRACKED_EID_LISP
ciscoasa(config-pmap-p)# validate-key MadMaxShinyandChrome
Step 2 Configure LISP inspection for UDP traffic between the first hop router and the ITR or ETR on port 4342:
a) Configure the extended ACL to identify LISP traffic:
access list inspect_acl_name extended permit udp source_address mask destination_address mask eq
4342
You must specify UDP port 4342. Both IPv4 and IPv6 ACLs are accepted. See the command reference
for exact access-list extended syntax.
b) Create a class map for the ACL:
class-map inspect_class_name
match access-list inspect_acl_name
c) Specify the policy map, the class map, enable inspection using the optional LISP inspection map, and
apply the service policy to an interface (if new):
policy-map policy_map_name
class inspect_class_name
inspect lisp [inspect_map_name]
service-policy policy_map_name {global | interface ifc_name}
If you have an existing service policy, specify the existing policy map name. By default, the ASA includes
a global policy called global_policy, so for a global policy, specify that name. You can also create one
service policy per interface if you do not want to apply the policy globally. LISP inspection is applied to
traffic bidirectionally so you do not need to apply the service policy on both the source and destination
interfaces; all traffic that enters or exits the interface to which you apply the policy map is affected if the
traffic matches the class map for both directions.
Example:
ciscoasa(config)# access-list LISP_ACL extended permit udp host 192.168.50.89 host
192.168.10.8 eq 4342
ciscoasa(config)# class-map LISP_CLASS
ciscoasa(config-cmap)# match access-list LISP_ACL
ciscoasa(config-cmap)# policy-map INSIDE_POLICY
ciscoasa(config-pmap)# class LISP_CLASS
ciscoasa(config-pmap-c)# inspect lisp LISP_EID_INSPECT
ciscoasa(config)# service-policy INSIDE_POLICY interface inside
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
369
Configure Clustering on the FXOS Chassis
The ASA inspects LISP traffic for the EID-notify message sent between the first hop router and the ITR or
ETR. The ASA maintains an EID table that correlates the EID and the site ID.
Example:
ciscoasa(config)# access-list IMPORTANT-FLOWS extended permit tcp any 10.10.10.0 255.255.255.0
eq https
ciscoasa(config)# class-map IMPORTANT-FLOWS-MAP
ciscoasa(config)# match access-list IMPORTANT-FLOWS
ciscoasa(config-cmap)# policy-map INSIDE_POLICY
ciscoasa(config-pmap)# class IMPORTANT-FLOWS-MAP
ciscoasa(config-pmap-c)# cluster flow-mobility lisp
Step 4 Enter cluster group configuration mode, and enable flow mobility for the cluster:
cluster group name
flow-mobility lisp
This on/off toggle lets you easily enable or disable flow mobility.
Examples
The following example:
• Limits EIDs to those on the 10.10.10.0/24 network
• Inspects LISP traffic (UDP 4342) between a LISP router at 192.168.50.89 (on inside) and an ITR or
ETR router (on another ASA interface) at 192.168.10.8
• Enables flow mobility for all inside traffic going to a server on 10.10.10.0/24 using HTTPS.
• Enables flow mobility for the cluster.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
370
Configure Clustering on the FXOS Chassis
parameters
allowed-eid access-list TRACKED_EID_LISP
validate-key MadMaxShinyandChrome
!
access-list LISP_ACL extended permit udp host 192.168.50.89 host 192.168.10.8 eq 4342
class-map LISP_CLASS
match access-list LISP_ACL
policy-map INSIDE_POLICY
class LISP_CLASS
inspect lisp LISP_EID_INSPECT
service-policy INSIDE_POLICY interface inside
!
access-list IMPORTANT-FLOWS extended permit tcp any 10.10.10.0 255.255.255.0 eq https
class-map IMPORTANT-FLOWS-MAP
match access-list IMPORTANT-FLOWS
policy-map INSIDE_POLICY
class IMPORTANT-FLOWS-MAP
cluster flow-mobility lisp
!
cluster group cluster1
flow-mobility lisp
Note When an ASA becomes inactive (either manually or through a health check failure), all data interfaces
are shut down; only the management-only interface can send and receive traffic. To resume traffic flow,
re-enable clustering; or you can remove the unit altogether from the cluster. The management interface
remains up using the IP address the unit received from the cluster IP pool. However if you reload, and the
unit is still inactive in the cluster, the management interface is disabled. You must use the console port
for any further configuration.
Procedure
Example:
ciscoasa(config)# cluster group pod1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
371
Configure Clustering on the FXOS Chassis
If this unit was the primary unit, a new primary election takes place, and a different member becomes the
primary unit.
The cluster configuration is maintained, so that you can enable clustering again later.
Inactivate a Member
To inactivate a member from any unit, perform the following steps.
Note When an ASA becomes inactive, all data interfaces are shut down; only the management-only interface
can send and receive traffic. To resume traffic flow, re-enable clustering; or you can remove the unit
altogether from the cluster. The management interface remains up using the IP address the unit received
from the cluster IP pool. However if you reload, and the unit is still inactive in the cluster, the management
interface is disabled. You must use the console port for any further configuration.
Procedure
Example:
ciscoasa(config)# cluster remove unit ?
The bootstrap configuration remains intact, as well as the last configuration synched from the primary unit,
so that you can later re-add the unit without losing your configuration. If you enter this command on a secondary
unit to remove the primary unit, a new primary unit is elected.
To view member names, enter cluster remove unit ?, or enter the show cluster info command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
372
Configure Clustering on the FXOS Chassis
Caution The best method to change the primary unit is to disable clustering on the primary unit, waiting for a new
primary election, and then re-enabling clustering. If you must specify the exact unit you want to become
the primary, use the procedure in this section. Note, however, that for centralized features, if you force a
primary unit change using this procedure, then all connections are dropped, and you have to re-establish
the connections on the new primary unit.
Procedure
Example:
ciscoasa(config)# cluster master unit asa2
Procedure
Send a command to all members, or if you specify the unit name, a specific member:
cluster exec [unit unit_name] command
Example:
ciscoasa# cluster exec show xlate
To view member names, enter cluster exec unit ? (to see all names except the current unit), or enter the show
cluster info command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
373
Monitoring the ASA Cluster on the FXOS chassis
Examples
To copy the same capture file from all units in the cluster at the same time to a TFTP server, enter the following
command on the primary unit:
Multiple PCAP files, one from each unit, are copied to the TFTP server. The destination capture file name is
automatically attached with the unit name, such as capture1_asa1.pcap, capture1_asa2.pcap, and so on. In
this example, asa1 and asa2 are cluster unit names.
The following sample output for the cluster exec show memory command shows memory information for
each member in the cluster:
unit-1-3:*************************************************************
Free memory: 108749922170 bytes (92%)
Used memory: 9371097334 bytes ( 8%)
------------- ------------------
Total memory: 118111600640 bytes (100%)
unit-1-2:*************************************************************
Free memory: 108426753537 bytes (92%)
Used memory: 9697869087 bytes ( 8%)
------------- ------------------
Total memory: 118111600640 bytes (100%)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
374
Monitoring the ASA Cluster on the FXOS chassis
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
375
Monitoring the ASA Cluster on the FXOS chassis
for a connection is flowing through the cluster, and can help you understand how a load balancer might
affect the performance of a flow.
The following is sample output for the show conn detail command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
376
Monitoring the ASA Cluster on the FXOS chassis
(hitcnt=1, 0, 0, 0, 1) 0x7b521307
access-list 101 line 4 extended permit tcp host 192.168.1.116 host 192.168.43.238
(hitcnt=0, 0, 0, 0, 0) 0x5795c069
access-list 101 line 5 extended permit tcp host 192.168.1.177 host 192.168.43.238
(hitcnt=1, 0, 0, 1, 0) 0x51bde7ee
access list 101 line 6 extended permit tcp host 192.168.1.177 host 192.168.43.13
(hitcnt=0, 0, 0, 0, 0) 0x1e68697c
access-list 101 line 7 extended permit tcp host 192.168.1.177 host 192.168.43.132
(hitcnt=2, 0, 0, 1, 1) 0xc1ce5c49
access-list 101 line 8 extended permit tcp host 192.168.1.177 host 192.168.43.192
(hitcnt=3, 0, 1, 1, 1) 0xb6f59512
access-list 101 line 9 extended permit tcp host 192.168.1.177 host 192.168.43.44
(hitcnt=0, 0, 0, 0, 0) 0xdc104200
access-list 101 line 10 extended permit tcp host 192.168.1.112 host 192.168.43.44
(hitcnt=429, 109, 107, 109, 104)
0xce4f281d
access-list 101 line 11 extended permit tcp host 192.168.1.170 host 192.168.43.238
(hitcnt=3, 1, 0, 0, 2) 0x4143a818
access-list 101 line 12 extended permit tcp host 192.168.1.170 host 192.168.43.169
(hitcnt=2, 0, 1, 0, 1) 0xb18dfea4
access-list 101 line 13 extended permit tcp host 192.168.1.170 host 192.168.43.229
(hitcnt=1, 1, 0, 0, 0) 0x21557d71
access-list 101 line 14 extended permit tcp host 192.168.1.170 host 192.168.43.106
(hitcnt=0, 0, 0, 0, 0) 0x7316e016
access-list 101 line 15 extended permit tcp host 192.168.1.170 host 192.168.43.196
(hitcnt=0, 0, 0, 0, 0) 0x013fd5b8
access-list 101 line 16 extended permit tcp host 192.168.1.170 host 192.168.43.75
(hitcnt=0, 0, 0, 0, 0) 0x2c7dba0d
To display the aggregated count of in-use connections for all units, enter:
unit-1-1(LOCAL):******************************************************
40 in use, 48 most used, fwd connection 0 in use, 0 most used, dir connection 0 in use,
0 most used, centralized connection 0 in use, 46 most used
unit-2-2:*************************************************************
18 in use, 40 most used, fwd connection 0 in use, 0 most used, dir connection 0 in use,
0 most used, centralized connection 0 in use, 45 most used
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
377
Monitoring the ASA Cluster on the FXOS chassis
Debugging Clustering
See the following commands for debugging clustering:
• debug cluster [ccp | datapath | fsm | general | hc | license | rpc | service-module | transport]
Shows debug messages for clustering.
• debug service-module
Shows debug messages for blade level issues including health check issues between the supervisor and
the application.
• show cluster info trace
The show cluster info trace command shows the debug information for further troubleshooting.
See the following output for the show cluster info trace command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
378
History for ASA Clustering on the FXOS Chassis
Site-specific MAC 9.5(2) You can now use inter-site clustering for Spanned EtherChannels in routed mode. To avoid
addresses for inter-site MAC address flapping, configure a site ID for each cluster member so that a site-specific MAC
clustering support for address for each interface can be shared among a site’s units.
Spanned EtherChannel
We introduced or modified the following commands: site-id, mac-address site-id, show
in Routed firewall mode
cluster info, show interface
ASA cluster 9.5(2) You can now customize the auto-rejoin behavior when an interface or the cluster control link
customization of the fails.
auto-rejoin behavior We introduced the following command: health-check auto-rejoin
when an interface or the
cluster control link fails
The ASA cluster 9.5(2) The ASA cluster now supports GTPv1 and GTPv2 inspection.
supports GTPv1 and We did not modify any commands.
GTPv2
Cluster replication delay 9.5(2) This feature helps eliminate the “unnecessary work” related to short-lived flows by delaying
for TCP connections the director/backup flow creation.
We introduced the following command: cluster replication delay
LISP Inspection for 9.5(2) Cisco Locator/ID Separation Protocol (LISP) architecture separates the device identity from
Inter-Site Flow Mobility its location into two different numbering spaces, making server migration transparent to clients.
The ASA can inspect LISP traffic for location changes and then use this information for
seamless clustering operation; the ASA cluster members inspect LISP traffic passing between
the first hop router and the egress tunnel router (ETR) or ingress tunnel router (ITR), and then
change the flow owner to be at the new site.
We introduced or modified the following commands: allowed-eid, clear cluster info
flow-mobility counters, clear lisp eid, cluster flow-mobility lisp, debug cluster
flow-mobility, debug lisp eid-notify-intercept, flow-mobility lisp, inspect lisp, policy-map
type inspect lisp, site-id, show asp table classify domain inspect-lisp, show cluster info
flow-mobility counters, show conn, show lisp eid, show service-policy, validate-key
Carrier Grade NAT 9.5(2) For carrier-grade or large-scale PAT, you can allocate a block of ports for each host, rather
enhancements now than have NAT allocate one port translation at a time (see RFC 6888). This feature is now
supported in failover and supported in failover and ASA cluster deployments.
ASA clustering We modified the following command: show local-host
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
379
History for ASA Clustering on the FXOS Chassis
Inter-chassis clustering 9.5(2.1) With FXOS 1.1.3, you can now enable inter-chassis, and by extension inter-site clustering.
for 6 modules, and You can include up to 6 modules in up to 6 chassis.
inter-site clustering for We did not modify any commands.
the Firepower 9300 ASA
application
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
380
PART III
Interfaces
• Basic Interface Configuration, page 383
• EtherChannel and Redundant Interfaces, page 395
• VLAN Interfaces, page 409
• VXLAN Interfaces, page 415
• Routed and Transparent Mode Interfaces, page 431
• Advanced Interface Configuration, page 449
• Traffic Zones, page 457
CHAPTER 10
Basic Interface Configuration
This chapter includes basic interface configuration including Ethernet settings and Jumbo frame configuration.
Note For multiple context mode, complete all tasks in this section in the system execution space. To change
from the context to the system execution space, enter the changeto system command.
Note For the ASA Services Module interfaces, see the ASA Services Module quick start guide.
For the ASA on the FXOS chassis, you configure basic interface settings on the FXOS chassis supervisor.
See the quick start guide for your chassis for more information.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
383
About Basic Interface Configuration
Auto-MDI/MDIX Feature
For RJ-45 interfaces, the default auto-negotiation setting also includes the Auto-MDI/MDIX feature.
Auto-MDI/MDIX eliminates the need for crossover cabling by performing an internal crossover when a
straight cable is detected during the auto-negotiation phase. Either the speed or duplex must be set to
auto-negotiate to enable Auto-MDI/MDIX for the interface. If you explicitly set both the speed and duplex
to a fixed value, thus disabling auto-negotiation for both settings, then Auto-MDI/MDIX is also disabled. For
Gigabit Ethernet, when the speed and duplex are set to 1000 and full, then the interface always auto-negotiates;
therefore Auto-MDI/MDIX is always enabled and you cannot disable it.
Management Interface
The management interface, depending on your model, is a separate interface just for management traffic.
You may need to configure management access to the interface according to Management Access, on page
795.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
384
About Basic Interface Configuration
ASAv Yes No No No No No
Note If you installed a module, then the module management interface(s) provides management access for the
module only. For models with software modules, the software module uses the same physical Management
interface as the ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
385
Licensing for Basic Interface Configuration
Note In transparent firewall mode, the management interface updates the MAC address table in the same manner
as a data interface; therefore you should not connect both a management and a data interface to the same
switch unless you configure one of the switch ports as a routed port (by default Catalyst switches share a
MAC address for all VLAN switch ports). Otherwise, if traffic arrives on the management interface from
the physically-connected switch, then the ASA updates the MAC address table to use the management
interface to access the switch, instead of the data interface. This action causes a temporary traffic
interruption; the ASA will not re-update the MAC address table for packets from the switch to the data
interface for at least 30 seconds for security reasons.
Management Interface Characteristics on All Models Except for the ASA 5585-X
The Management interface has the following characteristics:
• No through traffic support
• No subinterface support
• No priority queue support
• No multicast MAC support
• The software module shares the Management interface. Separate MAC addresses and IP addresses are
supported for the ASA and module. You must perform configuration of the module IP address within
the module operating system. However, physical characteristics (such as enabling the interface) are
configured on the ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
386
Licensing for Basic Interface Configuration
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
387
Guidelines for Basic Interface Configuration
Note Interfaces of all types comprise the maximum number of combined interfaces; for example, VLANs,
VXLANs, physical, redundant, bridge group, and EtherChannel interfaces. Every interface command
defined in the configuration counts against this limit. For example, both of the following interfaces count
even if the GigabitEthernet 0/0 interface is defined as part of port-channel 1: interface gigabitethernet
0/0 and interface port-channel 1
Failover
You cannot share a failover or state interface with a data interface.
Additional Guidelines
Some management-related services are not available until a non-management interface is enabled, and the
the ASA achieves a “System Ready” state. The ASA generates the following syslog message when it is in a
“System Ready” state:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
388
Enable the Physical Interface and Configure Ethernet Parameters
• EtherChannel port-channel interfaces—Enabled. However, for traffic to pass through the EtherChannel,
the channel group physical interfaces must also be enabled.
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/0
The physical_interface ID includes the type, slot, and port number as type[slot/]port.
The physical interface types include the following:
• gigabitethernet
• tengigabitethernet
• management
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
389
Enable the Physical Interface and Configure Ethernet Parameters
Enter the type followed by slot/port, for example, gigabitethernet0/1. A space is optional between the type
and the slot/port.
Step 2 (Optional) Set the media type to SFP, if available for your model:
media-type sfp
To restore the default RJ-45, enter the media-type rj45 command.
Example:
ciscoasa(config-if)# speed 100
Example:
ciscoasa(config-if)# duplex full
The auto setting is the default. The duplex setting for an EtherChannel interface must be full or auto.
Step 5 (Optional) Enable pause (XOFF) frames for flow control on GigabitEthernet and TenGigabitEthernet interfaces:
flowcontrol send on [low_water high_water pause_time] [noconfirm]
Example:
ciscoasa(config-if)# flowcontrol send on 95 200 10000
If you have a traffic burst, dropped packets can occur if the burst exceeds the buffering capacity of the FIFO
buffer on the NIC and the receive ring buffers. Enabling pause frames for flow control can alleviate this issue.
Pause (XOFF) and XON frames are generated automatically by the NIC hardware based on the FIFO buffer
usage. A pause frame is sent when the buffer usage exceeds the high-water mark. The default high_water
value is 128 KB (10 GigabitEthernet) and 24 KB (1 GigabitEthernet); you can set it between 0 and 511 (10
GigabitEthernet) or 0 and 47 KB (1 GigabitEthernet). After a pause is sent, an XON frame can be sent when
the buffer usage is reduced below the low-water mark. By default, the low_water value is 64 KB (10
GigabitEthernet) and 16 KB (1 GigabitEthernet); you can set it between 0 and 511 (10 GigabitEthernet) or 0
and 47 KB (1 GigabitEthernet). The link partner can resume traffic after receiving an XON, or after the XOFF
expires, as controlled by the timer value in the pause frame. The default pause_time value is 26624; you can
set it between 0 and 65535. If the buffer usage is consistently above the high-water mark, pause frames are
sent repeatedly, controlled by the pause refresh threshold value.
When you use this command, you see the following warning:
Changing flow-control parameters will reset the interface. Packets may be lost during the
reset.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
390
Enable Jumbo Frame Support
To change the parameters without being prompted, use the noconfirm keyword.
Note Only flow control frames defined in 802.3x are supported. Priority-based flow control is not supported.
Example:
ciscoasa(config-if)# no shutdown
To disable the interface, enter the shutdown command. If you enter the shutdown command, you also shut
down all subinterfaces. If you shut down an interface in the system execution space, then that interface is shut
down in all contexts that share it.
Procedure
Examples
The following example enables jumbo frame reservation, saves the configuration, and reloads the ASA:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
391
Monitoring Interfaces
WARNING: this command will take effect after the running-config is saved
and the system has been rebooted. Command accepted.
Monitoring Interfaces
See the following commands:
• show interface
Displays interface statistics.
• show interface ip brief
Displays interface IP addresses and status.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
392
History for Basic Interface Configuration
Gigabit Ethernet Support for the ASA 5510 7.2(3) The ASA 5510 now supports GE (Gigabit Ethernet) for port 0
Security Plus License and 1 with the Security Plus license. If you upgrade the license
from Base to Security Plus, the capacity of the external
Ethernet0/0 and Ethernet0/1 ports increases from the original
FE (Fast Ethernet) (100 Mbps) to GE (1000 Mbps). The
interface names will remain Ethernet 0/0 and Ethernet 0/1. Use
the speed command to change the speed on the interface and
use the show interface command to see what speed is currently
configured for each interface.
Jumbo packet support for the ASA 5580 8.1(1) The Cisco ASA 5580 supports jumbo frames. A jumbo frame
is an Ethernet packet larger than the standard maximum of 1518
bytes (including Layer 2 header and FCS), up to 9216 bytes.
You can enable support for jumbo frames for all interfaces by
increasing the amount of memory to process Ethernet frames.
Assigning more memory for jumbo frames might limit the
maximum use of other features, such as ACLs.
This feature is also supported on the ASA 5585-X.
We introduced the following command: jumbo-frame
reservation.
Support for Pause Frames for Flow Control on the 8.2(2) You can now enable pause (XOFF) frames for flow control.
ASA 5580 Ten Gigabit Ethernet Interfaces This feature is also supported on the ASA 5585-X.
We introduced the following command: flowcontrol.
Support for Pause Frames for Flow Control on 8.2(5)/8.4(2) You can now enable pause (XOFF) frames for flow control for
Gigabit Ethernet Interfaces Gigabit Ethernet interfaces on all models.
We modified the following command: flowcontrol.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
393
History for Basic Interface Configuration
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
394
CHAPTER 11
EtherChannel and Redundant Interfaces
This chapter tells how to configure EtherChannels and redundant interfaces.
Note For multiple context mode, complete all tasks in this section in the system execution space. To change
from the context to the system execution space, enter the changeto system command.
For ASA cluster interfaces, which have special requirements, see ASA Cluster, on page 247.
Note For the Firepower 9300 ASA security module, EtherChannel interfaces are configured on the Firepower
9300 supervisor. Redundant interafces are not supported. See the Firepower 9300 configuration guide.
Redundant Interfaces
A logical redundant interface consists of a pair of physical interfaces: an active and a standby interface. When
the active interface fails, the standby interface becomes active and starts passing traffic. You can configure a
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
395
About EtherChannels and Redundant Interfaces
redundant interface to increase the ASA reliability. This feature is separate from device-level failover, but
you can configure redundant interfaces as well as device-level failover if desired.
You can configure up to 8 redundant interface pairs.
Related Topics
Configure the MTU and TCP MSS, on page 454
Configure Multiple Contexts, on page 166
EtherChannels
An 802.3ad EtherChannel is a logical interface (called a port-channel interface) consisting of a bundle of
individual Ethernet links (a channel group) so that you increase the bandwidth for a single network. A port
channel interface is used in the same way as a physical interface when you configure interface-related features.
You can configure up to 48 EtherChannels.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
396
About EtherChannels and Redundant Interfaces
interfaces are members of the same EtherChannel port-channel interface, because the separate switches act
like a single switch.
If you use the ASA in an Active/Standby failover deployment, then you need to create separate EtherChannels
on the switches in the VSS/vPC, one for each ASA. On each ASA, a single EtherChannel connects to both
switches. Even if you could group all switch interfaces into a single EtherChannel connecting to both ASA
(in this case, the EtherChannel will not be established because of the separate ASA system IDs), a single
EtherChannel would not be desirable because you do not want traffic sent to the standby ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
397
About EtherChannels and Redundant Interfaces
• Passive—Receives LACP updates. A passive EtherChannel can only establish connectivity with an
active EtherChannel.
• On—The EtherChannel is always on, and LACP is not used. An “on” EtherChannel can only establish
a connection with another “on” EtherChannel.
LACP coordinates the automatic addition and deletion of links to the EtherChannel without user intervention.
It also handles misconfigurations and checks that both ends of member interfaces are connected to the correct
channel group. “On” mode cannot use standby interfaces in the channel group when an interface goes down,
and the connectivity and configurations are not checked.
Load Balancing
The ASA distributes packets to the interfaces in the EtherChannel by hashing the source and destination IP
address of the packet (this criteria is configurable). The resulting hash is divided by the number of active links
in a modulo operation where the resulting remainder determines which interface owns the flow. All packets
with a hash_value mod active_links result of 0 go to the first interface in the EtherChannel, packets with a
result of 1 go to the second interface, packets with a result of 2 go to the third interface, and so on. For example,
if you have 15 active links, then the modulo operation provides values from 0 to 14. For 6 active links, the
values are 0 to 5, and so on.
For a spanned EtherChannel in clustering, load balancing occurs on a per ASA basis. For example, if you
have 32 active interfaces in the spanned EtherChannel across 8 ASAs, with 4 interfaces per ASA in the
EtherChannel, then load balancing only occurs across the 4 interfaces on the ASA.
If an active interface goes down and is not replaced by a standby interface, then traffic is rebalanced between
the remaining links. The failure is masked from both Spanning Tree at Layer 2 and the routing table at Layer
3, so the switchover is transparent to other network devices.
Related Topics
Customize the EtherChannel, on page 405
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
398
Guidelines for EtherChannels and Redundant Interfaces
Model Support
• EtherChannels are supported on ASA appliances only; they are not supported on the ASAv or the
ASASM.
• For the Firepower 9300, you configure EtherChannels in the Firepower Chassis Manager, not in the
module OS.
• Redundant interfaces are not supported on the Firepower 9300 and ASASM.
Clustering
• When you use a redundant or EtherChannel interface as the cluster control link, it must be pre-configured
on all units in the cluster; you cannot configure it on the primary unit and expect it to replicate to member
units because the cluster control link itself is required for replication.
• To configure a spanned EtherChannel or an individual cluster interface, see the clustering chapter.
Redundant Interfaces
• You can configure up to 8 redundant interface pairs.
• All ASA configuration refers to the logical redundant interface instead of the member physical interfaces.
• You cannot use a redundant interface as part of an EtherChannel, nor can you use an EtherChannel as
part of a redundant interface. You cannot use the same physical interfaces in a redundant interface and
an EtherChannel interface. You can, however, configure both types on the ASA if they do not use the
same physical interfaces.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
399
Default Settings for EtherChannels and Redundant Interfaces
• If you shut down the active interface, then the standby interface becomes active.
• Redundant interfaces do not support Management slot/port interfaces as members. You can, however,
set a redundant interface comprised of non-Management interfaces as management-only.
EtherChannels
• EtherChannels are not supported on the ASAv.
• You can configure up to 48 EtherChannels.
• Each channel group can have up to 16 active interfaces. For switches that support only 8 active interfaces,
you can assign up to 16 interfaces to a channel group: while only eight interfaces can be active, the
remaining interfaces can act as standby links in case of interface failure.
• All interfaces in the channel group must be the same type and speed. The first interface added to the
channel group determines the correct type and speed.
• The device to which you connect the ASA EtherChannel must also support 802.3ad EtherChannels; for
example, you can connect to the Catalyst 6500 switch or Cisco Nexus 7000 switch.
• The ASA does not support LACPDUs that are VLAN-tagged. If you enable native VLAN tagging on
the neighboring switch using the Cisco IOS vlan dot1Q tag native command, then the ASA will drop
the tagged LACPDUs. Be sure to disable native VLAN tagging on the neighboring switch. In multiple
context mode, these messages are not included in a packet capture, so that you cannot diagnose the issue
easily.
• In Catalyst 3750-X Cisco IOS software versions earlier than 15.1(1)S2, the ASA did not support
connecting an EtherChannel to a switch stack. With default switch settings, if the ASA EtherChannel
is connected cross stack, and if the master switch is powered down, then the EtherChannel connected
to the remaining switch will not come up. To improve compatibility, set the stack-mac persistent timer
command to a large enough value to account for reload time; for example, 8 minutes or 0 for indefinite.
Or, you can upgrade to more a more stable switch software version, such as 15.1(1)S2.
• All ASA configuration refers to the logical EtherChannel interface instead of the member physical
interfaces.
• You cannot use a redundant interface as part of an EtherChannel, nor can you use an EtherChannel as
part of a redundant interface. You cannot use the same physical interfaces in a redundant interface and
an EtherChannel interface. You can, however, configure both types on the ASA if they do not use the
same physical interfaces.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
400
Configure a Redundant Interface
In single mode or in the system execution space, interfaces have the following default states:
• Physical interfaces—Disabled.
• Redundant Interfaces—Enabled. However, for traffic to pass through the redundant interface, the member
physical interfaces must also be enabled.
• EtherChannel port-channel interfaces—Enabled. However, for traffic to pass through the EtherChannel,
the channel group physical interfaces must also be enabled.
Caution If you are using a physical interface already in your configuration, removing the name will clear any
configuration that refers to the interface.
Procedure
Example:
ciscoasa(config)# interface redundant 1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
401
Configure a Redundant Interface
Example:
ciscoasa(config-if)# member-interface gigabitethernet 0/0
Example:
ciscoasa(config-if)# member-interface gigabitethernet 0/1
Make sure the second interface is the same physical type as the first interface.
To remove a member interface, enter the no member-interface physical_interface command. You cannot
remove both member interfaces from the redundant interface; the redundant interface requires at least one
member interface.
Examples
The following example creates two redundant interfaces:
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
402
Configure an EtherChannel
Example:
Configure an EtherChannel
This section describes how to create an EtherChannel port-channel interface, assign interfaces to the
EtherChannel, and customize the EtherChannel.
Caution If you are using a physical interface already in your configuration, removing the name will clear any
configuration that refers to the interface.
Procedure
Step 1 Specify the interface you want to add to the channel group:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
403
Configure an EtherChannel
interface physical_interface
Example:
ciscoasa(config)# interface gigabitethernet 0/0
The physical_interface ID includes the type, slot, and port number as type[slot/]port. This first interface in
the channel group determines the type and speed for all other interfaces in the group.
In transparent mode, if you create a channel group with multiple Management interfaces, then you can use
this EtherChannel as the management-only interface.
Example:
ciscoasa(config-if)# channel-group 1 mode active
The channel_id is an integer between 1 and 48. If the port-channel interface for this channel ID does not yet
exist in the configuration, one will be added:
interface port-channel channel_id
We recommend using active mode.
Step 3 (Optional) Set the priority for a physical interface in the channel group:
lacp port-priority number
Example:
ciscoasa(config-if)# lacp port-priority 12345
The priority number is an integer between 1 and 65535. The default is 32768. The higher the number, the
lower the priority. The ASA uses this setting to decide which interfaces are active and which are standby if
you assign more interfaces than can be used. If the port priority setting is the same for all interfaces, then the
priority is determined by the interface ID (slot/port). The lowest interface ID is the highest priority. For
example, GigabitEthernet 0/0 is a higher priority than GigabitEthernet 0/1.
If you want to prioritize an interface to be active even though it has a higher interface ID, then set this command
to have a lower value. For example, to make GigabitEthernet 1/3 active before GigabitEthernet 0/7, then make
the lacp port-priority value be 12345 on the 1/3 interface vs. the default 32768 on the 0/7 interface.
If the device at the other end of the EtherChannel has conflicting port priorities, the system priority is used
to determine which port priorities to use. See the lacp system-priority command.
Step 4 Repeat Steps 1 through 3 for each interface you want to add to the channel group.
Each interface in the channel group must be the same type and speed. Half duplex is not supported. If you
add an interface that does not match, it will be placed in a suspended state.
Related Topics
Link Aggregation Control Protocol, on page 397
Customize the EtherChannel, on page 405
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
404
Configure an EtherChannel
Procedure
Example:
ciscoasa(config)# interface port-channel 1
This interface was created automatically when you added an interface to the channel group. If you have not
yet added an interface, then this command creates the port-channel interface.
You need to add at least one member interface to the port-channel interface before you can configure logical
parameters for it such as a name.
Step 2 Specify the maximum number of active interfaces allowed in the channel group:
lacp max-bundle number
Example:
ciscoasa(config-if)# lacp max-bundle 6
The number is between 1 and 16. The default is 16. If your switch does not support 16 active interfaces, be
sure to set this command to 8 or fewer.
Step 3 Specify the minimum number of active interfaces required for the port-channel interface to become active:
port-channel min-bundle number
Example:
ciscoasa(config-if)# port-channel min-bundle 2
The number is between 1 and 16. The default is 1. If the active interfaces in the channel group falls below
this value, then the port-channel interface goes down, and could trigger a device-level failover.
Example:
ciscoasa(config-if)# port-channel load-balance src-dst-mac
By default, the ASA balances the packet load on interfaces according to the source and destination IP address
(src-dst-ip) of the packet. If you want to change the properties on which the packet is categorized, use this
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
405
Monitoring EtherChannel and Redundant Interfaces
command. For example, if your traffic is biased heavily towards the same source and destination IP addresses,
then the traffic assignment to interfaces in the EtherChannel will be unbalanced. Changing to a different
algorithm can result in more evenly distributed traffic.
Example:
ciscoasa(config)# lacp system-priority 12345
The number is between 1 and 65535. The default is 32768. The higher the number, the lower the priority.
This command is global for the ASA.
If the device at the other end of the EtherChannel has conflicting port priorities, the system priority is used
to determine which port priorities to use. For interface priorities within an EtherChannel, see the lacp
port-priority command.
Step 6 (Optional) Set the Ethernet properties for the port-channel interface to override the properties set on the
individual interfaces.
See Enable the Physical Interface and Configure Ethernet Parameters, on page 389 for Ethernet commands.
This method provides a shortcut to set these parameters because these parameters must match for all interfaces
in the channel group.
Related Topics
Load Balancing, on page 398
Add Interfaces to the EtherChannel, on page 403
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
406
Examples for EtherChannel and Redundant Interfaces
For EtherChannel, displays port-channel load-balance information along with the hash result and member
interface selected for a given set of parameters.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
407
History for EtherChannels and Redundant Interfaces
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
408
CHAPTER 12
VLAN Interfaces
This chapter tells how to configure VLAN subinterfaces.
Note For multiple context mode, complete all tasks in this section in the system execution space. To change
from the context to the system execution space, enter the changeto system command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
409
Licensing for VLAN Interfaces
Note For an interface to count against the VLAN limit, you must assign a VLAN to it. For example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
410
Guidelines for VLAN Interfaces
Additional Guidelines
• Preventing untagged packets on the physical interface—If you use subinterfaces, you typically do not
also want the physical interface to pass traffic, because the physical interface passes untagged packets.
This property is also true for the active physical interface in a redundant interface pair and for
EtherChannel links. Because the physical, redundant, or EtherChannel interface must be enabled for the
subinterface to pass traffic, ensure that the physical, redundant, or EtherChannel interface does not pass
traffic by leaving out the nameif command. If you want to let the physical, redundant, or EtherChannel
interface pass untagged packets, you can configure the nameif command as usual.
• (All models except for the ASA 5585-X) You cannot configure subinterfaces on the Management
interface.
• The ASA does not support the Dynamic Trunking Protocol (DTP), so you must configure the connected
switch port to trunk unconditionally.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
411
Configure VLAN Subinterfaces and 802.1Q Trunking
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/1.100
The redundant number argument is the redundant interface ID, such as redundant 1.
The port-channel number argument is the EtherChannel interface ID, such as port-channel 1.
The subinterface ID is an integer between 1 and 4294967293.
Example:
ciscoasa(config-subif)# vlan 101 secondary 52 64,66-74
The vlan_id is an integer between 1 and 4094. Some VLAN IDs might be reserved on connected switches,
so check the switch documentation for more information.
The secondary VLANs can be separated by spaces, commas, and dashes (for a contiguous range). When the
ASA receives traffic on the secondary VLANs, it maps the traffic to the primary VLAN.
You cannot assign the same VLAN to multiple subinterfaces. You cannot assign a VLAN to the physical
interface. Each subinterface must have a VLAN ID before it can pass traffic. To change a VLAN ID, you do
not need to remove the old VLAN ID with the no option; you can enter the vlan command with a different
VLAN ID, and the ASA changes the old ID. To remove some secondary VLANs from the list, you can use
the no command and only list the VLANs to remove. You can only selectively remove listed VLANs; you
cannot remove a single VLAN in a range, for example.
Examples
The following example maps a set of secondary VLANs to VLAN 200:
The following example removes secondary VLAN 503 from the list:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
412
Monitoring VLAN Interfaces
Related Topics
Licensing for VLAN Interfaces, on page 410
The following example shows how VLAN mapping works with the Catalyst 6500. Consult the Catalyst 6500
configuration guide on how to connect nodes to PVLANS.
ASA Configuration
interface GigabitEthernet1/1
description Connected to Switch GigabitEthernet1/5
no nameif
no security-level
no ip address
no shutdown
!
interface GigabitEthernet1/1.70
vlan 70 secondary 71 72
nameif vlan_map1
security-level 50
ip address 10.11.1.2 255.255.255.0
no shutdown
!
interface GigabitEthernet1/2
nameif outside
security-level 0
ip address 172.16.171.31 255.255.255.0
no shutdown
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
413
History for VLAN Interfaces
vlan 70
private-vlan primary
private-vlan association 71-72
!
vlan 71
private-vlan community
!
vlan 72
private-vlan isolated
!
interface GigabitEthernet1/5
description Connected to ASA GigabitEthernet1/1
switchport
switchport trunk encapsulation dot1q
switchport trunk allowed vlan 70-72
switchport mode trunk
!
Increased VLANs 7.2(2) VLAN limits were increased for the ASA 5510 (from 10 to 50
for the Base license, and from 25 to 100 for the Security Plus
license), the ASA 5520 (from 100 to 150), the ASA 5550 (from
200 to 250).
Increased VLANs for the ASA 5580 8.1(2) The number of VLANs supported on the ASA 5580 are
increased from 100 to 250.
Support to map a Secondary VLANs to a Primary 9.5(2) You can now configure one or more secondary VLANs for a
VLAN subinterface. When the ASA receives traffic on the secondary
VLANs, it maps it to the primary VLAN.
We introduced or modified the following commands: vlan
secondary, show vlan mapping
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
414
CHAPTER 13
VXLAN Interfaces
This chapter tells how to configure Virtual eXtensible LAN (VXLAN) interfaces. VXLANs act as Layer 2
virtual networks over Layer 3 physical networks to stretch Layer 2 networks.
This section describes how VXLAN works. For detailed information, see RFC 7348.
VXLAN Encapsulation
VXLAN is a Layer 2 overlay scheme on a Layer 3 network. It uses MAC Address-in-User Datagram Protocol
(MAC-in-UDP) encapsulation. The original Layer 2 frame has a VXLAN header added and is then placed in
a UDP-IP packet.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
415
About VXLAN Interfaces
The underlying IP network between VTEPs is independent of the VXLAN overlay. Encapsulated packets are
routed based on the outer IP address header, which has the initiating VTEP as the source IP address and the
terminating VTEP as the destination IP address. The destination IP address can be a multicast group when
the remote VTEP is not known. The destination port is UDP port 4789 by default (user configurable).
VNI Interfaces
VNI interfaces are similar to VLAN interfaces: they are virtual interfaces that keep network traffic separated
on a given physical interface by using tagging. You apply your security policy directly to each VNI interface.
All VNI interfaces are associated with the same VTEP interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
416
About VXLAN Interfaces
Peer VTEPs
When the ASA sends a packet to a device behind a peer VTEP, the ASA needs two important pieces of
information:
• The destination MAC address of the remote device
• The destination IP address of the peer VTEP
There are two ways in which the ASA can find this information:
• A single peer VTEP IP address can be statically configured on the ASA.
You cannot manually define multiple peers.
The ASA then sends a VXLAN-encapsulated ARP broadcast to the VTEP to learn the end node MAC
address.
• A multicast group can be configured on each VNI interface (or on the VTEP as a whole).
The ASA sends a VXLAN-encapsulated ARP broadcast packet within an IP multicast packet through
the VTEP source interface. The response to this ARP request enables the ASA to learn both the remote
VTEP IP address along with the destination MAC address of the remote end node.
The ASA maintains a mapping of destination MAC addresses to remote VTEP IP addresses for the VNI
interfaces.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
417
About VXLAN Interfaces
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
418
About VXLAN Interfaces
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
419
Guidelines for VXLAN Interfaces
Note The ASA must use dynamic VTEP peer discovery because it has multiple VTEP peers in this scenario.
5 The ASA encapsulates the packets again with the VXLAN tag for VNI 2 and sends the packets to Virtual
Server 1. Before encapsulation, the ASA changes the inner frame destination MAC address to be the MAC
of VM1 (multicast-encapsulated ARP might be needed for the ASA to learn the VM1 MAC address).
6 When Virtual Server 1 receives the VXLAN packets, it decapsulates the packets and delivers the inner
frames to VM1.
Clustering
ASA clustering does not support VXLAN in Individual Interface mode. Only Spanned EtherChannel mode
supports VXLAN.
Routing
• Only static routing or Policy Based Routing is supported on the VNI interface; dynamic routing protocols
are not supported.
MTU
If the source interface MTU is less than 1554 bytes, then the ASA automatically raises the MTU to 1554
bytes. In this case, the entire Ethernet datagram is being encapsulated, so the new packet is larger and requires
a larger MTU. If the MTU used by other devices is larger, then you should set the source interface MTU to
be the network MTU + 54 bytes. This MTU requires you to enable jumbo frame reservation; see Enable Jumbo
Frame Support, on page 391.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
420
Default Settings for VXLAN Interfaces
Procedure
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 1/1
ciscoasa(config-if)# nve-only
This setting lets you configure an IP address for the interface. This command is optional for routed mode
where this setting restricts traffic to VXLAN and common management traffic only on this interface.
Example:
(Routed Mode)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
421
Configure VXLAN Interfaces
Example:
(Transparent Mode)
Example:
ciscoasa(cfg-nve)# source-interface outside
Note If the source interface MTU is less than 1554 bytes, then the ASA automatically raises the MTU to
1554 bytes.
Step 5 (Multiple context mode; Optional for single mode) Manually specify the peer VTEP IP address:
peer ip ip_address
Example:
ciscoasa(cfg-nve)# peer ip 10.1.1.2
If you specify the peer IP address, you cannot use multicast group discovery. Multicast is not supported in
multiple context mode, so manual configuration is the only option. You can only specify one peer for the
VTEP.
Step 6 (Optional; single mode only) Specify a default multicast group for all associated VNI interfaces:
default-mcast-group mcast_ip
Example:
ciscoasa(cfg-nve)# default-mcast-group 236.0.0.100
If you do not configure the multicast group per VNI interface, then this group is used. If you configure a group
at the VNI interface level, then that group overrides this setting.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
422
Configure VXLAN Interfaces
Procedure
Example:
ciscoasa(config)# interface vni 1
Set the ID between 1 and 10000. This ID is only an internal interface identifier.
Example:
ciscoasa(config-if)# segment-id 1000
Set the ID between 1 and 16777215. The segment ID is used for VXLAN tagging.
Step 3 (Transparent mode) Specify the bridge group to which you want to associate this interface:
bridge-group number
Example:
ciscoasa(config-if)# bridge-group 1
See Configure Transparent Mode Interfaces, on page 439 to configure the BVI interface and associate regular
interfaces to this bridge group.
Example:
ciscoasa(config-if)# nameif vxlan1000
The name is a text string up to 48 characters, and is not case-sensitive. You can change the name by reentering
this command with a new value. Do not enter the no form, because that command causes all commands that
refer to that name to be deleted.
Example:
ciscoasa(config-if)# ip address 10.1.1.1 255.255.255.0 standby 10.1.1.2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
423
Monitoring VXLAN Interfaces
Example:
ciscoasa(config-if)# security-level 50
Example:
ciscoasa(config-if)# mcast-group 236.0.0.100
If you do not set the multicast group for the VNI interface, the default group from the VTEP source interface
configuration is used, if available. If you manually set a VTEP peer IP for the VTEP source interface, you
cannot specify a multicast group for the VNI interface. Multicast is not supported in multiple context mode.
Procedure
Example:
ciscoasa(config)# vxlan port 5678
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
424
Monitoring VXLAN Interfaces
and peer VTEP IP addresses associated with this NVE interface. With the summary option, this command
only shows the status of the NVE interface, number of VNIs behind the NVE interface, and number of
VTEPs discovered.
See the following output for the show nve 1 command:
See the following output for the show nve 1 summary command:
See the following output for the show interface vni 1 summary command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
425
Examples for VXLAN Interfaces
VTEP-NVE 1
Segment-id 5001
Tag-switching: disabled
MTU: 1500
MAC: aaaa.bbbb.1234
IP address 192.168.0.1, subnet mask 255.255.255.0
Multicast group not configured
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
426
Examples for VXLAN Interfaces
ASA Configuration
firewall transparent
vxlan port 8427
!
interface gigabitethernet0/0
nve-only
nameif outside
ip address 192.168.1.30 255.255.255.0
no shutdown
!
nve 1
encapsulation vxlan
source-interface outside
!
interface vni1
segment-id 6000
nameif vxlan6000
security-level 0
bridge-group 1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
427
Examples for VXLAN Interfaces
vtep-nve 1
mcast-group 235.0.0.100
!
interface vni2
segment-id 8000
nameif vxlan8000
security-level 0
bridge-group 2
vtep-nve 1
mcast-group 236.0.0.100
!
interface vni3
segment-id 10000
nameif vxlan10000
security-level 0
bridge-group 3
vtep-nve 1
mcast-group 236.0.0.100
!
interface gigabitethernet0/1.100
nameif insidevm100
security-level 100
bridge-group 1
!
interface gigabitethernet0/1.200
nameif insidevm200
security-level 100
bridge-group 2
!
interface gigabitethernet0/2
nameif insidepc
security-level 100
bridge-group 3
!
interface bvi 1
ip address 10.10.10.1 255.255.255.0
!
interface bvi 2
ip address 10.20.20.1 255.255.255.0
!
interface bvi 3
ip address 10.30.30.1 255.255.255.0
Notes
• For VNI interfaces vni1 and vni2, the inner VLAN tag is removed during encapsulation.
• VNI interfaces vni2 and vni3 share the same multicast IP address for encapsulated ARP over multicast.
This sharing is allowed.
• The ASA bridges the VXLAN traffic to non-VXLAN-supported interfaces based on the above BVIs
and bridge group configurations. For each of the stretched Layer 2 network segments (10.10.10.0/24,
10.20.20.0/24 and 10.30.30.0/24), the ASA serves as a bridge.
• It is allowed to have more than one VNI or more than one regular interface (VLAN or just physical
interface) in a bridge group. The forwarding or association between VXLAN segment ID to the VLAN
ID (or a physical interface) is decided by the destination MAC address and which interface connects to
the destination.
• The VTEP source-interface is a Layer 3 interface in transparent firewall mode indicated by nve-only in
the interface configuration. The VTEP source interface is not a BVI interface or a management interface,
but it has an IP address and uses the routing table.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
428
Examples for VXLAN Interfaces
ASA Configuration
interface gigabitethernet0/0
nameif outside
ip address 192.168.1.30 255.255.255.0
no shutdown
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
429
History for VXLAN Interfaces
!
nve 1
encapsulation vxlan
source-interface outside
default-mcast-group 235.0.0.100
!
interface vni1
segment-id 6000
nameif vxlan6000
security-level 0
vtep-nve 1
ip address 10.20.20.1 255.255.255.0
!
interface vni2
segment-id 8000
nameif vxlan8000
security-level 0
vtep-nve 1
ip address 10.10.10.1 255.255.255.0
!
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
430
CHAPTER 14
Routed and Transparent Mode Interfaces
This chapter includes tasks to complete the interface configuration for all models in routed or transparent
firewall mode.
Note For multiple context mode, complete the tasks in this section in the context execution space. Enter the
changeto context name command to change to the context you want to configure.
Security Levels
Each interface must have a security level from 0 (lowest) to 100 (highest). For example, you should assign
your most secure network, such as the inside host network, to level 100. While the outside network connected
to the Internet can be level 0. Other networks, such as DMZs can be in between. You can assign interfaces to
the same security level.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
431
About Routed and Transparent Mode Interfaces
• Filtering—HTTP(S) and FTP filtering applies only for outbound connections (from a higher level to a
lower level).
If you enable communication for same security interfaces, you can filter traffic in either direction.
• established command—This command allows return connections from a lower security host to a higher
security host if there is already an established connection from the higher level host to the lower level
host.
If you enable communication for same security interfaces, you can configure established commands
for both directions.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
432
About Routed and Transparent Mode Interfaces
IPv6
This section includes information about how to configure IPv6.
IPv6 Addressing
You can configure two types of unicast addresses for IPv6:
• Global—The global address is a public address that you can use on the public network. For transparent
mode, this address needs to be configured for each bridge group, and not per-interface. You can also
configure a global IPv6 address for the management interface.
• Link-local—The link-local address is a private address that you can only use on the directly-connected
network. Routers do not forward packets using link-local addresses; they are only for communication
on a particular physical network segment. They can be used for address configuration or for the ND
functions such as address resolution and neighbor discovery. In transparent mode, because the link-local
address is only available on a segment, and is tied to the interface MAC address, you need to configure
the link-local address per interface.
At a minimum, you need to configure a link-local address for IPv6 to operate. If you configure a global address,
a link-local address is automatically configured on the interface, so you do not also need to specifically
configure a link-local address. If you do not configure a global address, then you need to configure the link-local
address, either automatically or manually.
Note If you want to only configure the link-local addresses, see the ipv6 enable (to auto-configure) or ipv6
address link-local (to manually configure) command in the command reference.
The address format verification is only performed when a flow is created. Packets from an existing flow are
not checked. Additionally, the address verification can only be performed for hosts on the local link. Packets
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
433
Guidelines for Routed and Transparent Mode Interfaces
received from hosts behind a router will fail the address format verification, and be dropped, because their
source MAC address will be the router MAC address and not the host MAC address.
Failover
Do not configure failover interfaces with the procedures in this chapter. See Failover for High Availability,
on page 195 to configure the failover and state links.
IPv6
IPv6 is supported on all interfaces.
The ASA does not support IPv6 anycast addresses.
Model Support
PPPoE and DHCP are not supported on the ASASM.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
434
Defaults for Routed and Transparent Mode Interfaces
If you add an interface for a VLAN that is not yet assigned to the ASA by the switch, the interface will be in
the down state. When you assign the VLAN to the ASA, the interface changes to an up state. See the show
interface command for more information about interface states.
Note If you change the security level of an interface, and you do not want to wait for existing connections to
time out before the new security information is used, you can clear the connections using the clear local-host
command.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
435
Configure Routed Mode Interfaces
Procedure
Example:
ciscoasa(config)# interface gigabithethernet 0/0
Example:
ciscoasa(config-if)# nameif inside
The name is a text string up to 48 characters, and is not case-sensitive. You can change the name by reentering
this command with a new value. Do not enter the no form, because that command causes all commands that
refer to that name to be deleted.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
436
Configure Routed Mode Interfaces
Example:
Note If you use failover, you must set the IP address and standby address manually; DHCP and
PPPoE are not supported.
The standby ip_address argument is used for failover.
The ip_address and mask arguments set the interface IP address and subnet mask.
• Obtain an IP address from a DHCP server:
ip address dhcp [setroute]
Example:
The setroute keyword lets the ASA use the default route supplied by the DHCP server.
Reenter this command to reset the DHCP lease and request a new lease.
If you do not enable the interface using the no shutdown command before you enter the ip address dhcp
command, some DHCP requests might not be sent.
• Obtain an IP address from a PPPoE server:
ip address pppoe [setroute]
Example:
The setroute option sets the default routes when the PPPoE client has not yet established a connection.
When using the setroute option, you cannot have a statically defined route in the configuration.
Note If PPPoE is enabled on two interfaces (such as a primary and backup interface), and you do not
configure dual ISP support, then the ASA can only send traffic through the first interface to
acquire an IP address.
Example:
ciscoasa(config-if)# security-level 50
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
437
Configure Routed Mode Interfaces
Step 5 (Optional) Set an interface to management-only mode so that it does not pass through traffic:
management-only
By default, Management interfaces are configured as management-only. Except for the ASA 5585-X, you
cannot disable management-only on the Management interface.
Examples
The following example configures parameters for VLAN 101:
The following example configures parameters in multiple context mode for the context configuration. The
interface ID is a mapped name.
Related Topics
Configure IPv6 Addressing, on page 443
Enable the Physical Interface and Configure Ethernet Parameters, on page 389
Configure PPPoE, on page 438
Configure PPPoE
If the interface is connected to a DSL, cable modem, or other connection to your ISP, and your ISP uses
PPPoE to provide your IP address, configure the following parameters.
Procedure
Step 1 Define the VPDN group name of your choice to represent this connection:
vpdn group group_name request dialout pppoe
Example:
ciscoasa(config)# vpdn group pppoe-sbc request dialout pppoe
Example:
ciscoasa(config)# vpdn group pppoe-sbc ppp authentication chap
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
438
Configure Transparent Mode Interfaces
Enter the appropriate keyword for the type of authentication used by your ISP.
When using CHAP or MS-CHAP, the username may be referred to as the remote system name, while the
password may be referred to as the CHAP secret.
Step 3 Associate the username assigned by your ISP to the VPDN group:
vpdn group group_name localname username
Example:
ciscoasa(config)# vpdn group pppoe-sbc localname johncrichton
Step 4 Create a username and password pair for the PPPoE connection:
vpdn username usernamepassword password [store-local]
Example:
ciscoasa(config)# vpdn username johncrichton password moya
The store-local option stores the username and password in a special location of NVRAM on the ASA. If an
Auto Update Server sends a clear config command to the ASA and the connection is then interrupted, the
ASA can read the username and password from NVRAM and re-authenticate to the Access Concentrator.
Procedure
Note For a separate management interface (for supported models), a non-configurable bridge group (ID 301)
is automatically added to your configuration. This bridge group is not included in the bridge group limit.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
439
Configure Transparent Mode Interfaces
Procedure
Example:
ciscoasa(config)# interface bvi 1
Example:
ciscoasa(config-if)# ip address 10.1.3.1 255.255.255.0 standby 10.1.3.2
Do not assign a host address (/32 or 255.255.255.255) to the bridge group. Also, do not use other subnets that
contain fewer than 3 host addresses (one each for the upstream router, downstream router, and transparent
firewall) such as a /30 subnet (255.255.255.252). The ASA drops all ARP packets to or from the first and last
addresses in a subnet. Therefore, if you use a /30 subnet and assign a reserved address from that subnet to the
upstream router, then the ASA drops the ARP request from the downstream router to the upstream router.
The standby keyword and address is used for failover.
Example
The following example sets the management address and standby address of bridge group 1:
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
440
Configure Transparent Mode Interfaces
interface id
Example:
ciscoasa(config)# interface gigabithethernet 0/0
Example:
ciscoasa(config-if)# bridge-group 1
The number is an integer between 1 and 100. You can assign up to four interfaces to a bridge group. You
cannot assign the same interface to more than one bridge group.
Example:
ciscoasa(config-if)# nameif inside
The name is a text string up to 48 characters, and is not case-sensitive. You can change the name by reentering
this command with a new value. Do not enter the no form, because that command causes all commands that
refer to that name to be deleted.
Example:
ciscoasa(config-if)# security-level 50
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
441
Configure Transparent Mode Interfaces
Related Topics
Configure the MTU and TCP MSS, on page 454
Procedure
Example:
ciscoasa(config)# interface management 0/0.1
The port-channel number argument is the EtherChannel interface ID, such as port-channel 1. The
EtherChannel interface must have only Management member interfaces.
Redundant interfaces do not support Management slot/port interfaces as members. You can, however, set a
redundant interface comprised of non-Management interfaces as management-only.
In multiple context mode, enter the mapped_name if one was assigned using the allocate-interface command.
Example:
ciscoasa(config-if)# nameif management
The name is a text string up to 48 characters, and is not case-sensitive. You can change the name by reentering
this command with a new value. Do not enter the no form, because that command causes all commands that
refer to that name to be deleted.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
442
Configure IPv6 Addressing
For use with failover, you must set the IP address and standby address manually; DHCP is not supported.
The ip_address and mask arguments set the interface IP address and subnet mask.
The standby ip_address argument is used for failover.
ip address ip_address [mask] [standby ip_address]
Example:
The setroute keyword lets the ASA use the default route supplied by the DHCP server.
Reenter this command to reset the DHCP lease and request a new lease.
If you do not enable the interface using the no shutdown command before you enter the ip address dhcp
command, some DHCP requests might not be sent.
Example:
ciscoasa(config-if)# security-level 100
Note Configuring the global address automatically configures the link-local address, so you do not need to
configure it separately.
Note See IPv6 Neighbor Discovery, on page 729 to configure IPv6 neighbor discovery.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
443
Configure IPv6 Addressing
Procedure
Example:
ciscoasa(config)# interface gigabithethernet 0/0
Example:
ciscoasa(config)# interface bvi 1
When you assign a global address, the link-local address is automatically created for the interface.
standby specifies the interface address used by the secondary unit or failover group in a failover pair.
• (Routed mode only) Assign a global address to the interface by combining the specified prefix with an
interface ID generated from the interface MAC address using the Modified EUI-64 format:
ipv6 address ipv6-prefix/prefix-length eui-64
Example:
When you assign a global address, the link-local address is automatically created for the interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
444
Monitoring Routed and Transparent Mode Interfaces
You do not need to specify the standby address; the interface ID will be generated automatically.
Step 3 (Optional) Enforce the use of Modified EUI-64 format interface identifiers in IPv6 addresses on a local link:
ipv6 enforce-eui64 if_name
Example:
ciscoasa(config)# ipv6 enforce-eui64 inside
The if_name argument is the name of the interface, as specified by the nameif command, on which you are
enabling the address format enforcement.
Interface Statistics
• show interface
Displays interface statistics.
• show interface ip brief
Displays interface IP addresses and status.
PPPoE
• show ip address interface_name pppoe
Displays the current PPPoE client configuration information.
• debug pppoe {event | error | packet}
Enables debugging for the PPPoE client.
• show vpdn session [l2tp | pppoe] [id sess_id | packets | state | window]
Views the status of PPPoE sessions.
The following examples show information provided by this command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
445
Examples for Routed and Transparent Mode Interfaces
ciscoasa#
ciscoasa# show vpdn session
PPPoE Session Information (Total tunnels=1 sessions=1)
Remote Internet Address is 10.0.0.1
Session state is SESSION_UP
Time since event change 65887 secs, interface outside
PPP interface id is 1
6 packets sent, 6 received, 84 bytes sent, 0 received
ciscoasa#
ciscoasa# show vpdn tunnel
PPPoE Tunnel Information (Total tunnels=1 sessions=1)
Tunnel id 0, 1 active sessions
time since change 65901 secs
Remote Internet Address 10.0.0.1
Local Internet Address 199.99.99.3
6 packets sent, 6 received, 84 bytes sent, 0 received
ciscoasa#
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
446
History for Routed and Transparent Mode Interfaces
Bridge groups for transparent mode 8.4(1) If you do not want the overhead of security contexts, or want
to maximize your use of security contexts, you can group
interfaces together in a bridge group, and then configure
multiple bridge groups, one for each network. Bridge group
traffic is isolated from other bridge groups. You can configure
up to eight bridge groups of four interfaces each in single mode
or per context.
We introduced the following commands: interface bvi, show
bridge-group.
Transparent mode bridge group maximum 9.3(1) The bridge group maximum was increased from 8 to 250 bridge
increased to 250 groups. You can configure up to 250 bridge groups in single
mode or per context in multiple mode, with 4 interfaces
maximum per bridge group.
We modified the following commands: interface bvi,
bridge-group.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
447
History for Routed and Transparent Mode Interfaces
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
448
CHAPTER 15
Advanced Interface Configuration
This chapter describes how to configure MAC addresses for interfaces, how to set the maximum transmission
unit (MTU), and set the TCP maximum segment size (TCP MSS), and how to allow same security level
communication. Setting the correct MTU and maximum TCP segment size is essential for the best network
performance.
Note For multiple context mode, complete the tasks in this section in the context execution space. Enter the
changeto contextname command to change to the context you want to configure.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
449
About Advanced Interface Configuration
numbered channel group interface MAC address as the port-channel MAC address. Alternatively you can
manually configure a MAC address for the port-channel interface. In multiple context mode, you can
automatically assign unique MAC addresses to interfaces, including an EtherChannel port interface. We
recommend manually, or in multiple context mode, automatically configuring a unique MAC address in case
the group channel interface membership changes. If you remove the interface that was providing the
port-channel MAC address, then the port-channel MAC address changes to the next lowest numbered interface,
thus causing traffic disruption.
In multiple context mode, if you share an interface between contexts, you can assign a unique MAC address
to the interface in each context. This feature lets the ASA easily classify packets into the appropriate context.
Using a shared interface without unique MAC addresses is possible, but has some limitations. You can assign
each MAC address manually, or you can automatically generate MAC addresses for shared interfaces in
contexts. If you automatically generate MAC addresses, you can use this procedure to override the generated
address.
You might want to assign unique MAC addresses to subinterfaces. For example, your service provider might
perform access control based on the MAC address.
Related Topics
How the ASA Classifies Packets, on page 154
Assign MAC Addresses to Context Interfaces Automatically, on page 175
Default MTU
The default MTU on the ASA is 1500 bytes. This value does not include the 18 bytes for the Ethernet header
or VLAN tagging.
When you enable VXLAN on the VTEP source interface, if the MTU is less than 1554 bytes, then the ASA
automatically raises the MTU to 1554 bytes. In this case, the entire Ethernet datagram is being encapsulated,
so the new packet is larger and requires a larger MTU. If the MTU used by other devices is larger, then you
should set the source interface MTU to be the network MTU + 54 bytes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
450
About Advanced Interface Configuration
For TCP packets, the endpoints typically use their MTU to determine the TCP maximum segment size (MTU
- 40, for example). If additional TCP headers are added along the way, for example for site-to-site VPN
tunnels, then the TCP MSS might need to be adjusted down by the tunneling entity. See About the TCP MSS,
on page 451.
For UDP or ICMP, the application should take the MTU into account to avoid fragmentation.
Note The ASA can receive frames larger than the configured MTU as long as there is room in memory.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
451
About Advanced Interface Configuration
Inter-Interface Communication
Allowing interfaces on the same security level to communicate with each other provides the following benefits:
• You can configure more than 101 communicating interfaces.
If you use different levels for each interface and do not assign any interfaces to the same security level,
you can configure only one interface per level (0 to 100).
• You want traffic to flow freely between all same security interfaces without ACLs.
If you enable same security interface communication, you can still configure interfaces at different security
levels as usual.
Note All traffic allowed by this feature is still subject to firewall rules. Be careful not to create an asymmetric
routing situation that can cause return traffic not to traverse the ASA.
For the ASASM, before you can enable this feature, you must first correctly configure the MSFC so that
packets are sent to the ASA MAC address instead of being sent directly through the switch to the destination
host. The following figure shows a network where hosts on the same interface need to communicate.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
452
Configure the MAC Address
The following sample configuration shows the Cisco IOS route-map commands used to enable policy routing
in the network shown in the figure:
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
453
Configure the MTU and TCP MSS
interface id
Example:
ciscoasa(config)# interface gigabithethernet 0/0
Example:
ciscoasa(config-if)# mac-address 000C.F142.4CDE
The mac_address is in H.H.H format, where H is a 16-bit hexadecimal digit. For example, the MAC address
00-0C-F1-42-4C-DE is entered as 000C.F142.4CDE.
The first two bytes of a manual MAC address cannot be A2 if you also want to use auto-generated MAC
addresses.
For use with failover, set the standby MAC address. If the active unit fails over and the standby unit becomes
active, the new active unit starts using the active MAC addresses to minimize network disruption, while the
old active unit uses the standby address.
Procedure
Step 1 Set the MTU between 300 and 9198 bytes (9000 for the ASAv and Firepower 9300 ASA security module):
mtu interface_name bytes
Example:
ciscoasa(config)# mtu inside 9000
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
454
Allow Same Security Level Communication
Step 2 Set the maximum TCP segment size in bytes, between 48 and any maximum number:
sysopt connection tcpmss [minimum] bytes
Example:
ciscoasa(config)# sysopt connection tcpmss 8500
ciscoasa(config)# sysopt connection tcpmss minimum 1290
The default value is 1380 bytes. You can disable this feature by setting bytes to 0.
For the minimum keyword, sets the maximum segment size to be no less than bytes, between 48 and 65535.
The minimum feature is disabled by default (set to 0).
Step 3 For ASA Cluster settings, see Configure Interfaces on the Primary Unit, on page 290.
Examples
The following example enables jumbo frames, increases the MTU on all interfaces, and disables the TCP
MSS for non-VPN traffic (by setting the TCP MSS to 0, which means there is no limit):
jumbo frame-reservation
mtu inside 9198
mtu outside 9198
sysopt connection tcpmss 0
The following example enables jumbo frames, increases the MTU on all interfaces, and changes the TCP
MSS for VPN traffic to 9078 (the MTU minus 120):
jumbo frame-reservation
mtu inside 9198
mtu outside 9198
sysopt connection tcpmss 9078
Procedure
Step 1 Enable interfaces on the same security level so that they can communicate with each other:
same-security-traffic permit inter-interface
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
455
Allow Same Security Level Communication
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
456
CHAPTER 16
Traffic Zones
You can assign multiple interfaces to a traffic zone, which lets traffic from an existing flow exit or enter the
ASA on any interface within the zone. This capability allows Equal-Cost Multi-Path (ECMP) routing on the
ASA as well as external load balancing of traffic to the ASA across multiple interfaces.
Non-Zoned Behavior
The Adaptive Security Algorithm takes into consideration the state of a packet when deciding to permit or
deny the traffic. One of the enforced parameters for the flow is that traffic enters and exits the same interface.
Any traffic for an existing flow that enters a different interface is dropped by the ASA.
Traffic zones let you group multiple interfaces together so that traffic entering or exiting any interface in the
zone fulfills the Adaptive Security Algorithm security checks.
Related Topics
Stateful Inspection Overview, on page 16
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
457
About Traffic Zones
Asymmetric Routing
In the following scenario, a connection was established between an inside host and an outside host through
ISP 1 on the Outside1 interface. Due to asymmetric routing on the destination network, return traffic arrived
from ISP 2 on the Outside2 interface.
Non-Zoned Problem: The ASA maintains the connection tables on a per-interface basis. When the returning
traffic arrives at Outside2, it will not match the connection table and will be dropped.
Zoned Solution: The ASA maintains connection tables on a per-zone basis. If you group Outside1 and
Outside2 into a zone, then when the returning traffic arrives at Outside2, it will match the per-zone connection
table, and the connection will be allowed.
Lost Route
In the following scenario, a connection was established between an inside host and an outside host through
ISP 1 on the Outside1 interface. Due to a lost or moved route between Outside1 and ISP 1, traffic needs to
take a different route through ISP 2.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
458
About Traffic Zones
Non-Zoned Problem: The connection between the inside and outside host will be deleted; a new connection
must be established using a new next-best route. For UDP, the new route will be used after a single packet
drop, but for TCP, a new connection has to be reestablished.
Zoned Solution: The ASA detects the lost route and switches the flow to the new path through ISP 2. Traffic
will be seamlessly forwarded without any packet drops.
Load Balancing
In the following scenario, a connection was established between an inside host and an outside host through
ISP 1 on the Outside1 interface. A second connection was established through an equal cost route through
ISP 2 on Outside2.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
459
About Traffic Zones
Non-Zoned Problem: Load-balancing across interfaces is not possible; you can only load-balance with equal
cost routes on one interface.
Zoned Solution: The ASA load-balances connections across up to eight equal cost routes on all the interfaces
in the zone.
ECMP Routing
The ASA supports Equal-Cost Multi-Path (ECMP) routing.
In this case, traffic is load-balanced on the outside interface between 10.1.1.2, 10.1.1.3, and 10.1.1.4. Traffic
is distributed among the specified gateways based on an algorithm that hashes the source and destination IP
addresses.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
460
About Traffic Zones
ECMP is not supported across multiple interfaces, so you cannot define a route to the same destination on a
different interface. The following route is disallowed when configured with any of the routes above:
Similarly, your dynamic routing protocol can automatically configure equal cost routes. The ASA load-balances
traffic across the interfaces with a more robust load balancing mechanism.
When a route is lost, the ASA seamlessly moves the flow to a different route.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
461
About Traffic Zones
• NAT
• Service Rules, except for QoS traffic policing.
• Routing
You can also configure to- and from-the-box services listed in To- and From-the-Box Traffic, on page 462,
although full zoned support is not available.
Do not configure other services (such as VPN or Botnet Traffic Filter) for interfaces in a traffic zone; they
may not function or scale as expected.
Note For detailed information about how to configure the security policy, see Prerequisites for Traffic Zones,
on page 463.
Security Levels
The first interface that you add to a zone determines the security level of the zone. All additional interfaces
must have the same security level. To change the security level for interfaces in a zone, you must remove all
but one interface, and then change the security levels, and re-add the interfaces.
Intra-Zone Traffic
To allow traffic to enter one interface and exit another in the same zone, enable the same-security permit
intra-interface command, which allows traffic to enter and exit the same interface, as well as the same-security
permit inter-interface command, which allows traffic between same-security interfaces. Otherwise, a flow
cannot be routed between two interfaces in the same zone.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
462
Prerequisites for Traffic Zones
• For management traffic on regular interfaces in a zone, only asymmetric routing on existing flows is
supported; there is no ECMP support.
• You can configure a management service on only one zone interface, but to take advantage of asymmetric
routing support, you need to configure it on all interfaces. Even when the configurations are parallel on
all interfaces, ECMP is not supported.
• The ASA supports the following to- and from-the-box services in a zone:
◦Telnet
◦SSH
◦HTTPS
◦SNMP
◦Syslog
◦NAT—Configure the same NAT policy on all member interfaces of the zone or use a global NAT
rule (in other words, use “any” to represent the zone interfaces in the NAT rule).
Interface PAT is not supported.
For example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
463
Guidelines for Traffic Zones
Note When you use interface-specific NAT and PAT pools, the ASA cannot switch connections
over in case of the original interface failure.
If you use interface-specific PAT pools, multiple connections from the same host might
load-balance to different interfaces and use different mapped IP addresses. Internet
services that use multiple concurrent connections may not work correctly in this case.
◦Service Rules—Use the global service policy, or assign the same policy to each interface in a zone.
QoS traffic policing is not supported.
For example:
Note For VoIP inspections, zone load balancing can cause increased out-of-order packets.
This situation can occur because later packets might reach the ASA before earlier packets
that take a different path. Symptoms of out-of-order packets include:
• Higher memory utilization at intermediate nodes (firewall and IDS) and the
receiving end nodes if queuing is used.
• Poor video or voice quality.
To mitigate these effects, we recommend that you use IP addresses only for load
distribution for VoIP traffic.
Failover
• You cannot add the failover or state link to a zone.
• In Active/Active failover mode, you can assign an interface in each context to an asymmetrical routing
(ASR) group. This service allows traffic returning on a similar interface on the peer unit to be restored
to the original unit. You cannot configure both ASR groups and traffic zones within a context. If you
configure a zone in a context, none of the context interfaces can be part of an ASR group. See Configure
Support for Asymmetrically Routed Packets (Active/Active Mode), on page 233 for more information
about ASR groups.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
464
Configure a Traffic Zone
• Only the primary interfaces for each connection are replicated to the standby unit; current interfaces are
not replicated. If the standby unit becomes active, it will assign a new current interface if necessary.
Clustering
• You cannot add the cluster control link to a zone.
Additional Guidelines
• You can create a maximum of 256 zones.
• You can add the following types of interfaces to a zone:
◦Physical
◦VLAN
◦EtherChannel
◦Redundant
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
465
Monitoring Traffic Zones
Example:
zone outside
Example:
interface gigabitethernet0/0
zone-member outside
Step 3 Add more interfaces to the zone; ensure they have the same security level as the first interface you added.
Example:
interface gigabitethernet0/1
zone-member outside
interface gigabitethernet0/2
zone-member outside
interface gigabitethernet0/3
zone-member outside
Examples
The following example configures an outside zone with 4 member interfaces:
zone outside
interface gigabitethernet0/0
zone-member outside
interface gigabitethernet0/1
zone-member outside
interface gigabitethernet0/2
zone-member outside
interface gigabitethernet0/3
zone-member outside
Zone Information
• show zone [name]
Shows zone ID, context, security level, and members.
See the following output for the show zone command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
466
Monitoring Traffic Zones
Zone Connections
• show conn [long | detail] [zone zone_name [zone zone_name] [...]]
The show conn zone command displays connections for a zone. The long and detail keywords show
the primary interface on which the connection was built and the current interface used to forward the
traffic.
See the following output for the show conn long zone command:
Conn:
TCP outside-zone:outside1(outside2): 10.122.122.1:1080
inside-zone:inside1(inside2): 10.121.121.1:34254, idle 0:00:02, bytes 10, flags UO
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
467
Example for Traffic Zones
Zone Routing
• show route zone
Shows the routes for zone interfaces.
See the following output for the show route zone command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
468
Example for Traffic Zones
interface gigabitethernet0/0
no shutdown
description outside switch 1
interface gigabitethernet0/1
no shutdown
description outside switch 2
interface gigabitethernet0/2
no shutdown
description inside switch
zone outside
interface gigabitethernet0/0.101
vlan 101
nameif outside1
security-level 0
ip address 209.165.200.225 255.255.255.224
zone-member outside
no shutdown
interface gigabitethernet0/0.102
vlan 102
nameif outside2
security-level 0
ip address 209.165.201.1 255.255.255.224
zone-member outside
no shutdown
interface gigabitethernet0/1.201
vlan 201
nameif outside3
security-level 0
ip address 198.51.100.1 255.255.255.0
zone-member outside
no shutdown
interface gigabitethernet0/1.202
vlan 202
nameif outside4
security-level 0
ip address 203.0.113.1 255.255.255.0
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
469
Example for Traffic Zones
zone-member outside
no shutdown
interface gigabitethernet0/2.301
vlan 301
nameif inside
security-level 100
ip address 192.168.9.1 255.255.255.0
no shutdown
interface gigabitethernet0/2.302
vlan 302
nameif dmz
security-level 50
ip address 10.3.5.1 255.255.255.0
no shutdown
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
470
History for Traffic Zones
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
471
History for Traffic Zones
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
472
PART IV
Basic Settings
• Basic Settings, page 475
• DHCP and DDNS Services, page 495
• Digital Certificates, page 513
CHAPTER 17
Basic Settings
This chapter describes how to configure basic settings on the ASA that are typically required for a functioning
configuration.
• Set the Hostname, Domain Name, and the Enable and Telnet Passwords, page 475
• Recover Enable and Telnet Passwords, page 477
• Set the Date and Time, page 482
• Configure the Master Passphrase, page 485
• Configure the DNS Server, page 489
• Configure the Hardware Bypass (Cisco ISA 3000), page 490
• Adjust ASP (Accelerated Security Path) Performance and Behavior, page 492
• Monitoring the DNS Cache, page 493
• History for Basic Settings, page 494
Set the Hostname, Domain Name, and the Enable and Telnet Passwords
To set the hostname, domain name, and the enable and Telnet passwords, perform the following steps.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
475
Set the Hostname, Domain Name, and the Enable and Telnet Passwords
Procedure
Step 1 Specify the hostname for the ASA or for a context. The default hostname is “asa.”
hostname name
Example:
ciscoasa(config)# hostname myhostnamexample12345
This name can be up to 63 characters. The hostname must start and end with a letter or digit, and have only
letters, digits, or a hyphen.
When you set a hostname for the ASA, that name appears in the command line prompt. If you establish
sessions to multiple devices, the hostname helps you keep track of where you enter commands.
For multiple context mode, the hostname that you set in the system execution space appears in the command
line prompt for all contexts. The hostname that you optionally set within a context does not appear in the
command line, but can be used by the banner command $(hostname) token.
Step 2 Specify the domain name for the ASA. The default domain name is default.domain.invalid.
domain-name name
Example:
ciscoasa(config)# domain-name example.com
The ASA appends the domain name as a suffix to unqualified names. For example, if you set the domain
name to “example.com” and specify a syslog server by the unqualified name of “jupiter,” then the ASA qualifies
the name to “jupiter.example.com.”
Step 3 Change the enable password. By default, the enable password is blank.
The enable password lets you enter privileged EXEC mode if you do not configure enable authentication.
The enable password also lets you log into ASDM with a blank username if you do not configure HTTP
authentication.
enable password password
Example:
ciscoasa(config)# enable passwd Pa$$w0rd
The password argument is a case-sensitive password of up to 16 alphanumeric and special characters. You
can use any character in the password except a question mark or a space.
This command changes the password for the highest privilege level (15). If you configure local command
authorization, you can set enable passwords for each privilege level from 0 to 15 using the following syntax:
enable password password level number
The password is saved in the configuration in encrypted form, so you cannot view the original password after
you enter it. Enter the enable password command without a password to set the password to the default,
which is blank.
Step 4 Set the login password for Telnet access. There is no default password.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
476
Recover Enable and Telnet Passwords
The login password is used for Telnet access when you do not configure Telnet authentication. You also use
this password when accessing the ASASM from the switch with the session command.
{passwd | password} password [encrypted]
Example:
ciscoasa(config)# password cisco12345
You can enter passwd or password. The password is a case-sensitive password of up to 16 alphanumeric and
special characters. You can use any character in the password except a question mark or a space.
The password is saved in the configuration in encrypted form, so you cannot view the original password after
you enter it. If for some reason you need to copy the password to another ASA but do not know the original
password, you can enter the passwd command with the encrypted password and the encrypted keyword.
Normally, you only see this keyword when you enter the show running-config passwd command.
Procedure
Step 5 To set the ASA to ignore the startup configuration, enter the following command:
The ASA displays the current configuration register value, and asks whether you want to change it:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
477
Recover Enable and Telnet Passwords
Step 6 Record the current configuration register value, so you can restore it later.
Step 7 At the prompt, enter Y to change the value.
The ASA prompts you for new values.
Step 8 Accept the default values for all settings, except for the "disable system configuration?" value.
Step 9 At the prompt, enter Y.
Step 10 Reload the ASA by entering the following command:
The ASA loads the default configuration instead of the startup configuration.
Step 11 Access the privileged EXEC mode by entering the following command:
ciscoasa# enable
Step 14 Access the global configuration mode by entering the following command:
Step 15 Change the passwords, as required, in the default configuration by entering the following commands:
ciscoasa(config)# no config-register
The default configuration register value is 0x1. See the command reference for more information about the
configuration register.
Step 17 Save the new passwords to the startup configuration by entering the following command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
478
Recover Enable and Telnet Passwords
Recover Passwords on the ASA 5506-X, ASA 5508-X, and ASA 5516-X
To recover passwords for the ASA 5506-X, ASA 5508-X, and ASA 5516-X perform the following steps:
Procedure
You must reset or power cycle for new config to take effect
The ASA displays the current configuration register value and a list of configuration options. Record the
current configuration register value, so you can restore it later.
Configuration Summary
[ 0 ] password recovery
[ 1 ] display break prompt
[ 2 ] ignore system configuration
[ 3 ] auto-boot image in disks
[ 4 ] console baud: 9600
boot: ...... auto-boot index 1 image in disks
The ASA loads the default configuration instead of the startup configuration.
Step 6 Access the privileged EXEC mode by entering the following command:
ciscoasa# enable
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
479
Recover Enable and Telnet Passwords
Step 9 Access the global configuration mode by entering the following command:
Step 10 Change the passwords, as required, in the default configuration by entering the following commands:
ciscoasa(config)# no config-register
The default configuration register value is 0x1. See the command reference for more information about the
configuration register.
Step 12 Save the new passwords to the startup configuration by entering the following command:
Procedure
Example:
ciscoasa# copy running-config backup.cfg
Step 3 From the GNU GRUB menu, press the down arrow, choose the <filename> with no configuration load
option, then press Enter. The filename is the default boot image filename on the ASAv. The default boot
image is never automatically booted through the fallback command. Then load the selected boot image.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
480
Recover Enable and Telnet Passwords
Example:
GNU GRUB version 2.0(12)4
bootflash: /asa100123-20-smp-k8.bin with no configuration load
Example:
ciscoasa (config)# copy backup.cfg running-config
Example:
ciscoasa(config)# enable password cisco123
Example:
ciscoasa(config)# write memory
To disable password recovery to ensure that unauthorized users cannot use the password recovery mechanism
to compromise the ASA, perform the following steps.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
481
Set the Date and Time
command does not change the setting. If you disable password recovery when the ASA is configured to ignore
the startup configuration at startup (in preparation for password recovery), then the ASA changes the setting
to load the startup configuration as usual. If you use failover, and the standby unit is configured to ignore the
startup configuration, then the same change is made to the configuration register when the no service password-
recovery command replicates to the standby unit.
Procedure
Example:
ciscoasa (config)# no service password-recovery
Note Do not set the date and time for the ASASM or the Firepower 9300 ASA security module; they receive
these settings from the host device.
Procedure
Step 1 Set the time zone. By default, the time zone is UTC and the daylight saving time date range is from 2:00 a.m.
on the first Sunday in April to 2:00 a.m. on the last Sunday in October.
clock timezone zone [-]hours [minutes]
Example:
ciscoasa(config)# clock timezone PST -8
The zone argument specifies the time zone as a string, for example, PST for Pacific Standard Time.
The [-]hours value sets the number of hours of offset from UTC. For example, PST is -8 hours.
The minutes value sets the number of minutes of offset from UTC.
Step 2 Enter one of the following commands to change the date range for daylight saving time from the default. The
default recurring date range is from 2:00 a.m. on the second Sunday in March to 2:00 a.m. on the first Sunday
in November.
• Set the start and end dates for daylight saving time as a specific date in a specific year. If you use this
command, you need to reset the dates every year.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
482
Set the Date and Time
clock summer-time zone date {day month | month day} year hh:mm {day month | month day} year
hh:mm [offset]
Example:
The zone value specifies the time zone as a string, for example, PDT for Pacific Daylight Time.
The day value sets the day of the month, from 1 to 31. You can enter the day and month as April 1 or
as 1 April, for example, depending on your standard date format.
The month value sets the month as a string. You can enter the day and month as April 1 or as 1 April,
depending on your standard date format.
The year value sets the year using four digits, for example, 2004. The year range is 1993 to 2035.
The hh:mm value sets the hour and minutes in 24-hour time.
The offset value sets the number of minutes to change the time for daylight saving time. By default, the
value is 60 minutes.
• Specify the start and end dates for daylight saving time, in the form of a day and time of the month, and
not a specific date in a year. This command enables you to set a recurring date range that you do not
need to change yearly.
clock summer-time zone recurring [week weekday month hh:mm week weekday month hh:mm] [offset]
Example:
The zone value specifies the time zone as a string, for example, PDT for Pacific Daylight Time.
The week value specifies the week of the month as an integer between 1 and 4 or as the words first or
last. For example, if the day might fall in the partial fifth week, then specify last.
The weekday value specifies the day of the week: Monday, Tuesday, Wednesday, and so on.
The month value sets the month as a string.
The hh:mm value sets the hour and minutes in 24-hour time.
The offset value sets the number of minutes to change the time for daylight savings time. By default,
the value is 60 minutes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
483
Set the Date and Time
Procedure
Example:
ciscoasa(config)# ntp authenticate
Step 2 Specify an authentication key ID to be a trusted key, which is required for authentication with an NTP server.
ntp trusted-key key_id
Example:
ciscoasa(config)# ntp trusted-key 1
The key_id argument is a value between 1 and 4294967295. You can enter multiple trusted keys for use with
multiple servers.
Example:
ciscoasa(config)# ntp authentication-key 1 md5 aNiceKey
The key_id argument is the ID that you set using the ntp trusted-key command, and the key argument is a
string up to 32 characters long.
Example:
ciscoasa(config)# ntp server 10.1.1.1 key 1 prefer
The key_id argument is the ID that you set using the ntp trusted-key command.
The source interface_name keyword-argument pair identifies the outgoing interface for NTP packets if you
do not want to use the default interface in the routing table. Because the system does not include any interfaces
in multiple context mode, specify an interface name defined in the admin context.
The prefer keyword sets this NTP server as the preferred server if multiple servers have similar accuracy.
NTP uses an algorithm to determine which server is the most accurate and synchronizes to that one. If servers
are of similar accuracy, then the prefer keyword specifies which of those servers to use. However, if a server
is significantly more accurate than the preferred one, the ASA uses the more accurate one. For example, the
ASA uses a server of stratum 2 over a server of stratum 3 that is preferred.
You can identify multiple servers; the ASA uses the most accurate server.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
484
Configure the Master Passphrase
Procedure
Example:
ciscoasa# clock set 20:54:00 april 1 2004
The hh:mm:ss argument sets the hour, minutes, and seconds in 24-hour time. For example, enter 20:54:00 for
8:54 pm.
The day value sets the day of the month, from 1 to 31. You can enter the day and month as april 1 or as 1
april, for example, depending on your standard date format.
The month value sets the month. Depending on your standard date format, you can enter the day and month
as april 1 or as 1 april.
The year value sets the year using four digits, for example, 2004. The year range is from 1993 to 2035.
The default time zone is UTC. If you change the time zone after you enter the clock set command using the
clock timezone command, the time automatically adjusts to the new time zone.
This command sets the time in the hardware chip, and does not save the time in the configuration file. This
time endures reboots. Unlike the other clock commands, this command is a privileged EXEC command. To
reset the clock, you need to set a new time with the clock set command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
485
Configure the Master Passphrase
• Logging
• Shared licenses
Note If failover is enabled but no failover shared key is set, an error message appears if you change the master
passphrase, informing you that you must enter a failover shared key to protect the master passphrase
changes from being sent as plain text.
Procedure
Step 1 Set the passphrase used for generating the encryption key. The passphrase must be between 8 and 128 characters
long. All characters except a backspace and double quotes are accepted for the passphrase. If you do not enter
the new passphrase in the command, you are prompted for it. To change the passphrase, you must enter the
old passphrase.
key config-key password-encryption [new_passphrase [old_passphrase]]
Example:
ciscoasa(config)# key config-key password-encryption
Old key: bumblebee
New key: haverford
Confirm key: haverford
Note Use the interactive prompts to enter passwords to avoid having the passwords logged in the command
history buffer.
Use the no key config-key password-encrypt command with caution, because it changes the encrypted
passwords into plain text passwords. You may use the no form of this command when downgrading to a
software version that does not support password encryption.
Example:
ciscoasa(config)# password encryption aes
As soon as password encryption is enabled and the master passphrase is available, all the user passwords will
be encrypted. The running configuration will show the passwords in the encrypted format.
If the passphrase is not configured at the time that password encryption is enabled, the command will succeed
in anticipation that the passphrase will be available in the future.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
486
Configure the Master Passphrase
If you later disable password encryption using the no password encryption aes command, all existing
encrypted passwords are left unchanged, and as long as the master passphrase exists, the encrypted passwords
will be decrypted, as required by the application.
Step 3 Save the runtime value of the master passphrase and the resulting configuration.
write memory
Example:
ciscoasa(config)# write memory
If you do not enter this command, passwords in startup configuration may still be visible if they were not
saved with encryption previously. In addition, in multiple context mode the master passphrase is changed in
the system context configuration. As a result, the passwords in all contexts will be affected. If the write memory
command is not entered in the system context mode, but not in all user contexts, then the encrypted passwords
in user contexts may be stale. Alternatively, use the write memory all command in the system context to save
all configurations.
Examples
The following example shows that no previous key was present:
In the following example, you enter the command without parameters so that you will be prompted for keys.
Because a key already exists, you are prompted for it.
In the following example, there is no existing key, so you are not prompted to supply it.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
487
Configure the Master Passphrase
• This procedure works only in a secure session; that is, by Telnet, SSH, or ASDM via HTTPS.
To disable the master passphrase, perform the following steps:
Procedure
Step 1 Remove the master passphrase. If you do not enter the passphrase in the command, you are prompted for it.
no key config-key password-encryption [old_passphrase]]
Example:
ciscoasa(config)# no key config-key password-encryption
Warning! You have chosen to revert the encrypted passwords to plain text.
This operation will expose passwords in the configuration and therefore
exercise caution while viewing, storing, and copying configuration.
Step 2 Save the runtime value of the master passphrase and the resulting configuration.
write memory
Example:
ciscoasa(config)# write memory
The non-volatile memory containing the passphrase will be erased and overwritten with the 0xFF pattern.
In multiple mode, the master passphrase is changed in the system context configuration. As a result, the
passwords in all contexts will be affected. If the write memory command is entered in the system context
mode, but not in all user contexts, then the encrypted passwords in user contexts may be stale. Alternatively,
use the write memory all command in the system context to save all configurations.
Procedure
Step 1 Remove the master key and the configuration that includes the encrypted passwords.
write erase
Example:
ciscoasa(config)# write erase
Step 2 Reload the ASA with the startup configuration, without any master key or encrypted passwords.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
488
Configure the DNS Server
reload
Example:
ciscoasa(config)# reload
Note The ASA has limited support for using the DNS server, depending on the feature. For example, most
commands require you to enter an IP address and can only use a name when you manually configure the
name command to associate a name with an IP address and enable use of the names using the names
command.
Procedure
Step 1 Enable the ASA to send DNS requests to a DNS server to perform a name lookup for supported commands.
dns domain-lookup interface_name
Example:
ciscoasa(config)# dns domain-lookup inside
Step 2 Specify the DNS server group that the ASA uses for outgoing requests.
dns server-group DefaultDNS
Example:
ciscoasa(config)# dns server-group DefaultDNS
Other DNS server groups can be configured for VPN tunnel groups. See the tunnel-group command in the
command reference for more information.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
489
Configure the Hardware Bypass (Cisco ISA 3000)
Step 3 Specify one or more DNS servers. You may enter all six IP addresses in the same command, separated by
spaces, or you can enter each command separately. The ASA tries each DNS server in order until it receives
a response.
name-server ip_address [ip_address2] [...] [ip_address6] [interface_name]
Example:
ciscoasa(config-dns-server-group)# name-server 10.1.1.5 192.168.1.67 209.165.201.6 dmz
(Optional) Specify the interface_name through which the ASA communicates with the server. If you do not
specify the interface, the ASA checks the management-only routing table; if there are no matches, it then
checks the data routing table.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
490
Configure the Hardware Bypass (Cisco ISA 3000)
• If you have a fiber Ethernet model, only the copper Ethernet pair (GigabitEthernet 1/1 & 1/2) supports
hardware bypass.
• We suggest that you disable TCP sequence randomization (as described in this procedure). If
randomization is enabled (the default), then when the hardware bypass is activated, TCP sessions will
need to be re-established. Bt default, the ISA 3000 rewrites the initial sequence number (ISN) of TCP
connections passing through it to a random number. When the hardware bypass is activated, the ISA
3000 is no longer in the data path and does not translate the sequence numbers; the receiving client
receives an unexpected sequence number and drops the connection. Even with TCP sequence
randomization disabled, some TCP connections will have to be re-established because of the link that
is temporarily down during the switchover.
• When the hardware bypass is deactivated and traffic resumes going through the ISA 3000 data path,
some existing TCP sessions need to be re-established because of the link that is temporarily down during
the switchover.
• When the ISA 3000 loses power and goes into hardware bypass mode, only the above interface pairs
can communicate; when using the default configuration, inside1 <---> inside2, and outside1 <--->
outside2 can no longer communicate. Any existing connections between these interfaces will be lost.
Procedure
Example:
ciscoasa(config)# hardware-bypass GigabitEthernet 1/1-1/2
ciscoasa(config)# hardware-bypass GigabitEthernet 1/3-1/4
The sticky keyword keeps the appliance in hardware bypass mode after the power comes back and the appliance
boots up. In this case, you need to manually turn off the hardware bypass when you are ready; this option lets
you control when the brief interruption in traffic occurs.
Example:
ciscoasa# hardware-bypass manual GigabitEthernet 1/1-1/2
ciscoasa# no hardware-bypass manual GigabitEthernet 1/1-1/2
Step 3 (Optional) Configure the hardware bypass to remain active until after the ASA FirePOWER module boots
up:
hardware-bypass boot-delay module-up sfr
You must enable hardware bypass without the sticky option for the boot delay to operate. Without the
hardware-bypass boot-delay command, the hardware bypass is likely to become inactive before the ASA
FirePOWER module finishes booting up. This scenario can cause traffic to be dropped if you configured the
module to fail-close, for example.
Step 4 Disable TCP sequence randomization. This example shows how to disable randomization for all traffic by
adding the setting to the default configuration.
policy-map global_policy
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
491
Adjust ASP (Accelerated Security Path) Performance and Behavior
class sfrclass
set connection random-sequence-number disable
If you later decide to turn it back on, replace "disable" with enable.
Transactional Matches old rules. Match old rules. Matches new rules.
(The rate for connections per second
is unaffected.)
An additional benefit of the transactional model is that, when replacing an ACL on an interface, there is no
gap between deleting the old ACL and applying the new one. This feature reduces the chances that acceptable
connections may be dropped during the operation.
Tip If you enable the transactional model for a rule type, syslogs to mark the beginning and the end of the
compilation are generated. These syslogs are numbered 780001 through 780004.
Use the following procedure to enable the transactional commit model for the rule engine.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
492
Monitoring the DNS Cache
Procedure
Example:
ciscoasa(config)# asp rule-engine transactional-commit access-group
The asp load-balance per-packet command allows multiple cores to work simultaneously on packets that
were received from a single interface receive ring. If the system drops packets, and the show cpu command
output is far less than 100%, then this command may help your throughput if the packets belong to many
unrelated connections. The auto option enables the ASA to automatically switch per-packet load balancing
on and off.
To enable the automatic switching on and off of per-packet load balancing, enter the following command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
493
History for Basic Settings
Password Encryption Visibility 8.4(1) We modified the show password encryption command.
Removal of the default Telnet password 9.0(2)/9.1(2) To improve security for management access to the ASA, the
default login password for Telnet was removed; you must
manually set the password before you can log in using Telnet.
Note The login password is only used for Telnet if you do
not configure Telnet user authentication (the aaa
authentication telnet console command).
Previously, when you cleared the password, the ASA restored
the default of “cisco.” Now when you clear the password, the
password is removed.
The login password is also used for Telnet sessions from the
switch to the ASASM (see the session command). For initial
ASASM access, you must use the service-module session
command, until you set a login password.
We modified the following command: passwd.
ASP Load Balancing 9.3(2) We introduced this feature. The ASP load balancing mechanism
reduces packet drop and improves throughput by allowing
multiple cores of the CPU to receive packets from an interface
receive ring and work on them independently.
We introduced the following command: asp load-balance
per-packet-auto.
ISA 3000 hardware bypass 9.4(1.225) The ISA 3000 supports a hardware bypass function to allow
traffic to continue flowing through the appliance when there is
a loss of power.
We introduced the following commands: hardware-bypass,
hardware-bypass manual, hardware-bypass boot-delay,
show hardware-bypass
This feature is not available in Version 9.5(1).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
494
CHAPTER 18
DHCP and DDNS Services
This chapter describes how to configure the DHCP server or DHCP relay as well as dynamic DNS (DDNS)
update methods.
DHCP Options
DHCP provides a framework for passing configuration information to hosts on a TCP/IP network. The
configuration parameters are carried in tagged items that are stored in the Options field of the DHCP message
and the data are also called options. Vendor information is also stored in Options, and all of the vendor
information extensions can be used as DHCP options.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
495
About DHCP and DDNS Services
For example, Cisco IP Phones download their configuration from a TFTP server. When a Cisco IP Phone
starts, if it does not have both the IP address and TFTP server IP address preconfigured, it sends a request
with option 150 or 66 to the DHCP server to obtain this information.
• DHCP option 150 provides the IP addresses of a list of TFTP servers.
• DHCP option 66 gives the IP address or the hostname of a single TFTP server.
• DHCP option 3 sets the default route.
A single request might include both options 150 and 66. In this case, the ASA DHCP server provides values
for both options in the response if they are already configured on the ASA.
You can use advanced DHCP options to provide DNS, WINS, and domain name parameters to DHCP clients;
DHCP option 15 is used for the DNS domain suffix.You can also use the DHCP automatic configuration
setting to obtain these values or define them manually. When you use more than one method to define this
information, it is passed to DHCP clients in the following sequence:
1 Manually configured settings.
2 Advanced DHCP options settings.
3 DHCP automatic configuration settings.
For example, you can manually define the domain name that you want the DHCP clients to receive and then
enable DHCP automatic configuration. Although DHCP automatic configuration discovers the domain together
with the DNS and WINS servers, the manually defined domain name is passed to DHCP clients with the
discovered DNS and WINS server names, because the domain name discovered by the DHCP automatic
configuration process is superseded by the manually defined domain name.
About DDNS
DDNS update integrates DNS with DHCP. The two protocols are complementary: DHCP centralizes and
automates IP address allocation; DDNS update automatically records the association between assigned
addresses and hostnames at predefined intervals. DDNS allows frequently changing address-hostname
associations to be updated frequently. Mobile hosts, for example, can then move freely on a network without
user or administrator intervention. DDNS provides the necessary dynamic update and synchronization of the
name-to-address mapping and address-to-name mapping on the DNS server.
The DDNS name and address mapping is held on the DHCP server in two resource records (RRs): the A RR
includes the name-to-IP address mapping, while the PTR RR maps addresses to names. Of the two methods
for performing DDNS updates—the IETF standard defined by RFC 2136 and a generic HTTP method—the
ASA supports the IETF method.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
496
Guidelines for DHCP and DDNS Services
In general, the DHCP server maintains DNS PTR RRs on behalf of clients. Clients may be configured to
perform all desired DNS updates. The server may be configured to honor these updates or not. The DHCP
server must know the fully qualified domain name (FQDN) of the client to update the PTR RR. The client
provides an FQDN to the server using a DHCP option called Client FQDN.
If the three commands are present at the same time, the ASA allows the automatically configured length up
to the configured client or server maximum. For all other DNS traffic, the message-length maximum is used.
Firewall Mode
DHCP Relay is not supported in transparent firewall mode; DHCP Server is supported in transparent firewall
mode.
DDNS is not supported in transparent firewall mode.
IPv6
Does not support IPv6 for DHCP server; IPv6 for DHCP relay is supported.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
497
Configure the DHCP Server
DHCP Server
• The maximum available DHCP pool is 256 addresses.
• You can configure only one DHCP server on each interface. Each interface can have its own pool of
addresses to use. However the other DHCP settings, such as DNS servers, domain name, options, ping
timeout, and WINS servers, are configured globally and used by the DHCP server on all interfaces.
• You cannot configure a DHCP client or DHCP relay service on an interface on which the server is
enabled. Additionally, DHCP clients must be directly connected to the interface on which the server is
enabled.
• ASA does not support QIP DHCP servers for use with the DHCP proxy service.
• The relay agent cannot be enabled if the DHCP server is also enabled.
• The DHCP server does not support BOOTP requests.
DHCP Relay
• You can configure a maximum of 10 DHCPv4 relay servers in single mode and per context, global and
interface-specific servers combined, with a maximum of 4 servers per interface.
• You can configure a maximum of 10 DHCPv6 relay servers in single mode and per context.
Interface-specific servers for IPv6 are not supported.
• The relay agent cannot be enabled if the DHCP server feature is also enabled.
• DHCP relay services are not available in transparent firewall mode. You can, however, allow DHCP
traffic through using an access rule. To allow DHCP requests and replies through the ASA in transparent
mode, you need to configure two access rules, one that allows DCHP requests from the inside interface
to the outside (UDP destination port 67), and one that allows the replies from the server in the other
direction (UDP destination port 68).
• For IPv4, clients must be directly-connected to the ASA and cannot send requests through another relay
agent or a router. For IPv6, the ASA supports packets from another relay server.
• The DHCP clients must be on different interfaces from the DHCP servers to which the ASA relays
requests.
Procedure
Step 1 Enable the DHCP Server. See Enable the DHCP Server, on page 499.
Step 2 Configure advanced DHCP options. See Configure Advanced DHCP Options.
Step 3 Configure either a DHCPv4 relay agent or a DHCPv6 relay agent. See Configure the DHCPv4 Relay Agent,
on page 502 or Configure the DHCPv6 Relay Agent, on page 504.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
498
Configure the DHCP Server
Procedure
Step 1 Create a DHCP address pool. The ASA assigns a client one of the addresses from this pool to use for a given
period of time. These addresses are the local, untranslated addresses for the directly connected network.
dhcpd address ip_address if_name
Example:
ciscoasa(config)# dhcpd address 10.0.1.101-10.0.1.110 inside
The address pool must be on the same subnet as the ASA interface.
Example:
ciscoasa(config)# dhcpd dns 209.165.201.2 209.165.202.129
Step 3 (Optional) Specify the IP address(es) of the WINS server(s). You may specify up to two WINS servers.
dhcpd wins wins1 [wins2]
Example:
ciscoasa(config)# dhcpd wins 209.165.201.5
Step 4 (Optional) Change the lease length to be granted to the client. The lease length equals the amount of time in
seconds that the client can use its allocated IP address before the lease expires. Enter a value from 0 to
1,048,575. The default value is 3600 seconds.
dhcpd lease lease_length
Example:
ciscoasa(config)# dhcpd lease 3000
Example:
ciscoasa(config)# dhcpd domain example.com
Step 6 (Optional) Configure the DHCP ping timeout value for ICMP packets. To avoid address conflicts, the ASA
sends two ICMP ping packets to an address before assigning that address to a DHCP client.
dhcpd ping timeout milliseconds
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
499
Configure the DHCP Server
Example:
ciscoasa(config)# dhcpd ping timeout 20
Step 7 Define a default gateway that is sent to DHCP clients. If you do not use the dhcpd option 3 command to
define the default gateway, DHCP clients use the ASA interface IP address that is closest to the DHCP clients
by default; the ASA does not use the management interface IP address. As a result, the DHCP ACK does not
include this option.
Example:
ciscoasa(config)# dhcpd option 3 ip 10.10.1.1
Step 8 Enable the DHCP daemon within the ASA to listen for DHCP client requests on the enabled interface.
dhcpd enable interface_name
Example:
ciscoasa(config)# dhcpd enable outside
Procedure
Example:
ciscoasa(config)# dhcpd option 150 ip 10.10.1.1
ciscoasa(config)# dhcpd option 3 ip 10.10.1.10
Option 150 provides the IP address or names of one or two TFTP servers for use with Cisco IP phones. Option
3 sets the default route for Cisco IP phones.
Example:
ciscoasa(config)# dhcpd option 66 ascii exampleserver
Option 66 provides the IP address or name of a TFTP server for use with Cisco IP phones.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
500
Configure the DHCP Server
Example:
ciscoasa(config)# dhcpd option 2 hex 22.0011.01.FF1111.00FF.0000.AAAA.1111.1111.1111.11
Note The ASA does not verify that the option type and value that you provide match the expected type
and value for the option code as defined in RFC 2132. For example, you can enter the dhcpd option
46 ascii hello command, and the ASA accepts the configuration, although option 46 is defined in
RFC 2132 to expect a single-digit, hexadecimal value. For more information about option codes and
their associated types and expected values, see RFC 2132.
The following table shows the DHCP options that are not supported by the dhcpd option command.
1 HCPOPT_SUBNET_MASK
12 DHCPOPT_HOST_NAME
50 DHCPOPT_REQUESTED_ADDRESS
51 DHCPOPT_LEASE_TIME
52 DHCPOPT_OPTION_OVERLOAD
53 DHCPOPT_MESSAGE_TYPE
54 DHCPOPT_SERVER_IDENTIFIER
58 DHCPOPT_RENEWAL_TIME
59 DHCPOPT_REBINDING_TIME
61 DHCPOPT_CLIENT_IDENTIFIER
67 DHCPOPT_BOOT_FILE_NAME
82 DHCPOPT_RELAY_INFORMATION
255 DHCPOPT_END
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
501
Configure the DHCP Server
Procedure
• Specify the interface ID connected to the DHCP client network, and the DHCP server IP address to be
used for DHCP requests that enter that interface.
interface interface_id
dhcprelay server ip_address
Example:
Note that you do not specify the egress interface for the requests, as in the global dhcprelay server
command; instead, the ASA uses the routing table to determine the egress interface.
Step 2 Enable the DHCP relay service on the interface connected to the DHCP clients. You may enable DHCP relay
on multiple interfaces.
dhcprelay enable interface
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
502
Configure the DHCP Server
Example:
ciscoasa(config)# dhcprelay enable inside
ciscoasa(config)# dhcprelay enable dmz
ciscoasa(config)# dhcprelay enable eng1
ciscoasa(config)# dhcprelay enable eng2
ciscoasa(config)# dhcprelay enable mktg
Step 3 (Optional) Set the number of seconds allowed for DHCP relay address handling.
dhcprelay timeout seconds
Example:
ciscoasa(config)# dhcprelay timeout 25
Step 4 (Optional) Change the first default router address in the packet sent from the DHCP server to the address of
the ASA interface.
dhcprelay setroute interface_name
Example:
ciscoasa(config)# dhcprelay setroute inside
This action allows the client to set its default route to point to the ASA even if the DHCP server specifies a
different router.
If there is no default router option in the packet, the ASA adds one containing the interface address.
interface interface_id
dhcprelay information trusted
Example:
You can configure interfaces as trusted interfaces to preserve DHCP Option 82. DHCP Option 82 is
used by downstream switches and routers for DHCP snooping and IP Source Guard. Normally, if the
ASA DHCP relay agent receives a DHCP packet with Option 82 already set, but the giaddr field (which
specifies the DHCP relay agent address that is set by the relay agent before it forwards the packet to the
server) is set to 0, then the ASA will drop that packet by default. You can now preserve Option 82 and
forward the packet by identifying an interface as a trusted interface.
• Configure all client interfaces as trusted.
dhcprelay information trust-all
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
503
Configure DDNS
Example:
Procedure
Step 1 Specify the IPv6 DHCP server destination address to which client messages are forwarded.
ipv6 dhcprelay server ipv6_address [interface]
Example:
ciscoasa(config)# ipv6 dhcprelay server 3FFB:C00:C18:6:A8BB:CCFF:FE03:2701
The ipv6-address argument can be a link-scoped unicast, multicast, site-scoped unicast, or global IPv6 address.
Unspecified, loopback, and node-local multicast addresses are not allowed as the relay destination. The optional
interface argument specifies the egress interface for a destination. Client messages are forwarded to the
destination address through the link to which the egress interface is connected. If the specified address is a
link-scoped address, then you must specify the interface.
Example:
ciscoasa(config)# ipv6 dhcprelay enable inside
Step 3 (Optional) Specify the amount of time in seconds that is allowed for responses from the DHCPv6 server to
pass to the DHCPv6 client through the relay binding for relay address handling.
ipv6 dhcprelay timeout seconds
Example:
ciscoasa(config)# ipv6 dhcprelay timeout 25
Valid values for the seconds argument range from 1 to 3600. The default is 60 seconds.
Configure DDNS
This section describes how to configure DDNS.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
504
Configure DDNS
Procedure
Step 1 Create a DDNS update method that dynamically updates DNS RRs.
ddns update method name
Example:
ciscoasa(config)# ddns update method ddns-2
Step 2 Specify that the client update both the DNS A and PTR RRs.
ddns both
Example:
ciscoasa(DDNS-update-method)# ddns both
Example:
ciscoasa(DDNS-update-method)# interface eth1
Step 4 Associate the DDNS method with the interface and an update hostname.
ddns update [method-name | hostname hostname]
Example:
ciscoasa(config-if)# ddns update ddns-2
ciscoasa(config-if)# ddns update hostname asa.example.com
Example:
ciscoasa(config-if)# ip address 10.0.0.40 255.255.255.0
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
505
Configure DDNS
Procedure
Step 1 Configure the DHCP client to request that the DHCP server perform no updates.
dhcp-client update dns [server {both | none}]
Example:
ciscoasa(config)# dhcp-client update dns server none
Step 2 Create a DDNS update method that dynamically updates DNS RRs.
ddns update method name
Example:
ciscoasa(config)# ddns update method ddns-2
Step 3 Specify that the client update both the DNS A and PTR RRs.
ddns both
Example:
Example:
Example:
ciscoasa(DDNS-update-method)# interface Ethernet0
Step 5 Associate the DDNS method with the interface and an update hostname.
ddns update [method-name | hostname hostname]
Example:
ciscoasa(config-if)# ddns update ddns-2
ciscoasa(config-if)# ddns update hostname asa.example.com
Example:
ciscoasa(if-config)# ip address dhcp
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
506
Configure DDNS
Example:
ciscoasa(if-config)# dhcpd update dns
Procedure
Step 1 Create a DDNS update method that dynamically updates DNS RRs.
ddns update method name
Example:
ciscoasa(config)# ddns update method ddns-2
Step 2 Specify that the client updates both the DNS A and PTR RRs.
ddns both
Example:
ciscoasa(DDNS-update-method)# ddns both
Example:
ciscoasa(DDNS-update-method)# interface Ethernet0
Step 4 Associate the DDNS method with the interface and an update hostname.
ddns update [method-name | hostname hostname]
Example:
ciscoasa(config-if)# ddns update ddns-2
ciscoasa(config-if)# ddns update hostname asa.example.com
Step 5 Configure the DHCP client to request that the DHCP server perform no updates.
dhcp-client update dns [server {both | none}]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
507
Configure DDNS
Example:
ciscoasa(config)# dhcp-client update dns server none
Example:
ciscoasa(if-config)# ip address dhcp
Step 7 Configure the DHCP server to override the client update requests.
dhcpd update dns [both] [override] [interface srv_ifc_name]
Example:
ciscoasa(if-config)# dhcpd update dns both override
Procedure
Example:
ciscoasa(config)# interface Ethernet0
Step 2 Request that the DHCP server update both the DNS A and PTR RRs.
dhcp-client update dns [server {both | none}]
Example:
ciscoasa(config-if)# dhcp-client update dns both
Example:
ciscoasa(config-if)# ddns update hostname asa
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
508
Configure DDNS
Example:
ciscoasa(config-if)# dhcpd update dns
Step 5 Define the DNS domain name for DHCP clients.
dhcpd domain domain_name [interface if_name]
Example:
ciscoasa(config-if)# dhcpd domain example.com
Procedure
Step 1 Create a DDNS update method that dynamically updates DNS RRs.
ddns update method name
Example:
ciscoasa(config)# ddns update method ddns-2
Example:
ciscoasa(DDNS-update-method)# ddns both
Example:
ciscoasa(DDNS-update-method)# interface Ethernet0
Step 4 Configure the update parameters that the DHCP client passes to the DHCP server.
dhcp-client update dns [server {both | none}]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
509
Monitoring DHCP and DDNS Services
Example:
ciscoasa(config-if)# dhcp-client update dns
Step 5 Associate the DDNS method with the interface and an update hostname.
ddns update [method-name | hostname hostname]
Example:
ciscoasa(config-if)# ddns update ddns-2
ciscoasa(config-if)# ddns update hostname asa
Example:
ciscoasa(if-config)# dhcpd update dns
Example:
ciscoasa(config-if)# dhcpd domain example.com
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
510
History for DHCP and DDNS Services
DHCP relay for IPv6 9.0(1) DHCP relay support for IPv6 was added.
(DHCPv6) We introduced the following commands: ipv6 dhcprelay server, ipv6 dhcprelay enable,
ipv6 dhcprelay timeout, clear config ipv6 dhcprelay, ipv6 nd managed-config-flag,
ipv6 nd other-config-flag, debug ipv6 dhcp, debug ipv6 dhcprelay, show ipv6 dhcprelay
binding, clear ipv6 dhcprelay binding, show ipv6 dhcprelay statistics, and clear ipv6
dhcprelay statistics.
DHCP relay servers per 9.1(2) You can now configure DHCP relay servers per-interface, so requests that enter a given
interface (IPv4 only) interface are relayed only to servers specified for that interface. IPv6 is not supported for
per-interface DHCP relay.
We introduced or modified the following commands: dhcprelay server (interface config
mode), clear configure dhcprelay, show running-config dhcprelay.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
511
History for DHCP and DDNS Services
DHCP rebind function 9.1(4) During the DHCP rebind phase, the client now tries to rebind to other DHCP servers in
the tunnel group list. Before this release, the client did not rebind to an alternate server
when the DHCP lease fails to renew.
We did not introduce or modify any commands.
DHCP Relay server 9.2(4)/ 9.3(3) If the ASA DHCP relay server receives a reply from an incorrect DHCP server, it now
validates the DHCP verifies that the reply is from the correct server before acting on the reply. We did not
Server identifier for introduce or modify any commands. We did not modify any ASDM screens.
replies We did not introduce or modify any commands.
DHCPv6 monitoring 9.4(1) You can now monitor DHCP statistics for IPv6 and DHCP bindings for IPv6.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
512
CHAPTER 19
Digital Certificates
This chapter describes how to configure digital certificates.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
513
About Digital Certificates
The local CA integrates an independent certificate authority feature on the ASA, deploys certificates, and
provides secure revocation checking of issued certificates. The local CA provides a secure, configurable,
in-house authority for certificate authentication with user enrollment through a website login page.
Note CA certificates and identity certificates apply to both site-to-site VPN connections and remote access VPN
connections. Procedures in this document refer to remote access VPN use in the ASDM GUI.
Digital certificates provide digital identification for authentication. A digital certificate includes information
that identifies a device or user, such as the name, serial number, company, department, or IP address. CAs
are trusted authorities that “sign” certificates to verify their authenticity, thereby guaranteeing the identity of
the device or user. CAs issue digital certificates in the context of a PKI, which uses public-key or private-key
encryption to ensure security.
For authentication using digital certificates, at least one identity certificate and its issuing CA certificate must
exist on an ASA. This configuration allows multiple identities, roots, and certificate hierarchies. Descriptions
of several different types of available digital certificates follow:
• A CA certificate is used to sign other certificates. It is self-signed and called a root certificate.
• A certificate that is issued by another CA certificate is called a subordinate certificate.
CAs are responsible for managing certificate requests and issuing digital certificates. A digital certificate
includes information that identifies a user or device, such as a name, serial number, company, department, or
IP address. A digital certificate also includes a copy of the public key for the user or device. A CA can be a
trusted third party, such as VeriSign, or a private (in-house) CA that you establish within your organization.
Tip For an example of a scenario that includes certificate configuration and load balancing, see the following
URL: https://supportforums.cisco.com/docs/DOC-5964.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
514
About Digital Certificates
Certificate Scalability
Without digital certificates, you must manually configure each IPsec peer for each peer with which it
communicates; as a result, each new peer that you add to a network would require a configuration change on
each peer with which it needs to communicate securely.
When you use digital certificates, each peer is enrolled with a CA. When two peers try to communicate, they
exchange certificates and digitally sign data to authenticate each other. When a new peer is added to the
network, you enroll that peer with a CA and none of the other peers need modification. When the new peer
attempts an IPsec connection, certificates are automatically exchanged and the peer can be authenticated.
With a CA, a peer authenticates itself to the remote peer by sending a certificate to the remote peer and
performing some public key cryptography. Each peer sends its unique certificate, which was issued by the
CA. This process works because each certificate encapsulates the public key for the associated peer, each
certificate is authenticated by the CA, and all participating peers recognize the CA as an authenticating
authority. The process is called IKE with an RSA signature.
The peer can continue sending its certificate for multiple IPsec sessions, and to multiple IPsec peers, until the
certificate expires. When its certificate expires, the peer administrator must obtain a new one from the CA.
CAs can also revoke certificates for peers that no longer participate in IPsec. Revoked certificates are not
recognized as valid by other peers. Revoked certificates are listed in a CRL, which each peer may check before
accepting a certificate from another peer.
Some CAs have an RA as part of their implementation. An RA is a server that acts as a proxy for the CA, so
that CA functions can continue when the CA is unavailable.
Key Pairs
Key pairs are RSA keys, which have the following characteristics:
• RSA keys can be used for SSH or SSL.
• SCEP enrollment supports the certification of RSA keys.
• For the purposes of generating keys, the maximum key modulus for RSA keys is 2048 bits. The default
size is 1024. Many SSL connections using identity certificates with RSA key pairs that exceed 1024
bits can cause a high CPU usage on the ASA and rejected clientless logins.
• For signature operations, the supported maximum key size is 4096 bits. We recommend using a key size
of at least 2048.
• You can generate a general purpose RSA key pair, used for both signing and encryption, or you can
generate separate RSA key pairs for each purpose. Separate signing and encryption keys help to reduce
exposure of the keys, because SSL uses a key for encryption but not signing. However, IKE uses a key
for signing but not encryption. By using separate keys for each, exposure of the keys is minimized.
Trustpoints
Trustpoints let you manage and track CAs and certificates. A trustpoint is a representation of a CA or identity
pair. A trustpoint includes the identity of the CA, CA-specific configuration parameters, and an association
with one, enrolled identity certificate.
After you have defined a trustpoint, you can reference it by name in commands requiring that you specify a
CA. You can configure many trustpoints.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
515
About Digital Certificates
Note If the Cisco ASA has multiple trustpoints that share the same CA, only one of these trustpoints sharing
the CA can be used to validate user certificates. To control which trustpoint sharing a CA is used for
validation of user certificates issued by that CA, use the support-user-cert-validation command.
For automatic enrollment, a trustpoint must be configured with an enrollment URL, and the CA that the
trustpoint represents must be available on the network and must support SCEP.
You can export and import the keypair and issued certificates associated with a trustpoint in PKCS12 format.
This format is useful to manually duplicate a trustpoint configuration on a different ASA.
Certificate Enrollment
The ASA needs a CA certificate for each trustpoint and one or two certificates for itself, depending upon the
configuration of the keys used by the trustpoint. If the trustpoint uses separate RSA keys for signing and
encryption, the ASA needs two certificates, one for each purpose. In other key configurations, only one
certificate is needed.
The ASA supports automatic enrollment with SCEP and with manual enrollment, which lets you paste a
base-64-encoded certificate directly into the terminal. For site-to-site VPNs, you must enroll each ASA. For
remote access VPNs, you must enroll each ASA and each remote access VPN client.
Revocation Checking
When a certificate is issued, it is valid for a fixed period of time. Sometimes a CA revokes a certificate before
this time period expires; for example, because of security concerns or a change of name or association. CAs
periodically issue a signed list of revoked certificates. Enabling revocation checking forces the ASA to check
that the CA has not revoked a certificate each time that it uses the certificate for authentication.
When you enable revocation checking, the ASA checks certificate revocation status during the PKI certificate
validation process, which can use either CRL checking, OCSP, or both. OCSP is only used when the first
method returns an error (for example, indicating that the server is unavailable).
With CRL checking, the ASA retrieves, parses, and caches CRLs, which provide a complete list of revoked
(and unrevoked) certificates with their certificate serial numbers. The ASA evaluates certificates according
to CRLs, also called authority revocation lists, from the identity certificate up the chain of subordinate certificate
authorities.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
516
About Digital Certificates
OCSP offers a more scalable method of checking revocation status in that it localizes certificate status through
a validation authority, which it queries for status of a specific certificate.
Supported CA Servers
The ASA supports the following CA servers:
Cisco IOS CS, ASA Local CA, and third-party X.509 compliant CA vendors including, but not limited to:
• Baltimore Technologies
• Entrust
• Digicert
• Geotrust
• GoDaddy
• iPlanet/Netscape
• Microsoft Certificate Services
• RSA Keon
• Thawte
• VeriSign
CRLs
CRLs provide the ASA with one way of determining whether a certificate that is within its valid time range
has been revoked by the issuing CA. CRL configuration is part of configuration of a trustpoint.
You can configure the ASA to make CRL checks mandatory when authenticating a certificate by using the
revocation-check crl command. You can also make the CRL check optional by using the revocation-check
crl none command, which allows the certificate authentication to succeed when the CA is unavailable to
provide updated CRL data.
The ASA can retrieve CRLs from CAs using HTTP, SCEP, or LDAP. CRLs retrieved for each trustpoint are
cached for a configurable amount of time for each trustpoint.
When the ASA has cached a CRL for longer than the amount of time it is configured to cache CRLs, the ASA
considers the CRL too old to be reliable, or “stale.” The ASA tries to retrieve a newer version of the CRL the
next time that a certificate authentication requires a check of the stale CRL.
The ASA caches CRLs for an amount of time determined by the following two factors:
• The number of minutes specified with the cache-time command. The default value is 60 minutes.
• The NextUpdate field in the CRLs retrieved, which may be absent from CRLs. You control whether the
ASA requires and uses the NextUpdate field with the enforcenextupdate command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
517
About Digital Certificates
• If the NextUpdate field is required, the ASA marks CRLs as stale at the sooner of the two times specified
by the cache-time command and the NextUpdate field. For example, if the cache-time command is set
to 100 minutes and the NextUpdate field specifies that the next update is 70 minutes away, the ASA
marks CRLs as stale in 70 minutes.
If the ASA has insufficient memory to store all CRLs cached for a given trustpoint, it deletes the least recently
used CRL to make room for a newly retrieved CRL.
OCSP
OCSP provides the ASA with a way of determining whether a certificate that is within its valid time range
has been revoked by the issuing CA. OCSP configuration is part of trustpoint configuration.
OCSP localizes certificate status on a validation authority (an OCSP server, also called the responder) which
the ASA queries for the status of a specific certificate. This method provides better scalability and more
up-to-date revocation status than does CRL checking, and helps organizations with large PKI installations
deploy and expand secure networks.
Note The ASA allows a five-second time skew for OCSP responses.
You can configure the ASA to make OCSP checks mandatory when authenticating a certificate by using the
revocation-check ocsp command. You can also make the OCSP check optional by using the revocation-check
ocsp none command, which allows the certificate authentication to succeed when the validation authority is
unavailable to provide updated OCSP data.
OCSP provides three ways to define the OCSP server URL. The ASA uses these servers in the following
order:
1 The OCSP URL defined in a match certificate override rule by using the match certificate command).
2 The OCSP URL configured by using the ocsp url command.
3 The AIA field of the client certificate.
Note To configure a trustpoint to validate a self-signed OCSP responder certificate, you import the self-signed
responder certificate into its own trustpoint as a trusted CA certificate. Then you configure the match
certificate command in the client certificate validating trustpoint to use the trustpoint that includes the
self-signed OCSP responder certificate to validate the responder certificate. Use the same procedure for
configuring validating responder certificates external to the validation path of the client certificate.
The OCSP server (responder) certificate usually signs the OCSP response. After receiving the response,
the ASA tries to verify the responder certificate. The CA normally sets the lifetime of the OCSP responder
certificate to a relatively short period to minimize the chance of being compromised. The CA usually also
includes an ocsp-no-check extension in the responder certificate, which indicates that this certificate does
not need revocation status checking. However, if this extension is not present, the ASA tries to check
revocation status using the same method specified in the trustpoint. If the responder certificate is not
verifiable, revocation checks fail. To avoid this possibility, use the revocation-check none command to
configure the responder certificate validating trustpoint, and use the revocation-check ocsp command to
configure the client certificate.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
518
About Digital Certificates
The Local CA
The local CA performs the following tasks:
• Integrates basic certificate authority operation on the ASA.
• Deploys certificates.
• Provides secure revocation checking of issued certificates.
• Provides a certificate authority on the ASA for use with browser-based and client-based SSL VPN
connections.
• Provides trusted digital certificates to users, without the need to rely on external certificate authorization.
• Provides a secure, in-house authority for certificate authentication and offers straightforward user
enrollment by means of a website login.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
519
About Digital Certificates
and configuration files are maintained either on the ASA flash memory (default storage) or on a separate
storage device.
• Authorization
◦Enabled by the authorization server group setting in the tunnel group (also called ASDM Connection
Profile)
◦Uses the username as a credential
Certificates
If user digital certificates are configured, the ASA first validates the certificate. It does not, however, use any
of the DNs from certificates as a username for the authentication.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
520
Guidelines for Digital Certificates
If both authentication and authorization are enabled, the ASA uses the user login credentials for both user
authentication and authorization.
• Authentication
◦Enabled by the authentication server group setting
◦Uses the username and password as credentials
• Authorization
◦Enabled by the authorization server group setting
◦Uses the username as a credential
If authentication is disabled and authorization is enabled, the ASA uses the primary DN field for authorization.
• Authentication
◦DISABLED (set to None) by the authentication server group setting
◦No credentials used
• Authorization
◦Enabled by the authorization server group setting
◦Uses the username value of the certificate primary DN field as a credential
Note If the primary DN field is not present in the certificate, the ASA uses the secondary DN field value as the
username for the authorization request.
For example, consider a user certificate that includes the following Subject DN fields and values:
Cn=anyuser,OU=sales;O=XYZCorporation;L=boston;S=mass;C=us;[email protected]
If the Primary DN = EA (E-mail Address) and the Secondary DN = CN (Common Name), then the username
used in the authorization request would be [email protected].
Failover Guidelines
• Does not support replicating sessions in Stateful Failover.
• Does not support failover for local CAs.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
521
Guidelines for Digital Certificates
IPv6 Guidelines
Does not support IPv6.
Local CA Certificates
• Make sure that the ASA is configured correctly to support certificates. An incorrectly configured ASA
can cause enrollment to fail or request a certificate that includes inaccurate information.
• Make sure that the hostname and domain name of the ASA are configured correctly. To view the currently
configured hostname and domain name, enter the show running-config command.
• Make sure that the ASA clock is set accurately before configuring the CA. Certificates have a date and
time that they become valid and expire. When the ASA enrolls with a CA and obtains a certificate, the
ASA checks that the current time is within the valid range for the certificate. If it is outside that range,
enrollment fails.
• Thirty days before the local CA certificate expires, a rollover replacement certificate is generated, and
a syslog message informs the administrator that it is time for local CA rollover. The new local CA
certificate must be imported onto all necessary devices before the current certificate expires. If the
administrator does not respond by installing the rollover certificate as the new local CA certificate,
validations may fail.
• The local CA certificate rolls over automatically after expiration using the same keypair. The rollover
certificate is available for export in base 64 format.
The following example shows a base 64 encoded local CA certificate:
MIIXlwIBAzCCF1EGCSqGSIb3DQEHAaCCF0IEghc+MIIXOjCCFzYGCSqGSIb3DQEHBqCCFycwghcjAgEAMIIXHA
YJKoZIhvcNAQcBMBsGCiqGSIb3DQEMAQMwDQQIjph4SxJoyTgCAQGAghbw3v4bFy+GGG2dJnB4OLphsUM+IG3S
DOiDwZG9n1SvtMieoxd7Hxknxbum06JDrujWKtHBIqkrm+td34qlNE1iGeP2YC94/NQ2z+4kS+uZzwcRhl1KEZ
TS1E4L0fSaC3uMTxJq2NUHYWmoc8pi4CIeLj3h7VVMy6qbx2AC8I+q57+QG5vG5l5Hi5imwtYfaWwPEdPQxaWZ
PrzoG1J8BFqdPa1jBGhAzzuSmElm3j/2dQ3Atro1G9nIsRHgV39fcBgwz4fEabHG7/Vanb+fj81d5nlOiJjDYY
bP86tvbZ2yOVZR6aKFVI0b2AfCr6PbwfC9U8Z/aF3BCyM2sN2xPJrXva94CaYrqyotZdAkSYA5KWScyEcgdqmu
BeGDKOncTknfgy0XM+fG5rb3qAXy1GkjyFI5Bm9Do6RUROoG1DSrQrKeq/hj….
END OF CERTIFICATE
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
522
Guidelines for Digital Certificates
• The LOCAL-CA-SERVER.p12 file is the archive of the local CA certificate and keypair that is generated
when the local CA server is initially enabled.
• The LOCAL-CA-SERVER.crl file is the actual CRL.
• The LOCAL-CA-SERVER.ser file keeps track of the issued certificate serial numbers.
Additional Guidelines
• For ASAs that are configured as CA servers or clients, limit the validity period of the certificate to less
than the recommended end date of 03:14:08 UTC, January 19, 2038. This guideline also applies to
imported certificates from third-party vendors.
• You cannot configure the local CA when failover is enabled. You can only configure the local CA server
for standalone ASAs without failover. For more information, see CSCty43366.
• When a certificate enrollment is completed, the ASA stores a PKCS12 file containing the user's keypair
and certificate chain, which requires about 2 KB of flash memory or disk space per enrollment. The
actual amount of disk space depends on the configured RSA key size and certificate fields. Keep this
guideline in mind when adding a large number of pending certificate enrollments on an ASA with a
limited amount of available flash memory, because these PKCS12 files are stored in flash memory for
the duration of the configured enrollment retrieval timeout. We recommend using a key size of at least
2048.
• The lifetime ca-certificate command takes effect when the local CA server certificate is first generated
(that is, when you initially configure the local CA server and issue the no shutdown command). When
the CA certificate expires, the configured lifetime value is used to generate the new CA certificate. You
cannot change the lifetime value for existing CA certificates.
• You should configure the ASA to use an identity certificate to protect ASDM traffic and HTTPS traffic
to the management interface. Identity certificates that are automatically generated with SCEP are
regenerated after each reboot, so make sure that you manually install your own identity certificates. For
an example of this procedure that applies only to SSL, see the following URL: http://www.cisco.com/
en/US/products/ps6120/products_configuration_example09186a00809fcf91.shtml.
• The ASA and the AnyConnect clients can only validate certificates in which the X520Serialnumber
field (the serial number in the Subject Name) is in PrintableString format. If the serial number format
uses encoding such as UTF8, the certificate authorization will fail.
• Use only valid characters and values for certificate parameters when you import them on the ASA.
• To use a wildcard (*) symbol, make sure that you use encoding on the CA server that allows this character
in the string value. Although RFC 5280 recommends using either a UTF8String or PrintableString, you
should use UTF8String because PrintableString does not recognize the wildcard as a valid character.
The ASA rejects the imported certificate if an invalid character or value is found during the import. For
example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
523
Configure Digital Certificates
Procedure
Example:
ciscoasa/contexta(config)# crypto key generate rsa
The default key modulus is 1024. To specify other modulus sizes, use the modulus keyword.
Note Many SSL connections using identity certificates with RSA key pairs that exceed 1024 bits can cause
high CPU usage on the ASA and rejected clientless logins.
Step 2 (Optional) Assign a label to each key pair.
crypto key generate rsa label key-pair-label
Example:
ciscoasa/contexta(config)# crypto key generate rsa label exchange
The label is referenced by the trustpoint that uses the key pair. If you do not assign a label, the key pair is
automatically labeled, Default-RSA-Key.
Example:
ciscoasa/contexta(config)# show crypto key examplekey
Example:
ciscoasa(config)# write memory
Step 5 If necessary, remove existing key pairs so that you can generate new ones.
crypto key zeroize rsa
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
524
Configure Digital Certificates
Example:
ciscoasa(config)# crypto key zeroize rsa
Step 6 (Optional) Archive the local CA server certificate and key pair.
copy
Example:
ciscoasa# copy LOCAL-CA-SERVER_0001.pl2 tftp://10.1.1.22/user6/
This command copies the local CA server certificate and key pair and all files from the ASA using either FTP
or TFTP.
Note Make sure that you back up all local CA files as often as possible.
Example
The following example shows how to remove key pairs:
ciscoasa(config)# crypto key zeroize rsa
WARNING: All RSA keys will be removed.
WARNING: All device certs issued using these keys will also be removed.
Configure Trustpoints
To configure a trustpoint, perform the following steps:
Procedure
Step 1 Create a trustpoint that corresponds to the CA from which the ASA needs to receive a certificate.
crypto ca trustpoint trustpoint-name
Example:
ciscoasa/contexta(config)# crypto ca trustpoint Main
You enter the crypto ca trustpoint configuration mode, which controls CA-specific trustpoint parameters that
you may configure starting in Step 3.
Note When you try to connect, a warning occurs to indicate that the trustpoint does not contain an ID
certificate when an attempt is made to retrieve the ID certificate from the trustpoint.
Step 2 Choose one of the following options:
• Request automatic enrollment using SCEP with the specified trustpoint and configures the enrollment
URL.
enrollment url url
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
525
Configure Digital Certificates
Example:
• Request manual enrollment with the specified trustpoint by pasting the certificate received from the CA
into the terminal.
enrollment terminal
Example:
ciscoasa/contexta(config-ca-trustpoint)# revocation-check crl none
ciscoasa/contexta(config-ca-trustpoint)# revocation-check crl
ciscoasa/contexta(config-ca-trustpoint)# revocation-check none
Note To enable either required or optional CRL checking, make sure that you configure the trustpoint for
CRL management after obtaining certificates.
Step 4 Enter crl configuration mode.
crl configure
Example:
ciscoasa/contexta(config-ca-trustpoint)# crl configure
Step 5 During enrollment, ask the CA to include the specified e-mail address in the Subject Alternative Name
extension of the certificate.
email address
Example:
ciscoasa/contexta(config-ca-trustpoint)# email example.com
Step 6 (Optional) Specify a retry period in minutes, and applies only to SCEP enrollment.
enrollment retry period
Example:
ciscoasa/contexta(config-ca-trustpoint)# enrollment retry period 5
Step 7 (Optional) Specify a maximum number of permitted retries, and applies only to SCEP enrollment.
enrollment retry count
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
526
Configure Digital Certificates
Example:
ciscoasa/contexta(config-ca-trustpoint)# enrollment retry period 2
Step 8 During enrollment, ask the CA to include the specified fully qualified domain name in the Subject Alternative
Name extension of the certificate.
fqdn fqdn
Example:
ciscoasa/contexta(config-ca-trustpoint)# fqdn example.com
Step 9 During enrollment, ask the CA to include the IP address of the ASA in the certificate.
ip-address ip-address
Example:
ciscoasa/contexta(config-ca-trustpoint)# ip-address 10.10.100.1
Example:
ciscoasa/contexta(config-ca-trustpoint)# keypair exchange
Step 11 Configure OCSP URL overrides and trustpoints to use for validating OCSP responder certificates.
match certificate map-name override ocsp
Example:
ciscoasa/contexta(config-ca-trustpoint)# match certificate examplemap override ocsp
Step 12 Disable the nonce extension on an OCSP request. The nonce extension cryptographically binds requests with
responses to avoid replay attacks.
ocsp disable-nonce
Example:
ciscoasa/contexta(config-ca-trustpoint)# ocsp disable-nonce
Step 13 Configure an OCSP server for the ASA to use to check all certificates associated with a trustpoint rather than
the server specified in the AIA extension of the client certificate.
ocsp url
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
527
Configure Digital Certificates
Example:
ciscoasa/contexta(config-ca-trustpoint)# ocsp url
Step 14 Specify a challenge phrase that is registered with the CA during enrollment. The CA usually uses this phrase
to authenticate a subsequent revocation request.
password string
Example:
ciscoasa/contexta(config-ca-trustpoint)# password mypassword
Step 15 Set one or more methods for revocation checking: CRL, OCSP, and none.
revocation check
Example:
ciscoasa/contexta(config-ca-trustpoint)# revocation check
Step 16 During enrollment, ask the CA to include the specified subject DN in the certificate. If a DN string includes
a comma, enclose the value string within double quotes (for example, O=”Company, Inc.”).
subject-name X.500 name
Example:
ciscoasa/contexta(config-ca-trustpoint)# myname X.500 examplename
Step 17 During enrollment, ask the CA to include the ASA serial number in the certificate.
serial-number
Example:
ciscoasa/contexta(config-ca-trustpoint)# serial number JMX1213L2A7
Example:
ciscoasa/contexta(config)# write memory
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
528
Configure Digital Certificates
Procedure
Step 1 Enter crypto ca trustpoint configuration mode for the trustpoint whose CRL configuration you want to modify.
crypto ca trustpoint trustpoint-name
Example:
ciscoasa (config)# crypto ca trustpoint Main
Note Make sure that you have enabled CRLs before entering this command. In addition, the CRL must be
available for authentication to succeed.
Step 2 Enter crl configuration mode for the current trustpoint.
crl configure
Example:
ciscoasa(config-ca-trustpoint)# crl configure
Tip To set all CRL configuration parameters to default values, use the default command. At any time
during CRL configuration, reenter this command to restart the procedure.
Step 3 Choose one of the following to configure retrieval policy:
• CRLs are retrieved only from the CRL distribution points that are specified in authenticated certificates.
policy cdp
• CRLs are retrieved from CRL distribution points specified in authenticated certificates and from URLs
that you configure.
policy both
Step 4 If you used the static or both keywords when you configured the CRL policy, you must configure URLs for
CRL retrieval. You can enter up to five URLs, ranked 1 through 5. The n argument is the rank assigned to
the URL.
url n url
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
529
Configure Digital Certificates
Example:
ciscoasa (config-ca-crl)# url 2 http://www.example.com
Example:
ciscoasa(config-ca-crl)# protocol http
Step 6 Configure how long the ASA caches CRLs for the current trustpoint. The refresh-time argument is the number
of minutes that the ASA waits before considering a CRL stale.
cache-time refresh-time
Example:
ciscoasa(config-ca-crl)# cache-time 420
ciscoasa(config-ca-crl)# enforcenextupdate
ciscoasa(config-ca-crl)# no enforcenextupdate
Step 8 Identify the LDAP server to the ASA if LDAP is specified as the retrieval protocol. You can specify the server
by DNS hostname or by IP address. You can also provide a port number if the server listens for LDAP queries
on a port other than the default of 389.
ldap-defaults server
Example:
ciscoasa (config-ca-crl)# ldap-defaults ldap1
Note If you use a hostname instead of an IP address to specify the LDAP server, make sure that you have
configured the ASA to use DNS.
Step 9 Allow CRL retrieval if the LDAP server requires credentials.
ldap-dn admin-DN password
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
530
Configure Digital Certificates
Example:
ciscoasa (config-ca-crl)# ldap-dn cn=admin,ou=devtest,o=engineering c00lRunZ
Step 10 Retrieve the current CRL from the CA represented by the specified trustpoint and test the CRL configuration
for the current trustpoint.
crypto ca crl request trustpoint
Example:
ciscoasa (config-ca-crl)# crypto ca crl request Main
Example:
ciscoasa (config)# write memory
Procedure
Step 1 Export a trustpoint configuration with all associated keys and certificates in PKCS12 format.
crypto ca export trustpoint
Example:
ciscoasa(config)# crypto ca export Main
The ASA displays the PKCS12 data in the terminal. You can copy the data. The trustpoint data is password
protected; however, if you save the trustpoint data in a file, make sure that the file is in a secure location.
Step 2 Import keypairs and issued certificates that are associated with a trustpoint configuration.
crypto ca import trustpoint pkcs12
Example:
ciscoasa(config)# crypto ca import Main pkcs12
The ASA prompts you to paste the text into the terminal in base 64 format. The key pair imported with the
trustpoint is assigned a label that matches the name of the trustpoint that you create.
Note If an ASA has trustpoints that share the same CA, you can use only one of the trustpoints that share
the CA to validate user certificates. To control which trustpoint that shares a CA is used for validation
of user certificates issued by that CA, use the support-user-cert-validation keyword.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
531
Configure Digital Certificates
Examples
The following example exports PKCS12 data for the trustpoint Main with the passphrase Wh0zits:
The following example manually imports PKCS12 data to the trustpoint Main with the passphrase Wh0zits:
ciscoasa (config)# crypto ca import Main pkcs12 Wh0zits
The following example manually imports a certificate for the trustpoint Main:
Procedure
Step 1 Enter CA certificate map configuration mode for the rule you want to configure and specify the rule index
number.
crypto ca certificate map sequence-number
Example:
ciscoasa(config)# crypto ca certificate map 1
Step 2 Specify the distinguished name of all issued certificates. which is also the subject-name DN of the self-signed
CA certificate.
issuer-name DN-string
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
532
Configure Digital Certificates
Example:
ciscoasa(config-ca-cert-map)# issuer-name cn=asa.example.com
Step 3 Use commas to separate attribute-value pairs. Insert quotation marks around any value that includes a comma.
An issuer-name must be less than 500 alphanumeric characters. The default issuer-name is
cn=hostame.domain-name.
Specify tests that the ASA can apply to values found in the Subject field of certificates.
subject-name attr tag eq | co | ne | nc string
Example:
ciscoasa(config-ca-cert-map)# subject-name attr cn eq mycert
The tests can apply to specific attributes or to the entire field. You can configure many tests per rule, and all
the tests you specify with these commands must be true for a rule to match a certificate. The following are
valid operators:
• eq—The field or attribute must be identical to the value given.
• ne—The field or attribute cannot be identical to the value given.
• co—Part or all of the field or attribute must match the value given.
• nc—No part of the field or attribute can match the value given.
Example:
ciscoasa(config)# write memory
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
533
Configure Digital Certificates
Example:
ciscoasa(config)# crypto ca authenticate Main
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line by itself
MIIDRTCCAu+gAwIBAgIQKVcqP/KW74VP0NZzL+JbRTANBgkqhkiG9w0BAQUFADCB
[ certificate data omitted ]
/7QEM8izy0EOTSErKu7Nd76jwf5e4qttkQ==
quit
Whether a trustpoint requires that you manually obtain certificates is determined by the use of the enrollment
terminal command when you configure the trustpoint.
Example:
ciscoasa(config)# crypto ca enroll Main
% Start certificate enrollment ..
MIIBoDCCAQkCAQAwIzEhMB8GCSqGSIb3DQEJAhYSRmVyYWxQaXguY2lzY28uY29t
[ certificate request data omitted ]
jF4waw68eOxQxVmdgMWeQ+RbIOYmvt8g6hnBTrd0GdqjjVLt
This command generates a certificate for signing data and depending on the type of keys that you have
configured, for encrypting data. If you use separate RSA keys for signing and encryption, the crypto ca enroll
command displays two certificate requests, one for each key. If you use general-purpose RSA keys for both
signing and encryption, the crypto ca enroll command displays one certificate request.
To complete enrollment, obtain a certificate for all certificate requests generated by the crypto ca enroll
command from the CA represented by the applicable trustpoint. Make sure that the certificate is in base-64
format.
Step 3 Import each certificate you receive from the CA and make sure that you paste the certificate to the terminal
in base-64 format.
crypto ca import trustpoint certificate
Example:
ciscoasa (config)# crypto ca import Main certificate
% The fully-qualified domain name in the certificate will be: securityappliance.example.com
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
534
Configure Digital Certificates
Step 4 Verify that the enrollment process was successful by displaying certificate details issued for the ASA and the
CA certificate for the trustpoint.
show crypto ca server certificate
Example:
ciscoasa(config)# show crypto ca server certificate Main
Example:
ciscoasa(config)# write memory
Step 6 Repeat these steps for each trustpoint that you configure for manual enrollment.
Procedure
Example:
ciscoasa/contexta(config)# crypto ca authenticate Main
When you configure the trustpoint, use of the enrollment url command determines whether or not you must
obtain certificates automatically via SCEP.
Step 2 Enroll the ASA with the trustpoint. This command retrieves a certificate for signing data and depending on
the type of keys that you have configured, for encrypting data. Before entering this command, contact the CA
administrator, who may need to authenticate the enrollment request manually before the CA grants certificates.
crypto ca enroll trustpoint
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
535
Configure Digital Certificates
Example:
ciscoasa/contexta(config)# crypto ca enroll Main
If the ASA does not receive a certificate from the CA within one minute (the default) of sending a certificate
request, it resends the certificate request. The ASA continues sending a certificate request each minute until
a certificate is received.
If the fully qualified domain name configured for the trustpoint is not identical to the fully qualified domain
name of the ASA, including the case of the characters, a warning appears. To resolve this issue, exit the
enrollment process, make any necessary corrections, and reenter the crypto ca enroll command.
Note If the ASA reboots after you have issued the crypto ca enroll command but before you have received
the certificate, reenter the crypto ca enroll command and notify the CA administrator.
Step 3 Verify that the enrollment process was successful by displaying certificate details issued for the ASA and the
CA certificate for the trustpoint.
show crypto ca server certificate
Example:
ciscoasa/contexta(config)# show crypto ca server certificate Main
Example:
ciscoasa/contexta(config)# write memory
Procedure
Example:
ciscoasa(config)# tunnel-group remotegrp ipsec-attributes
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
536
Configure Digital Certificates
Example:
ciscoasa(config-tunnel-ipsec)# crypto ikev2 enable outside client-services
Example:
ciscoasa(config)# tunnel-group 209.165.200.225 general-attributes
Example:
Example:
ciscoasa(config)# group-policy FirstGroup attributes
Step 6 Enroll the SCEP CA for the group policy. Enter this command once per group policy to support a third-party
digital certificate.
scep-forwarding-url value URL
Example:
ciscoasa(config-group-policy)# scep-forwarding-url value http://ca.example.com:80/
Step 7 Supply a common, secondary password when a certificate is unavailable for WebLaunch support of the SCEP
proxy.
secondary-pre-fill-username clientless hide use-common-password password
Example:
ciscoasa(config)# tunnel-group remotegrp webvpn-attributes
ciscoasa(config-tunnel-webvpn)# secondary-pre-fill-username clientless hide
use-common-password secret
You must use the hide keyword to support the SCEP proxy.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
537
Configure Digital Certificates
For example, a certificate is not available to an endpoint requesting one. Once the endpoint has the certificate,
AnyConnect disconnects, then reconnects to the ASA to qualify for a DAP policy that provides access to
internal network resources.
Step 8 Hide the secondary prefill username for AnyConnect VPN sessions.
secondary-pre-fill-username ssl-client hide use-common-password password
Example:
ciscoasa(config-tunnel-webvpn)# secondary-pre-fill-username ssl-client hide
use-common-password secret
Despite the ssl-client keyword inherited from earlier releases, use this command to support AnyConnect
sessions that use either IKEv2 or SSL.
You must use the hide keyword to support the SCEP proxy.
Example:
ciscoasa(config-tunnel-webvpn)# secondary-username-from-certificate CN no-certificate-fallback
cisco-secure-desktop machine-unique-id
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Determine the expiration date to be included in the certificate. The default lifetime of a local CA certificate
is three years.
lifetime ca-certificate time
Example:
ciscoasa(config-ca-server)# lifetime ca-certificate 365
Make sure that you limit the validity period of the certificate to less than the recommended end date of 03:14:08
UTC, January 19, 2038.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
538
Configure Digital Certificates
Step 3 (Optional) Reset the local CA certificate lifetime to the default value of three years.
no lifetime ca-certificate
Example:
ciscoasa(config-ca-server)# no lifetime ca-certificate
The local CA server automatically generates a replacement CA certificate 30 days before it expires, which
allows the replacement certificate to be exported and imported onto any other devices for certificate validation
of user certificates that have been issued by the local CA certificate after the current local CA certificate has
expired. The following pre-expiration syslog message is generated:
%ASA-1-717049: Local CA Server certificate is due to expire in days days and a replacement
certificate is available for export.
Note When notified of this automatic rollover, the administrator must make sure that the new local CA
certificate is imported onto all required devices before it expires.
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Set the length of time that you want user certificates to remain valid.
lifetime certificate time
Example:
ciscoasa(config-ca-server)# lifetime certificate 60
Note Before a user certificate expires, the local CA server automatically initiates certificate renewal
processing by granting enrollment privileges to the user several days ahead of the certificate expiration
date, setting renewal reminders, and delivering an e-mail message that includes the enrollment
username and OTP for certificate renewal. Make sure that you limit the validity period of the certificate
to less than the recommended end date of 03:14:08 UTC, January 19, 2038.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
539
Configure Digital Certificates
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Set the length of time that you want the CRL to remain valid.
lifetime crl time
Example:
ciscoasa(config-ca-server)# lifetime crl 10
The local CA updates and reissues the CRL each time that a user certificate is revoked or unrevoked, but if
no revocation changes occur, the CRL is reissued automatically once each CRL lifetime. If you do not specify
a CRL lifetime, the default time period is six hours.
Step 3 Force the issuance of a CRL at any time, which immediately updates and regenerates a current CRL to overwrite
the existing CRL.
crypto ca server crl issue
Example:
ciscoasa(config-ca-server)# crypto ca server crl issue
Note Do not use this command unless the CRL file has been removed in error or has been corrupted and
must be regenerated.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
540
How to Set Up Specific Certificate Types
Example:
ciscoasa(config)# crypto ca server
Step 2 Specify the size of the public and private keys generated at user-certificate enrollment.
keysize server
Example:
ciscoasa(config-ca-server)# keysize server 2048
The key pair size options are 512, 768, 1024, 2048 bits, and the default value is 1024 bits.
Note After you have enabled the local CA, you cannot change the local CA keysize, because all issued
certificates would be invalidated. To change the local CA keysize, you must delete the current local
CA and reconfigure a new one.
Example
The following is sample output that shows two user certificates in the database.
Username: user1
Renewal allowed until: Not Allowed
Number of times user notified: 0
PKCS12 file stored until: 12:45:52 UTC Fri Jan 4 2017
Certificates Issued:
serial: 0x71
issued: 12:45:52 UTC Thu Jan 3 2008
expired: 12:17:37 UTC Sun Dec 31 2017
status: Not Revoked
Username: user2
Renewal allowed until: Not Allowed
Number of times user notified: 0
PKCS12 file stored until: 12:27:59 UTC Fri Jan 4 2008
Certificates Issued:
serial: 0x2
issued: 12:27:59 UTC Thu Jan 3 2008
expired: 12:17:37 UTC Sun Dec 31 2017
status: Not Revoked
<--- More --->
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
541
How to Set Up Specific Certificate Types
Procedure
A local CA allows VPN clients to enroll for certificates directly from the ASA. This advanced configuration
converts the ASA into a CA. To configure CAs, refer to CA Certificates, on page 542.
What to Do Next
Set up a certificate expiration alert or monitor digital certificates and certificate management history.
CA Certificates
This page is where you manage CA certificates. You can:
For more information about certificates on the ASA, see About Digital Certificates, on page 513.
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Specify the SMTP from-address, a valid e-mail address that the local CA uses as a from address when sending
e-mail messages that deliver one-time passwords (OTPs) for an enrollment invitation to users.
smtp from-address e-mail_address
Example:
ciscoasa(config-ca-server) # smtp from-address [email protected]
Step 3 (Optional) Specify the subject-name DN that is appended to each username on issued certificates.
subject-name-default dn
Example:
ciscoasa(config-ca-server)# subject-name-default cn=engineer, o=asc systems, c=”US”
The subject-name DN and the username combine to form the DN in all user certificates that are issued by the
local CA server. If you do not specify a subject-name DN, you must specify the exact subject name DN to be
included in a user certificate each time that you add a user to the user database.
Note Make sure that you review all optional parameters carefully before you enable the configured local
CA, because you cannot change issuer-name and keysize server values after you enable the local CA
for the first time.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
542
How to Set Up Specific Certificate Types
Step 4 Create the self-signed certificate and associate it with the local CA on the ASA.
no shutdown
Example:
ciscoasa(config-ca-server)# no shutdown
The self-signed certificate key usage extension has key encryption, key signature, CRL signing, and certificate
signing capabilities.
Note After the self-signed local CA certificate has been generated, to change any characteristics, you must
delete the existing local CA server and completely recreate it.
The local CA server keeps track of user certificates, so the administrator can revoke or restore privileges as
needed.
Example
The following example shows how to configure the local CA server using the predefined default values for
all required parameters:
CA Server Management
Procedure
Enter one of the following commands to remove an existing local CA server (either enabled or disabled):
• no crypto ca server
Example
Note Deleting the local CA server removes the configuration from the ASA. After the configuration has
been deleted, it is unrecoverable.
Make sure that you also delete the associated local CA server database and configuration files (that is, all files
with the wildcard name, LOCAL-CA-SERVER.*).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
543
How to Set Up Specific Certificate Types
Procedure
Step 1 Select specific certificates by username or by certificate serial number in the Manage User Certificates pane.
Step 2 Choose one of the following options:
• Click Revoketo remove user access if the user certificate lifetime period runs out. The local CA also
marks the certificate as revoked in the certificate database, automatically updates the information, and
reissues the CRL.
• Select a revoked certificate and click Unrevoke to restore access. The local CA also marks the certificate
as unrevoked in the certificate database, automatically updates the certificate information, and reissues
an updated CRL.
Step 3 Click Apply when you are done to save your changes.
Procedure
Example:
ciscoasa(config)# crypto ca server
Example:
ciscoasa(config-ca-server)# no shutdown
This command generates the local CA server certificate, keypair and necessary database files, and archives
the local CA server certificate and keypair in a PKCS12 file. You must enter an 8-65 alphanumeric password.
After initial startup, you can disable the local CA without being prompted for the password.
Step 3 Save the configuration to make sure that the local CA certificate and keypair are not lost after a reboot occurs.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
544
How to Set Up Specific Certificate Types
write memory
Example:
ciscoasa(config)# write memory
Examples
The following example enables the local CA server:
Password: caserver
The following is sample output that shows local CA server configuration and status:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
545
How to Set Up Specific Certificate Types
To give you more flexibility to set downloads during off peak hours or other convenient times, enter the
following command which enables the import with a custom time:
ciscoasa(config-ca-trustpool)# auto-import time 23:23:23
Setting the automatic import with both a custom URL and custom time requires the following command:
ciscoasa(config-ca-trustpool)# auto-import time 23:23:23 url http://www.thawte.com
Trustpool Policy
Policy Overrides:
None configured
Clear CA Trustpool
To reset the trustpool policy to its default state, use the following command:
clear configure crypto ca trustpool
Since the automatic import of trustpoint certificates is turned off by default, using this command disables the
feature.
Procedure
Example:
ciscoasa(config)# crypto ca server
Example:
ciscoasa(config-ca-server)# issuer-name cn=xx5520,cn=30.132.0.25,ou=DevTest,ou=QA,o=ASC
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
546
How to Set Up Specific Certificate Types
Systems
Step 3 Customize the text that appears in the subject field of all e-mail messages sent from the local CA server.
smtp subject subject-line
Example:
ciscoasa(config-ca-server)# smtp subject Priority E-Mail: Enclosed Confidential Information
is Required for Enrollment
Step 4 Specify the e-mail address that is to be used as the From: field of all e-mail messages that are generated by
the local CA server.
smtp from-address e-mail_address
Example:
ciscoasa(config-ca-server)# smtp from-address [email protected]
Example:
ciscoasa(config-ca-server)# subject-name default cn=engineer, o=ASC Systems, c=US
The default subject-name DN becomes part of the username in all user certificates issued by the local CA
server.
The allowed DN attribute keywords are as follows:
• C = Country
• CN = Common Name
• EA = E-mail Address
• L = Locality
• O = Organization Name
• OU = Organization Unit
• ST = State/Province
• SN = Surname
• ST = State/Province
Note If you do not specify a subject-name-default to serve as a standard subject-name default, you must
specify a DN each time that you add a user.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
547
How to Set Up Specific Certificate Types
Procedure
Example:
ciscoasa(config)# crypto ca server
Example:
ciscoasa(config-ca-server)# shutdown
INFO: Local CA Server has been shutdown.
This command disables website enrollment, allows you to modify the local CA server configuration, and
stores the current configuration and associated files. After initial startup, you can reenable the local CA without
being prompted for the password.
Procedure
Step 1 Access configuration mode for the specific file system type.
mount name type
Example:
ciscoasa(config)# mount mydata type cifs
Example:
ciscoasa(config-mount-cifs)# mount mydata type cifs
server 10.1.1.10 share myshare
domain example.com
username user6
password ********
status enable
Note Only the user who mounts a file system can unmount it with the no mount command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
548
How to Set Up Specific Certificate Types
crypto ca server
Example:
ciscoasa(config)# crypto ca server
Step 4 Specify the location of mydata, the premounted CIFS file system to be used for the local CA server database.
database path mount-name directory-path
Example:
ciscoasa(config-ca-server)# database path mydata:newuser
This command establishes a path to the server and then specifies the local CA file or folder name to use for
storage and retrieval. To return local CA file storage to the ASA flash memory, use the no database path
command.
Note To secure stored local CA files on an external server requires a premounted file system of file type
CIFS or FTP that is username-protected and password-protected.
Step 5 Save the running configuration.
write memory
Example:
ciscoasa(config)# write memory
For external local CA file storage, each time that you save the ASA configuration, user information is saved
from the ASA to the premounted file system and file location, mydata:newuser.
For flash memory storage, user information is saved automatically to the default location for the start-up
configuration.
Example
The following example shows the list of local CA files that appear in flash memory or in external storage:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
549
How to Set Up Specific Certificate Types
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Open a port on an interface to make the CRL accessible from that interface. The specified interface and port
are used to listen for incoming requests for the CRL.
publish-crl interface interface port portnumber
Example:
ciscoasa(config-ca-server)# publish-crl outside 70
Note If you do not specify this command, the CRL is not accessible from the CDP location, because this
command is required to open an interface to download the CRL file.
The CDP URL can be configured to use the IP address of an interface, and the path of the CDP URL and the
filename can also be configured (for example, http://10.10.10.100/user8/my_crl_file).
In this case, only the interface with that IP address configured listens for CRL requests, and when a request
comes in, the ASA matches the path, /user8/my_crl_file to the configured CDP URL. When the path matches,
the ASA returns the stored CRL file.
Note The protocol must be HTTP, so the prefix displayed is
http://.
Step 3 Specify the CDP to be included in all issued certificates. If you do not configure a specific location for the
CDP, the default URL location is http://hostname.domain/+CSCOCA+/asa_ca.crl.
cdp-url url
Example:
ciscoasa(config-ca-server)# cdp-url http://172.16.1.1/pathname/myca.crl
The local CA updates and reissues the CRL each time a user certificate is revoked or unrevoked. If no revocation
changes occur, the CRL is reissued once each CRL lifetime.
If this command is set to serve the CRL directly from the local CA ASA, see Download and Store CRLs for
instructions about opening a port on an interface to make the CRL accessible from that interface.
The CRL exists for other devices to validate the revocation of certificates issued by the local CA. In addition,
the local CA tracks all issued certificates and status within its own certificate database. Revocation checking
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
550
How to Set Up Specific Certificate Types
is performed when a validating party needs to validate a user certificate by retrieving the revocation status
from an external server, which might be the CA that issued the certificate or a server designated by the CA.
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Specify the number of hours that an issued OTP for the local CA enrollment page is valid. The default expiration
time is 72 hours.
otp expiration timeout
Example:
ciscoasa(config-ca-server)# otp expiration 24
Note The user OTP to enroll for a certificate on the enrollment website is also used as the password to
unlock the PKCS12 file that includes the issued certificate and keypair for the specified user.
Step 3 Specify the number of hours an already-enrolled user can retrieve a PKCS12 enrollment file.
enrollment-retrieval timeout
Example:
ciscoasa(config-ca-server)# enrollment-retrieval 120
This time period begins when the user is successfully enrolled. The default retrieval period is 24 hours. Valid
values for the retrieval period range from 1 to 720 hours. The enrollment retrieval period is independent of
the OTP expiration period.
After the enrollment retrieval time expires, the user certificate and keypair are no longer available. The only
way a user may receive a certificate is for the administrator to reinitialize certificate enrollment and allow a
user to log in again.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
551
How to Set Up Specific Certificate Types
Procedure
Example:
ciscoasa(config-ca-server)# crypto ca server user-db add user1 dn [email protected], Engineer,
Example Company, US, email [email protected]
The username argument is a string of 4-64 characters, which is the simple username for the user being added.
The username can be an e-mail address, which then is used to contact the user as necessary for enrollment
invitations.
The dn argument is the distinguished name, a global, authoritative name of an entry in the OSI Directory
(X.500) (for example, [email protected], cn=Engineer, o=Example Company, c=US).
The e-mail-address argument is the e-mail address of the new user to which OTPs and notices are to be sent.
Example:
ciscoasa(config-ca-server)# crypto ca server user-db allow user
Step 3 Notify a user in the local CA database to enroll and download a user certificate, which automatically e-mails
the OTP to that user.
crypto ca server user-db email-otp username
Example:
ciscoasa(config-ca-server)# crypto ca server user-db email-otp exampleuser1
Note When an administrator wants to notify a user through e-mail, the administrator must specify the
e-mail address in the username field or in the e-mail field when adding that user.
Step 4 Show the issued OTP.
crypto ca server user-db show-otp
Example:
ciscoasa(config-ca-server)# crypto ca server user-db show-otp
Step 5 Set the enrollment time limit in hours. The default expiration time is 72 hours.
otp expiration timeout
Example:
ciscoasa(config-ca-server)# otp expiration 24
This command defines the amount of time that the OTP is valid for user enrollment. This time period begins
when the user is allowed to enroll.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
552
How to Set Up Specific Certificate Types
After a user enrolls successfully within the time limit and with the correct OTP, the local CA server creates
a PKCS12 file, which includes a keypair for the user and a user certificate that is based on the public key from
the keypair generated and the subject-name DN specified when the user is added. The PKCS12 file contents
are protected by a passphrase, the OTP. The OTP can be handled manually, or the local CA can e-mail this
file to the user to download after the administrator allows enrollment.
The PKCS12 file is saved to temporary storage with the name, username.p12. With the PKCS12 file in storage,
the user can return within the enrollment-retrieval time period to download the PKCS12 file as many times
as needed. When the time period expires, the PKCS12 file is removed from storage automatically and is no
longer available to download.
Note If the enrollment period expires before the user retrieves the PKCS12 file that includes the user
certificate, enrollment is not permitted.
Renew Users
To specify the timing of renewal notices, perform the following steps:
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Specifies the number of days (1-90) before the local CA certificate expires that an initial reminder to re-enroll
is sent to certificate owners.
renewal-reminder time
Example:
ciscoasa(config-ca-server)# renewal-reminder 7
If a certificate expires, it becomes invalid. Renewal notices and the times they are e-mailed to users are variable,
and can be configured by the administrator during local CA server configuration.
Three reminders are sent. An e-mail is automatically sent to the certificate owner for each of the three reminders,
provided an e-mail address is specified in the user database. If no e-mail address exists for the user, a syslog
message alerts you of the renewal requirement.
The ASA automatically grants certificate renewal privileges to any user who holds a valid certificate that is
about to expire, as long as the user still exists in the user database. Therefore, if an administrator does not
want to allow a user to renew automatically, the administrator must remove the user from the database before
the renewal time period.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
553
How to Set Up Specific Certificate Types
Restore Users
To restore a user and a previously revoked certificate that was issued by the local CA server, perform the
following steps:
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Restore a user and unrevoke a previously revoked certificate that was issued by the local CA server.
crypto ca server unrevoke cert-serial-no
Example:
ciscoasa(config-ca-server)# crypto ca server unrevoke 782ea09f
The local CA maintains a current CRL with serial numbers of all revoked user certificates. This list is available
to external devices and can be retrieved directly from the local CA if it is configured to do so with the cdp-url
command and the publish-crl command. When you revoke (or unrevoke) any current certificate by certificate
serial number, the CRL automatically reflects these changes.
Remove Users
To delete a user from the user database by username, perform the following steps:
Procedure
Example:
ciscoasa(config)# crypto ca server
Step 2 Remove a user from the user database and allow revocation of any valid certificates that were issued to that
user.
crypto ca server user-db remove username
Example:
ciscoasa(config-ca-server)# crypto ca server user-db remove user1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
554
Set a Certificate Expiration Alert (for Identity or CA Certificates)
Revoke Certificates
To revoke a user certificate, perform the following steps:
Procedure
Example:
ciscoasa(config)# crypto ca server
Example:
ciscoasa(config-ca-server)# crypto ca server revoke 782ea09f
This command marks the certificate as revoked in the certificate database on the local CA server and in the
CRL, which is automatically reissued.
Note The password is also required if the certificate for the ASA needs to be revoked, so make sure that
you record it and store it in a safe place.
[no] crypto ca alerts expiration [begin <days before expiration>] [repeat <days>]
Irrespective of the alerts configuration, a reminder is sent every day during the last week of expiration. The
following show and clear commands have also been added:
In addition to the renewal reminder, if an already expired certificate is found in the configuration, a syslog is
generated once every day to rectify the configuration by either renewing the certificate or removing the expired
certificate.
For example, assume that the expiration alerts are configured to begin at 60 days and repeat every 6 days after
that. If the ASA is rebooted at 40 days, an alert is sent on that day, and the next alert is sent on the 36th day.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
555
Monitoring Digital Certificates
Note Expiration checking is not done on trust pool certificates. The Local CA trust point is treated as a regular
trustpoint for expiration checking too.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
556
Monitoring Digital Certificates
Examples
The following example shows an RSA general-purpose key:
The following example shows output of the show running-config command, in which local CA certificate
map rules appear:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
557
History for Certificate Management
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
558
History for Certificate Management
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
559
History for Certificate Management
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
560
PART V
IP Routing
• Routing Overview, page 563
• Static and Default Routes, page 577
• Policy Based Routing, page 585
• Route Maps, page 597
• BGP, page 603
• OSPF, page 641
• EIGRP, page 691
• Multicast Routing, page 711
• IPv6 Neighbor Discovery, page 729
CHAPTER 20
Routing Overview
This chapter describes underlying concepts of how routing behaves within the Cisco ASA, and the routing
protocols that are supported. Routing is the act of moving information across a network from a source to a
destination. Along the way, at least one intermediate node is typically encountered. Routing involves two
basic activities: determining optimal routing paths and transporting packets through a network.
Path Determination
Routing protocols use metrics to evaluate what path will be the best for a packet to travel. A metric is a standard
of measurement, such as path bandwidth, that is used by routing algorithms to determine the optimal path to
a destination. To aid the process of path determination, routing algorithms initialize and maintain routing
tables, which include route information. Route information varies depending on the routing algorithm used.
Routing algorithms fill routing tables with a variety of information. Destination or next hop associations tell
a router that a particular destination can be reached optimally by sending the packet to a particular router
representing the next hop on the way to the final destination. When a router receives an incoming packet, it
checks the destination address and attempts to associate this address with a next hop.
Routing tables also can include other information, such as data about the desirability of a path. Routers compare
metrics to determine optimal routes, and these metrics differ depending on the design of the routing algorithm
used.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
563
Supported Route Types
Routers communicate with one another and maintain their routing tables through the transmission of a variety
of messages. The routing update message is one such message that generally consists of all or a portion of a
routing table. By analyzing routing updates from all other routers, a router can build a detailed picture of
network topology. A link-state advertisement, another example of a message sent between routers, informs
other routers of the state of the sender links. Link information also can be used to build a complete picture of
network topology to enable routers to determine optimal routes to network destinations.
Note Asymmetric routing is only supported for Active/Active failover in multiple context mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
564
How Routing Behaves Within the ASA
through the backbone until they reach the general area of the destination. At this point, they travel from the
last backbone router through one or more non-backbone routers to the final destination.
Routing systems often designate logical groups of nodes, called domains, autonomous systems, or areas. In
hierarchical systems, some routers in a domain can communicate with routers in other domains, while others
can communicate only with routers within their domain. In very large networks, additional hierarchical levels
may exist, with routers at the highest hierarchical level forming the routing backbone.
The primary advantage of hierarchical routing is that it mimics the organization of most companies and
therefore supports their traffic patterns well. Most network communication occurs within small company
groups (domains). Because intradomain routers need to know only about other routers within their domain,
their routing algorithms can be simplified, and, depending on the routing algorithm being used, routing update
traffic can be reduced accordingly.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
565
How Routing Behaves Within the ASA
The following figure shows the egress interface selection method in routed mode. In almost all cases, a route
lookup is equivalent to the NAT rule interface, but in some configurations, the two methods might differ.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
566
Supported Internet Protocols for Routing
ECMP Routing
The ASA supports Equal-Cost Multi-Path (ECMP) routing.
Without zones: You can have up to 3 equal cost static or dynamic routes per interface. For example, you can
configure three default routes on the outside interface that specify different gateways.
In this case, traffic is load-balanced on the outside interface between 10.1.1.2, 10.1.1.3, and 10.1.1.4. Traffic
is distributed among the specified gateways based on an algorithm that hashes the source and destination IP
addresses.
ECMP is not supported across multiple interfaces, so you cannot define a route to the same destination on a
different interface. The following route is disallowed when configured with any of the routes above:
With zones: You can have up to 8 equal cost static or dynamic routes across up to 8 interfaces within a zone.
For example, you can configure three default routes across three interfaces in the zone:
Similarly, your dynamic routing protocol can automatically configure equal cost routes. The ASA load-balances
traffic across the interfaces with a more robust load balancing mechanism.
When a route is lost, the device seamlessly moves the flow to a different route.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
567
Routing Table
BGP is an interautonomous system routing protocol. BGP is used to exchange routing information for
the Internet and is the protocol used between Internet service providers (ISP). Customers connect to
ISPs, and ISPs use BGP to exchange customer and ISP routes. When BGP is used between autonomous
systems (AS), the protocol is referred to as External BGP (EBGP). If a service provider is using BGP
to exchange routes within an AS, then the protocol is referred to as Interior BGP (IBGP).
Routing Table
This section describes the routing table.
Even though OSPF routes have the better administrative distance, both routes are installed in the routing
table because each of these routes has a different prefix length (subnet mask). They are considered
different destinations and the packet forwarding logic determines which route to use.
• If the ASA learns about multiple paths to the same destination from a single routing protocol, such as
RIP, the route with the better metric (as determined by the routing protocol) is entered into the routing
table.
Metrics are values associated with specific routes, ranking them from most preferred to least preferred.
The parameters used to determine the metrics differ for different routing protocols. The path with the
lowest metric is selected as the optimal path and installed in the routing table. If there are multiple paths
to the same destination with equal metrics, load balancing is done on these equal cost paths.
• If the ASA learns about a destination from more than one routing protocol, the administrative distances
of the routes are compared, and the routes with lower administrative distance are entered into the routing
table.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
568
Routing Table
Administrative distance is a route parameter that the ASA uses to select the best path when there are two or
more different routes to the same destination from two different routing protocols. Because the routing protocols
have metrics based on algorithms that are different from the other protocols, it is not always possible to
determine the best path for two routes to the same destination that were generated by different routing protocols.
Each routing protocol is prioritized using an administrative distance value. The following table shows the
default administrative distance values for the routing protocols supported by the ASA.
Static route 1
External BGP 20
Internal EIGRP 90
OSPF 110
RIP 120
Unknown 255
The smaller the administrative distance value, the more preference is given to the protocol. For example, if
the ASA receives a route to a certain network from both an OSPF routing process (default administrative
distance - 110) and a RIP routing process (default administrative distance - 120), the ASA chooses the OSPF
route because OSPF has a higher preference. In this case, the router adds the OSPF version of the route to the
routing table.
In this example, if the source of the OSPF-derived route was lost (for example, due to a power shutdown),
the ASA would then use the RIP-derived route until the OSPF-derived route reappears.
The administrative distance is a local setting. For example, if you use the distance-ospf command to change
the administrative distance of routes obtained through OSPF, that change would only affect the routing table
for the ASA on which the command was entered. The administrative distance is not advertised in routing
updates.
Administrative distance does not affect the routing process. The EIGRP, OSPF, RIP and BGP routing processes
only advertise the routes that have been discovered by the routing process or redistributed into the routing
process. For example, the RIP routing process advertises RIP routes, even if routes discovered by the OSPF
routing process are used in the ASA routing table.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
569
Routing Table
Backup Routes
A backup route is registered when the initial attempt to install the route in the routing table fails because
another route was installed instead. If the route that was installed in the routing table fails, the routing table
maintenance process calls each routing protocol process that has registered a backup route and requests them
to reinstall the route in the routing table. If there are multiple protocols with registered backup routes for the
failed route, the preferred route is chosen based on administrative distance.
Because of this process, you can create floating static routes that are installed in the routing table when the
route discovered by a dynamic routing protocol fails. A floating static route is simply a static route configured
with a greater administrative distance than the dynamic routing protocols running on the ASA. When the
corresponding route discovered by a dynamic routing process fails, the static route is installed in the routing
table.
For example, a packet destined for 192.168.32.1 arrives on an interface with the following routes in the routing
table:
• 192.168.32.0/24 gateway 10.1.1.2
• 192.168.32.0/19 gateway 10.1.1.3
In this case, a packet destined to 192.168.32.1 is directed toward 10.1.1.2, because 192.168.32.1 falls within
the 192.168.32.0/24 network. It also falls within the other route in the routing table, but 192.168.32.0/24 has
the longest prefix within the routing table (24 bits verses 19 bits). Longer prefixes are always preferred over
shorter ones when forwarding a packet.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
570
Routing Table
After the secondary members learn the routes from the primary unit, each unit makes forwarding decisions
independently.
The OSPF LSA database is not synchronized from the primary unit to secondary units. If there is a primary
unit switchover, the neighboring router will detect a restart; the switchover is not transparent. The OSPF
process picks an IP address as its router ID. Although not required, you can assign a static router ID to ensure
a consistent router ID is used across the cluster. See the OSPF Non-Stop Forwarding feature to address the
interruption.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
571
Routing Table
In the above diagram, Router A learns that there are 4 equal-cost paths to Router B, each through an ASA.
ECMP is used to load balance traffic between the 4 paths. Each ASA picks a different router ID when talking
to external routers.
You must configure a cluster pool for the router ID so that each unit has a separate router ID.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
572
Routing Table for Management Traffic
All CLIs that are available in single mode are also available in multiple context mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
573
Disable Proxy ARP Requests
Procedure
Example:
ciscoasa(config)# sysopt noproxyarp exampleinterface
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
574
Reference
Reference
Table 31: History for Route Overview
Platform
Feature Name Releases Feature Information
Routing Table for 9.5(1) To segregate and isolate, management traffic from data traffic, a
Management separate routing table is added for management traffic. Separate
Interface routing tables, for management and data respectively, are created for
both IPv4 and IPv6, for each context, of the ASA. Further, for each
context of the ASA, two extra routing tables are added in both the
RIB and FIB.
We introduced the following commands: show route
management-only, show ipv6 route management-only, show asp
table route-management- only, clear route management-only, clear
ipv6 route management-only, copy interface <interface> tftp/ftp
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
575
Reference
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
576
CHAPTER 21
Static and Default Routes
This chapter describes how to configure static and default routes on the Cisco ASA.
Default Route
The simplest option is to configure a default route to send all traffic to an upstream router, relying on the
router to route the traffic for you. A default route identifies the gateway IP address to which the ASA sends
all IP packets for which it does not have a learned or static route. A default static route is simply a static route
with 0.0.0.0/0 as the destination IP address.
Static Routes
You might want to use static routes in single context mode in the following cases:
• Your networks use a different router discovery protocol from BGP, EIGRP, RIP, or OSPF.
• Your network is small and you can easily manage static routes.
• You do not want the traffic or CPU overhead associated with routing protocols.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
577
About Static and Default Routes
• In some cases, a default route is not enough. The default gateway might not be able to reach the destination
network, so you must also configure more specific static routes. For example, if the default gateway is
outside, then the default route cannot direct traffic to any inside networks that are not directly connected
to the ASA.
Route Priorities
• Routes that identify a specific destination take precedence over the default route.
• When multiple routes exist to the same destination (either static or dynamic), then the administrative
distance for the route determines priority. Static routes are set to 1, so they typically are the highest
priority routes.
• When you have multiple static routes to the same destination with the same administrative distance, see
ECMP Routing, on page 567.
• For traffic emerging from a tunnel with the Tunneled option, this route overrides any other configured
or learned default routes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
578
Guidelines for Static and Default Routes
IPv6
• IPv6 static routes are not supported in transparent mode in ASDM.
• Static route tracking is not supported for IPv6.
Clustering
In clustering, static route monitoring is only supported on the master unit.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
579
Configure Default and Static Routes
IPv6:
ipv6 route if_name ::/0 next_hop_ipv6_addr [distance | tunneled]
Example:
ciscoasa(config)# route outside 0.0.0.0 0.0.0.0 192.168.2.4
ciscoasa(config)# route inside 0.0.0.0 0.0.0.0 10.1.2.3 tunneled
ciscoasa(config)# ipv6 route inside ::/0 3FFE:1100:0:CC00::1
The if_name is the interface through which you want to send the specific traffic.
The distance argument is the administrative distance for the route, between 1 and 254. The default is 1 if you
do not specify a value. Administrative distance is a parameter used to compare routes among different routing
protocols. The default administrative distance for static routes is 1, giving it precedence over routes discovered
by dynamic routing protocols but not directly connect routes. The default administrative distance for routes
discovered by OSPF is 110. If a static route has the same administrative distance as a dynamic route, the static
routes take precedence. Connected routes always take precedence over static or dynamically discovered routes.
Note If you have two default routes configured on different interfaces that have different metrics, the
connection to the ASA that is made from the higher metric interface fails, but connections to the
ASA from the lower metric interface succeed as expected.
You can define a separate default route for tunneled traffic along with the standard default route using the
tunneled keyword. When you create a default route with the tunneled option, all traffic from a tunnel
terminating on the ASA that cannot be routed using learned or static routes is sent to this route.
Tip Tip You can enter 0 0 instead of 0.0.0.0 0.0.0.0 for the destination network address and mask, as shown
in the following example: route outside 0 0 192.168.2.4
Procedure
Example:
ciscoasa(config)# route outside 10.10.10.0 255.255.255.0 192.168.1.1
The if_name is the interface through which you want to send the specific traffic. To “black hole” unwanted
traffic, enter the null0 interface.
The dest_ip and mask arguments indicate the IP address for the destination network and the gateway_ip
argument is the address of the next-hop router. The addresses you specify for the static route are the addresses
that are in the packet before entering the ASA and performing NAT.
The distance argument is the administrative distance for the route. The default is 1 if you do not specify a
value. Administrative distance is a parameter used to compare routes among different routing protocols. The
default administrative distance for static routes is 1, giving it precedence over routes discovered by dynamic
routing protocols but not directly connected routes. The default administrative distance for routes discovered
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
580
Configure Default and Static Routes
by OSPF is 110. If a static route has the same administrative distance as a dynamic route, the static route takes
precedence. Connected routes always take precedence over static or dynamically discovered routes.
Step 2
The following example shows static routes for 3 networks that go to the same gateway, and another network
that goes to a separate gateway:
You can configure static route tracking for statically defined routes or default routes obtained through DHCP
or PPPoE. You can only enable PPPoE clients on multiple interfaces with route tracking configured.
To configure static route tracking, complete the following steps.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
581
Configure Default and Static Routes
Procedure
Example:
ciscoasa(config)# sla monitor 5
ciscoasa(config-sla-monitor)#
Step 2 Specify the monitoring protocol, the target host on the tracked network, and the interface through which you
reach the network:
type echo protocol ipicmpecho target_ip interface if_name
Example:
ciscoasa(config-sla-monitor)# type echo protocol ipicmpecho 172.29.139.134
ciscoasa(config-sla-monitor-echo)#
The target_ip argument is the IP address of the network object whose availability the tracking process monitors.
While this object is available, the tracking process route is installed in the routing table. When this object
becomes unavailable, the tracking process removes the route and the backup route is used in its place.
Step 3 (Optional) Configure monitoring options. See the command reference for the following commands: frequency,
num-packets, request-data-size, threshold, timeout, and tos.
Step 4 Schedule the monitoring process:
sla monitor schedule sla_id [life {forever | seconds}] [start-time {hh:mm [:ss] [month day | day month] |
pending | now | after hh:mm:ss}] [ageout seconds] [recurring]
Example:
ciscoasa(config)# sla monitor schedule 5 life forever start-time now
Typically, you will use the sla monitor schedule sla_id life forever start-time now command for the
monitoring schedule, and allow the monitoring configuration to determine how often the testing occurs.
However, you can schedule this monitoring process to begin in the future and to only occur at specified times.
Step 5 Associate a tracked static route with the SLA monitoring process:
track track_id rtr sla_id reachability
Example:
ciscoasa(config)# track 6 rtr 5 reachability
The track_id argument is a tracking number you assign with this command. The sla_id argument is the ID
number of the SLA process.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
582
Monitoring a Static or Default Route
Example:
interface interface_id
dhcp client route track track_id
ip address dhcp setroute
interface interface_id
pppoe client route track track_id
ip address pppoe setroute
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
583
History for Static and Default Routes
Platform
Feature Name Feature Information
Releases
Static Route Tracking 7.2(1) The static route tracking feature provides a method for tracking
the availability of a static route and installing a backup route if
the primary route should fail.
We introduced the following commands: clear configure sla,
frequency, num-packets, request-data-size, show sla
monitor, show running-config sla, sla monitor, sla monitor
schedule, threshold, timeout, tos, track rtr
Static null0 route to “black hole” traffic 9.2(1) Sending traffic to a null0 interface results in dropping the
packets destined to the specified network. This feature is useful
in configuring Remotely Triggered Black Hole (RTBH) for
BGP.
We modified the following command: route.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
584
CHAPTER 22
Policy Based Routing
This chapter describes how to configure the Cisco ASA to support policy based routing (PBR). The following
sections describe policy based routing, guidelines for PBR, and configuration for PBR.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
585
About Policy Based Routing
Quality of Service
By tagging packets with policy based routing, network administrators can classify the network traffic at the
perimeter of the network for various classes of service and then implementing those classes of service in the
core of the network using priority, custom or weighted fair queuing (as shown in the figure below). This setup
improves network performance by eliminating the need to classify the traffic explicitly at each WAN interface
in the core of backbone network.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
586
Guidelines for Policy Based Routing
Cost Saving
An organization can direct the bulk traffic associated with a specific activity to use a higher-bandwidth
high-cost link for a short time and continues basic connectivity over a lower-bandwidth low-cost link for
interactive traffic by defining the topology, as show here.
Load Sharing
In addition to the dynamic load-sharing capabilities offered by ECMP load balancing, network administrators
can now implement policies to distribute traffic among multiple paths based on the traffic characteristics.
As an example, in the topology depicted in the Equal-Access Source Sensitive Routing scenario, an
administrator can configure policy based routing to load share the traffic from HR network through ISP1 and
traffic from Eng network through ISP2.
Implementation of PBR
The ASA uses ACLs to match traffic and then perform routing actions on the traffic. Specifically, you configure
a route map that specifies an ACL for matching, and then you specify one or more actions for that traffic.
Finally, you associate the route map with an interface where you want to apply PBR on all incoming traffic
Clustering
• Clustering is supported.
• In a cluster scenario, without static or dynamic routes, with ip-verify- reverse path, enabled, asymmetric
traffic may get dropped. So it is recommended to disable ip-verify-reverse path.
Additional Guidelines
All existing route map related configuration restrictions and limitations will be carried forward.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
587
Configure Policy Based Routing
IPv6 Support
IPv6 is supported
Procedure
Example:
ciscoasa(config)# access-list testacl extended permit ip 10.1.1.0 255.255.255.0 10.2.2.0
255.255.255.0
For the extended ACL, you can specify IPv4, IPv6, Identity Firewall, or Cisco TrustSec parameters. For
complete syntax, see the ASA command reference.
Example:
ciscoasa(config)# route-map testmap permit 12
Route map entries are read in order. You can identify the order using the sequence_number argument, or the
ASA uses the order in which you add route map entries.
The ACL also includes its own permit and deny statements. For Permit/Permit matches between the route
map and the ACL, the Policy Based Routing processing continues. For Permit/Deny matches, processing ends
for this route map, and other route maps are checked. If the result is still Permit/Deny, then the regular routing
table is used. For Deny/Deny matches, the Policy Based Routing processing continues.
Note When a route-map is configured without a permit or deny action and without a sequence-number, it
by default will assume the action as permit and sequence-number as 10.
Step 3 Define the match criteria to be applied using an access-list:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
588
Configure Policy Based Routing
Example:
ciscoasa(config-route-map)# match ip address testacl
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
589
Examples for Policy Based Routing
• Classify IP traffic by setting a Differentiated Services Code Point (DSCP) or an IP-precedence value in
the packet:
set {ip | ipv6} dscp new_dscp
Note When multiple set actions are configured, the ASA evaluates them in the following order: set ip
next-hop verify-availability; set ip next-hop; set ip next-hop recursive; set interface; set ip
default next-hop; set default interface.
Step 5 Configure an interface and enter interface configuration mode:
interface interface_id
Example:
ciscoasa(config)# interface GigabitEthernet0/0
Example:
ciscoasa(config-if)# policy-route route-map testmap
In the following example, since no match criteria is specified, an implicit match 'any' is assumed:
In this example, all traffic matching <acl> will be policy routed and forwarded through outside interface.
In this example, since there are no interface or next-hop actions are configured, all traffic matching <acl> will
have df bit and dscp fields modified as per configuration and are forwarding using normal routing.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
590
Examples for Policy Based Routing
In the following example, all traffic matching <acl_1> is forwarded using next-hop 1.1.1.10, all traffic matching
<acl_2> is forwarded using next-hop 2.1.1.10 and rest of the traffic is dropped. No "match" criteria implies
an implicit match "any".
In the following example, the route-map evaluation will be such that (i) a route-map action permit and acl
action permit will apply the set actions (ii) a route-map action deny and acl action permit will skip to normal
route lookup (iii) a route-map action of permit/deny and acl action deny will continue with next route-map
entry. When no next route-map entry available, we will fallback to normal route lookup.
In the following example, when multiple set actions are configured, they are evaluated in the order mentioned
above. Only when all options of a set action are evaluated and cannot be applied, the next set actions will be
considered. This ordering will ensure that the most available and least distant next-hop will be tried first
followed by next most available and least distant next-hop and so on.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
591
Examples for Policy Based Routing
We need to configure a route-map by specifying the above access-list as match criteria along with the required
set actions.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
592
Examples for Policy Based Routing
First, we will start with the basic configuration for all the devices involved in the setup. Here, A, B, C & D
are assumed as ASA devices and H1, H2 as IOS routers.
ASA-A:
ASA-B:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
593
Examples for Policy Based Routing
ASA-C:
ASA-D:
H1:
H2:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
594
Examples for Policy Based Routing
ASA-A:
pbr: policy based route lookup called for 15.1.1.100/44397 to 65.1.1.100/0 proto 1 sub_proto
8 received on interface inside
pbr: First matching rule from ACL(2)
pbr: route map testmap, sequence 10, permit; proceed with policy routing
pbr: evaluating next-hop 25.1.1.61
pbr: policy based routing applied; egress_ifc = outside : next_hop = 25.1.1.61
The packet is forwarded as expected using the next-hop address in the route-map.
When a next-hop is configured, we do a lookup in input route table to identify a connected route to the
configured next-hop and use the corresponding interface. The input route table for this example is shown here
(with the matching route entry highlighted).
Next let's configure ASA-A to route packets from H1 loopback2 out of ASA-A dmz interface.
pbr: policy based route lookup called for 15.1.1.101/1234 to 65.1.1.100/1234 proto 6 sub_proto
0 received on interface inside
pbr: First matching rule from ACL(3)
pbr: route map testmap, sequence 20, permit; proceed with policy routing
pbr: evaluating next-hop 35.1.1.61
pbr: policy based routing applied; egress_ifc = dmz : next_hop = 35.1.1.61
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
595
History for Policy Based Routing
and the route entry chosen from input route table is shown here:
IPv6 support for Policy Based Routing 9.5(1) IPv6 addresses are now supported for Policy Based Routing.
We introduced the following commands: set ipv6 next-hop,set
default ipv6-next hop, set ipv6 dscp
VXLAN support for Policy Based Routing 9.5(1) You can now enable Policy Based Routing on a VNI interface.
We did not modify any commands.
Policy Based Routing support for Identity Firewall 9.5(1) You can configure Identity Firewall and Cisco TrustSec and
and Cisco Trustsec then use Identity Firewall and Cisco TrustSec ACLs in Policy
Based Routing route maps.
We did not modify any commands.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
596
CHAPTER 23
Route Maps
This chapter describes how to configure and customize route-maps, for Cisco ASA.
These are some of the differences between route maps and ACLs:
• Route maps are more flexible than ACLs and can verify routes based on criteria which ACLs can not
verify. For example, a route map can verify if the type of route is internal.
• Each ACL ends with an implicit deny statement, by design convention. If the end of a route map is
reached during matching attempts, the result depends on the specific application of the route map. Route
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
597
About Route Maps
maps that are applied to redistribution behave the same way as ACLs: if the route does not match any
clause in a route map then the route redistribution is denied, as if the route map contained a deny statement
at the end.
For each route that is being redistributed, the router first evaluates the match criteria of a clause in the route
map. If the match criteria succeeds, then the route is redistributed or rejected as dictated by the permit or deny
clause, and some of its attributes might be modified by the values set from the set commands. If the match
criteria fail, then this clause is not applicable to the route, and the software proceeds to evaluate the route
against the next clause in the route map. Scanning of the route map continues until a clause is found that
matches the route or until the end of the route map is reached.
A match or set value in each clause can be missed or repeated several times, if one of these conditions exists:
• If several match entries are present in a clause, all must succeed for a given route in order for that route
to match the clause (in other words, the logical AND algorithm is applied for multiple match commands).
• If a match entry refers to several objects in one entry, either of them should match (the logical OR
algorithm is applied).
• If a match entry is not present, all routes match the clause.
• If a set entry is not present in a route map permit clause, then the route is redistributed without
modification of its current attributes.
Note Do not configure a set entry in a route map deny clause because the deny clause prohibits route
redistribution—there is no information to modify.
A route map clause without a match or set entry does perform an action. An empty permit clause allows a
redistribution of the remaining routes without modification. An empty deny clause does not allow a
redistribution of other routes (this is the default action if a route map is completely scanned, but no explicit
match is found).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
598
Guidelines for Route Maps
Additional Guidelines
Route maps do not support ACLs that include a user, user group, or fully qualified domain name objects.
Procedure
Example:
ciscoasa(config)# route-map name {permit} [12]
Route map entries are read in order. You can identify the order using the sequence_number argument, or the
ASA uses the order in which you add route map entries.
Procedure
Example:
ciscoasa(config)# route-map name {permit} [12]
Route map entries are read in order. You can identify the order using the sequence_number option, or the
ASA uses the order in which you add route map entries.
Step 2 Match any routes that have a destination network that matches a standard ACL or prefix list:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
599
Customize a Route Map
Example:
ciscoasa(config-route-map)# match ip address acl1
If you specify more than one ACL, then the route can match any of the ACLs.
Example:
ciscoasa(config-route-map)# match metric 200
Step 4 Match any routes that have a next hop router address that matches a standard ACL:
match ip next-hop acl_id [acl_id] [...]
Example:
ciscoasa(config-route-map)# match ip next-hop acl2
If you specify more than one ACL, then the route can match any of the ACLs.
Step 5 Match any routes with the specified next hop interface:
match interface if_name
Example:
ciscoasa(config-route-map)# match interface if_name
If you specify more than one interface, then the route can match either interface.
Step 6 Match any routes that have been advertised by routers that match a standard ACL:
match ip route-source acl_id [acl_id] [...]
Example:
ciscoasa(config-route-map)# match ip route-source acl_id [acl_id] [...]
If you specify more than one ACL, then the route can match any of the ACLs.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
600
Example for Route Maps
To configure the metric value for a route action, perform the following steps:
Procedure
Example:
ciscoasa(config)# route-map name {permit} [12]
Route map entries are read in order. You can identify the order using the sequence_number argument, or the
ASA uses the order in which you add route map entries.
Example:
ciscoasa(config-route-map)# set metric 200
Example:
ciscoasa(config-route-map)# set metric-type type-2
The following example shows how to redistribute the 10.1.1.0 static route into eigrp process 1 with the
configured metric value:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
601
History for Route Maps
Enhanced support for static and dynamic route 8.0(2) Enhanced support for dynamic and static route maps was added.
maps
Support for Stateful Failover of dynamic routing 8.4(1) We introduced the following commands: debug route, show
protocols (EIGRP, OSPF, and RIP) and debugging debug route.
of general routing-related operations
We modified the following command: show route.
Dynamic Routing in Multiple Context Mode 9.0(1) Route maps are supported in multiple context mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
602
CHAPTER 24
BGP
This chapter describes how to configure the Cisco ASA to route data, perform authentication, and redistribute
routing information using the Border Gateway Protocol (BGP).
About BGP
BGP is an inter and intra autonomous system routing protocol. An autonomous system is a network or group
of networks under a common administration and with common routing policies. BGP is used to exchange
routing information for the Internet and is the protocol used between Internet service providers (ISP).
Note When a BGPv6 device joins the cluster, it generates a soft traceback when logging level 7 is enabled.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
603
About BGP
• AS_path—When a route advertisement passes through an autonomous system, the AS number is added
to an ordered list of AS numbers that the route advertisement has traversed. Only the route with the
shortest AS_path list is installed in the IP routing table.
• Next hop—The EBGP next-hop attribute is the IP address that is used to reach the advertising router.
For EBGP peers, the next-hop address is the IP address of the connection between the peers. For IBGP,
the EBGP next-hop address is carried into the local AS.
• Community—The community attribute provides a way of grouping destinations, called communities,
to which routing decisions (such as acceptance, preference, and redistribution) can be applied. Route
maps are used to set the community attribute. The predefined community attributes are as follows:
◦no-export—Do not advertise this route to EBGP peers.
◦no-advertise—Do not advertise this route to any peer.
◦internet—Advertise this route to the Internet community; all routers in the network belong to it.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
604
Guidelines for BGP
IPv6 Guidelines
Supports IPv6. Graceful restart is not supported for IPv6 address family.
Configure BGP
This section describes how to enable and configure the BGP process on your system.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
605
Configure BGP
Procedure
Enable BGP
This section describes the steps required to enable BGP routing, establish a BGP routing process and configure
general BGP parameters.
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Discard routes that have as-path segments that exceed a specified value:
bgp maxas-limit number
Example:
ciscoasa(config-router)# bgp maxas-limit 15
The number argument specifies the maximum number of autonomous system segments, allowed. Valid values
are from 1 to 254.
Step 4 Enable BGP to automatically discover the best TCP path MTU for each BGP session:
bgp transport path-mtu-discovery
Step 5 Enable BGP to terminate external BGP sessions of any directly adjacent peer if the link used to reach the peer
goes down; without waiting for the hold-down timer to expire:
bgp fast-external-fallover
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
606
Configure BGP
Step 6 Allow a BGP routing process to discard updates received from an external BGP (eBGP) peers that do not list
their autonomous system (AS) number as the first AS path segment in the AS_PATH attribute of the incoming
route:
bgp enforce-first-as
Step 7 Change the default display and regular expression match format of BGP 4-byte autonomous system numbers
from asplain (decimal values) to dot notation:
bgp asnotation dot
Example:
ciscoasa(config-router)# timers bgp 80 120
• keepalive — frequency (in seconds) with which the ASA sends keepalive messages to its peer. The
default value 60 seconds.
• holdtime — interval (in seconds) after not receiving a keepalive message that the ASA declares a peer
dead. The default is 180 seconds.
• (Optional) min-holdtime — interval (in seconds) after not receiving a keepalive message from a neighbor,
that the ASA declares a neighbor dead.
Example:
ciscoasa(config-router)# bgp graceful-restart restart-time 200
• restart-time — maximum time period (in seconds) that the ASA will wait for a graceful-restart-capable
neighbor to return to normal operation after a restart event occurs. The default is 120 seconds. Valid
values are from 1 to 3600 seconds.
• stalepath-time — maximum time period (in seconds) that the ASA will hold stale paths for a restarting
peer. All stale paths are deleted after this timer expires. The default value is 360 seconds. Valid values
are from 1 to 3600 seconds.
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
607
Configure BGP
Example:
ciscoasa(config)# router bgp 2
Example:
ciscoasa(config-router)# bgp default local-preference 500
The number argument is any value between 0 and 4294967295. Higher values indicate higher preference.
The default value is 100.
Step 3 Enable Multi Exit Discriminator (MED) comparison among paths learned from neighbors in different
autonomous systems:
bgp always-compare-med
Step 4 Compare between similar routes received from external BGP (eBGP) peers during the best path selection
process and switch the best path to the route with the lowest router ID:
bgp bestpath compare-routerid
Step 5 Select the best MED path advertised from the neighboring AS:
bgp deterministic-med
Step 6 Set a path with a missing MED attribute as the least preferred path:
bgp bestpath med missing-as-worst
Procedure
Step 1 Enable the policy-map configuration mode and allows you to create a BGP policy list:
policy-list policy_list_name {permit | deny}
Example:
ciscoasa(config)# policy-list Example-policy-list1 permit
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
608
Configure BGP
Step 2 Distribute routes that have their next hop out of one of the interfaces specified:
match interface [...interface_name]
Example:
ciscoasa(config-policy-list)# match interface outside
Step 3 Redistribute routes by matching either or all of the following: the destination address, next hop router address,
and router/access server source:
match ip {address | next-hop | route-source}
Example:
ciscoasa(config-policy-list)# match community ExampleCommunity1
Step 7 Redistribute routes in the routing table that match the specified tags:
match tag
Note The as-path access-lists are not the same as the regular firewall ACLs.
Procedure
Configure an autonomous system path filter using a regular expression in the global configuration mode:
as-path access-list acl-number {permit|deny} regexp
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
609
Configure BGP
Example:
ciscoasa(config)# as-path access-list 35 permit testaspath
Procedure
Example:
ciscoasa(config)# community-list standard excomm1 permit 100 internet no-advertise no-export
• standard — configures a standard community list using a number from 1 to 99 to identify one or more
permit or deny groups of communities.
• (Optional) community-number — community as a 32-bit number from 1 to 4294967200. A single
community can be entered or multiple communities can be entered, each separated by a space.
• AA:NN — an autonomous system number and network number entered in the 4-byte new community
format. This value is configured with two 2-byte numbers separated by a colon. A number from 1 to
65535 can be entered for each 2-byte number. A single community can be entered or multiple communities
can be entered, each separated by a space.
• (Optional) internet — specifies the Internet community. Routes with this community are advertised to
all peers (internal and external).
• (Optional) no-advertise — specifies the no-advertise community. Routes with this community are not
advertised to any peer (internal or external).
• (Optional) no-export — specifies the no-export community. Routes with this community are advertised
to only peers in the same autonomous system or to only other subautonomous systems within a
confederation. These routes are not advertised to external peers.
• (Optional) expanded— configures an expanded community list number from 100 to 500 to identify one
or more permit or deny groups of communities.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
610
Configure BGP
• regexp — regular expression that defines the AS-path filter. The autonomous system number is expressed
in the range from 1 to 65535.
Note Regular expressions can be used only with expanded community
lists.
Procedure
Step 1 Enable a BGP routing process, which places the router in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 4 (IPv4)
address prefixes:
address-family ipv4 [unicast]
The keyword unicast specifies IPv4 unicast address prefixes. This is the default, even if not specified.
Step 3 (Optional) Configure a fixed router ID for the local BGP routing process:
bgp router-id A.B.C.D
Example:
ciscoasa(config-router-af)# bgp router-id 10.86.118.3
The argument A.B.C.D specifies a router identifier in the form of an IP address. If you do not specify a router
ID, it is automatically assigned.
Step 4 (Optional) Configure a cluster pool of IP addresses in the Individual Interface (L3) mode:
bgp router-id cluster-pool
Example:
ciscoasa(config-router-af)# bgp router-id cp
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
611
Configure BGP
Note In an L3 cluster, you cannot define a BGP neighbor as one of the cluster pool IP addresses.
Example:
ciscoasa(config-router-af)# distance bgp 80 180 180
• external-distance — administrative distance for external BGP routes. Routes are external when learned
from an external autonomous system. The range of values for this argument are from 1 to 255.
• internal-distance — administrative distance for internal BGP routes. Routes are internal when learned
from peer in the local autonomous system. The range of values for this argument are from 1 to 255.
• local-distance — administrative distance for local BGP routes. Local routes are those networks listed
with a network router configuration command, often as back doors, for the router or for the networks
that is being redistributed from another process. The range of values for this argument are from 1 to 255.
Step 6 Modify metric and tag values when the IP routing table is updated with BGP learned routes:
table-map {WORD|route-map_name}
Example:
ciscoasa(config-router-af)# table-map example1
The argument route-map_name specifies the route map name from the route-map command.
Step 7 Configure a BGP routing process to distribute a default route (network 0.0.0.0):
default-information originate
Step 9 Suppress the advertisement of routes that are not installed in the routing information base (RIB):
bgp suppress-inactive
Step 10 Synchronize between BGP and your Interior Gateway Protocol (IGP) system:
synchronization
Step 12 Configure scanning intervals of BGP routers for next hop validation:
bgp scan-time scanner-interval
Example:
ciscoasa(config-router-af)# bgp scan-time 15
The argument scanner-interval specifies scanning interval of BGP routing information. Valid values are from
5 to 60 seconds. The default is 60 seconds.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
612
Configure BGP
Example:
ciscoasa(config-router-af)# bgp nexthop trigger delay 15
• trigger — specifies the use of BGP next-hop address tracking. Use this keyword with the delay keyword
to change the next-hop tracking delay. Use this keyword with the enable keyword to enable next-hop
address tracking.
• delay — changes the delay interval between checks on updated next-hop routes installed in the routing
table.
• seconds — specifies the delay in seconds. Range is from 0 to 100. Default is 5.
• enable — enables BGP next-hop address tracking immediately.
Step 14 Control the maximum number of parallel iBGP routes that can be installed in a routing table:
maximum-paths {number_of_paths|ibgp number_of_paths}
Example:
ciscoasa(config-router-af)# maximum-paths ibgp 2
Note If the ibgp keyword is not used, then the number_of_paths argument controls the maximum number
of parallel EBGP routes.
The number_of_paths argument specifies the number of routes to install to the routing table. Valid values are
between 1 and 8.
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 4 (IPv4)
address prefixes:
address-family ipv4 [unicast]
The keyword unicast specifies IPv4 unicast address prefixes. This is the default, even if not specified.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
613
Configure BGP
Example:
ciscoasa(config-router-af) aggregate-address 10.86.118.0 255.255.255.0 as-set summary-only
suppress-map example1 advertise-map example1 attribute-map example1
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 4 (IPv4)
address prefixes:
address-family ipv4 [unicast]
The keyword unicast specifies IPv4 unicast address prefixes. This is the default, even if not specified.
Step 3 Filter routes or networks received in incoming or advertised in outgoing BGP updates:
distribute-list acl-number in|out[]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
614
Configure BGP
Example:
ciscoasa(config-router-af)# distribute-list ExampleAcl in bgp 2
The argument acl-number specifies IP access list number. The access list defines which networks are to be
received and which are to be suppressed in routing updates.
The keyword in specifies that the filter must be applied to incoming BGP updates and out specifies that the
filter must be applied to outgoing BGP updates.
Procedure
Step 1 Enable a BGP routing process, which places the router in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 4 (IPv4)
address prefixes:
address-family ipv4 [unicast]
The keyword unicast specifies IPv4 unicast address prefixes. This is the default, even if not specified.
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 remote-as 3
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 shutdown 3
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
615
Configure BGP
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 activate
Step 6 Enable or disable the Border Gateway Protocol (BGP) graceful restart capability for a BGP neighbor:
neighbor ip-address ha-mode graceful-restart [disable]
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 ha-mode graceful-restart
(Optional) The disable keyword disables BGP graceful restart capability for a neighbor.
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 distribute-list ExampleAcl in
• access-list-number — the number of a standard or extended access list. The range of a standard access
list number is from 1 to 99. The range of an extended access list number is from 100 to 199.
• expanded-list-number — the number of an expanded access list number. The range of an expanded
access list is from 1300 to 2699.
• access-list-name — the name of a standard or extended access list.
• prefix-list-name — the name of a BGP prefix list.
• in — the access list is applied to incoming advertisements to that neighbor.
• out — that the access list is applied to outgoing advertisements to that neighbor.
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 route-map example1 in
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 prefix-list NewPrefixList in
The keyword in implies that the prefix list is applied to incoming advertisements from that neighbor.
The keyword out implies that the prefix list is applied to outgoing advertisements to that neighbor.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
616
Configure BGP
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 filter-list 5 in
• access-list-name — specifies the number of an autonomous system path access list. You define this
access list with the ip as-path access-list command.
• in — that the access list is applied to incoming advertisements from that neighbor.
• out — that the access list is applied to outgoing advertisements to that neighbor.
Step 11 Control the number of prefixes that can be received from a neighbor:
neighbor {ip-address} maximum-prefix maximum [threshold][restart restart interval][warning-only]
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 maximum-prefix 7 75 restart 12
Step 12 Allow a BGP speaker (the local router) to send the default route 0.0.0.0 to a neighbor for use as a default
route:
neighbor {ip-address} default-originate [route-map map-name]
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 default-originate route-map example1
The argument map-name is the name of the route-map.The route map allows route 0.0.0.0 to be injected
conditionally.
Step 13 Set the minimum interval between the sending of BGP routing updates:
neighbor {ip-address} advertisement-interval seconds
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 advertisement-interval 15
The argument seconds is the time (in seconds). Valid values are from 0 to 600.
Step 14 Advertise the routes in the BGP table that matches the configured route-map:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
617
Configure BGP
Example:
ciscoasa(config-router-af)# neighbor 10.2.1.1 advertise-map MAP1 exist-map MAP2
• advertise-map map name — the name of the route map that will be advertised if the conditions of the
exist map or non-exist map are met.
• exist-map map name — the name of the exist-map that is compared with the routes in the BGP table to
determine whether the advertise-map route is advertised or not.
• non-exist-map map name — the name of the non-exist-map that is compared with the routes in the BGP
table to determine whether the advertise-map route is advertised or not.
• (Optional) check all paths — enables checking of all paths by the exist-map with a prefix in the BGP
table.
Step 15 Remove private autonomous system numbers from outbound routing updates:
neighbor {ip-address} remove-private-as
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 remove-private-as
Step 16 Sets the timers for a specific BGP peer or peer group.
neighbor {ip-address} timers keepalive holdtime min holdtime
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 timers 15 20 12
• keepalive — the frequency (in seconds) with which the ASA sends keepalive messages to its peer. The
default is 60 seconds. Valid values are from 0 to 65535.
• holdtime — the interval (in seconds) after not receiving a keepalive message that the ASA declares a
peer dead. The default is 180 seconds.
• min holdtime — the minimum interval (in seconds) after not receiving a keepalive message that the
ASA declares a peer dead.
Step 17 Enable Message Digest 5 (MD5) authentication on a TCP connection between two BGP peers:
neighbor {ip-address} password string
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 password test
The argument string is a case-sensitive password of up to 25 characters when the service password-encryption
command is enabled and up to 81 characters when the service password-encryption command is not enabled.
The string can contain any alphanumeric characters, including spaces.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
618
Configure BGP
Note The first character cannot be a number. You cannot specify a password in the format
number-space-anything. The space after the number can cause authentication to fail.
Step 18 Specify that communities attributes should be sent to a BGP neighbor:
neighbor {ip-address} send-community[both|standard|extended]
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 send-community
• (Optional) both keyword — both standard and extended communities will be sent.
• (Optional) standard keyword — only standard communities will be sent.
• (Optional) extended keyword — only extended communities will be sent.
Step 19 Configure the router as the next hop for a BGP-speaking neighbor or peer group:
neighbor {ip-address}next-hop-self
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 next-hop-self
Step 20 Accept and attempt BGP connections to external peers residing on networks that are not directly connected:
neighbor {ip-address} ebgp-multihop [ttl]
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 ebgp-multihop 5
The argument ttl specifies time-to-live in the range from 1 to 255 hops.
Step 21 Disable connection verification to establish an eBGP peering session with a single-hop peer that uses a loopback
interface:
neighbor {ip-address} disable-connected-check
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 disable-connected-check
Step 22 Secure a BGP peering session and configures the maximum number of hops that separate two external BGP
(eBGP) peers:
neighbor {ip-address} ttl-security hops hop-count
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 ttl-security hops 15
The argument hop-count is the number of hops that separate the eBGP peers. The TTL value is calculated by
the router from the configured hop-count argument. Valid values are from 1 to 254.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
619
Configure BGP
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 weight 30
The argument number is the weight to assign to a neighbor connection. Valid values are from 0 to 65535.
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 version 4
The argument number specifies the BGP version number. The version can be set to 2 to force the software to
use only Version 2 with the specified neighbor. The default is to use Version 4 and dynamically negotiate
down to Version 2 if requested.
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 transport path-mtu-discovery
Step 26 Customize the AS_PATH attribute for routes received from an external Border Gateway Protocol (eBGP)
neighbor:
neighbor {ip-address} local-as [autonomous-system-number[no-prepend]]
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 local-as 5 no-prepend replace-as
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
620
Configure BGP
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 4 (IPv4)
address prefixes:
address-family ipv4 [unicast]
The keyword unicast specifies IPv4 unicast address prefixes. This is the default, even if not specified.
Example:
ciscoasa(config-router-af)# network 10.86.118.13 mask 255.255.255.255 route-map example1
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 4 (IPv4)
address prefixes:
address-family ipv4 [unicast]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
621
Configure BGP
Example:
ciscoasa(config-router)# address-family ipv4[unicast]
The keyword unicast specifies IPv4 unicast address prefixes. This is the default, even if not specified.
Step 3 Redistribute routes from another routing domain into a BGP autonomous system:
redistribute protocol [process-id] [metric] [route-map [map-tag]]
Example:
ciscoasa(config-router-af)# redistribute ospf 2 route-map example1 match external
• protocol — the source protocol from which routes are being redistributed. It can be one of the following:
Connected, EIGRP, OSPF, RIP or Static.
• (Optional) process-id — a name for the specific routing process.
• (Optional) metric — the metric for the redistributed route.
• (Optional) map-tag — the identifier of a configured route map.
Note The route map should be examined to filter the networks to be redistributed. If not specified, all
networks are redistributed.
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 4 (IPv4)
address prefixes:
address-family ipv4 [unicast]
Example:
ciscoasa(config-router)# address-family ipv4[unicast]
The keyword unicast specifies IPv4 unicast address prefixes. This is the default, even if not specified.
Step 3 Configure conditional route injection to inject more specific routes into a BGP routing table:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
622
Configure BGP
Example:
ciscoasa(config-router-af)# bgp inject-map example1 exist-map example2 copy-attributes
• inject-map — the name of the route map that specifies the prefixes to inject into the local BGP routing
table.
• exist-map — the name of the route map containing the prefixes that the BGP speaker will track.
• (Optional) copy-attributes — configures the injected route to inherit attributes of the aggregate route.
Procedure
Step 1 Enable a BGP routing process, which places the router in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 6 (IPv6)
address prefixes:
address-family ipv6 [unicast]
Example:
ciscoasa(config-router-af)# distance bgp 80 180 180
• external-distance — administrative distance for external BGP routes. Routes are external when learned
from an external autonomous system. The range of values for this argument are from 1 to 255.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
623
Configure BGP
• internal-distance — administrative distance for internal BGP routes. Routes are internal when learned
from peer in the local autonomous system. The range of values for this argument are from 1 to 255.
• local-distance — administrative distance for local BGP routes. Local routes are those networks listed
with a network router configuration command, often as back doors, for the router or for the networks
that is being redistributed from another process. The range of values for this argument are from 1 to 255.
Step 4 (Optional) Configure a BGP routing process to distribute a default route (network 0.0.0.0):
default-information originate
Step 5 (Optional) Suppress the advertisement of routes that are not installed in the routing information base (RIB):
bgp suppress-inactive
Step 6 Synchronize between BGP and your Interior Gateway Protocol (IGP) system:
synchronization
Step 8 Configure scanning intervals of BGP routers for next hop validation:
bgp scan-time scanner-interval
Example:
ciscoasa(config-router-af)# bgp scan-time 15
Valid values for the scanner-interval argument from 5 to 60 seconds. The default is 60 seconds.
Step 9 Control the maximum number of parallel iBGP routes that can be installed in a routing table:
maximum-paths {number_of_paths|ibgp number_of_paths}
Example:
ciscoasa(config-router-af)# maximum-paths ibgp 2
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
624
Configure BGP
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 6 (IPv6)
address prefixes:
address-family ipv6 unicast
Example:
ciscoasa(config-router-af) aggregate-address 2000::1/8 summary-only
Example:
ciscoasa(config-router-af)bgp aggregate-timer 20
Procedure
Step 1 Enable a BGP routing process, which places the router in router configuration mode:
router bgp autonomous-num
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
625
Configure BGP
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 6 (IPv6)
address prefixes:
address-family ipv6 [unicast]
Example:
ciscoasa(config-router-af)# neighbor 2000::1/8 remote-as 3
The argument ipv6-address specifies the IPv6 address of the next hop that can be used to reach the specified
network.TheIPv6 address of the next hop need not be directly connected; recursion is done to find the IPv6
address of the directly connected next hop.When an interface type and interface number are specified, you
can optionally specify the IPv6 address of the next hop to which packets are output.You must specify an
interface type and an interface number when using a link-local address as the next hop (the link-local next
hop must also be an adjacent device).
Note This argument must be in the form documented in RFC 2373 where the address is specified in
hexadecimal using 16-bit values between colons.
Step 4 (Optional) Disable a neighbor or peer group:
neighbor ipv6-address shutdown
Example:
ciscoasa(config-router-af)# neighbor 2000::1/8 shutdown 3
Example:
ciscoasa(config-router-af)# neighbor 2000::1/8 activate
Example:
ciscoasa(config-router-af)# neighbor 2000::1 route-map example1 in
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
626
Configure BGP
Example:
ciscoasa(config-router-af)# neighbor 2000::1 prefix-list NewPrefixList in
The keyword in implies that the prefix list is applied to incoming advertisements from that neighbor.
The keyword out implies that the prefix list is applied to outgoing advertisements to that neighbor.
Example:
ciscoasa(config-router-af)# neighbor 2000::1 filter-list 5 in
• access-list-name — specifies the number of an autonomous system path access list. You define this
access list with the ip as-path access-list command.
• in — that the access list is applied to incoming advertisements from that neighbor.
• out — that the access list is applied to outgoing advertisements to that neighbor.
Step 9 Control the number of prefixes that can be received from a neighbor:
neighbor {ipv6-address} maximum-prefix maximum [threshold][restart restart interval][warning-only]
Example:
ciscoasa(config-router-af)# neighbor 2000::1 maximum-prefix 7 75 restart 12
Step 10 Allow a BGP speaker (the local router) to send the default route 0.0.0.0 to a neighbor for use as a default
route:
neighbor {ipv6-address} default-originate [route-map map-name]
Example:
ciscoasa(config-router-af)# neighbor 2000::1 default-originate route-map example1
The argument map-name is the name of the route-map.The route map allows route 0.0.0.0 to be injected
conditionally.
Step 11 Set the minimum interval between the sending of BGP routing updates:
neighbor {ipv6-address} advertisement-interval seconds
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
627
Configure BGP
Example:
ciscoasa(config-router-af)# neighbor 2000::1 advertisement-interval 15
The argument seconds is the time (in seconds). Valid values are from 0 to 600.
Step 12 Remove private autonomous system numbers from outbound routing updates:
neighbor {ipv6-address} remove-private-as
Example:
ciscoasa(config-router-af)# neighbor 2000::1 remove-private-as
Step 13 Advertise the routes in the BGP table that matches the configured route-map:
neighbor {ipv6-address} advertise-map map-name {exist-map map-name |non-exist-map
map-name}[check-all-paths]
Example:
ciscoasa(config-router-af)# neighbor 2000::1 advertise-map MAP1 exist-map MAP2
• advertise-map map name — the name of the route map that will be advertised if the conditions of the
exist map or non-exist map are met.
• exist-map map name — the name of the exist-map that is compared with the routes in the BGP table to
determine whether the advertise-map route is advertised or not.
• non-exist-map map name — the name of the non-exist-map that is compared with the routes in the BGP
table to determine whether the advertise-map route is advertised or not.
• (Optional) check all paths — enables checking of all paths by the exist-map with a prefix in the BGP
table.
Step 14 Sets the timers for a specific BGP peer or peer group.
neighbor {ipv6-address} timers keepalive holdtime min holdtime
Example:
ciscoasa(config-router-af)# neighbor 2000::1 timers 15 20 12
• keepalive — the frequency (in seconds) with which the ASA sends keepalive messages to its peer. The
default is 60 seconds. Valid values are from 0 to 65535.
• holdtime — the interval (in seconds) after not receiving a keepalive message that the ASA declares a
peer dead. The default is 180 seconds.
• min holdtime — the minimum interval (in seconds) after not receiving a keepalive message that the
ASA declares a peer dead.
Step 15 Enable Message Digest 5 (MD5) authentication on a TCP connection between two BGP peers:
neighbor {ipv6-address} password string
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
628
Configure BGP
Example:
ciscoasa(config-router-af)# neighbor 2000::1 password test
The argument string is a case-sensitive password of up to 25 characters when the service password-encryption
command is enabled and up to 81 characters when the service password-encryption command is not enabled.
The string can contain any alphanumeric characters, including spaces.
Note The first character cannot be a number. You cannot specify a password in the format
number-space-anything. The space after the number can cause authentication to fail.
Step 16 Specify that communities attributes should be sent to a BGP neighbor:
neighbor {ipv6-address} send-community [standard]
Example:
ciscoasa(config-router-af)# neighbor 2000::1 send-community
Step 17 Configure the router as the next hop for a BGP-speaking neighbor or peer group:
neighbor {ipv6-address}next-hop-self
Example:
ciscoasa(config-router-af)# neighbor 2000::1 next-hop-self
Step 18 Accept and attempt BGP connections to external peers residing on networks that are not directly connected:
neighbor {ipv6-address} ebgp-multihop [ttl]
Example:
ciscoasa(config-router-af)# neighbor 2000::1 ebgp-multihop 5
The argument ttl specifies time-to-live in the range from 1 to 255 hops.
Step 19 Disable connection verification to establish an eBGP peering session with a single-hop peer that uses a loopback
interface:
neighbor {ipv6-address} disable-connected-check
Example:
ciscoasa(config-router-af)# neighbor 2000::1 disable-connected-check
Step 20 Secure a BGP peering session and configures the maximum number of hops that separate two external BGP
(eBGP) peers:
neighbor {ipv6-address} ttl-security hops hop-count
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 ttl-security hops 15
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
629
Configure BGP
The argument hop-count is the number of hops that separate the eBGP peers. The TTL value is calculated by
the router from the configured hop-count argument. Valid values are from 1 to 254.
Example:
ciscoasa(config-router-af)# neighbor 2000::1 weight 30
The argument number is the weight to assign to a neighbor connection. Valid values are from 0 to 65535.
Example:
ciscoasa(config-router-af)# neighbor 2000::1 version 4
The argument number specifies the BGP version number. The default is Version 4. Currently only BGP
version 4 is supported.
Example:
ciscoasa(config-router-af)# neighbor 2000::1 transport connection-mode active
Step 24 Customize the AS_PATH attribute for routes received from an external Border Gateway Protocol (eBGP)
neighbor:
neighbor {ipv6-address} local-as [autonomous-system-number[no-prepend]]
Example:
ciscoasa(config-router-af)# neighbor 10.86.118.12 local-as 5 no-prepend replace-as
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
630
Configure BGP
Caution BGP prepends the autonomous system number from each BGP network that a route traverses
to maintain network reachability information and to prevent routing loops. This command
should be configured only for autonomous system migration, and should be removed after
the transition has been completed. This procedure should be attempted only by an experienced
network operator. Routing loops can be created through improper configuration.
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 6 (IPv6)
address prefixes:
address-family ipv6 [unicast]
Example:
ciscoasa(config-router-af)# network 2001:1/64 route-map test_route_map
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
631
Configure BGP
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 6 (IPv6)
address prefixes:
address-family ipv6 [unicast]
Example:
ciscoasa(config-router)# address-family ipv6[unicast]
Step 3 Redistribute routes from another routing domain into a BGP autonomous system:
Example:
ciscoasa(config-router-af)# redistribute ospf 2 route-map example1 match external
• protocol — the source protocol from which routes are being redistributed. It can be one of the following:
Connected, EIGRP, OSPF, RIP or Static.
• (Optional) process-id — For the ospf protocol, this is an appropriate OSPF process ID from which routes
are to be redistributed. This identifies the routing process. This value takes the form of a nonzero decimal
number.
Note This value is auto-populated for the other
protocols.
• (Optional) metric metric value — When redistributing from one OSPF process to another OSPF process
on the same router, the metric will be carried through from one process to the other if no metric value
is specified. When redistributing other processes to an OSPF process, the default metric is 20 when no
metric value is specified. The default value is 0.
• (Optional) match internal | external1 | external2 | NSSA external 1 | NSSA external 2 — For the criteria
by which OSPF routes are redistributed into other routing domains. It can be one of the following:
◦internal — Routes that are internal to a specific autonomous system.
◦external 1 — Routes that are external to the autonomous system, but are imported into BGP as
OSPF Type 1 external route.
◦external 2 — Routes that are external to the autonomous system, but are imported into BGP as
OSPF Type 2 external route.
◦NSSA external 1 — Routes that are external to the autonomous system, but are imported into BGP
as OSPF NSSA Type 1 external route.
◦NSSA external 2 — Routes that are external to the autonomous system, but are imported into BGP
as OSPF NSSA Type 2 external route.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
632
Monitoring BGP
Note The route map should be examined to filter the networks to be redistributed. If not specified, all
networks are redistributed
Procedure
Step 1 Enable a BGP routing process, which places the ASA in router configuration mode:
router bgp autonomous-num
Example:
ciscoasa(config)# router bgp 2
Step 2 Enter address family configuration mode to configure a routing session using standard IP Version 6 (IPv6)
address prefixes:
address-family ipv6 [unicast]
Example:
ciscoasa(config-router)# address-family ipv6 [unicast]
Step 3 Configure conditional route injection to inject more specific routes into a BGP routing table:
bgp inject-map inject-map exist-map exist-map [copy-attributes]
Example:
ciscoasa(config-router-af)# bgp inject-map example1 exist-map example2 copy-attributes
• inject-map — the name of the route map that specifies the prefixes to inject into the local BGP routing
table.
• exist-map — the name of the route map containing the prefixes that the BGP speaker will track.
• (Optional) copy-attributes — configures the injected route to inherit attributes of the aggregate route.
Monitoring BGP
You can use the following commands to monitor the BGP routing process. For examples and descriptions of
the command output, see the command reference. Additionally, you can disable the logging of neighbor
change messages and neighbor warning messages.
To monitor various BGP routing statistics, enter one of the following commands:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
633
Monitoring BGP
• show bgp [ip-address [mask [longer-prefixes [injected] | shorter-prefixes [length]]]| prefix-list name |
route-map name]
Displays the entries in the BGP routing table.
• show bgp cidr-only
Displays routes with non-natural network masks (that is, classless interdomain routing, or CIDR).
• show bgp community community-number [exact-match][no-advertise][no-export]
Display routes that belong to specified BGP communities.
• show bgp community-list community-list-name [exact-match]
Displays routes that are permitted by the BGP community list.
• show bgp filter-list access-list-number
Displays routes that conform to a specified filter list.
• show bgp injected-paths
Displays all the injected paths in the BGP routing table.
• show bgp ipv4 unicast
Displays entries in the IP version 4 (IPv4) BGP routing table for unicast sessions.
• show bgp ipv6 unicast
Displays entries in the IPv6 Border Gateway Protocol (BGP) routing table.
• show bgp ipv6 community
Displays routes that belong to specified IPv6 Border Gateway Protocol (BGP) communities.
• show bgp ipv6 community-list
Displays routes that are permitted by the IPv6 Border Gateway Protocol (BGP) community list.
• show bgp ipv6 filter-list
Display routes that conform to a specified IPv6 filter list.
• show bgp ipv6 inconsistent-as
Displays IPv6 Border Gateway Protocol (BGP) routes with inconsistent originating autonomous systems.
• show bgp ipv6 neighbors
Displays information about IPv6 Border Gateway Protocol (BGP) connections to neighbors.
• show bgp ipv6 paths
Displays all the IPv6 Border Gateway Protocol (BGP) paths in the database.
• show bgp ipv6 prefix-list
Displays routes that match a prefix list.
• show bgp ipv6 quote-regexp
Displays IPv6 Border Gateway Protocol (BGP) routes matching the autonomous system path regular
expression as a quoted string of characters.
• show bgp ipv6 regexp
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
634
Monitoring BGP
Displays IPv6 Border Gateway Protocol (BGP) routes matching the autonomous system path regular
expression.
• show bgp ipv6 route-map
Displays IPv6 Border Gateway Protocol (BGP) routes that failed to install in the routing table.
• show bgp ipv6 summary
Displays the status of all IPv6 Border Gateway Protocol (BGP) connections.
• show bgp neighbors ip_address
Displays information about BGP and TCP connections to neighbors.
• show bgp paths [LINE]
Displays all the BGP paths in the database.
• show bgp pending-prefixes
Displays prefixes that are pending deletion.
• show bgp prefix-list prefix_list_name [WORD]
Displays routes that match a specified prefix list.
• show bgp regexp regexp
Displays routes that match the autonomous system path regular expression.
• show bgp replication [index-group | ip-address]
Displays update replication statistics for BGP update groups.
• show bgp rib-failure
Displays BGP routes that failed to install in the Routing Information Base (RIB) table.
• show bgp route-map map-name
Displays entries in the BGP routing table, based on the route map specified.
• show bgp summary
Display the status of all BGP connections.
• show bgp system-config
Display the system context specific BGP configuration in multi-context mode.
This command is available in all user contexts in multi-context mode.
• show bgp update-group
Display information about the BGP update groups.
Note To disable BGP Log messages, enter the no bgp log-neighbor-changes command in the router configuration
mode. This disables the logging of neighbor change messages. Enter this command in router configuration
mode for the BGP routing process. By default, neighbor changes are logged.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
635
Example for BGP
2 Redistribute any routes that have a route address or match packet that is passed by one of the access lists
specified:
3 Indicate where to output packets that pass a match clause of a route map for policy routing:
5 Configure a fixed router ID for the local Border Gateway Protocol (BGP) routing process in the address
family configuration mode:
This example shows how to enable and configure BGPv6 with various optional processes.
1 Define the conditions for redistributing routes from one routing protocol into another, or enable policy
routing:
2 Redistribute any routes that have a route address or match packet that is passed by one of the access lists
specified:
3 Indicate where to output packets that pass a match clause of a route map for policy routing:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
636
Example for BGP
5 Configure a fixed router ID for the local Border Gateway Protocol (BGP) routing process in the address
family configuration mode:
6 Enter address family configuration mode to configure a routing session using standard IP Version 6 (IPv6)
address prefixes:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
637
History for BGP
BGP support for ASA clustering 9.3(1) We added support for L2 and L3 clustering.
We introduced the following command: bgp router-id
clusterpool
BGP support for nonstop forwarding 9.3(1) We added support for Nonstop Forwarding.
We introduced the following commands: bgp graceful-restart,
neighbor ha-mode graceful-restart
BGP support for advertised maps 9.3(1) We added support for BGPv4 advertised map.
We introduced the following command: neighbor advertise-map
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
638
History for BGP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
639
History for BGP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
640
CHAPTER 25
OSPF
This chapter describes how to configure the Cisco ASA to route data, perform authentication, and redistribute
routing information using the Open Shortest Path First (OSPF) routing protocol.
About OSPF
OSPF is an interior gateway routing protocol that uses link states rather than distance vectors for path selection.
OSPF propagates link-state advertisements rather than routing table updates. Because only LSAs are exchanged
instead of the entire routing tables, OSPF networks converge more quickly than RIP networks.
OSPF uses a link-state algorithm to build and calculate the shortest path to all known destinations. Each router
in an OSPF area contains an identical link-state database, which is a list of each of the router usable interfaces
and reachable neighbors.
The advantages of OSPF over RIP include the following:
• OSPF link-state database updates are sent less frequently than RIP updates, and the link-state database
is updated instantly, rather than gradually, as stale information is timed out.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
641
About OSPF
• Routing decisions are based on cost, which is an indication of the overhead required to send packets
across a certain interface. The ASA calculates the cost of an interface based on link bandwidth rather
than the number of hops to the destination. The cost can be configured to specify preferred paths.
The disadvantage of shortest path first algorithms is that they require a lot of CPU cycles and memory.
The ASA can run two processes of OSPF protocol simultaneously on different sets of interfaces. You might
want to run two processes if you have interfaces that use the same IP addresses (NAT allows these interfaces
to coexist, but OSPF does not allow overlapping addresses). Or you might want to run one process on the
inside and another on the outside, and redistribute a subset of routes between the two processes. Similarly,
you might need to segregate private addresses from public addresses.
You can redistribute routes into an OSPF routing process from another OSPF routing process, a RIP routing
process, or from static and connected routes configured on OSPF-enabled interfaces.
The ASA supports the following OSPF features:
• Intra-area, interarea, and external (Type I and Type II) routes.
• Virtual links.
• LSA flooding.
• Authentication to OSPF packets (both password and MD5 authentication).
• Configuring the ASA as a designated router or a designated backup router. The ASA also can be set up
as an ABR.
• Stub areas and not-so-stubby areas.
• Area boundary router Type 3 LSA filtering.
OSPF supports MD5 and clear text neighbor authentication. Authentication should be used with all routing
protocols when possible because route redistribution between OSPF and other protocols (such as RIP) can
potentially be used by attackers to subvert routing information.
If NAT is used, if OSPF is operating on public and private areas, and if address filtering is required, then you
need to run two OSPF processes—one process for the public areas and one for the private areas.
A router that has interfaces in multiple areas is called an Area Border Router (ABR). A router that acts as a
gateway to redistribute traffic between routers using OSPF and routers using other routing protocols is called
an Autonomous System Boundary Router (ASBR).
An ABR uses LSAs to send information about available routes to other OSPF routers. Using ABR Type 3
LSA filtering, you can have separate private and public areas with the ASA acting as an ABR. Type 3 LSAs
(interarea routes) can be filtered from one area to other, which allows you to use NAT and OSPF together
without advertising private networks.
Note Only Type 3 LSAs can be filtered. If you configure the ASA as an ASBR in a private network, it will send
Type 5 LSAs describing private networks, which will get flooded to the entire AS, including public areas.
If NAT is employed but OSPF is only running in public areas, then routes to public networks can be redistributed
inside the private network, either as default or Type 5 AS external LSAs. However, you need to configure
static routes for the private networks protected by the ASA. Also, you should not mix public and private
networks on the same ASA interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
642
About OSPF
You can have two OSPF routing processes, one RIP routing process, and one EIGRP routing process running
on the ASA at the same time.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
643
Guidelines for OSPF
Failover Guidelines
OSPFv2 and OSPFv3 support Stateful Failover.
IPv6 Guidelines
• OSPFv2 does not support IPv6.
• OSPFv3 supports IPv6.
• OSPFv3 uses IPv6 for authentication.
• The ASA installs OSPFv3 routes into the IPv6 RIB, provided it is the best route.
• OSPFv3 packets can be filtered out using IPv6 ACLs in the capture command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
644
Configure OSPFv2
Clustering Guidelines
• OSPFv3 encryption is not supported. An error message appears if you try to configure OSPFv3 encryption
in a clustering environment.
• In Spanned interface mode, dynamic routing is not supported on management-only interfaces.
• In Individual interface mode, make sure that you establish the master and slave units as either OSPFv2
or OSPFv3 neighbors.
• In Individual interface mode, OSPFv2 adjacencies can only be established between two contexts on a
shared interface on the master unit. Configuring static neighbors is supported only on point-to point-links;
therefore, only one neighbor statement is allowed on an interface.
• When a master role change occurs in the cluster, the following behavior occurs:
◦In spanned interface mode, the router process is active only on the master unit and is in a suspended
state on the slave units. Each cluster unit has the same router ID because the configuration has
been synchronized from the master unit. As a result, a neighboring router does not notice any
change in the router ID of the cluster during a role change.
◦In individual interface mode, the router process is active on all the individual cluster units. Each
cluster unit chooses its own distinct router ID from the configured cluster pool. A mastership role
change in the cluster does not change the routing topology in any way.
Additional Guidelines
• OSPFv2 and OSPFv3 support multiple instances on an interface.
• OSPFv3 supports encryption through ESP headers in a non-clustered environment.
• OSPFv3 supports Non-Payload Encryption.
• OSPFv2 supports Cisco NSF Graceful Restart and IETF NSF Graceful Restart mechanisms as defined
in RFCs 4811, 4812 & 3623 respectively.
• OSPFv3 supports Graceful Restart mechanism as defined in RFC 5187.
Configure OSPFv2
This section describes how to enable an OSPFv2 process on the ASA.
After you enable OSPFv2, you need to define a route map. For more information, see Define a Route Map,
on page 599. Then you generate a default route. For more information, see Configure a Static Route, on page
580.
After you have defined a route map for the OSPFv2 process, you can customize it for your particular needs,
To learn how to customize the OSPFv2 process on the ASA, see Customize OSPFv2, on page 647.
To enable OSPFv2, you need to create an OSPFv2 routing process, specify the range of IP addresses associated
with the routing process, then assign area IDs associated with that range of IP addresses.
You can enable up to two OSPFv2 process instances. Each OSPFv2 process has its own associated areas and
networks.
To enable OSPFv2, perform the following steps:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
645
Configure OSPF Fast Hello Packets
Procedure
Example:
ciscoasa(config)# router ospf 2
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
If there is only one OSPF process enabled on the ASA, then that process is selected by default. You cannot
change the OSPF process ID when editing an existing area.
Step 2 Define the IP addresses on which OSPF runs and the area ID for that interface:
network ip_address mask area area_id
Example:
ciscoasa(config)# router ospf 2
ciscoasa(config-rtr)# network 10.0.0.0 255.0.0.0 area 0
When adding a new area, enter the area ID. You can specify the area ID as either a decimal number or an IP
address. Valid decimal values range from 0 to 4294967295. You cannot change the area ID when editing an
existing area.
Procedure
Example:
ciscoasa(config)# interface port-channel 10
Step 2 Set the interval during which at least one hello packet must be received, or else the neighbor is considered
down:
ospf dead-interval minimal hello-multiplier no.of times
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
646
Customize OSPFv2
Example:
ciscoasa(config-if)# ospf dead-interval minimal hell0-multiplier 5
ciscoasa
The no. of times argument indicates the number of hello packets to be sent every second. Valid values are
between 3 and 20.
In this example, OSPF Support for Fast Hello Packets is enabled by specifying the minimal keyword and the
hello-multiplier keyword and value. Because the multiplier is set to 5, five hello packets will be sent every
second.
Customize OSPFv2
This section explains how to customize the OSPFv2 processes.
Note If you want to redistribute a route by defining which of the routes from the specified routing protocol are
allowed to be redistributed into the target routing process, you must first generate a default route. See
Configure a Static Route, on page 580, and then define a route map according to Define a Route Map,
on page 599.
To redistribute static, connected, RIP, or OSPFv2 routes into an OSPFv2 process, perform the following steps:
Procedure
Example:
ciscoasa(config)# router ospf 2
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
647
Customize OSPFv2
Example:
ciscoasa(config)# redistribute connected 5 type-1 route-map-practice
Example:
ciscoasa(config)# redistribute static 5 type-1 route-map-practice
Step 4 Redistribute routes from an OSPF routing process into another OSPF routing process:
redistribute ospf pid [match {internal | external [1 | 2] | nssa-external [1 | 2]}] [metric metric-value]
[metric-type {type-1 | type-2}] [tag tag_value] [subnets] [route-map map_name]
Example:
ciscoasa(config)# route-map 1-to-2 permit
ciscoasa(config-route-map)# match metric 1
ciscoasa(config-route-map)# set metric 5
ciscoasa(config-route-map)# set metric-type type-1
ciscoasa(config-route-map)# router ospf 2
ciscoasa(config-rtr)# redistribute ospf 1 route-map 1-to-2
You can either use the match options in this command to match and set route properties, or you can use a
route map. The subnets option does not have equivalents in the route-map command. If you use both a route
map and match options in the redistribute command, then they must match.
The example shows route redistribution from OSPF process 1 into OSPF process 2 by matching routes with
a metric equal to 1. The ASA redistributes these routes as external LSAs with a metric of 5 and a metric type
of Type 1.
Step 5 Redistribute routes from a RIP routing process into the OSPF routing process:
redistribute rip [metric metric-value] [metric-type {type-1 | type-2}] [tag tag_value] [subnets] [route-map
map_name]
Example:
ciscoasa(config)# redistribute rip 5
ciscoasa(config-route-map)# match metric 1
ciscoasa(config-route-map)# set metric 5
ciscoasa(config-route-map)# set metric-type type-1
ciscoasa(config-rtr)# redistribute ospf 1 route-map 1-to-2
Step 6 Redistribute routes from an EIGRP routing process into the OSPF routing process:
redistribute eigrp as-num [metric metric-value] [metric-type {type-1 | type-2}] [tag tag_value] [subnets]
[route-map map_name]
Example:
ciscoasa(config)# redistribute eigrp 2
ciscoasa(config-route-map)# match metric 1
ciscoasa(config-route-map)# set metric 5
ciscoasa(config-route-map)# set metric-type type-1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
648
Customize OSPFv2
Procedure
Example:
ciscoasa(config)# router ospf 1
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
Example:
ciscoasa(config)# router ospf 1
ciscoasa(config-rtr)# summary-address 10.1.0.0 255.255.0.0
In this example, the summary address 10.1.0.0 includes addresses 10.1.1.0, 10.1.2.0, 10.1.3.0, and so on. Only
the 10.1.0.0 address is advertised in an external link-state advertisement.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
649
Customize OSPFv2
networks in one area into another area. If the network numbers in an area are assigned in a way so that they
are contiguous, you can configure the area boundary router to advertise a summary route that includes all the
individual networks within the area that fall into the specified range.
To define an address range for route summarization, perform the following steps:
Procedure
Step 1 Create an OSPF routing process and enters router configuration mode for this OSPF process:
router ospf process_id
Example:
ciscoasa(config)# router ospf 1
The process_id argument is an internally used identifier for this routing process. It can be any positive integer.
This ID does not have to match the ID on any other device; it is for internal use only. You can use a maximum
of two processes.
Example:
ciscoasa(config-rtr)# area 17 range 12.1.0.0 255.255.0.0
Procedure
Example:
ciscoasa(config)# router ospf 2
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
650
Customize OSPFv2
Step 2 Define the IP addresses on which OSPF runs and the area ID for that interface:
network ip_address mask area area_id
Example:
ciscoasa(config)# router ospf 2
ciscoasa(config-rtr)# network 10.0.0.0 255.0.0.0 area 0
Example:
ciscoasa(config)# interface my_interface
Example:
ciscoasa(config-interface)# ospf authentication message-digest
Step 5 Assign a password to be used by neighboring OSPF routers on a network segment that is using the OSPF
simple password authentication:
ospf authentication-key key
Example:
ciscoasa(config-interface)# ospf authentication-key cisco
The key argument can be any continuous string of characters up to 8 bytes in length.
The password created by this command is used as a key that is inserted directly into the OSPF header when
the ASA software originates routing protocol packets. A separate password can be assigned to each network
on a per-interface basis. All neighboring routers on the same network must have the same password to be able
to exchange OSPF information.
Example:
ciscoasa(config-interface)# ospf cost 20
Step 7 Set the number of seconds that a device must wait before it declares a neighbor OSPF router down because
it has not received a hello packet:
ospf dead-interval seconds
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
651
Customize OSPFv2
Example:
ciscoasa(config-interface)# ospf dead-interval 40
The value must be the same for all nodes on the network.
Step 8 Specify the length of time between the hello packets that the ASA sends on an OSPF interface:
ospf hello-interval seconds
Example:
ciscoasa(config-interface)# ospf hello-interval 10
The value must be the same for all nodes on the network.
Example:
ciscoasa(config-interface)# ospf message-digest-key 1 md5 cisco
Step 10 Set the priority to help determine the OSPF designated router for a network:
ospf priority number_value
Example:
ciscoasa(config-interface)# ospf priority 20
Step 11 Specify the number of seconds between LSA retransmissions for adjacencies belonging to an OSPF interface:
ospf retransmit-interval seconds
Example:
ciscoasa(config-interface)# ospf retransmit-interval seconds
The value for seconds must be greater than the expected round-trip delay between any two routers on the
attached network. The range is from 1 to 8192 seconds. The default value is 5 seconds.
Step 12 Set the estimated number of seconds required to send a link-state update packet on an OSPF interface:
ospf transmit-delay seconds
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
652
Customize OSPFv2
Example:
ciscoasa(config-interface)# ospf transmit-delay 5
The seconds value ranges from 1 to 8192 seconds.The default value is 1 second.
Example:
ciscoasa(config-if)# ospf dead-interval minimal hello-multiplier 6
Example:
ciscoasa(config-interface)# ospf network point-to-point non-broadcast
When you designate an interface as point-to-point and non-broadcast, you must manually define the OSPF
neighbor; dynamic neighbor discovery is not possible. See Define Static OSPFv2 Neighbors, on page 656 for
more information. Additionally, you can only define one OSPF neighbor on that interface.
Procedure
Example:
ciscoasa(config)# router ospf 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
653
Customize OSPFv2
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
Example:
ciscoasa(config-rtr)# area 0 authentication
Example:
ciscoasa(config-rtr)# area 0 authentication message-digest
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
654
Customize OSPFv2
Example:
ciscoasa(config)# router ospf 2
The process_id argument is an internally used identifier for this routing process. It can be any positive integer.
This ID does not have to match the ID on any other device; it is for internal use only. You can use a maximum
of two processes.
Example:
ciscoasa(config-rtr)# area 0 nssa
Step 3 Set the summary address and helps reduce the size of the routing table:
summary-address ip_address mask [not-advertise] [tag tag]
Example:
ciscoasa(config-rtr)# summary-address 10.1.0.0 255.255.0.0
Using this command for OSPF causes an OSPF ASBR to advertise one external route as an aggregate for all
redistributed routes that are covered by the address.
In this example, the summary address 10.1.0.0 includes addresses 10.1.1.0, 10.1.2.0, 10.1.3.0, and so on. Only
the 10.1.0.0 address is advertised in an external link-state advertisement.
Note OSPF does not support summary-address 0.0.0.0
0.0.0.0.
Procedure
Example:
hostname(config)# ip local pool rpool 1.1.1.1-1.1.1.4
hostname(config)# router ospf 1
hostname(config-rtr)# router-id cluster-pool rpool
hostname(config-rtr)# network 17.5.0.0 255.255.0.0 area 1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
655
Customize OSPFv2
hostname(config-rtr)# log-adj-changes
The cluster-pool keyword enables configuration of an IP address pool when Individual Interface clustering
is configured. The hostname | A.B.C.D. keyword specifies the OSPF router ID for this OSPF process. The
ip_pool argument specifies the name of the IP address pool.
Note If you are using clustering, then you do not need to specify an IP address pool for the router ID. If
you do not configure an IP address pool, then the ASA uses the automatically generated router ID.
Procedure
Example:
ciscoasa(config)# router ospf 2
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
Example:
ciscoasa(config-rtr)# neighbor 255.255.0.0 [interface my_interface]
The addr argument is the IP address of the OSPFv2 neighbor. The if_name argument is the interface used to
communicate with the neighbor. If the OSPF v2neighbor is not on the same network as any of the directly
connected interfaces, you must specify the interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
656
Customize OSPFv2
Procedure
Example:
ciscoasa(config)# router ospf 2
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
Example:
ciscoasa(config-router)# timers throttle spf 500 500 600
The spf-start argument is the delay time (in milliseconds) between when OSPF receives a topology change
and when it starts an SPF calculation. It can be an integer from 0 to 600000.
The spf-hold argument is the minimum time (in milliseconds) between two consecutive SPF calculations. It
can be an integer from 0 to 600000.
The spf-maximum argument is the maximum time (in milliseconds) between two consecutive SPF calculations.
It can be integer from 0 to 600000.
Procedure
Example:
ciscoasa(config)# router ospf 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
657
Configure OSPFv3
The process_id argument is an internally used identifier for this routing process and can be any positive
integer. This ID does not have to match the ID on any other device; it is for internal use only. You can use a
maximum of two processes.
Configure OSPFv3
This section describes the tasks involved in configuring an OSPFv3 routing process.
Enable OSPFv3
To enable OSPFv3, you need to create an OSPFv3 routing process, create an area for OSPFv3, enable an
interface for OSPFv3, then redistribute the route into the targeted OSPFv3 routing processes.
Procedure
Example:
ciscoasa(config)# ipv6 router ospf 10
The process-id argument is an internally used tag for this routing process and can be any positive integer.
This tag does not have to match the tag on any other device; it is for internal use only. You can use a maximum
of two processes.
Example:
ciscoasa(config)# interface Gigabitethernet0/0
Step 3 Create the OSPFv3 routing process with the specified process ID and an area for OSPFv3 with the specified
area ID:
ipv6 ospf process-id area area_id
Example:
ciscoasa(config)# ipv6 ospf 200 area 100
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
658
Configure OSPFv3
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 10
The process-id argument is an internally used tag for this routing process and can be any positive integer.
This tag does not have to match the tag on any other device; it is for internal use only. You can use a maximum
of two processes.
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
The area-num argument is the area for which authentication is to be enabled and can be either a decimal value
or an IP address. The instance keyword specifies the area instance ID that is to be assigned to an interface.
An interface can have only one OSPFv3 area. You can use the same area on multiple interfaces, and each
interface can use a different area instance ID.
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
659
Configure OSPFv3
The interface-cost argument specifies an unsigned integer value expressed as the link-state metric, which can
range in value from 1 to 65535. The default cost is based on the bandwidth.
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf database-filter all out
Step 5 Set the time period in seconds for which hello packets must not be seen before neighbors indicate that the
router is down:
ipv6 ospf dead-interval seconds
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf dead-interval 60
The value must be the same for all nodes on the network and can range from 1 to 65535. The default is four
times the interval set by the ipv6 ospf hello-interval command.
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
660
Configure OSPFv3
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf encryption ipsec spi 1001 esp null sha1 123456789A123456789B123456789C123456789D
The ipsec keyword specifies the IP security protocol. The spi spi keyword-argument pair specifies the security
policy index, which must be in the range of 256 to 42949667295 and entered as a decimal.
The esp keyword specifies the encapsulating security payload. The encryption-algorithm argument specifies
the encryption algorithm to be used with ESP. Valid values include the following:
• aes-cdc—Enables AES-CDC encryption.
• 3des—Enables 3DES encryption.
• des—Enables DES encryption.
• null—Specifies ESP with no encryption.
The key argument specifies the number used in the calculation of the message digest. The number is 32
hexadecimal digits (16 bytes) long. The size of the key depends on the encryption algorithm used. Some
algorithms, such as AES-CDC, allow you to choose the size of the key. The authentication-algorithm argument
specifies the encryption authentication algorithm to be used, which can be one of the following:
• md5—Enables message digest 5 (MD5).
• sha1—Enables SHA-1.
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf flood reduction
Step 8 Specify the interval in seconds between hello packets sent on the interface:
ipv6 ospf hello-interval seconds
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
661
Configure OSPFv3
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf hello-interval 15
The value must be the same for all nodes on a specific network and can range from 1 to 65535. The default
interval is 10 seconds for Ethernet interfaces and 30 seconds for non-broadcast interfaces.
Step 9 Disable the OSPF MTU mismatch detection when DBD packets are received:
ipv6 ospf mtu-ignore
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf mtu-ignore
Step 10 Set the OSPF network type to a type other than the default, which depends on the network type:
ipv6 ospf network {broadcast | point-to-point non-broadcast}
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf network point-to-point non-broadcast
The point-to-point non-broadcast keyword sets the network type to point-to-point non-broadcast. The
broadcast keyword sets the network type to broadcast.
Step 11 Set the router priority, which helps determine the designated router for a network:
ipv6 ospf priority number-value
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
662
Configure OSPFv3
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf priority 4
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf neighbor FE80::A8BB:CCFF:FE00:C01
Step 13 Specify the time in seconds between LSA retransmissions for adjacencies that belong to the interface:
ipv6 ospf retransmit-interval seconds
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf retransmit-interval 8
The time must be greater than the expected round-trip delay between any two routers on the attached network.
Valid values range from 1 to 65535 seconds. The default is 5 seconds.
Step 14 Set the estimated time in seconds to send a link-state update packet on the interface:
ipv6 ospf transmit-delay seconds
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
663
Configure OSPFv3
Example:
ciscoasa(config-if)# interface GigabitEthernet3/2.200
vlan 200
nameif outside
security-level 100
ip address 10.20.200.30 255.255.255.0 standby 10.20.200.31
ipv6 address 3001::1/64 standby 3001::8
ipv6 address 6001::1/64 standby 6001::8
ipv6 enable
ospf priority 255
ipv6 ospf cost 100
ipv6 ospf 100 area 10 instance 200
ipv6 ospf retransmit-delay 3
Procedure
Example:
ciscoasa(config)# ipv6 router ospf 10
The process-id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Example:
ciscoasa(config-rtr)# area 10
Supported parameters include the area ID as a decimal value from 0 to 4294967295 and the area ID in the IP
address format of A.B.C.D.
Example:
ciscoasa(config-rtr)# default originate
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
664
Configure OSPFv3
Step 5 Define the OSPFv3 route administrative distance based on the route type:
distance
Example:
ciscoasa(config-rtr)# distance 200
Supported parameters include the administrative distance with values from 1 to 254 and ospf for the OSPFv3
distance.
Step 6 Suppress the sending of syslog messages with the lsa parameter when the router receives a link-state
advertisement (LSA) for Type 6 Multicast OSPF (MOSPF) packets:
ignore
Example:
ciscoasa(config-rtr)# ignore lsa
Step 7 Configure the router to send a syslog message when an OSPFv3 neighbor goes up or down:
log-adjacency-changes
Example:
ciscoasa(config-rtr)# log-adjacency-changes detail
Example:
ciscoasa(config-rtr)# passive-interface inside
The interface_name argument specifies the name of the interface on which the OSPFv3 process is running.
Step 9 Configure the redistribution of routes from one routing domain into another:
redistribute {connected | ospf | static}
Where:
• connected—Specifies connected routes.
• ospf—Specifies OSPFv3 routes.
• static—Specifies static routes.
Example:
ciscoasa(config-rtr)# redistribute ospf
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
665
Configure OSPFv3
Example:
ciscoasa(config-rtr)# router-id 10.1.1.1
Step 11 Configure IPv6 address summaries with valid values from 0 to 128:
summary-prefix X:X:X:X::X/
Example:
ciscoasa(config-if)# ipv6 router ospf 1
ciscoasa(config-router)# router-id 192.168.3.3
ciscoasa(config-router)# summary-prefix FECO::/24
ciscoasa(config-router)# redistribute static
Example:
ciscoasa(config)# ipv6 router ospf 10
ciscoasa(config-rtr)# timers throttle spf 6000 12000 14000
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
666
Configure OSPFv3
Example:
ciscoasa(config)# ipv6 router ospf 1
The process-id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535.
This ID does not have to match the ID on any other device; it is for internal administrative use only. You can
use a maximum of two processes.
Step 2 Set the summary default cost of an NSSA area or a stub area:
area area-id default-cost cost
Example:
ciscoasa(config-rtr)# area 1 default-cost nssa
Step 3 Summarize routes that match the address and mask for border routers only:
area area-id range ipv6-prefix/ prefix-length [advertise | not advertise] [cost cost]
Example:
ciscoasa(config-rtr)# area 1 range FE01:1::1/64
• The area-id argument identifies the area for which routes are to be summarized. The value can be
specified as a decimal or an IPv6 prefix.
• The ipv6-prefix argument specifies the IPv6 prefix. The prefix-length argument specifies the prefix
length.
• The advertise keyword sets the address range status to advertised and generates a Type 3 summary
LSA.
• The not-advertise keyword sets the address range status to DoNotAdvertise.
• The Type 3 summary LSA is suppressed, and the component networks remain hidden from other networks.
• The cost cost keyword-argument pair specifies the metric or cost for the summary route, which is used
during OSPF SPF calculations to determine the shortest paths to the destination.
• Valid values range from 0 to 16777215.
Example:
ciscoasa(config-rtr)# area 1 nssa
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
667
Configure OSPFv3
Example:
ciscoasa(config-rtr)# area 1 stub
Example:
ciscoasa(config-rtr)# area 1 virtual-link 192.168.255.1 hello-interval 5
• The area-id argument identifies the area for which routes are to be summarized. The virtual link keyword
specifies the creation of a virtual link neighbor.
• The router-id argument specifies the router ID that is associated with the virtual link neighbor.
• Enter the show ospf or show ipv6 ospf command to display the router ID. There is no default value.
• The hello-interval keyword specifies the time in seconds between the hello packets that are sent on an
interface. The hello interval is an unsigned integer that is to be advertised in the hello packets. The value
must be the same for all routers and access servers that are attached to a common network. Valid values
range from 1 to 8192. The default is 10.
• The retransmit-interval seconds keyword-argument pair specifies the time in seconds between LSA
retransmissions for adjacencies that belong to the interface. The retransmit interval is the expected
round-trip delay between any two routers on the attached network. The value must be greater than the
expected round-trip delay, and can range from 1 to 8192. The default is 5.
• The transmit-delay seconds keyword-argument pair specifies the estimated time in seconds that is
required to send a link-state update packet on the interface. The integer value must be greater than zero.
LSAs in the update packet have their own ages incremented by this amount before transmission. The
range of values can be from 1 to 8192. The default is 1.
• The dead-interval seconds keyword-argument pair specifies the time in seconds that hello packets are
not seen before a neighbor indicates that the router is down. The dead interval is an unsigned integer.
The default is four times the hello interval, or 40 seconds. The value must be the same for all routers
and access servers that are attached to a common network. Valid values range from 1 to 8192.
• The ttl-security hops keyword configures the time-to-live (TTL) security on a virtual link. The hop-count
argument value can range from 1 to 254.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
668
Configure OSPFv3
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process_id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Example:
ciscoasa(config-rtr)# passive-interface inside
The interface_name argument specifies the name of the interface on which the OSPFv3 process is running.
If the no interface_name argument is specified, all of the interfaces in the OSPFv3 process process_id are
made passive.
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process_id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Example:
ciscoasa(config-rtr)# distance ospf external 200
The ospf keyword specifies OSPFv3 routes. The external keyword specifies the external Type 5 and Type 7
routes for OSPFv3. The inter-area keyword specifies the inter-area routes for OSPVv3. The intra-area
keyword specifies the intra-area routes for OSPFv3. The distance argument specifies the administrative
distance, which is an integer from 10 to 254.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
669
Configure OSPFv3
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process-id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Step 2 Set the minimum interval at which the ASA accepts the same LSA from OSPF neighbors:
timers lsa arrival milliseconds
Example:
ciscoasa(config-rtr)# timers lsa arrival 2000
The milliseconds argument specifies the minimum delay in milliseconds that must pass between acceptance
of the same LSA arriving from neighbors. The range is from 0 to 6,000,000 milliseconds. The default is 1000
milliseconds.
Example:
ciscoasa(config-rtr)# timers lsa flood 20
The milliseconds argument specifies the time in milliseconds at which LSAs in the flooding queue are paced
in between updates. The configurable range is from 5 to 100 milliseconds. The default value is 33 milliseconds.
Step 4 Change the interval at which OSPFv3 LSAs are collected into a group and refreshed, checksummed, or aged:
timers pacing lsa-group seconds
Example:
ciscoasa(config-rtr)# timers pacing lsa-group 300
The seconds argument specifies the number of seconds in the interval at which LSAs are grouped, refreshed,
check summed, or aged. The range is from 10 to 1800 seconds. The default value is 240 seconds.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
670
Configure OSPFv3
Example:
ciscoasa(config-rtr)# timers pacing retransmission 100
The milliseconds argument specifies the time in milliseconds at which LSAs in the retransmission queue are
paced. The configurable range is from 5 to 200 milliseconds. The default value is 66 milliseconds.
Example:
ciscoasa(config-rtr)# timers throttle lsa 500 6000 8000
• The milliseconds1 argument specifies the delay in milliseconds to generate the first occurrence of the
LSA. The milliseconds2 argument specifies the maximum delay in milliseconds to originate the same
LSA. The milliseconds3 argument specifies the minimum delay in milliseconds to originate the same
LSA.
• For LSA throttling, if the minimum or maximum time is less than the first occurrence value, then OSPFv3
automatically corrects to the first occurrence value. Similarly, if the maximum delay specified is less
than the minimum delay, then OSPFv3 automatically corrects to the minimum delay value.
• For milliseconds1, the default value is 0 milliseconds.
• For milliseconds2 and milliseconds3, the default value is 5000 milliseconds.
Example:
ciscoasa(config-rtr)# timers throttle spf 5000 12000 16000
• The milliseconds1 argument specifies the delay in milliseconds to receive a change to the SPF calculation.
The milliseconds2 argument specifies the delay in milliseconds between the first and second SPF
calculations. The milliseconds3 argument specifies the maximum wait time in milliseconds for SPF
calculations.
• For SPF throttling, if milliseconds2 or milliseconds3 is less than milliseconds1, then OSPFv3 automatically
corrects to the milliseconds1 value. Similarly, if milliseconds3 is less than milliseconds2, then OSPFv3
automatically corrects to the milliseconds2 value.
• For milliseconds1, the default value of SPF throttling is 5000 milliseconds.
• For milliseconds2 and milliseconds3, the default value of SPF throttling is 10000 milliseconds.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
671
Configure OSPFv3
Procedure
Step 1 Enable an OSPFv3 routing process and enters IPv6 router configuration mode.
ipv6 router ospf process-id
Example:
ciscoasa(config)# ipv6 router ospf 1
The process-id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Example:
ciscoasa(config-if)# interface ethernet0/0 ipv6 ospf neighbor FE80::A8BB:CCFF:FE00:C01
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process_id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
672
Configure OSPFv3
Example:
ciscoasa(config-rtr)# default metric 5
• The area keyword specifies the OSPFv3 area parameters. The auto-cost keyword specifies the OSPFv3
interface cost according to bandwidth.
• The default-information keyword distributes default information. The default-metric keyword specifies
the metric for a redistributed route
• The discard-route keyword enables or disables the discard-route installation. The distance keyword
specifies the administrative distance.
• The distribute-list keyword filters networks in routing updates.
• The ignore keyword ignores a specific event. The log-adjacency-changes keyword logs changes in the
adjacency state.
• The maximum-paths keyword forwards packets over multiple paths.
• The passive-interface keyword suppresses routing updates on an interface.
• The redistribute keyword redistributes IPv6 prefixes from another routing protocol.
• The router-id keyword specifies the router ID for the specified routing process.
• The summary-prefix keyword specifies the IPv6 summary prefix.
• The timers keyword specifies the OSPFv3 timers.
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process-id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
673
Configure OSPFv3
Step 2 Configure the router to send a syslog message when an OSPFv3 neighbor goes up or down:
log-adjacency-changes [detail]
Example:
ciscoasa(config-rtr)# log-adjacency-changes detail
The detail keyword sends a syslog message for each state, not only when an OSPFv3 neighbor goes up or
down.
Procedure
Example:
ciscoasa(config-if)# router ospf 1
The process_id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Step 2 Suppress the sending of syslog messages when the router receives unsupported LSA Type 6 MOSPF packets:
ignore lsa mospf
Example:
ciscoasa(config-rtr)# ignore lsa mospf
Procedure
Restore the methods that are used to calculate summary route costs according to RFC 1583:
compatible rfc1583
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
674
Configure OSPFv3
Example:
ciscoasa (config-rtr)# compatible rfc1583
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process-id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Example:
ciscoasa(config-rtr)# default-information originate always metric 3 metric-type 2
• The always keyword advertises the default route whether or not the default route exists.
• The metric metric-value keyword-argument pair specifies the metric used for generating the default
route.
• If you do not specify a value using the default-metric command, the default value is 10. Valid metric
values range from 0 to 16777214.
• The metric-type type-value keyword-argument pair specifies the external link type that is associated
with the default route that is advertised into the OSPFv3 routing domain. Valid values can be one of the
following:
◦1—Type 1 external route
◦2—Type 2 external route
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
675
Configure OSPFv3
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process_id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Example:
ciscoasa(config-if)# ipv6 router ospf 1
ciscoasa(config-rtr)# router-id 192.168.3.3
ciscoasa(config-rtr)# summary-prefix FECO::/24
ciscoasa(config-rtr)# redistribute static
The prefix argument is the IPv6 route prefix for the destination. The not-advertise keyword suppresses routes
that match the specified prefix and mask pair. This keyword applies to OSPFv3 only. The tag tag-value
keyword-argument pair specifies the tag value that can be used as a match value for controlling redistribution
through route maps. This keyword applies to OSPFv3 only.
Procedure
Example:
ciscoasa(config-if)# ipv6 router ospf 1
The process-id argument is an internally used identifier for this routing process, is locally assigned, and can
be any positive integer from 1 to 65535. This ID does not have to match the ID on any other device; it is for
internal administrative use only. You can use a maximum of two processes.
Step 2 Redistribute IPv6 routes from one OSPFv3 process into another:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
676
Configure OSPFv3
Example:
ciscoasa(config-rtr)# redistribute connected 5 type-1
• The source-protocol argument specifies the source protocol from which routes are being redistributed,
which can be static, connected, or OSPFv3.
• The process-id argument is the number that is assigned administratively when the OSPFv3 routing
process is enabled.
• The include-connected keyword allows the target protocol to redistribute routes learned by the source
protocol and connected prefixes on those interfaces over which the source protocol is running.
• The level-1 keyword specifies that for Intermediate System-to-Intermediate System (IS-IS), Level 1
routes are redistributed into other IP routing protocols independently.
• The level-1-2 keyword specifies that for IS-IS, both Level 1 and Level 2 routes are redistributed into
other IP routing protocols.
• The level-2 keyword specifies that for IS-IS, Level 2 routes are redistributed into other IP routing
protocols independently.
• For the metric metric-value keyword-argument pair, when redistributing routes from one OSPFv3
process into another OSPFv3 process on the same router, the metric is carried through from one process
to the other if no metric value is specified. When redistributing other processes into an OSPFv3 process,
the default metric is 20 when no metric value is specified.
• The metric transparent keyword causes RIP to use the routing table metric for redistributed routes as
the RIP metric.
• The metric-type type-value keyword-argument pair specifies the external link type that is associated
with the default route that is advertised into the OSPFv3 routing domain. Valid values can be one of the
following: 1 for a Type 1 external route or 2 for a Type 2 external route. If no value is specified for the
metric-type keyword, the ASA adopts a Type 2 external route. For IS-IS, the link type can be one of
the following: internal for an IS-IS metric that is less than 63 or external for an IS-IS metric that is greater
than 64 and less than 128. The default is internal.
• The match keyword redistributes routes into other routing domains and is used with one of the following
options: external [1|2] for routes that are external to the autonomous system, but are imported into
OSPFv3 as Type 1 or Type 2 external routes; internal for routes that are internal to a specific autonomous
system; nssa-external [1|2] for routes that are external to the autonomous system, but are imported into
OSPFv3 in an NSSA for IPv6 as Type 1 or Type 2 external routes.
• The tag tag-value keyword-argument pair specifies the 32-bit decimal value that is attached to each
external route, which may be used to communicate information between ASBRs. If none is specified,
then the remote autonomous system number is used for routes from BGP and EGP. For other protocols,
zero is used. Valid values range from 0 to 4294967295.
• The route-map keyword specifies the route map to check for filtering the importing of routes from the
source routing protocol to the current routing protocol. If this keyword is not specified, all routes are
redistributed. If this keyword is specified, but no route map tags are listed, no routes are imported. The
map-tag argument identifies a configured route map.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
677
Configure Graceful Restart
Note When fast hellos are configured for OSPFv2, graceful restart does not occur when the active unit reloads
and the standby unit becomes active. This is because the time taken for the role change is more than the
configured dead interval.
Configure Capabilities
The Cisco NSF Graceful Restart mechanism depends on the LLS capability as it sends an LLS block with the
RS-bit set in the Hello packet, to indicate the restart activity. The IETF NSF mechanism depends on the opaque
LSA capability as it sends opaque-LSAs of type-9 to indicate the restart activity. To configure capabilities
enter the following commands:
Procedure
Step 1 Create an OSPF routing process and enters router configuration mode for the OSPF process that you want to
redistribute:
router ospf process_id
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
678
Configure Graceful Restart
Example:
ciscoasa(config)# router ospf 2
The process_id argument is an internally used identifier for this routing process and can be any positive integer.
This ID does not have to match the ID on any other device; it is for internal use only. You can use a maximum
of two processes.
Step 2 Enable the use of LLS data block or opaque LSAs to enable NSF:
capability {lls|opaque}
The lls keyword is used to enable LLS capability for Cisco NSF Graceful Restart mechanism.
The opaque keyword is used to enable opaque LSA capability for IETF NSF Graceful Restart mechanism.
Procedure
Example:
ciscoasa(config-router)# nsf cisco
The enforce global keyword cancels NSF restart when non-NSF-aware neighbor devices are detected.
Example:
ciscoasa(config-router)# capability lls
This command is enabled by default. Using the no form of the command disables it.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
679
Configure Graceful Restart
Procedure
Example:
ciscoasa(config-router)# nsf ietf restart interval 80
The restart interval seconds specifies the length of the graceful restart interval, in seconds. Valid values are
from 1 to 1800 seconds. The default value is 120 seconds.
Graceful restart might be terminated when restart interval is configured with a value less than the time taken
for the adjacency to come up. For example, a restart interval below 30 seconds, is not supported.
Example:
ciscoasa(config-router)# nsf ietf helper
The strict-LSA-checking keyword indicates that the helper router will terminate the process of the restarting
router if it detects that there is a change to a LSA that would be flooded to the restarting router, or if there is
a changed LSA on the retransmission list of the restarting router when the graceful restart process is initiated.
This command is enabled by default. Using the no form of the command disables it.
Procedure
Step 1 Enable IPv6 processing on an interface that has not been configured with an explicit IPv6 address:
interface physical_interface ipv6 enable
Example:
ciscoasa(config)# interface ethernet 0/0
ciscoasa(config-if)# ipv6 enable
The physical_interface argument identifies the interface that participates in OSPFv3 NSF.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
680
Configure Graceful Restart
Example:
ciscoasa(config-router)# graceful-restart restart interval 80
The restart interval seconds specifies the length of the graceful restart interval, in seconds. Valid values are
from 1 to 1800 seconds. The default value is 120 seconds.
Graceful restart might be terminated when restart interval is configured with a value less than the time taken
for the adjacency to come up.For example, a restart interval below 30 seconds, is not supported.
Example:
ciscoasa(config-router)# graceful-restart helper strict-lsa-checking
The strict-LSA-checking keyword indicates that the helper router will terminate the process of the restarting
router if it detects that there is a change to a LSA that would be flooded to the restarting router, or if there is
a changed LSA on the retransmission list of the restarting router when the graceful restart process is initiated.
The graceful-restart helper mode is enabled by default.
Procedure
Example:
ciscoasa(config)# clear configure router ospf 1000
After the configuration is cleared, you must reconfigure OSPF using the router ospf command.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
681
Example for OSPFv2
Example:
ciscoasa(config)# clear configure ipv6 router ospf 1000
After the configuration is cleared, you must reconfigure OSPFv3 using the ipv6 router ospf command.
2 (Optional) To redistribute routes from one OSPFv2 process to another OSPFv2 process, enter the following
commands:
5 (Optional) To configure the route calculation timers and show the log neighbor up and down messages,
enter the following commands:
6 (Optional) To show current OSPFv2 configuration settings, enter the show ospf command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
682
Examples for OSPFv3
The following is sample output from the show running-config ipv6 command:
The following is sample output from the show running-config interface command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
683
Monitoring OSPF
For an example of how to configure an OSPFv3 virtual link, see the following URL:
http://www.cisco.com/en/US/tech/tk365/technologies_configuration_example09186a0080b8fd06.shtml
Monitoring OSPF
You can display specific statistics such as the contents of IP routing tables, caches, and databases. You can
also use the information provided to determine resource utilization and solve network problems. You can also
display information about node reachability and discover the routing path that your device packets are taking
through the network.
To monitor or display various OSPFv2 routing statistics, enter one of the following commands:
Command Purpose
show ospf [process-id [area-id]] Displays general information about OSPFv2 routing
processes.
show ospf border-routers Displays the internal OSPFv2 routing table entries to
the ABR and ASBR.
show ospf [process-id [area-id]] database Displays lists of information related to the OSPFv2
database for a specific router.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
684
Monitoring OSPF
Command Purpose
show ospf flood-list if-name Displays a list of LSAs waiting to be flooded over an
interface (to observe OSPF v2packet pacing).
OSPFv2 update packets are automatically paced so
they are not sent less than 33 milliseconds apart.
Without pacing, some update packets could get lost
in situations where the link is slow, a neighbor could
not receive the updates quickly enough, or the router
could run out of buffer space. For example, without
pacing, packets might be dropped if either of the
following topologies exist:
• A fast router is connected to a slower router over
a point-to-point link.
• During flooding, several neighbors send updates
to a single router at the same time.
show ospf request-list neighbor if_name Displays a list of all LSAs requested by a router.
show ospf retransmission-list neighbor if_name Displays a list of all LSAs waiting to be resent.
show ospf [process-id] summary-address Displays a list of all summary address redistribution
information configured under an OSPFv2 process.
show ospf [process-id] traffic Displays a list of different types of packets being sent
or received by a specific OSPFv2 instance.
To monitor or display various OSPFv3 routing statistics, enter one of the following commands:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
685
Monitoring OSPF
Command Purpose
show ipv6 ospf [process-id [area-id]] Displays general information about OSPFv3 routing processes.
show ipv6 ospf [process-id] border-routers Displays the internal OSPFv3 routing table entries to the ABR
and ASBR.
show ipv6 ospf [process-id [area-id]] database [external | Displays lists of information related to the OSPFv3 database for
inter-area prefix | inter-area-router | network | nssa-external a specific router.
| router | area | as | ref-lsa | [destination-router-id] [prefix
ipv6-prefix] [link-state-id]] [link [interface interface-name]
[adv-router router-id] | self-originate] [internal]
[database-summary]
show ipv6 ospf [process-id [area-id]] events Displays OSPFv3 event information.
show ipv6 ospf [process-id] [area-id] flood-list interface-type Displays a list of LSAs waiting to be flooded over an interface
interface-number (to observe OSPFv3 packet pacing).
OSPFv3 update packets are automatically paced so they are not
sent less than 33 milliseconds apart. Without pacing, some update
packets could get lost in situations where the link is slow, a
neighbor could not receive the updates quickly enough, or the
router could run out of buffer space. For example, without pacing,
packets might be dropped if either of the following topologies
exist:
• A fast router is connected to a slower router over a
point-to-point link.
• During flooding, several neighbors send updates to a single
router at the same time.
show ipv6 ospf [process-id] [area-id] interface [type number] Displays OSPFv3-related interface information.
[brief]
show ipv6 ospf neighbor [process-id] [area-id] [interface-type Displays OSPFv3 neighbor information on a per-interface basis.
interface-number] [neighbor-id] [detail]
show ipv6 ospf [process-id] [area-id] request-list [neighbor] Displays a list of all LSAs requested by a router.
[interface] [interface-neighbor]
show ipv6 ospf [process-id] [area-id] retransmission-list Displays a list of all LSAs waiting to be resent.
[neighbor] [interface] [interface-neighbor]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
686
History for OSPF
Command Purpose
show ipv6 ospf statistic [process-id] [detail] Displays various OSPFv3 statistics.
show ipv6 ospf [process-id] summary-prefix Displays a list of all summary address redistribution information
configured under an OSPFv3 process.
show ipv6 ospf [process-id] timers [lsa-group | rate-limit] Displays OSPFv3 timers information.
show ipv6 ospf [process-id] traffic [interface_name] Displays OSPFv3 traffic-related statistics.
show ipv6 route cluster [failover] [cluster] [interface] [ospf] Displays the IPv6 routing table sequence number, IPv6
[summary] reconvergence timer status, and IPv6 routing entries sequence
number in a cluster.
Clustering 9.0(1) For OSPFv2 and OSPFv3, bulk synchronization, route synchronization, and Spanned
EtherChannel load balancing are supported in the clustering environment.
We introduced or modified the following commands: show route cluster, show
ipv6 route cluster, debug route cluster, router-id cluster-pool.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
687
History for OSPF
OSPF support for Fast 9.2(1) OSPF supports the Fast Hello Packets feature, resulting in a configuration that results
Hellos in faster convergence in an OSPF network.
We modified the following command: ospf dead-interval
Timers 9.2(1) New OSPF timers were added; old ones were deprecated.
We introduced the following commands: timers lsa arrival, timers pacing, timers
throttle
We removed the following commands: Timers spf, timers lsa-grouping-pacing
Route filtering using 9.2(1) Route filtering using ACL is now supported.
access-list We introduced the following command: distribute-list
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
688
History for OSPF
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
689
History for OSPF
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
690
CHAPTER 26
EIGRP
This chapter describes how to configure the Cisco ASA to route data, perform authentication, and redistribute
routing information using the Enhanced Interior Gateway Routing Protocol (EIGRP).
About EIGRP
EIGRP is an enhanced version of IGRP developed by Cisco. Unlike IGRP and RIP, EIGRP does not send out
periodic route updates. EIGRP updates are sent out only when the network topology changes. Key capabilities
that distinguish EIGRP from other routing protocols include fast convergence, support for variable-length
subnet mask, support for partial updates, and support for multiple network layer protocols.
A router running EIGRP stores all the neighbor routing tables so that it can quickly adapt to alternate routes.
If no appropriate route exists, EIGRP queries its neighbors to discover an alternate route. These queries
propagate until an alternate route is found. Its support for variable-length subnet masks permits routes to be
automatically summarized on a network number boundary. In addition, EIGRP can be configured to summarize
on any bit boundary at any interface. EIGRP does not make periodic updates. Instead, it sends partial updates
only when the metric for a route changes. Propagation of partial updates is automatically bounded so that only
those routers that need the information are updated. As a result of these two capabilities, EIGRP consumes
significantly less bandwidth than IGRP.
Neighbor discovery is the process that the ASA uses to dynamically learn of other routers on directly attached
networks. EIGRP routers send out multicast hello packets to announce their presence on the network. When
the ASA receives a hello packet from a new neighbor, it sends its topology table to the neighbor with an
initialization bit set. When the neighbor receives the topology update with the initialization bit set, the neighbor
sends its topology table back to the ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
691
Guidelines for EIGRP
The hello packets are sent out as multicast messages. No response is expected to a hello message. The exception
to this is for statically defined neighbors. If you use the neighbor command, or configure the Hello Interval
in ASDM, to configure a neighbor, the hello messages sent to that neighbor are sent as unicast messages.
Routing updates and acknowledgements are sent out as unicast messages.
Once this neighbor relationship is established, routing updates are not exchanged unless there is a change in
the network topology. The neighbor relationship is maintained through the hello packets. Each hello packet
received from a neighbor includes a hold time. This is the time in which the ASA can expect to receive a hello
packet from that neighbor. If the ASA does not receive a hello packet from that neighbor within the hold time
advertised by that neighbor, the ASA considers that neighbor to be unavailable.
The EIGRP protocol uses four key algorithm technologies, four key technologies, including neighbor
discovery/recovery, Reliable Transport Protocol (RTP), and DUAL, which is important for route computations.
DUAL saves all routes to a destination in the topology table, not just the least-cost route. The least-cost route
is inserted into the routing table. The other routes remain in the topology table. If the main route fails, another
route is chosen from the feasible successors. A successor is a neighboring router used for packet forwarding
that has a least-cost path to a destination. The feasibility calculation guarantees that the path is not part of a
routing loop.
If a feasible successor is not found in the topology table, a route recomputation must occur. During route
recomputation, DUAL queries the EIGRP neighbors for a route, who in turn query their neighbors. Routers
that do no have a feasible successor for the route return an unreachable message.
During route recomputation, DUAL marks the route as active. By default, the ASA waits for three minutes
to receive a response from its neighbors. If the ASA does not receive a response from a neighbor, the route
is marked as stuck-in-active. All routes in the topology table that point to the unresponsive neighbor as a
feasibility successor are removed.
Note EIGRP neighbor relationships are not supported through the IPsec tunnel without a GRE tunnel.
IPv6 Guidelines
Does not support IPv6.
Context Guidelines
EIGRP instances cannot form adjacencies with each other across shared interfaces because inter-context
exchange of multicast traffic is not supported.
Additional Guidelines
A maximum of one EIGRP process is supported.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
692
Configure EIGRP
Configure EIGRP
This section describes how to enable the EIGRP process on your system. After you have enabled EIGRP, see
the following sections to learn how to customize the EIGRP process on your system.
Enable EIGRP
You can only enable one EIGRP routing process on the ASA.
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing:
network ip-addr [mask]
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
You can configure one or more network statements with this command.
Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that fall within the defined network participate in the EIGRP
routing process.
If you have an interface that you do not want to have participate in EIGRP routing, but that is attached to a
network that you want advertised, see Configure Interfaces for EIGRP, on page 695.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
693
Customize EIGRP
informing it of the stub status will not query the stub router for any routes, and a router that has a stub peer
will not query that peer. The stub router depends on the distribution router to send the correct updates to all
peers.
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing:
network ip-addr [mask]
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
You can configure one or more network statements with this command.
Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that fall within the defined network participate in the EIGRP
routing process.
If you have an interface that you do not want to have participate in EIGRP routing, but that is attached to a
network that you want advertised, see section Configure Passive Interfaces, on page 697.
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
ciscoasa(config-router)# eigrp stub {receive-only | [connected] [redistributed] [static]
[summary]}
You must specify which networks are advertised by the stub routing process to the distribution router. Static
and connected networks are not automatically redistributed into the stub routing process.
Note A stub routing process does not maintain a full topology table. At a minimum, stub routing needs a
default route to a distribution router, which makes the routing decisions.
Customize EIGRP
This section describes how to customize the EIGRP routing.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
694
Customize EIGRP
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing:
network ip-addr [mask]
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
You can configure one or more network statements with this command.
Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that fall within the defined network participate in the EIGRP
routing process.
If you have an interface that you do not want to have participate in EIGRP routing, but that is attached to a
network that you want advertised, see Configure Passive Interfaces, on page 697.
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
695
Customize EIGRP
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing:
network ip-addr [mask]
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
You can configure one or more network statements with this command.
Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that fall within the defined network participate in the EIGRP
routing process.
If you have an interface that you do not want to have participate in EIGRP routing, but that is attached to a
network that you want advertised, see Define a Network for an EIGRP Routing Process, on page 695.
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
ciscoasa(config-router)# no default-information {in | out | WORD}
Entering the no default-information in command causes the candidate default route bit to be blocked on
received routes.
Entering the no default-information out command disables the setting of the default route bit in advertised
routes.
For more information see, Configure Default Information in EIGRP, on page 706.
Example:
ciscoasa(config)# authentication mode eigrp 2 md5
The as-num argument is the autonomous system number of the EIGRP routing process configured on the
ASA. If EIGRP is not enabled or if you enter the wrong number, the ASA returns the following error message:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
696
Customize EIGRP
delay value
Example:
ciscoasa(config-if)# delay 200
The value argument entered is in tens of microseconds. To set the delay for 2000 microseconds, enter a value
of 200.
To view the delay value assigned to an interface, use the show interface command.
For more information, see Change the Interface Delay Value, on page 699.
Example:
ciscoasa(config)# hello-interval eigrp 2 60
For more information see Customize the EIGRP Hello Interval and Hold Time, on page 704.
Example:
ciscoasa(config)# hold-time eigrp 2 60
For more information see Customize the EIGRP Hello Interval and Hold Time, on page 704.
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing. You can configure one or more
network statements with this command:
network ip-addr [mask]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
697
Customize EIGRP
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that fall within the defined network participate in the EIGRP
routing process.
If you have an interface that you do not want to have participate in EIGRP routing, but that is attached to a
network that you want advertised, see Define a Network for an EIGRP Routing Process, on page 695.
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
ciscoasa(config-router)# passive-interface {default}
Using the default keyword disables EIGRP routing updates on all interfaces. Specifying an interface name,
as defined by the nameif command, disables EIGRP routing updates on the specified interface. You can use
multiple passive-interface commands in your EIGRP router configuration.
Procedure
Step 1 Enter interface configuration mode for the interface on which you are changing the delay value used by EIGRP:
interface phy_if
Example:
ciscoasa(config)# interface inside
Example:
ciscoasa(config-if)# summary-address eigrp 2 address mask [20]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
698
Customize EIGRP
By default, EIGRP summary addresses that you define have an administrative distance of 5. You can change
this value by specifying the optional distance argument in the summary-address command.
Procedure
Step 1 Enter interface configuration mode for the interface on which you are changing the delay value used by EIGRP:
interface phy_if
Example:
ciscoasa(config)# interface inside
Example:
ciscoasa(config-if)# delay 200
The value argument entered is in tens of microseconds. To set the delay for 2000 microseconds, you enter a
value of 200.
Note To view the delay value assigned to an interface, use the show interface command.
Note Before you can enable EIGRP route authentication, you must enable EIGRP.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
699
Customize EIGRP
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing:
network ip-addr [mask]
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
• You can configure one or more network statements with this command.
• Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that falls within the defined network participate in the
EIGRP routing process.
• If you have an interface that you do not want to have participate in EIGRP routing, but that is attached
to a network that you want advertised, see Configure EIGRP, on page 693.
Step 3 Enter interface configuration mode for the interface on which you are configuring EIGRP message
authentication:
interface phy_if
Example:
ciscoasa(config)# interface inside
Example:
ciscoasa(config)# authentication mode eigrp 2 md5
The as-num argument is the autonomous system number of the EIGRP routing process configured on the
ASA. If EIGRP is not enabled or if you enter the wrong number, the ASA returns the following error message:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
700
Customize EIGRP
Example:
ciscoasa(config)# authentication key eigrp 2 cisco key-id 200
• The as-num argument is the autonomous system number of the EIGRP routing process configured on
the ASA. If EIGRP is not enabled or if you enter the wrong number, the ASA returns the following error
message:
• The key argument can include up to 16 characters, including alphabets, numbers and special
characters.White spaces are not allowed, in the key argument.
• The key-id argument is a number that can range from 0 to 255.
Procedure
Step 1 Create an EIGRP routing process and enters router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# neighbor 10.0.0.0 interface interface1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
701
Customize EIGRP
Note For RIP only: Before you begin this procedure, you must create a route map to further define which routes
from the specified routing protocol are redistributed in to the RIP routing process.
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 (Optional) Specifies the default metrics that should be applied to routes redistributed into the EIGRP routing
process:
default-metric bandwidth delay reliability loading mtu
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# default-metric bandwidth delay reliability loading mtu
If you do not specify a default metric in the EIGRP router configuration, you must specify the metric values
in each redistribute command. If you specify the EIGRP metrics in the redistribute command and have the
default-metric command in the EIGRP router configuration, the metrics in the redistribute command are
used.
Example:
ciscoasa(config-router): redistribute connected [metric bandwidth delay reliability loading
mtu] [route-map map_name]
You must specify the EIGRP metric values in the redistribute command if you do not have a default-metric
command in the EIGRP router configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
702
Customize EIGRP
Example:
ciscoasa(config-router): redistribute static [metric bandwidth delay
reliability loading mtu] [route-map map_name]
Step 5 Redistribute routes from an OSPF routing process into the EIGRP routing process:
redistribute ospf pid [match {internal | external [1 | 2] | nssa-external [1 | 2]}] [metric bandwidth delay
reliability loading mtu] [route-map map_name]
Example:
ciscoasa(config-router): redistribute ospf pid [match {internal | external [1 | 2] |
nssa-external [1 | 2]}] [metric bandwidth delay reliability loading mtu] [route-map map_name]
Step 6 Redistribute routes from a RIP routing process into the EIGRP routing process:
redistribute rip [metric bandwidth delay reliability load mtu] [route-map map_name]
Example:
ciscoasa(config-router): redistribute rip [metric bandwidth delay
reliability load mtu] [route-map map_name]
Note Before you begin this process, you must create a standard ACL that defines the routes that you want to
advertise. That is, create a standard ACL that defines the routes that you want to filter from sending or
receiving updates.
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing:
ciscoasa(config-router)# network ip-addr [mask]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
703
Customize EIGRP
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
You can configure one or more network statements with this command.
Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that fall within the defined network participate in the EIGRP
routing process.
If you have an interface that you do not want to have participate in EIGRP routing, but that is attached to a
network that you want advertised, see Configure Interfaces for EIGRP, on page 695.
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
ciscoasa(config-router): distribute-list acl out [connected]
You can specify an interface to apply the filter to only those updates that are sent by that specific interface.
You can enter multiple distribute-list commands in your EIGRP router configuration.
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
ciscoasa(config-router): distribute-list acl in [interface interface1]
You can specify an interface to apply the filter to only those updates that are received by that interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
704
Customize EIGRP
Procedure
Step 1 Enter interface configuration mode for the interface on which you are configuring the hello interval or advertised
hold time:
interface phy_if
Example:
ciscoasa(config)# interface inside
Example:
ciscoasa(config)# hello-interval eigrp 2 60
Example:
ciscoasa(config)# hold-time eigrp 2 60
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
705
Customize EIGRP
Example:
ciscoasa(config-router)# no auto-summary
Procedure
Step 1 Create an EIGRP routing process and enter router configuration mode for this EIGRP process:
router eigrp as-num
Example:
ciscoasa(config)# router eigrp 2
The as-num argument is the autonomous system number of the EIGRP routing process.
Step 2 Configure the interfaces and networks that participate in EIGRP routing:
network ip-addr [mask]
Example:
ciscoasa(config)# router eigrp 2
ciscoasa(config-router)# network 10.0.0.0 255.0.0.0
You can configure one or more network statements with this command.
Directly connected and static networks that fall within the defined network are advertised by the ASA.
Additionally, only interfaces with an IP address that fall within the defined network participate in the EIGRP
routing process.
If you have an interface that you do not want to have participate in EIGRP routing, but that is attached to a
network that you want advertised, see Configure Interfaces for EIGRP, on page 695.
Example:
ciscoasa(config)# router eigrp 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
706
Customize EIGRP
Note Entering the no default-information in command causes the candidate default route bit to be blocked
on received routes. Entering the no default-information out command disables the setting of the
default route bit in advertised routes.
Procedure
Step 1 Enter interface configuration mode for the interface on which you are changing the delay value used by EIGRP:
interface phy_if
Example:
ciscoasa(config)# interface phy_if
Example:
ciscoasa(config-if)# no split-horizon eigrp 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
707
Monitoring for EIGRP
Procedure
Example:
ciscoasa(config)# clear eigrp pid 10 neighbors
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
708
Example for EIGRP
Procedure
Step 2 To configure an interface from sending or receiving EIGRP routing messages, enter the following command:
Step 4 To configure the interfaces and networks that participate in EIGRP routing, enter the following command:
Step 5 To change the interface delay value used in EIGRP distance calculations, enter the following commands:
ciscoasa(config-router)# exit
ciscoasa(config)# interface phy_if
ciscoasa(config-if)# delay 200
Dynamic Routing in Multiple Context Mode 9.0(1) EIGRP routing is supported in multiple context mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
709
History for EIGRP
EIGRP Auto-Summary 9.2(1) For EIGRP, the Auto-Summary field is now disabled by default.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
710
CHAPTER 27
Multicast Routing
This chapter describes how to configure the Cisco ASA to use the multicast routing protocol.
Note The UDP and non-UDP transports are both supported for multicast routing. However, the non-UDP
transport has no FastPath optimization.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
711
About Multicast Routing
Note If the ASA is the PIM Rendezvous Point, use the untranslated outside address of the ASA as the Rendezvous
Point address.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
712
About Multicast Routing
information to all the other devices down the multicast tree, through BSR messages that travel from PIM
router to PIM router on a per-hop basis.
This feature provides a means of dynamically learning Rendezvous Points (RPs), which is very essential in
large complex networks where an RP can periodically go down and come up.
Multicast Addresses
Multicast addresses specify an arbitrary group of IP hosts that have joined the group and want to receive traffic
sent to this group.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
713
Guidelines for Multicast Routing
Clustering
Multicast routing supports clustering. In Layer 2 clustering, the master unit sends all multicast routing packets
and data packets until fast-path forwarding is established. After fast-path forwarding is established, slave units
may forward multicast data packets. All data flows are full flows. Stub forwarding flows are also supported.
Because only one unit receives multicast packets in Layer 2 clustering, redirection to the master unit is common.
In Layer 3 clustering, units do not act independently. All data and routing packets are processed and forwarded
by the master unit. Slave units drop all packets that have been sent.
For more information about clustering, see ASA Cluster, on page 247.
IPv6 Guidelines
Does not support IPv6.
Additional Guidelines
In clustering, for IGMP and PIM, this feature is only supported on the master unit.
Note Only the UDP transport layer is supported for multicast routing.
The following table lists the maximum number of entries for specific multicast tables based on the amount
of RAM on the ASA. Once these limits are reached, any new entries are discarded.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
714
Customize Multicast Routing
Procedure
Example:
ciscoasa(config)# multicast-routing
The number of entries in the multicast routing tables are limited by the amount of RAM on the ASA.
Note Stub multicast routing and PIM are not supported concurrently.
An ASA acting as the gateway to the stub area does not need to participate in PIM. Instead, you can configure
it to act as an IGMP proxy agent and forward IGMP messages from hosts connected on one interface to an
upstream multicast router on another interface. To configure the ASA as an IGMP proxy agent, forward the
host join and leave messages from the stub area interface to an upstream interface.
Procedure
Example:
ciscoasa(config-if)# igmp forward interface interface1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
715
Customize Multicast Routing
When using PIM, the ASA expects to receive packets on the same interface where it sends unicast packets
back to the source. In some cases, such as bypassing a route that does not support multicast routing, you may
want unicast packets to take one path and multicast packets to take another.
Static multicast routes are not advertised or redistributed.
Procedure
Example:
ciscoasa(config)# mroute src_ip src_mask {input_if_name | rpf_neighbor} [distance]
Example:
ciscoasa(config)# mroute src_ip src_mask input_if_name [dense output_if_name] [distance]
The dense output_if_name keyword and argument pair is only supported for stub multicast routing.
Note Only the no igmp command appears in the interface configuration when you use the show run command.
If the multicast-routing command appears in the device configuration, then IGMP is automatically enabled
on all interfaces.
This section describes how to configure optional IGMP setting on a per-interface basis.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
716
Customize Multicast Routing
Procedure
Example:
ciscoasa(config-if)# no igmp
Note If you want to forward multicast packets for a specific group to an interface without the ASA accepting
those packets as part of the group, see Configure a Statically Joined IGMP Group, on page 717.
Procedure
Example:
ciscoasa(config-if)# igmp join-group mcast-group
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
717
Customize Multicast Routing
Procedure
Example:
ciscoasa(config-if)# igmp static-group group-address
Procedure
Example:
ciscoasa(config)# access-list acl1 standard permit 192.52.662.25
You can create more than one entry for a single ACL. You can use extended or standard ACLs.
The ip_addr mask argument is the IP address of the multicast group being permitted or denied.
Example:
ciscoasa(config)# access-list acl2 extended permit protocol
src_ip_addr src_mask dst_ip_addr dst_mask
The dst_ip_addr argument is the IP address of the multicast group being permitted or denied.
Example:
ciscoasa(config-if)# igmp access-group acl
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
718
Customize Multicast Routing
Procedure
Example:
ciscoasa(config-if)# igmp limit 50
Valid values range from 0 to 500, with 500 being the default value.
Setting this value to 0 prevents learned groups from being added, but manually defined memberships (using
the igmp join-group and igmp static-group commands) are still permitted. The no form of this command
restores the default value.
Note The igmp query-timeout and igmp query-interval commands require IGMP Version 2.
To change the query interval, query response time, and query timeout value, perform the following steps:
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
719
Customize Multicast Routing
Example:
ciscoasa(config-if)# igmp query-interval 30
Example:
ciscoasa(config-if)# igmp query-timeout 30
Example:
ciscoasa(config-if)# igmp query-max-response-time 30
Procedure
Control the version of IGMP that you want to run on the interface:
igmp version {1 | 2}
Example:
ciscoasa(config-if)# igmp version 2
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
720
Customize Multicast Routing
Note PIM is not supported with PAT. The PIM protocol does not use ports, and PAT only works with protocols
that use ports.
Procedure
Example:
ciscoasa(config-if)# pim
Example:
ciscoasa(config-if)# no pim
Note The ASA does not support Auto-RP or PIM BSR. You must use the pim rp-address command to specify
the RP address.
You can configure the ASA to serve as RP to more than one group. The group range specified in the ACL
determines the PIM RP group mapping. If an ACL is not specified, then the RP for the group is applied to
the entire multicast group range (224.0.0.0/4).
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
721
Customize Multicast Routing
The ip_address argument is the unicast IP address of the router assigned to be a PIM RP.
The acl argument is the name or number of a standard ACL that defines with which multicast groups the RP
should be used. Do not use a host ACL with this command.
Excluding the bidir keyword causes the groups to operate in PIM sparse mode.
Note The ASA always advertises the bidirectional capability in the PIM hello messages, regardless of the
actual bidirectional configuration.
Example:
ciscoasa(config)# pim rp-address 10.86.75.23 [acl1] [bidir]
Procedure
Example:
ciscoasa(config-if)# pim dr-priority 500
Procedure
Example:
ciscoasa(config)# pim accept-register {list acl1 | route-map map2}
In the example, the ASA filters PIM register messages acl1 and route map map2.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
722
Customize Multicast Routing
Procedure
Example:
ciscoasa(config-if)# pim hello-interval 60
Valid values for the seconds argument range from 1 to 3600 seconds.
Step 2 Change the amount of time (in seconds) that the ASA sends PIM join or prune messages:
pim join-prune-interval seconds
Example:
ciscoasa(config-if)# pim join-prune-interval 60
Valid values for the seconds argument range from 10 to 600 seconds.
Procedure
Step 1 Use a standard ACL to define the routers that you want to have participate in PIM:
access-list pim_nbr deny router-IP_addr PIM neighbor
Example:
ciscoasa(config)# access-list pim_nbr deny 10.1.1.1 255.255.255.255
In the example, the following ACL, when used with the pim neighbor-filter command, prevents the 10.1.1.1
router from becoming a PIM neighbor.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
723
Customize Multicast Routing
Example:
ciscoasa(config)# interface GigabitEthernet0/3
ciscoasa(config-if)# pim neighbor-filter pim_nbr
In the example, the 10.1.1.1 router is prevented from becoming a PIM neighbor on interface GigabitEthernet0/3.
Procedure
Step 1 Use a standard ACL to define the routers that you want to have participate in PIM:
access-list pim_nbr deny router-IP_addr PIM neighbor
Example:
ciscoasa(config)# access-list pim_nbr deny 10.1.1.1 255.255.255.255
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
724
Customize Multicast Routing
In the example, the following ACL, when used with the pim neighbor-filter command, prevents the 10.1.1.1
router from becoming a PIM neighbor.
Example:
ciscoasa(config)# interface GigabitEthernet0/3
ciscoasa(config-if)# pim bidirectional neighbor-filter pim_nbr
In the example, the 10.1.1.1 router is prevented from becoming a PIM bidirectional neighbor on interface
GigabitEthernet0/3.
Procedure
Step 1 Configure the router to announce its candidacy as a bootstrap router (BSR):
pim bsr-candidate interface_name [hash_mask_length [priority]]
Example:
ciscoasa(config)# pim bsr-candidate inside 12 3
Example:
ciscoasa(config)# interface GigabitEthernet0/0
ciscoasa(config-if)# pim bsr-border
When this command is configured on an interface, no bootstrap router (BSR) messages will be sent or received
through an interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
725
Monitoring for PIM
You can set up an administratively scoped boundary on an interface for multicast group addresses. IANA has
designated the multicast address range from 239.0.0.0 to 239.255.255.255 as the administratively scoped
addresses. This range of addresses can be reused in domains administered by different organizations. The
addresses would be considered local, not globally unique.
A standard ACL defines the range of affected addresses. When a boundary is set up, no multicast data packets
are allowed to flow across the boundary from either direction. The boundary allows the same multicast group
address to be reused in different administrative domains.
You can configure, examine, and filter Auto-RP discovery and announcement messages at the administratively
scoped boundary by entering the filter-autorp keyword. Any Auto-RP group range announcements from the
Auto-RP packets that are denied by the boundary ACL are removed. An Auto-RP group range announcement
is permitted and passed by the boundary only if all addresses in the Auto-RP group range are permitted by
the boundary ACL. If any address is not permitted, the entire group range is filtered and removed from the
Auto-RP message before the Auto-RP message is forwarded.
Procedure
Example:
ciscoasa(config-if)# multicast boundary acl1 [filter-autorp]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
726
Example for Multicast Routing
ciscoasa(config)# multicast-routing
ciscoasa(config)# interface
ciscoasa(config-if)# igmp join-group group-address
Protocol Independent Multicast Source-Specific 9.5(1) Support was added to allow PIM-SSM packets to pass through
Multicast (PIM-SSM) pass-through support when multicast routing is enabled, unless the ASA is the
Last-Hop Router. This allows greater flexibility in choosing a
multicast group while also protecting against different attacks;
hosts only receive traffic from explicitly-requested sources.
We did not change any commands.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
727
History for Multicast Routing
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
728
CHAPTER 28
IPv6 Neighbor Discovery
• About IPv6 Neighbor Discovery, page 729
• Prerequisites for IPv6 Neighbor Discovery, page 730
• Guidelines for IPv6 Neighbor Discovery, page 730
• Defaults for IPv6 Neighbor Discovery, page 732
• Configure IPv6 Neighbor Discovery, page 733
• Monitoring IPv6 Neighbor Discovery, page 738
• History for IPv6 Neighbor Discovery, page 738
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
729
Prerequisites for IPv6 Neighbor Discovery
If the duplicate address is the link-local address of the interface, the processing of IPv6 packets is disabled
on the interface. If the duplicate address is a global address, the address is not used.
The ASA uses neighbor solicitation messages to perform Duplicate Address Detection. By default, the number
of times an interface performs Duplicate Address Detection is 1.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
730
Guidelines for IPv6 Neighbor Discovery
The following guidelines and limitations apply for configuring a static IPv6 neighbor:
• The ipv6 neighbor command is similar to the arp command. If an entry for the specified IPv6 address
already exists in the neighbor discovery cache—learned through the IPv6 neighbor discovery process—the
entry is automatically converted to a static entry. These entries are stored in the configuration when the
copy command is used to store the configuration.
• Use the show ipv6 neighbor command to view static entries in the IPv6 neighbor discovery cache.
• The clear ipv6 neighbor command deletes all entries in the IPv6 neighbor discovery cache except static
entries. The no ipv6 neighbor command deletes a specified static entry from the neighbor discovery
cache; the command does not remove dynamic entries—entries learned from the IPv6 neighbor discovery
process—from the cache. Disabling IPv6 on an interface by using the no ipv6 enable command deletes
all IPv6 neighbor discovery cache entries configured for that interface except static entries (the state of
the entry changes to INCMP [Incomplete]).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
731
Defaults for IPv6 Neighbor Discovery
• Static entries in the IPv6 neighbor discovery cache are not modified by the neighbor discovery process.
• The clear ipv6 neighbor command does not remove static entries from the IPv6 neighbor discovery
cache; it only clears the dynamic entries.
• The ICMP syslogs generated are caused by a regular refresh of IPv6 neighbor entries. The ASA default
timer for IPv6 neighbor entry is 30 seconds, so the ASA would generate ICMPv6 neighbor discovery
and response packets about every 30 seconds. If the ASA has both failover LAN and state interfaces
configured with IPv6 addresses, then every 30 seconds, ICMPv6 neighbor discovery and response
packets will be generated by both ASAs for both configured and link-local IPv6 addresses. In addition,
each packet will generate several syslogs (ICMP connection and local-host creation or teardown), so it
may appear that constant ICMP syslogs are being generated. The refresh time for IPV6 neighbor entry
is configurable on the regular data interface, but not configurable on the failover interface. However,
the CPU impact for this ICMP neighbor discovery traffic is minimal.
Parameters Default
value for the neighbor solicitation transmission 1000 seconds between neighbor solicitation
message interval transmissions.
value for the router advertisement transmission The default is 200 seconds.
interval
value for the number of consecutive neighbor The default is one message.
solicitation messages sent during DAD
on-link flag The flag is on by default, which means that the prefix
is used on the advertising interface.
autoconfig flag The flag is on by default, which means that the prefix
is used for autoconfiguration.
static IPv6 neighbor Static entries are not configured in the IPv6 neighbor
discovery cache.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
732
Configure IPv6 Neighbor Discovery
Procedure
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/0
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/0
ciscoasa(config-if)# ipv6 nd ns-interval 9000
Valid values for the value argument range from 1000 to 3600000 milliseconds.
This information is also sent in router advertisement messages.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
733
Configure IPv6 Neighbor Discovery
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/0
ciscoasa config-if)# ipv6 nd reachable-time 1700000
Valid values for the value argument range from 0 to 3600000 milliseconds.
When 0 is used for the value, the reachable time is sent as undetermined. It is up to the receiving devices to
set and track the reachable time value.
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/0
ciscoasa(config-if)# ipv6 nd ra-interval 201
The optional msec keyword indicates that the value provided is in milliseconds. If this keyword is not present,
the value provided is in seconds.
Valid values for the value argument range from 3 to 1800 seconds or from 500 to 1800000 milliseconds if
the msec keyword is provided.
The interval between transmissions should be less than or equal to the IPv6 router advertisement lifetime if
the ASA is configured as a default router. For more information, see Configure the Router Lifetime Value,
on page 735. To prevent synchronization with other IPv6 nodes, randomly adjust the actual value used to
within 20 percent of the desired value.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
734
Configure IPv6 Neighbor Discovery
Procedure
Specify the length of time that nodes on the local link should consider the ASA as the default router on the
link:
ipv6 nd ra-lifetime [msec] value
Example:
ciscoasa(config)# interface gigabitethernet 0/0
ciscoasa(config-if)# ipv6 nd ra-lifetime 2000
• The optional msec keyword indicates that the value provided is in milliseconds. If this keyword is not
present, the value provided is in seconds.
• Valid values for the value argument range from 0 to 9000 seconds.
• Entering 0 indicates that the ASA should not be considered a default router on the selected interface.
Procedure
Specify the uniqueness of new unicast IPv6 addresses before they are assigned and ensure that duplicate IPv6
addresses are detected in the network on a link basis:
ipv6 nd dad attempts value
Example:
ciscoasa(config)# interface gigabitethernet 0/0
ciscoasa(config-if)# ipv6 nd dad attempts 20
Valid values for the value argument range from 0 to 600. A zero value disables DAD processing on the
specified interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
735
Configure IPv6 Neighbor Discovery
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/0
ciscoasa(config-if)# ipv6 nd suppress-ra 900
The seconds argument specifies the validity of the ASA as a default router on this interface. Valid values
range from 0 to 9000 seconds.
A zero indicates that the ASA should not be considered a default router on the specified interface.
Note Entering this command causes the ASA to appear as a regular IPv6 neighbor on the link and not as
an IPv6 router.
Procedure
Step 1 Set the Managed Address Config flag in the IPv6 router advertisement packet:
ipv6 nd managed-config-flag
Example:
ciscoasa(config-if)# ipv6 nd managed-config-flag
This flag informs IPv6 autoconfiguration clients that they should use DHCPv6 to obtain addresses, in addition
to the derived stateless autoconfiguration address.
Step 2 Set the Other Address Config flag in the IPv6 router advertisement packet:
ipv6 nd other-config-flag
Example:
ciscoasa(config-if)# ipv6 nd other-config-flag
This flag informs IPv6 autoconfiguration clients that they should use DHCPv6 to obtain additional information
from DHCPv6, such as the DNS server address.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
736
Configure IPv6 Neighbor Discovery
Procedure
Example:
ciscoasa(config)# interface gigabitethernet 0/0
ciscoasa(config-if)# ipv6 nd prefix 2001:DB8::/32 1000 900
• The prefix advertisement can be used by neighboring devices to autoconfigure their interface addresses.
Stateless autoconfiguration uses IPv6 prefixes provided in router advertisement messages to create the
global unicast address from the link-local address.
• The at valid-date preferred-date syntax indicates the date and time at which the lifetime and preference
expire. The prefix is valid until this specified date and time are reached.
• Dates are expressed in the form date-valid-expire month-valid-expire hh:mm-valid-expire
date-prefer-expire month-prefer-expire hh:mm-prefer-expire.
• The default keyword indicates that default values are used.
• The optional infinite keyword specifies that the valid lifetime does not expire.
• The ipv6-prefix argument specifies the IPv6 network number to include in router advertisements. This
argument must be in the form documented in RFC 2373 where the address is specified in hexadecimal
using 16-bit values between colons.
• The optional no-advertise keyword indicates to hosts on the local link that the specified prefix is not to
be used for IPv6 autoconfiguration.
• The optional no-autoconfig keyword indicates to hosts on the local link that the specified prefix cannot
be used for IPv6 autoconfiguration.
• The optional off-link keyword indicates that the specified prefix is not used for on-link determination.
• The preferred-lifetime argument specifies the amount of time (in seconds) that the specified IPv6 prefix
is advertised as being preferred. Valid values range from 0 to 4294967295 seconds. The maximum value
represents infinity, which can also be specified with infinite. The default is 604800 (7 days).
• The prefix-length argument specifies the length of the IPv6 prefix. This value indicates how many of
the high-order, contiguous bits of the address comprise the network portion of the prefix. The slash (/)
must precede the prefix length.
• The valid-lifetime argument specifies the amount of time that the specified IPv6 prefix is advertised as
being valid. Valid values range from 0 to 4294967295 seconds. The maximum value represents infinity,
which can also be specified with infinite. The default is 2592000 (30 days).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
737
Monitoring IPv6 Neighbor Discovery
Procedure
Example:
ciscoasa(config-if)# ipv6 neighbor 3001:1::45A inside 002.7D1A.9472
The ipv6_address argument is the link-local IPv6 address of the neighbor, the if_name argument is the interface
through which the neighbor is available, and the mac_address argument is the MAC address of the neighbor
interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
738
History for IPv6 Neighbor Discovery
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
739
History for IPv6 Neighbor Discovery
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
740
PART VI
AAA Servers and the Local Database
• AAA and the Local Database, page 743
• RADIUS Servers for AAA, page 753
• TACACS+ Servers for AAA, page 775
• LDAP Servers for AAA, page 781
CHAPTER 29
AAA and the Local Database
This chapter describes authentication, authorization, and accounting (AAA, pronounced “triple A”). AAA
is a a set of services for controlling access to computer resources, enforcing policies, assessing usage, and
providing the information necessary to bill for services. These processes are considered important for effective
network management and security.
This chapter also describes how to configure the local database for AAA functionality. For external AAA
servers, see the chapter for your server type.
Authentication
Authentication provides a way to identify a user, typically by having the user enter a valid username and valid
password before access is granted. The AAA server compares a user's authentication credentials with other
user credentials stored in a database. If the credentials match, the user is permitted access to the network. If
the credentials do not match, authentication fails and network access is denied.
You can configure the Cisco ASA to authenticate the following items:
• All administrative connections to the ASA, including the following sessions:
◦Telnet
◦SSH
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
743
About AAA and the Local Database
◦Serial console
◦ASDM using HTTPS
◦VPN management access
Authorization
Authorization is the process of enforcing policies: determining what types of activities, resources, or services
a user is permitted to access. After a user is authenticated, that user may be authorized for different types of
access or activity.
You can configure the ASA to authorize the following items:
• Management commands
• Network access
• VPN access
Accounting
Accounting measures the resources a user consumes during access, which may include the amount of system
time or the amount of data that a user has sent or received during a session. Accounting is carried out through
the logging of session statistics and usage information, which is used for authorization control, billing, trend
analysis, resource utilization, and capacity planning activities.
AAA Servers
The AAA server is a network server that is used for access control. Authentication identifies the user.
Authorization implements policies that determine which resources and services an authenticated user may
access. Accounting keeps track of time and data resources that are used for billing and analysis.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
744
About AAA and the Local Database
For multiple context mode, you can configure usernames in the system execution space to provide individual
logins at the CLI using the login command; however, you cannot configure any AAA rules that use the local
database in the system execution space.
Note You cannot use the local database for network access authorization.
Fallback Support
The local database can act as a fallback method for several functions. This behavior is designed to help you
prevent accidental lockout from the ASA.
When a user logs in, the servers in the group are accessed one at a time, starting with the first server that you
specify in the configuration, until a server responds. If all servers in the group are unavailable, the ASA tries
the local database if you have configured it as a fallback method (for management authentication and
authorization only). If you do not have a fallback method, the ASA continues to try the AAA servers.
For users who need fallback support, we recommend that their usernames and passwords in the local database
match their usernames and passwords on the AAA servers. This practice provides transparent fallback support.
Because the user cannot determine whether a AAA server or the local database is providing the service, using
usernames and passwords on AAA servers that are different than the usernames and passwords in the local
database means that the user cannot be certain which username and password should be given.
The local database supports the following fallback functions:
• Console and enable password authentication—If the servers in the group are all unavailable, the ASA
uses the local database to authenticate administrative access, which can also include enable password
authentication.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
745
Guidelines for the Local Database
• Command authorization—If the TACACS+ servers in the group are all unavailable, the local database
is used to authorize commands based on privilege levels.
• VPN authentication and authorization—VPN authentication and authorization are supported to enable
remote access to the ASA if AAA servers that normally support these VPN services are unavailable.
When a VPN client of an administrator specifies a tunnel group configured to fallback to the local
database, the VPN tunnel can be established even if the AAA server group is unavailable, provided that
the local database is configured with the necessary attributes.
Procedure
Example:
ciscoasa(config)# username exampleuser1 privilege 1
Theusername username keyword is a string from 3 to 64 characters long, using any combination of ASCII
printable characters (character codes 32-126), with the exception of spaces and the question mark. The
password password keyword is a string from 3 to 32 characters long, and can be any combination of ASCII
printable characters (character codes 32-126), with the exception of spaces and the question mark. The privilege
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
746
Add a User Account to the Local Database
priv_level keyword sets the privilege level, which ranges from 0 to 15. The default is 2. This privilege level
is used with command authorization.
Caution If you do not use command authorization (the aaa authorization console LOCAL command),
then the default level 2 allows management access to privileged EXEC mode. If you want to limit
access to privileged EXEC mode, either set the privilege level to 0 or 1, or use the service-type
command.
The nopassword keyword creates a user account with no password. The encrypted keyword indicates that
the password is encrypted. When you define a password in the username command, the ASA encrypts it
when it saves it to the configuration for security purposes. When you enter the show running-config command,
the username command does not show the actual password; it shows the encrypted password followed by
the encrypted keyword. For example, if you enter the password “test,” the show running-config command
output would appear as something similar to the following:
The only time you would actually enter the encrypted keyword at the CLI is if you are cutting and pasting a
configuration file for use in another ASA, and you are using the same password.
Example:
ciscoasa(config)# username exampleuser1 attributes
The username argument is the username that you created in the first step.
By default, VPN users that you add with this command have no attributes or group policy association. You
must configure all values explicitly using the username attributes command. See the VPN configuration
guide for more information.
Step 3 (Optional) Configure the user level if you configured management authorization using the aaa authorization
exec command.
service-type {admin | nas-prompt | remote-access}
Example:
ciscoasa(config-username)# service-type admin
The admin keyword allows full access to any services specified by the aaa authentication console LOCAL
commands. The admin keyword is the default.
The nas-prompt keyword allows access to the CLI when you configure the aaa authentication {telnet | ssh
| serial} console command, but denies ASDM configuration access if you configure the aaa authentication
http console command. ASDM monitoring access is allowed. If you enable authentication with the aaa
authentication enable console command, the user cannot access privileged EXEC mode using the enable
command (or the login command).
The remote-access keyword denies management access. You cannot use any services specified by the aaa
authentication console commands (excluding the serial keyword; serial access is allowed).
Step 4 Enable public key authentication for SSH connections to the ASA on a per-user basis.
ssh authentication {pkf | publickey key [hashed]}
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
747
Add a User Account to the Local Database
Example:
ciscoasa(config-username)# ssh authentication pkf
You can specify a public key file (PKF) formatted key (the pkf keyword) or a Base64 key (the publickey
keyword). For a publickey, the key is a Base64-encoded public key. You can generate the key using any SSH
key generation software (such as ssh keygen) that can generate SSH-RSA raw keys (with no certificates).
For a pkf key, you are prompted to paste in a PKF formatted key, up to 4096 bits. Use this format for keys
that are too large to paste inline in Base64 format. For example, you can generate a 4096-bit key using ssh
keygen, then convert it to PKF, and use the pkf keyword to be prompted for the key.
Note You can use the pkf option with failover, but the PKF key is not automatically replicated to the
standby system. You must enter the write standby command to synchronize the PKF key.
When you view the key on the ASA using the show running-config username command, the key is encrypted
using a SHA-256 hash. Even if you entered the key as pkf, the ASA hashes the key, and shows it as a hashed
publickey. If you need to copy the key from show output, specify the publickey type with the hashed keyword.
Step 5 (Optional) If you are using this username for VPN authentication, you can configure many VPN attributes
for the user. See the VPN configuration guide for more information.
Examples
The following example assigns a privilege level of 15 to the admin user account:
The following example enables management authorization, creates a user account with a password, enters
username configuration mode, and specifies a service-type of nas-prompt:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
748
Generate a Shared Key
Procedure
Step 1 Generate the ssh-rsa public and private keys for 4096 bits on your computer:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
749
Generate a Shared Key
jcrichton-mac:.ssh john$
The following dialog box appears for you to enter your passphrase:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
750
Monitoring the Local Database
asa>
Support for SSH public key authentication 9.1(2) You can now enable public key authentication for SSH
connections to the ASA on a per-user basis. You can specify a
public key file (PKF) formatted key or a Base64 key. The PKF
key can be up to 4096 bits. Use PKF format for keys that are
too large to for the ASA support of the Base64 format (up to
2048 bits).
We introduced the following commands: ssh authentication.
Also available in 8.4(4.1); PKF key format support is only in
9.1(2).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
751
History for the Local Database
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
752
CHAPTER 30
RADIUS Servers for AAA
This chapter describes how to configure RADIUS servers for AAA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
753
About RADIUS Servers for AAA
Note To enable MS-CHAPv2 as the protocol used between the ASA and the RADIUS server
for a VPN connection, password management must be enabled in the tunnel group
general attributes. Enabling password management generates an MS-CHAPv2
authentication request from the ASA to the RADIUS server. See the description of the
password-management command for details.
If you use double authentication and enable password management in the tunnel group,
then the primary and secondary authentication requests include MS-CHAPv2 request
attributes. If a RADIUS server does not support MS-CHAPv2, then you can configure
that server to send a non-MS-CHAPv2 authentication request by using the no
mschapv2-capable command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
754
About RADIUS Servers for AAA
Note RADIUS attribute names do not contain the cVPN3000 prefix. Cisco Secure ACS 4.x supports this new
nomenclature, but attribute names in pre-4.0 ACS releases still include the cVPN3000 prefix. The ASAs
enforce the RADIUS attributes based on attribute numeric ID, not attribute name.
All attributes listed in the following table are downstream attributes that are sent from the RADIUS server
to the ASA except for the following attribute numbers: 146, 150, 151, and 152. These attribute numbers
are upstream attributes that are sent from the ASA to the RADIUS server. RADIUS attributes 146 and
150 are sent from the ASA to the RADIUS server for authentication and authorization requests. All four
previously listed attributes are sent from the ASA to the RADIUS server for accounting start, interim-update,
and stop requests. Upstream RADIUS attributes 146, 150, 151, and 152 were introduced in Version 8.4(3).
Cisco ACS 5.x and Cisco ISE do not support IPv6 framed IP addresses for IP address assignment using
RADIUS authentication in Version 9.0(1).
Authorization-DN-Field Y 67 String Single Possible values: UID, OU, O, CN, L, SP, C, EA,
T, N, GN, SN, I, GENQ, DNQ, SER,
use-entire-name
Banner1 Y 15 String Single Banner string to display for Cisco VPN remote
access sessions: IPsec IKEv1, AnyConnect
SSL-TLS/DTLS/IKEv2, and Clientless SSL
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
755
About RADIUS Servers for AAA
Client Type Y 150 Integer Single 1 = Cisco VPN Client (IKEv1) 2 = AnyConnect
Client SSL VPN 3 = Clientless SSL VPN 4 =
Cut-Through-Proxy 5 = L2TP/IPsec SSL VPN
6 = AnyConnect Client IPsec VPN (IKEv2)
Group-Policy Y 25 String Single Sets the group policy for the remote access VPN
session. For Versions 8.2.x and later, use this
attribute instead of IETF-Radius-Class. You can
use one of the following formats:
• group policy name
• OU=group policy name
• OU=group policy name;
IE-Proxy-Exception-List 82 String Single New line (\n) separated list of DNS domains
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
756
About RADIUS Servers for AAA
IPsec-Default-Domain Y 28 String Single Specifies the single default domain name to send
to the client (1-255 characters).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
757
About RADIUS Servers for AAA
IPsec-Split-Tunnel-List Y 27 String Single Specifies the name of the network or ACL that
describes the split tunnel inclusion list.
Engineering, Sales
An administrative attribute that can be used in
dynamic access policies. It does not set a group
policy.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
758
About RADIUS Servers for AAA
Required-Client- Firewall-Vendor-Code Y 45 Integer Single 1 = Cisco Systems (with Cisco Integrated Client)
2 = Zone Labs 3 = NetworkICE 4 = Sygate 5 =
Cisco Systems (with Cisco Intrusion Prevention
Security Agent)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
759
About RADIUS Servers for AAA
Smart-Tunnel-Auto-Signon-Enable Y 139 String Single Name of a Smart Tunnel Auto Signon list
appended by the domain name
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
760
About RADIUS Servers for AAA
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
761
About RADIUS Servers for AAA
WebVPN-Smart-Tunnel-Auto-Sign-On Y 139 String Single Name of a Smart Tunnel auto sign-on list
appended by the domain name
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
762
About RADIUS Servers for AAA
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
763
About RADIUS Servers for AAA
IETF-Radius-Filter-Id Y 11 String Single ACL name that is defined on the ASA, which
applies only to full tunnel IPsec and SSL VPN
clients.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
764
About RADIUS Servers for AAA
ACCT_DISC_LOST_CARRIER = 2
ACCT_DISC_LOST_SERVICE = 3
ACCT_DISC_IDLE_TIMEOUT = 4
ACCT_DISC_SESS_TIMEOUT = 5
ACCT_DISC_ADMIN_RESET = 6
ACCT_DISC_ADMIN_REBOOT = 7
ACCT_DISC_PORT_ERROR = 8
ACCT_DISC_NAS_ERROR = 9
ACCT_DISC_NAS_REQUEST = 10
ACCT_DISC_NAS_REBOOT = 11
ACCT_DISC_PORT_UNNEEDED = 12
ACCT_DISC_PORT_PREEMPTED = 13
ACCT_DISC_PORT_SUSPENDED = 14
ACCT_DISC_SERV_UNAVAIL = 15
ACCT_DISC_CALLBACK = 16
ACCT_DISC_USER_ERROR = 17
ACCT_DISC_HOST_REQUEST = 18
ACCT_DISC_ADMIN_SHUTDOWN = 19
ACCT_DISC_SA_EXPIRED = 21
ACCT_DISC_MAX_REASONS = 22
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
765
Guidelines for RADIUS Servers for AAA
IPv6
The AAA server must use an IPv4 address, but endpoints can use IPv6.
Additional Guidelines
• You can have up to 100 server groups in single mode or 4 server groups per context in multiple mode.
• Each group can have up to 16 servers in single mode or 4 servers in multiple mode.
Procedure
Step 1 Load the ASA attributes into the RADIUS server. The method that you use to load the attributes depends on
which type of RADIUS server that you are using:
• If you are using Cisco ACS: the server already has these attributes integrated. You can skip this step.
• For RADIUS servers from other vendors (for example, Microsoft Internet Authentication Service): you
must manually define each ASA attribute. To define an attribute, use the attribute name or number, type,
value, and vendor code (3076).
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
766
Configure RADIUS Servers for AAA
Example:
ciscoasa(config)# aaa-server servergroup1 protocol radius
ciscoasa(config-aaa-server-group)#
When you enter the aaa-server protocol command, you enter aaa-server group configuration mode.
Step 2 Merge a downloadable ACL with the ACL received in the Cisco AV pair from a RADIUS packet.
merge-dacl {before-avpair | after-avpair}
Example:
ciscoasa(config-aaa-server-group)# merge-dacl before-avpair
The default setting is no merge dacl, which specifies that downloadable ACLs will not be merged with Cisco
AV pair ACLs. If both an AV pair and a downloadable ACL are received, the AV pair has priority and is
used.
The before-avpair option specifies that the downloadable ACL entries should be placed before the Cisco AV
pair entries.
The after-avpair option specifies that the downloadable ACL entries should be placed after the Cisco AV
pair entries. This option applies only to VPN connections. For VPN users, ACLs can be in the form of Cisco
AV pair ACLs, downloadable ACLs, and an ACL that is configured on the ASA. This option determines
whether or not the downloadable ACL and the AV pair ACL are merged, and does not apply to any ACLs
configured on the ASA.
Step 3 Specify the maximum number of requests that can be sent to a RADIUS server in the group before the ASA
tries the next server.
max-failed-attempts number
Example:
ciscoasa(config-aaa-server-group)# max-failed-attempts 2
Step 4 Specify the method (reactivation policy) by which failed servers in a group are reactivated.
reactivation-mode {depletion [deadtime minutes] | timed}
Example:
ciscoasa(config-aaa-server-group)# reactivation-mode deadtime 20
The depletion keyword reactivates failed servers only after all of the servers in the group are inactive.
The deadtime minutes keyword-argument pair specifies the amount of time in minutes, between 0 and 1440,
that elapses between the disabling of the last server in the group and the subsequent reenabling of all servers.
The default is 10 minutes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
767
Configure RADIUS Servers for AAA
The timed keyword reactivates failed servers after 30 seconds of down time.
Example:
ciscoasa(config-aaa-server-group)# accounting-mode simultaneous
Enter the accounting-mode single command to restore the default of sending messages only to the active
server.
Step 6 Identify the server and the AAA server group to which it belongs.
aaa-server server_group [interface_name] host server_ip
Example:
ciscoasa(config)# aaa-server servergroup1 outside host 10.10.1.1
When you enter the aaa-server host command, you enter aaa-server host configuration mode.
Step 7 Enable the RADIUS Dynamic Authorization (CoA) services for the AAA server group.
dynamic-authorization {port port-number}
Example:
ciscoasa(config-aaa-server-group)# dynamic-authorization port 1700
Once defined, the corresponding RADIUS server group will be registered for CoA notification and the ASA
will listen to the port for the CoA policy updates from ISE.
The valid range of the CoA listening port-number is 1 to 65535.
If the port number or interface specified in the no form of this command does not match a line in the current
configuration, an error message appears.
Example:
ciscoasa(config-aaa-server-group)# authorize-only
When this server group is used for authorization, the RADIUS Access Request message will be built as an
“Authorize Only” request instead of the configured password methods that are available now.
The Authorize-Only request includes a Service-Type attribute with value Authorize-Only (17) and message
authenticator within the Access-Request.
The support of the authorize-only mode eliminates the need of including the RADIUS common password in
the Access-Request. Thus, it does not require the configuration of common password using the
radius-common-pw CLI in the aaa-server-host mode.
Note The authorize-only mode is configured for the server group; however, the common password is
host-specific. Thus, once authorize-only mode is configured, the common password configured for
an individual AAA server would be ignored.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
768
Configure RADIUS Servers for AAA
Step 9 Switch off hostscan processing for connections that are made to a specific tunnel group.
without-csd {anyconnect}
Example:
ciscoasa(config-tunnel-webvpn)# without-csd anyconnect
This setting currently applies to clientless and Layer 3 connections. This command has been modified to allow
this setting to be applied to AnyConnect connections only.
Examples
The following example shows how to add one RADIUS group with a single server:
The following example shows how to configure an ISE server object for authorization-only, dynamic
authorization (CoA) updates, and hourly periodic accounting:
The following example shows how to configure a tunnel group for password authentication with ISE:
The following example shows how to configure a tunnel group for local certificate validation and authorization
with ISE:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
769
Configure RADIUS Servers for AAA
Procedure
Step 1 Identify the RADIUS server and the AAA server group to which it belongs.
aaa-server server_group [interface_name] host server_ip
Example:
ciscoasa(config-aaa-server-group)# aaa-server servergroup1 outside host 10.10.1.1
When you enter the aaa-server host command, you enter aaa-server host configuration mode.
Step 2 Specify how the ASA treats netmasks received in a downloadable ACL from a RADIUS server that is accessed
by entering the aaa-server host configuration mode.
acl-netmask-convert {auto-detect | standard | wildcard}
Example:
ciscoasa(config-aaa-server-host)# acl-netmask-convert standard
Theauto-detect keyword specifies that the ASA should attempt to determine the type of netmask expression
used. If the ASA detects a wildcard netmask expression, it converts it to a standard netmask expression.
The standard keyword specifies that the ASA assumes downloadable ACLs received from the RADIUS
server contain only standard netmask expressions. No translation from wildcard netmask expressions is
performed.
The wildcard keyword specifies that the ASA assumes downloadable ACLs received from the RADIUS
server contain only wildcard netmask expressions and converts them all to standard netmask expressions
when the ACLs are downloaded.
Step 3 Specify a common password to be used for all users who are accessing a RADIUS authorization server through
the ASA.
radius-common-pw string
Example:
ciscoasa(config-aaa-server-host)# radius-common-pw examplepassword123abc
The string argument is a case-sensitive, alphanumeric keyword of up to 127 characters to be used as a common
password for all authorization transactions with the RADIUS server.
Example:
ciscoasa(config-aaa-server-host)# mschapv2-capable
Step 5 Specify the length of time, in seconds, that the ASA waits for a response from the primary server before
sending the request to the backup server.
timeout hh:mm:ss
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
770
Configure RADIUS Servers for AAA
Example:
ciscoasa(config-aaa-server-host)# timeout 15
Step 6 Configure the amount of time between retry attempts for a particular AAA server designated in a previous
command.
retry-interval seconds
Example:
ciscoasa(config-aaa-server-host)# retry-interval 8
The seconds argument specifies the retry interval (1-10 seconds) for the request. This is the time that the ASA
waits before retrying a connection request.
Note The interval between subsequent retries will always be 50 or 100 milliseconds, regardless of the
retry-interval settings you have entered. This is the intended behavior.
Step 7 Send accounting messages to all servers in the group.
accounting-mode simultaneous
Example:
ciscoasa(config-aaa-server-group)# accounting-mode simultaneous
Enter the accounting-mode single command to restore the default of sending messages only to the active
server.
Step 8 Specify the authentication port as port number1645, or the server port to be used for authentication of users.
authentication-port port
Example:
ciscoasa(config-aaa-server-host)# authentication-port 1646
Step 9 Specify the accounting port as port number 1646, or the server port to be used for accounting for this host.
accounting-port port
Example:
ciscoasa(config-aaa-server-host)# accounting-port 1646
Step 10 Specify the server secret value used to authenticate the RADIUS server to the ASA. The server secret that
you configure should match the one configured on the RADIUS server. If you do not know the server secret
value, ask the RADIUS server administrator. The maximum length is 64 characters.
key
Example:
ciscoasa(config-aaa-host)# key myexamplekey1
The server secret that you configure should match the one configured on the RADIUS server. If you do not
know the server secret value, ask the RADIUS server administrator. The maximum length is 64 characters.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
771
Monitoring RADIUS Servers for AAA
Example
The following example shows how to add a RADIUS server to an existing RADIUS server group:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
772
History for RADIUS Servers for AAA
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
773
History for RADIUS Servers for AAA
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
774
CHAPTER 31
TACACS+ Servers for AAA
This chapter describes how to configure TACACS+ servers used in AAA.
TACACS+ Attributes
The Cisco ASA provides support for TACACS+ attributes. TACACS+ attributes separate the functions of
authentication, authorization, and accounting. The protocol supports two types of attributes: mandatory and
optional. Both the server and client must understand a mandatory attribute, and the mandatory attribute must
be applied to the user. An optional attribute may or may not be understood or used.
Note To use TACACS+ attributes, make sure that you have enabled AAA services on the NAS.
The following table lists supported TACACS+ authorization response attributes for cut-through-proxy
connections.
Attribute Description
acl Identifies a locally configured ACL to be applied to the connection.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
775
About TACACS+ Servers for AAA
Attribute Description
idletime Indicates the amount of inactivity in minutes that is allowed before the authenticated
user session is terminated.
timeout Specifies the absolute amount of time in minutes that authentication credentials remain
active before the authenticated user session is terminated.
Attribute Description
bytes_in Specifies the number of input bytes transferred during this connection (stop records
only).
bytes_out Specifies the number of output bytes transferred during this connection (stop records
only).
disc-cause Indicates the numeric code that identifies the reason for disconnecting (stop records
only).
elapsed_time Defines the elapsed time in seconds for the connection (stop records only).
foreign_ip Specifies the IP address of the client for tunnel connections. Defines the address on the
lowest security interface for cut-through-proxy connections.
local_ip Specifies the IP address that the client connected to for tunnel connections. Defines the
address on the highest security interface for cut-through-proxy connections.
packs_in Specifies the number of input packets transferred during this connection.
packs_out Specifies the number of output packets transferred during this connection.
priv-level Set to the user privilege level for command accounting requests or to 1 otherwise.
service Specifies the service used. Always set to “shell” for command accounting only.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
776
Guidelines for TACACS+ Servers for AAA
IPv6
The AAA server must use an IPv4 address, but endpoints can use IPv6.
Additional Guidelines
• You can have up to 100 server groups in single mode or 4 server groups per context in multiple mode.
• Each group can have up to 16 servers in single mode or 4 servers in multiple mode.
Procedure
Procedure
Example:
ciscoasa(config)# aaa-server servergroup1 protocol tacacs+
When you enter the aaa-server protocol command, you enter aaa-server group configuration mode.
Step 2 Specify the maximum number of requests sent to a AAA server in the group before trying the next server.
max-failed-attempts number
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
777
Configure TACACS+ Servers
Example:
ciscoasa(config-aaa-server-group)# max-failed-attempts 2
Step 3 Specify the method (reactivation policy) by which failed servers in a group are reactivated.
reactivation-mode {depletion [deadtime minutes] | timed}
Example:
ciscoasa(config-aaa-server-group)# reactivation-mode deadtime 20
The depletion keyword reactivates failed servers only after all of the servers in the group are inactive.
The deadtime minutes keyword-argument pair specifies the amount of time in minutes, between 0 and 1440,
that elapses between the disabling of the last server in the group and the subsequent reenabling of all servers.
The default is 10 minutes.
The timed keyword reactivates failed servers after 30 seconds of down time.
Example:
ciscoasa(config-aaa-server-group)# accounting-mode simultaneous
To restore the default of sending messages only to the active server, enter the accounting-mode single
command.
Example
The following example shows how to add one TACACS+ group with one primary and one backup server:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
778
Monitoring TACACS+ Servers for AAA
Procedure
Step 1 Identify the TACACS+ server and the server group to which it belongs.
aaa-server server_group [interface_name] host server_ip
Example:
ciscoasa(config-aaa-server-group)# aaa-server servergroup1 outside host 10.10.1.1
When you enter the aaa-server host command, you enter aaa-server host configuration mode.
Step 2 Specify the length of time, in seconds, that the ASA waits for a response from the primary server before
sending the request to the backup server.
timeout hh:mm:ss
Example:
ciscoasa(config-aaa-server-host)# timeout 15
Step 3 Specify the server port as port number 49, or the TCP port number used by the ASA to communicate with
the TACACS+ server.
server-port port_number
Example:
ciscoasa(config-aaa-server-host)# server-port 49
Step 4 Specify the server secret value used to authenticate the NAS to the TACACS+ server.
key
Example:
ciscoasa(config-aaa-host)# key myexamplekey1
This value is a case-sensitive, alphanumeric keyword of up to 127 characters, which is the same value as the
key on the TACACS+ server. Any characters over 127 are ignored. The key is used between the client and
the server to encrypt data between them and must be the same on both the client and server systems. The key
cannot contain spaces, but other special characters are allowed.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
779
History for TACACS+ Servers for AAA
This command shows the configured TACACS+ server statistics. Enter the clear aaa-server statistics
command to clear the TACACS+ server statistics.
• show running-config aaa-server
This command shows the TACACS+ server running configuration. Enter the clear configure aaa-server
command to clear the TACACS+ server configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
780
CHAPTER 32
LDAP Servers for AAA
This chapter describes how to configure LDAP servers used in AAA.
By default, the ASA autodetects whether it is connected to Microsoft Active Directory, Sun LDAP, Novell,
OpenLDAP, or a generic LDAPv3 directory server. However, if autodetection fails to determine the LDAP
server type, you can manually configure it.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
781
About LDAP and the ASA
• Kerberos—The ASA responds to the LDAP server by sending the username and realm using the GSSAPI
Kerberos mechanism.
The ASA and LDAP server supports any combination of these SASL mechanisms. If you configure multiple
mechanisms, the ASA retrieves the list of SASL mechanisms that are configured on the server, and sets the
authentication mechanism to the strongest one configured on both the ASA and the server. For example, if
both the LDAP server and the ASA support both mechanisms, the ASA selects Kerberos, the stronger of the
two.
When user LDAP authentication has succeeded, the LDAP server returns the attributes for the authenticated
user. For VPN authentication, these attributes generally include authorization data that is applied to the VPN
session. In this case, using LDAP accomplishes authentication and authorization in a single step.
Note For more information about LDAP, see RFCs 1777, 2251, and 2849.
LDAP Hierarchy
Your LDAP configuration should reflect the logical hierarchy of your organization. For example, suppose an
employee at your company, Example Corporation, is named Employee1. Employee1 works in the Engineering
group. Your LDAP hierarchy could have one or many levels. You might decide to set up a single-level
hierarchy in which Employee1 is considered a member of Example Corporation. Or you could set up a
multi-level hierarchy in which Employee1 is considered to be a member of the department Engineering, which
is a member of an organizational unit called People, which is itself a member of Example Corporation. See
the following figure for an example of a multi-level hierarchy.
A multi-level hierarchy has more detail, but searches return results more quickly in a single-level hierarchy.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
782
About LDAP and the ASA
you are looking for. Together, these fields limit the search of the hierarchy to only the part that includes the
user permissions.
• LDAP Base DN defines where in the LDAP hierarchy that the server should begin searching for user
information when it receives an authorization request from the ASA.
• Search Scope defines the extent of the search in the LDAP hierarchy. The search proceeds this many
levels in the hierarchy below the LDAP Base DN. You can choose to have the server search only the
level immediately below it, or it can search the entire subtree. A single level search is quicker, but a
subtree search is more extensive.
• Naming Attribute(s) defines the RDN that uniquely identifies an entry in the LDAP server. Common
naming attributes can include cn (Common Name), sAMAccountName, and userPrincipalName.
The figure shows a sample LDAP hierarchy for Example Corporation. Given this hierarchy, you could define
your search in different ways. The following table shows two sample search configurations.
In the first example configuration, when Employee1 establishes the IPsec tunnel with LDAP authorization
required, the ASA sends a search request to the LDAP server, indicating it should search for Employee1 in
the Engineering group. This search is quick.
In the second example configuration, the ASA sends a search request indicating that the server should search
for Employee1 within Example Corporation. This search takes longer.
cn=Binduser1,ou=Admins,ou=Users,dc=company_A,dc=com
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
783
About LDAP and the ASA
Note As an LDAP client, the ASA does not support the transmission of anonymous binds or requests.
The ASA uses LDAP attribute maps to translate native LDAP user attributes to Cisco ASA attributes. You
can bind these attribute maps to LDAP servers or remove them. You can also show or clear attribute maps.
The LDAP attribute map does not support multi-valued attributes. For example, if a user is a member of
several AD groups, and the LDAP attribute map matches more than one group, the value chosen is based on
the alphabetization of the matched entries.
To use the attribute mapping features correctly, you need to understand LDAP attribute names and values, as
well as the user-defined attribute names and values.
The names of frequently mapped LDAP attributes and the type of user-defined attributes that they would
commonly be mapped to include the following:
• IETF-Radius-Class (Group_Policy in ASA version 8.2 and later)—Sets the group policy based on the
directory department or user group (for example, Microsoft Active Directory memberOf) attribute value.
The group policy attribute replaced the IETF-Radius-Class attribute with ASDM version 6.2/ASA version
8.2 or later.
• IETF-Radius-Filter-Id—Applies an access control list or ACL to VPN clients, IPsec, and SSL.
• IETF-Radius-Framed-IP-Address—Assigns a static IP address assigned to a VPN remote access client,
IPsec, and SSL.
• Banner1—Displays a text banner when the VPN remote access user logs in.
• Tunneling-Protocols—Allows or denies the VPN remote access session based on the access type.
Note A single LDAP attribute map may contain one or many attributes. You can only map
one LDAP attribute from a specific LDAP server.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
784
Guidelines for LDAP Servers for AAA
IPv6
The AAA server must use an IPv4 address, but endpoints can use IPv6.
Additional Guidelines
• The DN configured on the ASA to access a Sun directory server must be able to access the default
password policy on that server. We recommend using the directory administrator, or a user with directory
administrator privileges, as the DN. Alternatively, you can place an ACL on the default password policy.
• You must configure LDAP over SSL to enable password management with Microsoft Active Directory
and Sun servers.
• The ASA does not support password management with Novell, OpenLDAP, and other LDAPv3 directory
servers.
• The VPN 3000 concentrator and the ASA/PIX 7.0 software required a Cisco LDAP schema for
authorization operations. Beginning with Version 7.1(x), the ASA performs authentication and
authorization using the native LDAP schema, and the Cisco schema is no longer needed.
• You can have up to 100 LDAP server groups in single mode or 4 LDAP server groups per context in
multiple mode.
• Each group can have up to 16 LDAP servers in single mode or 4 LDAP servers in multiple mode.
• When a user logs in, the LDAP servers are accessed one at a time, starting with the first server that you
specify in the configuration, until a server responds. If all servers in the group are unavailable, the ASA
tries the local database if you configured it as a fallback method (management authentication and
authorization only). If you do not have a fallback method, the ASA continues to try the LDAP servers.
Procedure
Step 1 Configure LDAP attribute maps. See Configure LDAP Attribute Maps, on page 785.
Step 2 Add an LDAP server group. See Configure LDAP Server Groups, on page 787.
Step 3 (Optional) Configure authorization from an LDAP server that is separate and distinct from the authentication
mechanism. See Configure Authorization with LDAP for VPN, on page 789.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
785
Configure LDAP Servers for AAA
Procedure
Example:
ciscoasa(config)# ldap-attribute-map att_map_1
Step 2 Map the user-defined attribute name department to the Cisco attribute.
map-name user-attribute-name Cisco-attribute-name
Example:
ciscoasa(config-ldap-attribute-map)# map-name department IETF-Radius-Class
Step 3 Map the user-defined map value department to the user-defined attribute value and the Cisco attribute value.
map-value user-attribute-name Cisco-attribute-name
Example:
ciscoasa(config-ldap-attribute-map)# map-value department Engineering group1
Step 4 Identify the server and the AAA server group to which it belongs.
aaa-server server_group [interface_name] host server_ip
Example:
ciscoasa(config)# aaa-server ldap_dir_1 host 10.1.1.4
Example:
ciscoasa(config-aaa-server-host)# ldap-attribute-map att_map_1
Examples
The following example shows how to limit management sessions to the ASA based on an LDAP attribute
called accessType. The accessType attribute may have one of these values:
• VPN
• admin
• helpdesk
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
786
Configure LDAP Servers for AAA
The following example shows how each value is mapped to one of the valid IETF-Radius-Service-Type
attributes that the ASA supports: remote-access (Service-Type 5) Outbound, admin (Service-Type 6)
Administrative, and nas-prompt (Service-Type 7) NAS Prompt.
The following example shows how to display the complete list of Cisco LDAP attribute names:
Procedure
Example:
ciscoasa(config)# aaa-server servergroup1 protocol ldap
ciscoasa(config-aaa-server-group)#
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
787
Configure LDAP Servers for AAA
When you enter the aaa-server protocol command, you enter aaa-server group configuration mode.
Step 2 Specify the maximum number of requests sent to an LDAP server in the group before trying the next server.
max-failed-attempts number
Example:
ciscoasa(config-aaa-server-group)# max-failed-attempts 2
Step 3 Specify the method (reactivation policy) by which failed servers in a group are reactivated.
reactivation-mode {depletion [deadtime minutes] | timed}
Example:
ciscoasa(config-aaa-server-group)# reactivation-mode deadtime 20
The depletion keyword reactivates failed servers only after all of the servers in the group are inactive.
The deadtime minutes keyword-argument pair specifies the amount of time in minutes, between 0 and 1440,
that elapses between the disabling of the last server in the group and the subsequent reenabling of all servers.
The default is 10 minutes.
The timed keyword reactivates failed servers after 30 seconds of down time.
Step 4 Identify the LDAP server and AAA server group to which it belongs.
aaa-server server_group [interface_name] host server_ip
Example:
ciscoasa(config)# aaa-server servergroup1 outside host 10.10.1.1
When you enter the aaa-server host command, you enter aaa-server host configuration mode. As needed,
use host configuration mode commands to further configure the AAA server.
The following table lists the available commands for LDAP servers, and whether or not a new LDAP server
definition has a default value for that command. If no default value is provided (indicated by “—”), use the
command to specify the value.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
788
Configure LDAP Servers for AAA
ldap-login-dn — —
ldap-login-password — —
ldap-naming-attribute — —
ldap-over-ssl 636 If not set, the ASA uses sAMAccountName for LDAP requests. Whether using
SASL or plain text, you can secure communications between the ASA and the
LDAP server with SSL. If you do not configure SASL, we strongly recommend
that you secure LDAP communications with SSL.
ldap-scope — —
sasl-mechanism — —
server-port 389 —
server-type autodiscovery If autodetection fails to determine the LDAP server type, and you know the server
is either a Microsoft, Sun or generic LDAP server, you can manually configure
the server type.
timeout 10 seconds —
Example
The following example shows how to configure an LDAP server group named watchdogs and add an LDAP
server to the group. Because the example does not define a retry interval or the port that the LDAP server
listens to, the ASA uses the default values for these two server-specific parameters.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
789
Configure LDAP Servers for AAA
an LDAP directory after successful authentication, accomplishing authentication and authorization in two
steps.
To set up VPN user authorization using LDAP, perform the following steps.
Procedure
Example:
ciscoasa(config)# tunnel-group remotegrp
Example:
ciscoasa(config)# tunnel-group remotegrp general-attributes
Step 3 Assign a new tunnel group to a previously created AAA server group for authorization.
authorization-server-group group-tag
Example:
ciscoasa(config-general)# authorization-server-group ldap_dir_1
Example
While there are other authorization-related commands and options available for specific requirements, the
following example shows commands for enabling user authorization with LDAP. The example then creates
an IPsec remote access tunnel group named remote-1, and assigns that new tunnel group to the previously
created ldap_dir_1 AAA server group for authorization:
After you complete this configuration work, you can then configure additional LDAP authorization parameters
such as a directory password, a starting point for searching a directory, and the scope of a directory search by
entering the following commands:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
790
Monitoring LDAP Servers for AAA
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
791
History for LDAP Servers for AAA
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
792
PART VII
System Administration
• Management Access, page 795
• Software and Configurations, page 829
• Response Automation for System Events, page 877
• Testing and Troubleshooting, page 889
CHAPTER 33
Management Access
This chapter describes how to access the Cisco ASA for system management through Telnet, SSH, and
HTTPS (using ASDM), how to authenticate and authorize users, and how to create login banners.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
795
Configure Management Remote Access
• The ASA supports the SSH remote shell functionality provided in SSH Versions 1 and 2 and supports
DES and 3DES ciphers.
• (8.4 and later) The SSH default username is no longer supported. You can no longer connect to the ASA
using SSH with the pix or asa username and the login password. To use SSH, you must configure AAA
authentication using the aaa authentication ssh console LOCAL command; then define a local user
by entering the username command. If you want to use a AAA server for authentication instead of the
local database, we recommend also configuring local authentication as a backup method.
• When starting an SSH session, a dot (.) displays on the ASA console before the following SSH user
authentication prompt appears:
ciscoasa(config)#.
The display of the dot does not affect the functionality of SSH. The dot appears at the console when
generating a server key or decrypting a message using private keys during SSH key exchange before
user authentication occurs. These tasks can take up to two minutes or longer. The dot is a progress
indicator that verifies that the ASA is busy and has not hung. You can alternatively configure a public
key instead of using a password.
Procedure
Step 1 Generate an RSA key pair, which is required for SSH (for physical ASAs only).
crypto key generate rsa modulus modulus_size
Example:
ciscoasa(config)# crypto key generate rsa modulus 1024
For the ASAv, the RSA key pairs are automatically created after deployment.
The modulus value (in bits) is 512, 768, 1024, or 2048. The larger the key modulus size you specify, the
longer it takes to generate an RSA key pair. We recommend a value of 1024.
Example:
ciscoasa(config)# write memory
Step 3 Enable local authentication for SSH access. You can alternatively configure authentication using a AAA
server.
aaa authentication ssh console LOCAL
Example:
ciscoasa(config)# aaa authentication ssh console LOCAL
Step 4 Create a user in the local database that can be used for SSH access.
username user name password password
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
796
Configure Management Remote Access
Example:
ciscoasa(config)# username user1 password cisco123
Step 5 Identify the IP addresses from which the ASA accepts connections for each address or subnet, and the interface
on which you can use SSH.
ssh source_IP_address mask source_interface
Example:
ciscoasa(config)# ssh 192.168.3.0 255.255.255.0 inside
Unlike Telnet, you can SSH on the lowest security level interface.
Step 6 (Optional) Set the duration for how long an SSH session can be idle before the ASA disconnects the session.
ssh timeout minutes
Example:
ciscoasa(config)# ssh timeout 30
Set the timeout from 1 to 60 minutes. The default is 5 minutes. The default duration is too short in most cases,
and should be increased until all pre-production testing and troubleshooting have been completed
Step 7 (Optional) Limit access to SSH version 1 or 2. By default, SSH allows both versions 1 and 2.
ssh version version_number
Example:
ciscoasa(config)# ssh version 2
Examples
The following example shows how to generate RSA keys and let a host on the inside interface with an address
of 192.168.1.2 access the ASA:
WARNING: local database is empty! Use 'username' command to define local users.
The following example shows how to allow all users on the 192.168.3.0/24 network to access the ASA on
the inside interface:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
797
Configure Management Remote Access
Procedure
Example:
ciscoasa(config)# ssh key-exchange group dh-group14 sha-1
ciscoasa# show running-config key-exchangessh key-exchange group dh-group14 sha-1
The key-exchange keyword specifies that either the DH group 1 or DH group 14 key-exchange method will
follow and should be used when exchanging keys.
The group keyword indicates that either the DH group 1 key-exchange method or the DH group 14
key-exchange method will follow and should be used when exchanging keys.
The dh-group1 keyword indicates that the DH group 1 key-exchange method will follow and should be used
when exchanging keys. DH group 2 is called DH group 1 for legacy reasons.
The dh-group14 keyword indicates that the DH group 14 key-exchange method will follow and should be
used when exchanging keys.
The sha-1 keyword indicates that the SHA-1 encryption algorithm should be used.
Use the show running-config ssh key-exchange command to display the DH group key-exchange method
currently being used.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
798
Configure Management Remote Access
• You cannot use Telnet to the lowest security interface unless you use Telnet inside a VPN tunnel.
• The ASA allows a maximum of 5 concurrent Telnet connections per context/single mode, with a maximum
of 100 connections divided among all contexts.
• To gain access to the ASA CLI using Telnet, enter the login password set by the password command.
You must manually set the password before using Telnet.
Procedure
Step 1 Identify the IP addresses from which the ASA accepts connections for each address or subnet.
telnet source_IP_address mask source_interface
Example:
ciscoasa(config)# telnet 192.168.1.2 255.255.255.255 inside
If there is only one interface, you can configure Telnet to access that interface as long as the interface has a
security level of 100.
Step 2 Set the duration for how long a Telnet session can be idle before the ASA disconnects the session.
telnet timeout minutes
Example:
ciscoasa(config)# telnet timeout 30
Set the timeout from 1 to 1440 minutes. The default is 5 minutes. The default duration is too short in most
cases and should be increased until all pre-production testing and troubleshooting have been completed.
Examples
The following example shows how to let a host on the inside interface with an address of 192.168.1.2 access
the ASA:
The following example shows how to allow all users on the 192.168.3.0 network to access the ASA on the
inside interface:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
799
Configure Management Remote Access
Procedure
Step 1 Identify the IP addresses from which the ASA accepts HTTPS connections for each address or subnet.
http source_IP_address mask source_interface
Example:
ciscoasa(config)# http 192.168.1.2 255.255.255.255 inside
Example:
ciscoasa(config)# http server enable 444
By default, the port is 443. If you change the port number, be sure to include it in the ASDM access URL.
For example, if you change the port number to 444, enter the following URL:
https://10.1.1.1:444
Examples
The following example shows how to enable the HTTPS server and let a host on the inside interface with an
address of 192.168.1.2 access ASDM:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
800
Configure Management Remote Access
The following example shows how to allow all users on the 192.168.3.0/24 network to access ASDM on the
inside interface:
Procedure
Example:
ciscoasa(config)# http redirect outside 88
The port identifies the port from which the interface redirects HTTP connections. The default is 80.
Procedure
Specify the name of the management interface that you want to access when entering the ASA from another
interface.
management-access management_interface
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
801
Configure Management Remote Access
Example:
ciscoasa(config)# management-access inside
Procedure
Specify the idle time in minutes (0 through 60) after which the privileged session ends.
console timeout number
Example:
ciscoasa(config)# console timeout 0
The default timeout is 0, which means the session does not time out.
cluster-unit Displays the cluster unit name. Each unit in a cluster can have a unique name.
context (Multiple mode only) Displays the name of the current context.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
802
Configure Management Remote Access
state Displays the traffic-passing state of the unit. The following values appear for the
state:
• act—Failover is enabled, and the unit is actively passing traffic.
• stby— Failover is enabled, and the unit is not passing traffic and is in a
standby, failed, or another inactive state.
• actNoFailover—Failover is not enabled, and the unit is actively passing
traffic.
• stbyNoFailover—Failover is not enabled, and the unit is not passing traffic.
This condition might occur when there is an interface failure above the
threshold on the standby unit.
Shows the role (master or slave) of a unit in a cluster. For example, in the prompt
ciscoasa/cl2/slave, the hostname is ciscoasa, the unit name is cl2, and the state
name is slave.
Procedure
Example:
ciscoasa(config)# firewall transparent
• After a banner has been added, Telnet or SSH sessions to the ASA may close if:
◦There is not enough system memory available to process the banner message(s).
◦A TCP write error occurs when trying to display banner message(s).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
803
Configure Management Remote Access
Procedure
Add a banner to display at one of three times: when a user first connects (message-of-the-day (motd)), when
a user logs in (login), and when a user accesses privileged EXEC mode (exec).
banner {exec | login | motd} text
Example:
ciscoasa(config)# banner motd Welcome to $(hostname).
When a user connects to the ASA, the message-of-the-day banner appears first, followed by the login banner
and prompts. After the user successfully logs in to the ASA, the exec banner appears.
To add more than one line, precede each line by the banner command.
For the banner text:
• Spaces are allowed, but tabs cannot be entered using the CLI.
• There are no limits for banner length other than those for RAM and flash memory.
• You can dynamically add the hostname or domain name of the ASA by including the strings $(hostname)
and $(domain).
• If you configure a banner in the system configuration, you can use that banner text within a context by
using the $(system) string in the context configuration.
Examples
The following examples show how to add a message-of-the-day banner:
ciscoasa(config)# banner motd Welcome to $(hostname).
Procedure
Example:
ciscoasa(config)# quota management-session 1000
Entering the no form of this command sets the quota value to 0, which means that there is no session limit.
Valid values range from 0 to 10000.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
804
Configure AAA for System Administrators
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
805
Configure AAA for System Administrators
• AAA Authentication plus Certificate Authentication—(Single, routed mode only) When you enable
ASDM (HTTPS) authentication, you enter the username and password as defined on the AAA server
or local user database. If the username and password are different for the certificate authentication, you
are prompted to enter them as well. You can opt to pre-fill the username derived from your certificate.
For enable authentication using the local database, you can use the login command instead of the enable
command. The login command maintains the username, but requires no configuration to turn on authentication.
Caution If you add users to the local database who can gain access to the CLI and whom you do not want to enter
privileged EXEC mode, you should configure command authorization. Without command authorization,
users can access privileged EXEC mode (and all commands) at the CLI using their own password if their
privilege level is 2 or greater (2 is the default). Alternatively, you can discourage the login command by
using a AAA server for authentication instead of the local database, or you can set all local users to level
1 so you can control who can use the system enable password to access privileged EXEC mode.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
806
Configure AAA for System Administrators
again with the enable command to access privileged EXEC mode (commands at level 2 or higher), or
they can log in with the login command (local database only).
Note You can use local command authorization without any users in the local database and
without CLI or enable authentication. Instead, when you enter the enable command,
you enter the system enable password, and the ASA places you in level 15. You can
then create enable passwords for every level, so that when you enter enable n (2 to 15),
the ASA places you in level n. These levels are not used unless you enable local command
authorization.
• TACACS+ server privilege levels—On the TACACS+ server, configure the commands that a user or
group can use after authenticating for CLI access. Every command that a user enters at the CLI is validated
with the TACACS+ server.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
807
Configure AAA for System Administrators
When switching between security contexts, administrators can exit privileged EXEC mode and
enter the enable command again to use the username that they need.
Note The system execution space does not support AAA commands; therefore, command authorization is not
available in the system execution space.
If you move any configure mode commands to a lower level than 15, be sure to move the configure command
to that level as well, otherwise, the user cannot enter configuration mode.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
808
Configure AAA for System Administrators
aaa authentication {telnet | ssh | http | serial} console {LOCAL | server_group [LOCAL]}
Example:
ciscoasa(config)# aaa authentication ssh console radius_1 LOCAL
ciscoasa(config)# aaa authentication http console radius_1 LOCAL
ciscoasa(config)# aaa authentication serial console LOCAL
The telnet keyword controls Telnet access. For the ASASM, this keyword also affects the session from the
switch using the session command. The ssh keyword controls SSH access. The http keyword controls ASDM
access. The serial keyword controls console port access. For the ASASM, this keyword affects the virtual
console accessed from the switch using the service-module session command.
If you use a AAA server group for authentication, you can configure the ASA to use the local database as a
fallback method if the AAA server is unavailable. Specify the server group name followed by LOCAL (which
is case sensitive). We recommend that you use the same username and password in the local database as the
AAA server, because the ASA prompt does not give any indication which method is being used. You can
alternatively use the local database as your primary method of authentication (with no fallback) by entering
LOCAL alone.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
809
Configure AAA for System Administrators
Example:
ciscoasa# login
The ASA prompts for your username and password. After you enter your password, the ASA places
you in the privilege level that the local database specifies.
Users can log in with their own username and password to access privileged EXEC mode, so you do
not have to provide the system enable password to everyone. To allow users to access privileged EXEC
mode (and all commands) when they log in, set the user privilege level to 2 (the default) through 15. If
you configure local command authorization, then the user can only enter commands assigned to that
privilege level or lower.
Procedure
Example:
You configure certificate authentication for each interface, so that connections on a trusted/inside interface
do not have to provide a certificate. You can use the command multiple times to enable certificate authentication
on multiple interfaces.
Step 2 (Optional) Set the attribute used by ASDM to derive the username from the certificate:
http username-from-certificate{primary-attr [secondary-attr] | use-entire-name |
use-script} [pre-fill-username]
Example:
http username-from-certificate CN pre-fill-username
By default, ASDM uses CN OU attributes.
• The primary-attr argument specifies the attribute to be used to derive the username. The secondary-attr
argument specifies an additional attribute to use with the primary attribute to derive the username. You
can use the following attributes:
◦C—Country
◦CN—Common Name
◦DNQ—DN qualifier
◦EA—Email Address
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
810
Configure AAA for System Administrators
◦GENQ—Generational qualifier
◦GN—Given Name
◦I—Initials
◦L—Locality
◦N—Name
◦O—Organization
◦OU—Organizational Unit
◦SER—Serial Number
◦SN—Surname
◦SP—State/Province
◦T—Title
◦UID User ID
◦UPN—User Principal Name
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
811
Configure AAA for System Administrators
TACACS+ users
Authorization is requested with “service=shell,” and the server responds with PASS or FAIL.
Local users
Set the service-type command for a given username. By default, the service-type is admin, which allows full
access to any services specified by the aaa authentication consolecommand.
Management Authorization Attributes
See the following table for AAA server types and valid values for management authorization. The ASA uses
these values to determine the level of management access.
Partial Access—Allows access to the CLI or Service-Type 7 (NAS PASS, privilege level 2 nas-prompt
ASDM when you configure the aaa prompt), and higher
authentication console commands. However, Privilege-Level 2 and
if you configure enable authentication with the higher
aaa authentication enable console command, The Framed (2) and
then the CLI user cannot access privileged EXEC Login (1) service types
mode using the enable command. are treated the same
way.
Additional Guidelines
• Serial console access is not included in management authorization.
• You must also configure AAA authentication for management access to use this feature. See Configure
Authentication for CLI and ASDM Access, on page 808.
• If you use external authentication, you must pre-configure a AAA server group before you enable this
feature.
• HTTP authorization is supported in single, routed mode only.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
812
Configure AAA for System Administrators
Procedure
Step 3
Examples
The following example shows how to define an LDAP attribute map. In this example, the security policy
specifies that users being authenticated through LDAP map the user record fields or parameters title and
company to the IETF-RADIUS service-type and privilege-level, respectively.
The following example applies an LDAP attribute map to an LDAP AAA server:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
813
Configure AAA for System Administrators
Procedure
Example:
ciscoasa(config)# privilege show level 5 command filter
Repeat this command for each command that you want to reassign.
The options in this command are the following:
• show | clear | cmd—These optional keywords let you set the privilege only for the show, clear, or
configure form of the command. The configure form of the command is typically the form that causes
a configuration change, either as the unmodified command (without the show or clear prefix) or as the
no form. If you do not use one of these keywords, all forms of the command are affected.
• level level—A level between 0 and 15.
• mode {enable | configure}—If a command can be entered in user EXEC or privileged EXEC mode as
well as configuration mode, and the command performs different actions in each mode, you can set the
privilege level for these modes separately:
◦enable—Specifies both user EXEC mode and privileged EXEC mode.
◦configure—Specifies configuration mode, accessed using the configure terminal command.
• command command—The command you are configuring. You can only configure the privilege level
of the main command. For example, you can configure the level of all aaa commands, but not the level
of the aaa authentication command and the aaa authorization command separately.
Step 2 (Optional) Enable AAA users for command authorization. Without this command, the ASA only supports
privilege levels for local database users and defaults all other types of users to level 15.
aaa authorization exec authentication-server [auto-enable]
Example:
ciscoasa(config)# aaa authorization exec authentication-server
This command also enables management authorization. See Control CLI and ASDM Access with Management
Authorization, on page 811.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
814
Configure AAA for System Administrators
Example:
ciscoasa(config)# aaa authorization command LOCAL
When you set command privilege levels, command authorization does not occur unless you configure command
authorization with this command.
Examples
The filter command has the following forms:
• filter (represented by the configure option)
• show running-config filter
• clear configure filter
You can set the privilege level separately for each form, or set the same privilege level for all forms by omitting
this option. The following example shows how to set each form separately:
Alternatively, the following example shows how to set all filter commands to the same level:
The following example shows an additional command, the configure command, which uses the mode keyword:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
815
Configure AAA for System Administrators
See the following guidelines for configuring commands in Cisco Secure ACS Version 3.1; many of these
guidelines also apply to third-party servers:
• The ASA sends the commands to be authorized as shell commands, so configure the commands on the
TACACS+ server as shell commands.
Note Cisco Secure ACS might include a command type called “pix-shell.” Do not use this
type for ASA command authorization.
• The first word of the command is considered to be the main command. All additional words are considered
to be arguments, which need to be preceded by permit or deny.
For example, to allow the show running-configuration aaa-server command, add show
running-configuration to the command field, and type permit aaa-server in the arguments field.
• You can permit all arguments of a command that you do not explicitly deny by checking the Permit
Unmatched Args check box.
For example, you can configure just the show command, then all the show commands are allowed. We
recommend using this method so that you do not have to anticipate every variant of a command, including
abbreviations and a question mark, which shows CLI usage (see the following figure).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
816
Configure AAA for System Administrators
• For commands that are a single word, you must permit unmatched arguments, even if there are no
arguments for the command, for example enable or help (see the following figure).
• When you abbreviate a command at the command line, the ASA expands the prefix and main command
to the full text, but it sends additional arguments to the TACACS+ server as you enter them.
For example, if you enter sh log, then the ASA sends the entire command to the TACACS+ server, show
logging. However, if you enter sh log mess, then the ASA sends show logging mess to the TACACS+
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
817
Configure AAA for System Administrators
server, and not the expanded command show logging message. You can configure multiple spellings
of the same argument to anticipate abbreviations (see the following figure).
• We recommend that you allow the following basic commands for all users:
◦show checksum
◦show curpriv
◦enable
◦help
◦show history
◦login
◦logout
◦pager
◦show pager
◦clear pager
◦quit
◦show version
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
818
Configure AAA for System Administrators
Be sure that your TACACS+ system is completely stable and reliable. The necessary level of reliability
typically requires that you have a fully redundant TACACS+ server system and fully redundant connectivity
to the ASA. For example, in your TACACS+ server pool, include one server connected to interface 1, and
another to interface 2. You can also configure local command authorization as a fallback method if the
TACACS+ server is unavailable.
To configure command authorization using a TACACS+ server, perform the following steps:
Procedure
Example:
ciscoasa(config)# aaa authorization command tacacs+_server_group [LOCAL]
You can configure the ASA to use the local database as a fallback method if the TACACS+ server is
unavailable. To enable fallback, specify the server group name followed by LOCAL (LOCAL is case
sensitive). We recommend that you use the same username and password in the local database as the TACACS+
server because the ASA prompt does not give any indication of which method is being used. Be sure to
configure users in the local database and command privilege levels.
Procedure
Step 1 (Optional) Set the interval in days after which passwords expire for remote users (SSH, Telnet, HTTP).
password-policy lifetime days
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
819
Configure AAA for System Administrators
Example:
ciscoasa(config)# password-policy lifetime 180
Note Users at the console port are never locked out because of password expiration.
Valid values are between 0 and 65536 days. The default value is 0 days, a value indicating that passwords
will never expire.
Seven days before the password expires, a warning message appears. After the password expires, system
access is denied to remote users. To gain access after expiration, do one of the following:
• Have another administrator change your password with the username command.
• Log in to the physical console port to change your password.
Step 2 (Optional) Set the minimum number of characters that you must change between new and old passwords.
password-policy minimum-changes value
Example:
ciscoasa(config)# password-policy minimum-changes 2
Example:
ciscoasa(config)# password-policy minimum-length 8
Valid values are between 3 and 64 characters. We recommend a minimum password length of 8 characters.
Step 4 (Optional) Set the minimum number of upper case characters that passwords must have.
password-policy minimum-uppercase value
Example:
ciscoasa(config)# password-policy minimum-uppercase 3
Valid values are between 0 and 64 characters. The default value is 0, which means there is no minimum.
Step 5 (Optional) Set the minimum number of lower case characters that passwords must have.
password-policy minimum-lowercase value
Example:
ciscoasa(config)# password-policy minimum-lowercase 6
Valid values are between 0 and 64 characters. The default value is 0, which means there is no minimum.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
820
Configure AAA for System Administrators
Step 6 (Optional) Set the minimum number of numeric characters that passwords must have.
password-policy minimum-numeric value
Example:
ciscoasa(config)# password-policy minimum-numeric 1
Valid values are between 0 and 64 characters. The default value is 0, which means there is no minimum.
Step 7 (Optional) Set the minimum number of special characters that passwords must have.
password-policy minimum-special value
Example:
ciscoasa(config)# password-policy minimum-special 2
Valid values are between 0 and 64 characters. Special characters include the following: !, @, #, $, %, ^, &,
*, ‘(‘ and ‘)’. The default value is 0, which means there is no minimum.
Step 8 (Optional) Set whether users must change their password using the change-password command, instead of
letting users change their password with the username command.
password-policy authenticate enable
Example:
ciscoasa(config)# password-policy authenticate enable
The default setting is disabled: a user can use either method to change their password.
If you enable this feature and try to change your password with the username command, the following error
message appears:
You also cannot delete your own account with the clear configure username command. If you try, the
following error message appears:
ERROR: You cannot delete all usernames because you are not allowed to delete yourself
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
821
Configure AAA for System Administrators
Procedure
Example:
ciscoasa# change-password old-password j0hncr1chton new-password a3rynsun
If you do not enter the old and new passwords in the command, the ASA prompts you for input.
Procedure
Example:
ciscoasa(config)# aaa accounting telnet console group_1
Step 2 Enable command accounting. Only TACACS+ servers support command accounting.
aaa accounting command [privilege level] server-tag
Example:
ciscoasa(config)# aaa accounting command privilege 15 group_1
The privilege level keyword-argument pair is the minimum privilege level and the server-tag argument is the
name of the TACACS+ server group to which the ASA should send command accounting messages.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
822
Monitoring Device Access
Feature Lockout Condition Description Workaround: Single Mode Workaround: Multiple Mode
Local CLI No users have If you have no users in Log in and reset the passwords Session into the ASA from the
authentication been configured in the local database, you and aaa commands. switch. From the system
the local database. cannot log in, and you execution space, you can
cannot add any users. change to the context and add
a user.
TACACS+ You are logged in You enable command Fix the TACACS+ server user Session into the ASA from the
command as a user without authorization, but then account. switch. From the system
authorization enough privileges find that the user cannot If you do not have access to execution space, you can
or as a user that enter any more the TACACS+ server and you change to the context and
does not exist. commands. complete the configuration
need to configure the ASA
immediately, then log into the changes. You can also disable
command authorization until
maintenance partition and
reset the passwords and aaa you fix the TACACS+
configuration.
commands.
Local command You are logged in You enable command Log in and reset the passwords Session into the ASA from the
authorization as a user without authorization, but then and aaa commands. switch. From the system
enough privileges. find that the user cannot execution space, you can
enter any more change to the context and
commands. change the user level.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
823
Monitoring Device Access
• show curpriv
This command shows the currently logged-in user.
The following is sample output from the show curpriv command:
Field Description
Username Username. If you are logged in as the default user, the name is enable_1 (user
EXEC) or enable_15 (privileged EXEC).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
824
History for Management Access
Field Description
Current privilege level Levels range from 0 to 15. Unless you configure local command authorization
and assign commands to intermediate privilege levels, levels 0 and 15 are the
only levels that are used.
Increased SSH security; the SSH default username 8.4(2) Starting in 8.4(2), you can no longer connect to the ASA using
is no longer supported. SSH with the pix or asa username and the login password. To
use SSH, you must configure AAA authentication using the
aaa authentication ssh console LOCAL command (CLI) or
Configuration > Device Management > Users/AAA > AAA
Access > Authentication (ASDM); then define a local user by
entering the username command (CLI) or choosing
Configuration > Device Management > Users/AAA > User
Accounts (ASDM). If you want to use a AAA server for
authentication instead of the local database, we recommend
also configuring local authentication as a backup method.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
825
History for Management Access
Support for SSH public key authentication 8.4(4.1), You can enable public key authentication for SSH connections
9.1(2) to the ASA on a per-user basis. You can specify a public key
file (PKF) formatted key or a Base64 key. The PKF key can
be up to 4096 bits. Use PKF format for keys that are too large
to for the ASA support of the Base64 format (up to 2048 bits).
We introduced the following commands: ssh authentication.
PKF key format support is only in 9.1(2) and later.
Support for Diffie-Hellman Group 14 for the SSH 8.4(4.1), Support for Diffie-Hellman Group 14 for SSH Key Exchange
Key Exchange 9.1(2) was added. Formerly, only Group 1 was supported.
We introduced the following command: ssh key-exchange.
Support for a maximum number of management 8.4(4.1), You can set the maximum number of simultaneous ASDM,
sessions 9.1(2) SSH, and Telnet sessions.
We introduced the following commands: quota
management-session, show running-config quota
management-session, show quota management-session.
For the ASASM in multiple context mode, support 8.5(1) Although connecting to the ASASM from the switch in multiple
for Telnet and virtual console authentication from context mode connects to the system execution space, you can
the switch. configure authentication in the admin context to govern those
connections.
AES-CTR encryption for SSH 9.1(2) The SSH server implementation in the ASA now supports
AES-CTR mode encryption.
Improved SSH rekey interval 9.1(2) An SSH connection is rekeyed after 60 minutes of connection
time or 1 GB of data traffic.
We introduced the following command: show ssh sessions
detail.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
826
History for Management Access
ASDM management authorization 9.4(1) You can now configure management authorization separately
for HTTP access vs. Telnet and SSH access.
We introduced the following command: aaa authorization
http console
ASDM username from certificate configuration 9.4(1) When you enable ASDM certificate authentication (http
authentication-certificate), you can configure how ASDM
extracts the username from the certificate; you can also enable
pre-filling the username at the login prompt.
We introduced the following command: http
username-from-certificate
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
827
History for Management Access
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
828
CHAPTER 34
Software and Configurations
This chapter describes how to manage the Cisco ASA software and configurations.
Upgrade Path
See the following table for the upgrade path for your version. Some versions require an interim upgrade before
you can upgrade to the latest version.
Note There are no special requirements for Zero Downtime Upgrades for failover and ASA clustering with the
following exception. Upgrading ASA clustering from 9.0(1) or 9.1(1): due to CSCue72961, hitless
upgrading is not supported.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
829
Upgrade the Software
Configuration Migration
Depending on your current version, you might experience one or more configuration migrations when you
upgrade. For example, when upgrading from 8.0 to 9.4, you will experience all of these migrations:
• 8.2—See the 8.2 release notes.
• 8.3—See Cisco ASA 5500 Migration Guide to Version 8.3.
• 8.4—See the 8.4 upgrade guide.
• 9.0—See the 9.0 upgrade guide.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
830
Upgrade the Software
Procedure
Step 1 (If there is a configuration migration) Show the configuration on the terminal so that you can back up your
configuration:
more system:running-config
Copy the output from this command, then paste the configuration in to a text file. For other methods of backing
up, see the configuration guide.
Step 2 Copy the ASA software to the active unit flash memory:
copy tftp://server[/path]/asa_image_name {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa# copy tftp://10.1.1.1/asa941-smp-k8.bin disk0:/asa941-smp-k8.bin
Step 3 Copy the ASDM image to the active unit flash memory:
copy tftp://server[/path]/asdm_image_name {disk0:/ | disk1:/}[path/]asdm_image_name
Example:
ciscoasa# copy tftp://10.1.1.1/asdm-741.bin disk0:/asdm-741.bin
Step 4 If you are not already in global configuration mode, access global configuration mode:
configure terminal
Example:
ciscoasa(config)# show running-config boot system
boot system disk0:/cdisk.bin
boot system disk0:/asa914-smp-k8.bin
The ASA uses the images in the order listed; if the first image is unavailable, the next image is used, and so
on. You cannot insert a new image URL at the top of the list; to specify the new image to be first, you must
remove any existing entries, and enter the image URLs in the order desired, according to Step 6 and Step 7.
Step 6 Remove any existing boot image configurations so that you can enter the new boot image as your first choice:
no boot system {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa(config)# no boot system disk0:/cdisk.bin
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
831
Upgrade the Software
Step 7 Set the ASA image to boot (the one you just uploaded):
boot system {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa(config)# boot system disk0://asa941-smp-k8.bin
Repeat this command for any backup images that you want to use in case this image is unavailable. For
example, you can re-enter the images that you previously removed in Step 6.
Step 8 Set the ASDM image to use (the one you just uploaded):
asdm image {disk0:/ | disk1:/}[path/]asdm_image_name
Example:
ciscoasa(config)# asdm image disk0:/asdm-741.bin
You can only configure one ASDM image to use, so you do not need to first remove the existing configuration.
Procedure
Step 1 (If there is a configuration migration) Show the configuration on the terminal so that you can back up your
configuration:
more system:running-config
Example:
active# more system:running-config
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
832
Upgrade the Software
Copy the output from this command, then paste the configuration in to a text file. For other methods of backing
up, see the configuration guide.
Step 2 Copy the ASA software to the active unit flash memory:
copy tftp://server[/path]/asa_image_name {disk0:/ | disk1:/}[path/]asa_image_name
Example:
active# copy tftp://10.1.1.1/asa941-smp-k8.bin disk0:/asa941-smp-k8.bin
Step 3 Copy the software to the standby unit; be sure to specify the same path as for the active unit:
failover exec mate copy /noconfirm tftp://server[/path]/filename {disk0:/ | disk1:/}[path/]filename
Example:
active# failover exec mate copy /noconfirm
tftp://10.1.1.1/asa941-smp-k8.bin disk0:/asa941-smp-k8.bin
Step 4 Copy the ASDM image to the active unit flash memory:
copy tftp://server[/path]/asdm_image_name {disk0:/ | disk1:/}[path/]asdm_image_name
Example:
active# copy tftp://10.1.1.1/asdm-741.bin disk0:/asdm-741.bin
Step 5 Copy the ASDM image to the standby unit; be sure to specify the same path as for the active unit:
failover exec mate copy /noconfirm tftp://server[/path]/asdm_image_name {disk0:/ |
disk1:/}[path/]asdm_image_name
Example:
active# failover exec mate copy /noconfirm tftp://10.1.1.1/asdm-741.bin disk0:/asdm-741.bin
Step 6 If you are not already in global configuration mode, access global configuration mode:
configure terminal
Example:
ciscoasa(config)# show running-config boot system
boot system disk0:/cdisk.bin
boot system disk0:/asa931-smp-k8.bin
The ASA uses the images in the order listed; if the first image is unavailable, the next image is used, and so
on. You cannot insert a new image URL at the top of the list; to specify the new image to be first, you must
remove any existing entries, and enter the image URLs in the order desired, according to Step 8 and Step 9.
Step 8 Remove any existing boot image configurations so that you can enter the new boot image as your first choice:
no boot system {disk0:/ | disk1:/}[path/]asa_image_name
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
833
Upgrade the Software
Example:
ciscoasa(config)# no boot system disk0:/cdisk.bin
ciscoasa(config)# no boot system disk0:/asa931-smp-k8.bin
Step 9 Set the ASA image to boot (the one you just uploaded):
boot system {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa(config)# boot system disk0://asa941-smp-k8.bin
Repeat this command for any backup images that you want to use in case this image is unavailable. For
example, you can re-enter the images that you previously removed in Step 8.
Step 10 Set the ASDM image to use (the one you just uploaded):
asdm image {disk0:/ | disk1:/}[path/]asdm_image_name
Example:
ciscoasa(config)# asdm image disk0:/asdm-741.bin
You can only configure one ASDM image to use, so you do not need to first remove the existing configuration.
Step 13 Force the active unit to fail over to the standby unit:
no failover active
Step 14 Reload the former active unit (now the new standby unit):
reload
If you want to restore this unit to be active after it reloads, enter the failover active command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
834
Upgrade the Software
Procedure
Step 1 (If there is a configuration migration) Show the configuration on the terminal so that you can back up your
configuration:
more system:running-config
Copy the output from this command, then paste the configuration in to a text file. For other methods of backing
up, see the configuration guide.
Step 2 Copy the ASA software to the primary unit flash memory:
copy tftp://server[/path]/asa_image_name {disk0:/ | disk1:/}[path/]asa_image_name
Example:
primary# copy tftp://10.1.1.1/asa941-smp-k8.bin disk0:/asa941-smp-k8.bin
Step 3 Copy the software to the secondary unit; be sure to specify the same path as for the primary unit:
failover exec mate copy /noconfirm tftp://server[/path]/filename {disk0:/ | disk1:/}[path/]filename
Example:
primary# failover exec mate copy /noconfirm
tftp://10.1.1.1/asa941-smp-k8.bin disk0:/asa941-smp-k8.bin
Step 4 Copy the ASDM image to the primary unit flash memory:
copy tftp://server[/path]/asdm_image_name {disk0:/ | disk1:/}[path/]asdm_image_name
Example:
primary# copy tftp://10.1.1.1/asdm-741.bin disk0:/asdm-741.bin
Step 5 Copy the ASDM image to the secondary unit; be sure to specify the same path as for the active unit:
failover exec mate copy /noconfirm tftp://server[/path]/asdm_image_name {disk0:/ |
disk1:/}[path/]asdm_image_name
Example:
primary# failover exec mate copy /noconfirm tftp://10.1.1.1/asdm-741.bin disk0:/asdm-741.bin
Step 7 If you are not already in global configuration mode, access global configuration mode:
configure terminal
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
835
Upgrade the Software
Example:
primary(config)# configure terminal
Example:
ciscoasa(config)# show running-config boot system
boot system disk0:/cdisk.bin
boot system disk0:/asa931-smp-k8.bin
The ASA uses the images in the order listed; if the first image is unavailable, the next image is used, and so
on. You cannot insert a new image URL at the top of the list; to specify the new image to be first, you must
remove any existing entries, and enter the image URLs in the order desired, according to Step 9 and Step 10.
Step 9 Remove any existing boot image configurations so that you can enter the new boot image as your first choice:
no boot system {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa(config)# no boot system disk0:/cdisk.bin
ciscoasa(config)# no boot system disk0:/asa931-smp-k8.bin
Step 10 Set the ASA image to boot (the one you just uploaded):
boot system {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa(config)# boot system disk0://asa941-smp-k8.bin
Repeat this command for any backup images that you want to use in case this image is unavailable. For
example, you can re-enter the images that you previously removed in Step 9.
Step 11 Set the ASDM image to use (the one you just uploaded):
asdm image {disk0:/ | disk1:/}[path/]asdm_image_name
Example:
ciscoasa(config)# asdm image disk0:/asdm-741.bin
You can only configure one ASDM image to use, so you do not need to first remove the existing configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
836
Upgrade the Software
Step 14 Force both failover groups to become active on the secondary unit:
Procedure
Example:
master# cluster exec copy /noconfirm
tftp://10.1.1.1/asa941-smp-k8.bin disk0:/asa941-smp-k8.bin
Example:
master# cluster exec copy /noconfirm tftp://10.1.1.1/asdm-741.bin disk0:/asdm-741.bin
Step 4 If you are not already in global configuration mode, access global configuration mode:
configure terminal
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
837
Upgrade the Software
Example:
ciscoasa(config)# show running-config boot system
boot system disk0:/cdisk.bin
boot system disk0:/asa931-smp-k8.bin
The ASA uses the images in the order listed; if the first image is unavailable, the next image is used, and so
on. You cannot insert a new image URL at the top of the list; to specify the new image to be first, you must
remove any existing entries, and enter the image URLs in the order desired, according to Step 6 and Step 7.
Step 6 Remove any existing boot image configurations so that you can enter the new boot image as your first choice:
no boot system {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa(config)# no boot system disk0:/cdisk.bin
ciscoasa(config)# no boot system disk0:/asa931-smp-k8.bin
Step 7 Set the ASA image to boot (the one you just uploaded):
boot system {disk0:/ | disk1:/}[path/]asa_image_name
Example:
ciscoasa(config)# boot system disk0://asa941-smp-k8.bin
Repeat this command for any backup images that you want to use in case this image is unavailable. For
example, you can re-enter the images that you previously removed in Step 6.
Step 8 Set the ASDM image to use (the one you just uploaded):
asdm image {disk0:/ | disk1:/}[path/]asdm_image_name
Example:
ciscoasa(config)# asdm image disk0:/asdm-741.bin
You can only configure one ASDM image to use, so you do not need to first remove the existing configuration.
Step 10 Reload each slave unit when you repeat this command for each unit name:
cluster exec unit slave-unit reload noconfirm
Example:
master# cluster exec unit unit2 reload noconfirm
To avoid connection loss and allow traffic to stabilize, wait for each unit to come back up (approximately 5
minutes) before reloading the next unit. To view member names, enter cluster exec unit ?, or enter the show
cluster info command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
838
Upgrade the Software
Wait for 5 minutes for a new master to be selected and traffic to stabilize. Do not enter write memory; when
the master unit reloads, you want clustering to be enabled on it.
Procedure
Step 1 Connect to the ASA console port according to the instructions in Access the Appliance Console, on page 19.
Step 2 Power off the ASA, then power it on.
Step 3 During startup, press the Escape key when you are prompted to enter ROMMON mode.
Step 4 In ROMMOM mode, define the interface settings to the ASA, including the IP address, TFTP server address,
gateway address, software image file, and port, as follows:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
839
Upgrade the Software
LINKTIMEOUT=20
PKTTIMEOUT=4
RETRY=20
Loading...N
After the software image is successfully loaded, the ASA automatically exits ROMMON mode.
Step 8 Verify that the correct software image has been loaded into the ASA by checking the version in the ASA:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
840
Upgrade the Software
Procedure
Step 1 Connect to the ASA console port according to the instructions in Access the ASA Services Module Console,
on page 20.
Step 2 Make sure that you reload the ASASM image.
Step 3 During startup, press the Escape key when you are prompted to enter ROMMON mode.
Step 4 In ROMMOM mode, define the interface settings to the ASASM, including the IP address, TFTP server
address, gateway address, software image file, port, and VLAN, as follows:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
841
Upgrade the Software
GATEWAY=172.16.145.129
PORT=Data0
VLAN=1
IMAGE=f1/asa851-smp-k8.bin
CONFIG=
LINKTIMEOUT=20
PKTTIMEOUT=2
RETRY=20
After the software image is successfully loaded, the ASASM automatically exits ROMMON mode.
Note You must download the image to the system flash separately after ROMMON boot is complete;
booting the module into ROMMON mode does not preserve the system image across reloads.
Step 8 Verify that the correct software image has been loaded into the ASA by checking the version in the ASA:
Procedure
Step 1 Obtain the new ROMMON image from Cisco.com, and put it on a server to copy to the ASA. This procedure
shows a TFTP copy.
Download the image from:
https://software.cisco.com/download/type.html?mdfid=286283326&flowid=77251
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
842
Manage Files
Example:
ciscoasa# upgrade rommon disk0:asa5500-firmware-1108.SPA
Verifying file integrity of disk0:/asa5500-firmware-1108.SPA
Recover and Load an Image for the ASA 5506W-X Wireless Access Point
To recover and load a software image onto an ASA 5506W-X using TFTP, perform the following steps.
Procedure
Step 1 Session to the access point (AP) and enter the AP ROMMON (not the ASA ROMMON):
Step 2 Follow the procedure in the Cisco IOS Software Configuration Guide for Cisco Aironet Access Points.
Manage Files
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
843
Manage Files
Procedure
Example:
hostname# dir
Directory of disk0:/
500 -rw- 4958208 22:56:20 Nov 29 2004 cdisk.bin
2513 -rw- 4634 19:32:48 Sep 17 2004 first-backup
2788 -rw- 21601 20:51:46 Nov 23 2004 backup.cfg
2927 -rw- 8670632 20:42:48 Dec 08 2004 asdmfile.bin
Enter disk0: for the internal flash memory. The disk1: keyword represents the external flash memory. The
internal flash memory is the default.
Example:
hostname# show file information cdisk.bin
disk0:/cdisk.bin:
type is image (XXX) []
file size is 4976640 bytes version 7.0(1)
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
844
Manage Files
Procedure
Step 1 Connect to the ASA console port according to the instructions in Access the ASA Services Module Console,
on page 20 or Access the Appliance Console, on page 19.
Step 2 Power off the ASA, then power it on.
Step 3 During startup, press the Escape key when you are prompted to enter ROMMON mode.
Step 4 Enter the erase command, which overwrites all files and erases the file system, including hidden system files:
rommon #1> erase [disk0: | disk1: | flash:]
Procedure
Example:
ciscoasa(config)# ftp mode passive
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
845
Manage Files
• For multiple context mode, complete this procedure in the system execution space. To change from the
context to the system execution space, enter the changeto system command.
Procedure
Example:
ciscoasa# ssh stricthostkeycheck
ciscoasa# copy x scp://[email protected]/x
The authenticity of host '10.86.95.9 (10.86.95.9)' can't be established.
RSA key fingerprint is dc:2e:b3:e4:e1:b7:21:eb:24:e9:37:81:cf:bb:c3:2a.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '10.86.95.9' (RSA) to the list of known hosts.
Source filename [x]?
By default, this option is enabled. When this option is enabled, you are prompted to accept or reject the host
key if it is not already stored on the ASA. When this option is disabled, the ASA accepts the host key
automatically if it was not stored before.
Step 3 (Optional) Manually add or delete servers and their keys from the ASA database:
ssh pubkey-chain [no] server ip_address {key-string key_string exit| key-hash {md5 | sha256}
fingerprint}
Example:
ciscoasa(config)# ssh pubkey-chain
ciscoasa(config-ssh-pubkey-chain)# server 10.7.8.9
ciscoasa(config-ssh-pubkey-server)# key-string
Enter the base 64 encoded RSA public key.
End with the word "exit" on a line by itself
ciscoasa(config-ssh-pubkey-server-string)# c1:b1:30:29:d7:b8:de:6c:97:77:10:d7:46:41:63:87
ciscoasa(config-ssh-pubkey-server-string)# exit
ciscoasa(config-ssh-pubkey-server)# show running-config ssh pubkey-chain
ssh pubkey-chain
server 10.7.8.9
key-hash sha256 f1:22:49:47:b6:76:74:b2:db:26:fb:13:65:d8:99:19:
e7:9e:24:46:59:be:13:7f:25:27:70:9b:0e:d2:86:12
The ASA stores the SSH host key for each SCP server to which it connects. You can manually manage keys
if desired.
For each server, you can specify the key-string (public key) or key-hash (hashed value) of the SSH host.
The key_string is the Base64 encoded RSA public key of the remote peer. You can obtain the public key value
from an open SSH client; that is, from the .ssh/id_rsa.pub file. After you submit the Base64 encoded public
key, that key is then hashed via SHA-256.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
846
Manage Files
The key-hash {md5 | sha256} fingerprint enters the already hashed key (using an MD5 or SHA-256 key);
for example, a key that you copied from show command output.
Examples
From a client on the external host, perform an SCP file transfer. For example, in Linux enter the following
command:
scp -v -pw password source_filename username@asa_address:{disk0|disk1}:/dest_filename
The -v is for verbose, and if -pw is not specified, you will be prompted for a password.
The following example adds an already hashed host key for the server at 10.86.94.170:
The following example adds a host string key for the server at 10.7.8.9:
Procedure
Predefine the TFTP server address and filename for use with configure net and copy commands:
tftp-server interface_name server_ip filename
Example:
ciscoasa(config)# tftp-server inside 10.1.4.7 files/config1.cfg
ciscoasa(config)# copy tftp: test.cfg
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
847
Manage Files
Accessing tftp://10.1.4.7/files/config2.cfg;int=outside...
You can override the filename when you enter the command; for example, when you use the copy command,
you can take advantage of the predefined TFTP server address but still enter any filename at the interactive
prompts.
For the copy command, enter tftp: to use the tftp-server value instead of tftp://url.
• For information about installing the Cisco SSL VPN client, see the Cisco AnyConnect VPN Client
Administrator Guide. For information about installing Cisco Secure Desktop on the ASA, see the Cisco
Secure Desktop Configuration Guide for Cisco ASA 5500 Series Administrators.
• To configure the ASA to use a specific application image or ASDM image if you have more than one
installed, or have installed them in external flash memory, see Set the ASA Image, ASDM, and Startup
Configuration, on page 852.
• For multiple context mode, you must be in the system execution space.
• (Optional) Specify the interface through which the ASA communicates with the server. If you do not
specify the interface, the ASA checks the management-only routing table; if there are no matches, it
then checks the data routing table.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
848
Manage Files
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
849
Manage Files
Please use the following commands to add the hash key to the configuration:
ssh pubkey-chain
server 10.86.94.170
key-hash sha256
65:d9:9d:fe:1a:bc:61:aa:64:9d:fc:ee:99:87:38:df:a8:8e:d9:e9:ff:42:de:e8:8d:2d:bf:a9:2b:85:2e:19
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
850
Manage Files
Procedure
To copy a file to the startup configuration or running configuration, enter one of the following commands for
the appropriate download server:
• Copy from a TFTP server:
copy [/noconfirm] [interface_name] tftp://server[/path]/src_filename {startup-config | running-config}
Example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
851
Set the ASA Image, ASDM, and Startup Configuration
The ;int=interface option bypasses the route lookup and always uses the specified interface to reach the
SCP server.
Examples
For example, to copy the configuration from a TFTP server, enter the following command:
To copy the configuration from an FTP server, enter the following command:
To copy the configuration from an HTTP server, enter the following command:
• ASDM Image on All ASAs—Boots the first ASDM image that it finds in internal flash memory, or if
one does not exist in this location, then in external flash memory.
• Startup Configuration—By default, the ASA boots from a startup configuration that is a hidden file.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
852
Back Up and Restore Configurations or Other Files
Example:
ciscoasa(config)# boot system disk:/images/asa921.bin
You can enter up to four boot system command entries to specify different images to boot from in order; the
ASA boots the first image it finds successfully. When you enter the boot system command, it adds an entry
at the bottom of the list. To reorder the boot entries, you must remove all entries using the the clear configure
boot system command, and re-enter them in the order you desire. Only one boot system tftp command can
be configured, and it must be the first one configured.
Note If the ASA is stuck in a cycle of constant booting, you can reboot the ASA into ROMMON mode.
For more information about the ROMMON mode, see View Debugging Messages, on page 889.
Step 2 Set the ASDM image to boot:
asdm image {disk0:/ | disk1:/}[path/]filename
Example:
ciscoasa(config)# asdm image disk0:/images/asdm721.bin
If you do not specify the image to boot, even if you have only one image installed, then the ASA inserts the
asdm image command into the running configuration. To avoid problems with Auto Update (if configured),
and to avoid the image search at each startup, you should specify the ASDM image that you want to boot in
the startup configuration.
Step 3 (Optional) Set the startup configuration to be a known file instead of the default hidden file:
boot config {disk0:/ | disk1:/}[path/]filename
Example:
ciscoasa(config)# boot config disk0:/configs/startup1.cfg
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
853
Back Up and Restore Configurations or Other Files
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
854
Back Up and Restore Configurations or Other Files
Procedure
Example:
ciscoasa# backup location disk0:/sample-backup]
Backup location [disk0:/sample-backup]?
If you do not specify the interface name, the ASA checks the management-only routing table; if there are no
matches, it then checks the data routing table.
In multiple context mode from the system execution space, enter the context keyword to backup the specified
context files.
During the backup of VPN certificates and preshared keys, a secret key identified by the passphrase keyword
is required to encode the certificates. You must provide a passphrase to be used for encoding and decoding
the certificates in PKCS12 format. The backup only includes RSA key pairs tied to the certificates and excludes
any standalone certificates.
The backup location can be a local disk or a remote URL. If you do not provide a location, the following
default names are used:
• Single mode—disk0:hostname.backup.timestamp.tar.gz
• Multiple mode—disk0:hostname.context-ctx-name.backup.timestamp.tar.gz
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
855
Back Up and Restore Configurations or Other Files
Example:
ciscoasa# backup location disk0:/sample-backup
Backup location [disk0:/sample-backup]?
Begin backup…
Backing up [ASA version] … Done!
Backing up [Running Config] … Done!
Backing up [Startup Config] … Done!
IMPORTANT: This device uses master passphrase encryption. If this backup file
is used to restore to a device with a different master passphrase,
you will need to provide the current master passphrase during restore.
Backing up [VPN Pre-shared keys] … Done!
Backing up [SSL VPN Configurations: Application Profile Custom Framework] … Done!
Backing up [SSL VPN Configurations: Bookmarks]… Done!
Backing up [SSL VPN Configurations: Customization] … Done!
Backing up [SSL VPN Configurations: Dynamic Access Policy] … Done!
Backing up [SSL VPN Configurations: Plug-in] … Done!
Backing up [SSL VPN Configurations: Pre-fill scripts for Connection Profile] … Done!
Backing up [SSL VPN Configurations: Proxy auto-config] … Done!
Backing up [SSL VPN Configurations: Translation table] … Done!
Backing up [SSL VPN Configurations: Web Content] … Done!
Backing up [Anyconnect(SVC) client images and profiles] … Done!
Backing up [Anyconnect(SVC) customizations and transforms] … Done!
Backing up [Cisco Secure Desktop and Host Scan images] … Done!
Backing up [UC-IME tickets] … Done!
Compressing the backup directory ... Done!
Copying Backup ... Done!
Cleaning up ... Done!
Backup finished!
Procedure
Example:
ciscoasa# restore location disk0:/5525-2051.backup.2014-07-09-223$
restore location [disk0:/5525-2051.backup.2014-07-09-223251.tar.gz]?
Example:
ciscoasa# restore location disk0:/5525-2051.backup.2014-07-09-223$
restore location [disk0:/5525-2051.backup.2014-07-09-223251.tar.gz]?
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
856
Back Up and Restore Configurations or Other Files
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
857
Back Up and Restore Configurations or Other Files
Procedure
The ;int=interface option bypasses the route lookup and always uses the specified interface to reach the
SCP server.
• Copy to the local flash memory:
copy [/noconfirm] {startup-config | running-config} {disk0|disk1}:/[path/]dst_filename
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
858
Back Up and Restore Configurations or Other Files
Example:
Be sure that the destination directory exists. If it does not exist, first create the directory using the mkdir
command.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
859
Back Up and Restore Configurations or Other Files
The ;int=interface option bypasses the route lookup and always uses the specified interface to reach the
SCP server.
• Copy from flash to the local flash memory:
copy [/noconfirm] {disk0|disk1}:/[path/]src_filename {disk0|disk1}:/[path/]dst_filename
Example:
Be sure that the destination directory exists. If it does not exist, first create the directory using the mkdir
command.
Procedure
Step 1 Copy the running configuration to the startup configuration server (connected to the admin context):
Step 2 Copy the running configuration to a TFTP server connected to the context network:
Procedure
Step 2 Copy the output from this command, and then paste the configuration into a text file.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
860
Back Up and Restore Configurations or Other Files
The CLI lets you back up and restore individual elements of your configuration using the export and import
commands.
To back up these files, for example, those files that you imported with the import webvpn command or
certificates, perform the following steps.
Procedure
Step 2 Run the export command for the file that you want to back up (in this example, the rdp file):
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
861
Back Up and Restore Configurations or Other Files
Note You can alternatively use the backup and restore commands. See Perform a Complete System Backup
or Restoration, on page 854 for more information.
Another option is to use a commercially available tool. You can put the logic of this script into such a tool.
Procedure
Step 1 Download or cut-and-paste the script file to any location on your system.
Step 2 At the command line, enter Perlscriptname, where scriptname is the name of the script file.
Step 3 Press Enter.
Step 4 The system prompts you for values for each option. Alternatively, you can enter values for the options when
you enter the Perlscriptname command before you press Enter. Either way, the script requires that you enter
a value for each option.
Step 5 The script starts running, printing out the commands that it issues, which provides you with a record of the
CLIs. You can use these CLIs for a later restore, which is particularly useful if you want to restore only one
or two files.
Sample Script
#!/usr/bin/perl
#Description: The objective of this script is to show how to back up
configurations/extensions.
# It currently backs up the running configuration, all extensions imported via "import
webvpn" command, the CSD configuration XML file, and the DAP configuration XML file.
#Requirements: Perl with Expect, SSH to the ASA, and a TFTP server.
#Usage: backupasa -option option_value
# -h: ASA hostname or IP address
# -u: User name to log in via SSH
# -w: Password to log in via SSH
# -e: The Enable password on the security appliance
# -p: Global configuration mode prompt
# -s: Host name or IP address of the TFTP server to store the configurations
# -r: Restore with an argument that specifies the file name. This file is produced
during backup.
#If you don't enter an option, the script will prompt for it prior to backup.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
862
Back Up and Restore Configurations or Other Files
#
#Make sure that you can SSH to the ASA.
use Expect;
use Getopt::Std;
#global variables
%options=();
$restore = 0; #does backup by default
$restore_file = '';
$asa = '';
$storage = '';
$user = '';
$password = '';
$enable = '';
$prompt = '';
$date = ‘date +%F‘;
chop($date);
my $exp = new Expect();
getopts("h:u:p:w:e:s:r:",\%options);
do process_options();
do login($exp);
do enable($exp);
if ($restore) {
do restore($exp,$restore_file);
}
else {
$restore_file = "$prompt-restore-$date.cli";
open(OUT,">$restore_file") or die "Can't open $restore_file\n";
do running_config($exp);
do lang_trans($exp);
do customization($exp);
do plugin($exp);
do url_list($exp);
do webcontent($exp);
do dap($exp);
do csd($exp);
close(OUT);
}
do finish($exp);
sub enable {
$obj = shift;
$obj->send("enable\n");
unless ($obj->expect(15, 'Password:')) {
print "timed out waiting for Password:\n";
}
$obj->send("$enable\n");
unless ($obj->expect(15, "$prompt#")) {
print "timed out waiting for $prompt#\n";
}
}
sub lang_trans {
$obj = shift;
$obj->clear_accum();
$obj->send("show import webvpn translation-table\n");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
s/^\s+//;
s/\s+$//;
next if /show import/ or /Translation Tables/;
next unless (/^.+\s+.+$/);
($lang, $transtable) = split(/\s+/,$_);
$cli = "export webvpn translation-table $transtable language $lang
$storage/$prompt-$date-$transtable-$lang.po";
$ocli = $cli;
$ocli =~ s/^export/import/;
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
863
Back Up and Restore Configurations or Other Files
print "$cli\n";
print OUT "$ocli\n";
$obj->send("$cli\n");
$obj->expect(15, "$prompt#" );
}
}
sub running_config {
$obj = shift;
$obj->clear_accum();
$cli ="copy /noconfirm running-config $storage/$prompt-$date.cfg";
print "$cli\n";
$obj->send("$cli\n");
$obj->expect(15, "$prompt#" );
}
sub customization {
$obj = shift;
$obj->clear_accum();
$obj->send("show import webvpn customization\n");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
chop;
next if /^Template/ or /show import/ or /^\s*$/;
$cli = "export webvpn customization $_ $storage/$prompt-$date-cust-$_.xml";
$ocli = $cli;
$ocli =~ s/^export/import/;
print "$cli\n";
print OUT "$ocli\n";
$obj->send("$cli\n");
$obj->expect(15, "$prompt#" );
}
}
sub plugin {
$obj = shift;
$obj->clear_accum();
$obj->send("show import webvpn plug-in\n");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
chop;
next if /^Template/ or /show import/ or /^\s*$/;
$cli = "export webvpn plug-in protocol $_ $storage/$prompt-$date-plugin-$_.jar";
$ocli = $cli;
$ocli =~ s/^export/import/;
print "$cli\n";
print OUT "$ocli\n";
$obj->send("$cli\n");
$obj->expect(15, "$prompt#" );
}
}
sub url_list {
$obj = shift;
$obj->clear_accum();
$obj->send("show import webvpn url-list\n");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
chop;
next if /^Template/ or /show import/ or /^\s*$/ or /No bookmarks/;
$cli="export webvpn url-list $_ $storage/$prompt-$date-urllist-$_.xml";
$ocli = $cli;
$ocli =~ s/^export/import/;
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
864
Back Up and Restore Configurations or Other Files
print "$cli\n";
print OUT "$ocli\n";
$obj->send("$cli\n");
$obj->expect(15, "$prompt#" );
}
}
sub dap {
$obj = shift;
$obj->clear_accum();
$obj->send("dir dap.xml\n");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
return 0 if($output =~ /Error/);
sub csd {
$obj = shift;
$obj->clear_accum();
$obj->send("dir sdesktop\n");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
return 0 if($output =~ /Error/);
sub webcontent {
$obj = shift;
$obj->clear_accum();
$obj->send("show import webvpn webcontent\n");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
s/^\s+//;
s/\s+$//;
next if /show import/ or /No custom/;
next unless (/^.+\s+.+$/);
($url, $type) = split(/\s+/,$_);
$turl = $url;
$turl =~ s/\/\+//;
$turl =~ s/\+\//-/;
$cli = "export webvpn webcontent $url $storage/$prompt-$date-$turl";
$ocli = $cli;
$ocli =~ s/^export/import/;
print "$cli\n";
print OUT "$ocli\n";
$obj->send("$cli\n");
$obj->expect(15, "$prompt#" );
}
}
sub login {
$obj = shift;
$obj->raw_pty(1);
$obj->log_stdout(0); #turn off console logging.
$obj->spawn("/usr/bin/ssh $user\@$asa") or die "can't spawn ssh\n";
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
865
Back Up and Restore Configurations or Other Files
$obj->send("$password\n");
sub finish {
$obj = shift;
$obj->hard_close();
print "\n\n";
sub restore {
$obj = shift;
my $file = shift;
my $output;
open(IN,"$file") or die "can't open $file\n";
while (<IN>) {
$obj->send("$_");
$obj->expect(15, "$prompt#" );
$output = $obj->before();
print "$output\n";
}
close(IN);
}
sub process_options {
if (defined($options{s})) {
$tstr= $options{s};
$storage = "tftp://$tstr";
}
else {
print "Enter TFTP host name or IP address:";
chop($tstr=<>);
$storage = "tftp://$tstr";
}
if (defined($options{h})) {
$asa = $options{h};
}
else {
print "Enter ASA host name or IP address:";
chop($asa=<>);
}
if (defined ($options{u})) {
$user= $options{u};
}
else {
print "Enter user name:";
chop($user=<>);
}
if (defined ($options{w})) {
$password= $options{w};
}
else {
print "Enter password:";
chop($password=<>);
}
if (defined ($options{p})) {
$prompt= $options{p};
}
else {
print "Enter ASA prompt:";
chop($prompt=<>);
}
if (defined ($options{e})) {
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
866
Downgrade Your Software
$enable = $options{e};
}
else {
print "Enter enable password:";
chop($enable=<>);
}
if (defined ($options{r})) {
$restore = 1;
$restore_file = $options{r};
}
}
• Downgrading to Version 8.2 or earlier versions—Version 8.3 introduced more robust time-based key
usage as well as failover license changes:
◦If you have more than one time-based activation key active, when you downgrade, only the most
recently activated time-based key can be active. Any other keys are made inactive.
◦If you have mismatched licenses on a failover pair, downgrading will disable failover. Even if the
keys are matching, the license used will no longer be a combined license.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
867
Configure Auto Update
Where the /noconfirm option downgrades without prompting. The image_url is the path to the old image on
disk0, disk1, tftp, ftp, or smb. The old_config_url is the path to the saved, premigration configuration (by
default, t;his configuration was saved on disk0). If you need to revert to a pre-8.3 activation key, you can
enter the old activation key.
This command is a shortcut for completing the following functions:
1 Clearing the boot image configuration (clear configure boot).
2 Setting the boot image to be the old image (boot system).
3 (Optional) Entering a new activation key (activation-key).
4 Saving the running configuration to startup (write memory). This action sets the BOOT environment
variable to the old image, so when you reload, the old image is loaded.
5 Copying the old configuration to the startup configuration (copyold_config_url startup-config).
6 Reloading (reload).
Example:
ciscoasa(config)# downgrade /noconfirm disk0:/asa821-k8.bin disk0:/8_2_1_0_startup_cfg.sav
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
868
Configure Auto Update
The Auto Update specification provides the infrastructure necessary for remote management applications to
download ASA configurations, software images, and to perform basic monitoring from a centralized location
or multiple locations.
The Auto Update specification allows the Auto Update server to either push configuration information and
send requests for information to the ASA, or to pull configuration information by having the ASA periodically
poll the Auto Update server. The Auto Update server can also send a command to the ASA to send an immediate
polling request at any time. Communication between the Auto Update server and the ASA requires a
communications path and local CLI configuration on each ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
869
Configure Auto Update
• If hitless upgrade can be performed when secondary unit boots, then the secondary unit becomes
the active unit and the primary unit reloads. The primary unit becomes the active unit when it
has finished loading.
• If hitless upgrade cannot be performed when the standby unit boots, then both units reload at the
same time.
d If only the secondary (standby) unit has new image, then only the secondary unit reloads. The primary
unit waits until the secondary unit finishes reloading.
e If only the primary (active) unit has new image, the secondary unit becomes the active unit, and the
primary unit reloads.
f The update process starts again at Step 1.
5 If the ASA determines that the ASDM file needs to be updated for either the primary or secondary unit,
the following occurs:
a The primary unit retrieves the ASDM image file from the HTTP server using the URL provided by
the Auto Update Server.
b The primary unit copies the ASDM image to the standby unit, if needed.
c The primary unit updates the ASDM image on itself.
d The update process starts again at Step 1.
6 If the primary unit determines that the configuration needs to be updated, the following occurs:
a The primary unit retrieves the configuration file from the using the specified URL.
b The new configuration replaces the old configuration on both units simultaneously.
c The update process begins again at Step 1.
7 If the checksums match for all image and configuration files, no updates are required. The process ends
until the next poll time.
Procedure
Step 1 To specify the URL of the Auto Update Server, enter the following command:
auto-update server url [source interface] [verify-certificate | no-verification]
where url has the following syntax:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
870
Configure Auto Update
http[s]://[user:password@]server_ip[:port]/pathname
The source interface keyword and argument specify which interface to use when sending requests to the Auto
Update Server. If you specify the same interface specified by the management-access command, the Auto
Update requests travel over the same IPsec VPN tunnel used for management access.
For HTTPS, the verify-certificate keyword (the default) verifies the certificate returned by the Auto Update
Server. To disable verification (not recommended), specify the no-verification keyword.
Step 2 (Optional) To identify the device ID to send when communicating with the Auto Update Server, enter the
following command:
auto-update device-id {hardware-serial | hostname | ipaddress [if-name] | mac-address [if-name] | string
text}
The identifier used is determined by specifying one of the following parameters:
• The hardware-serial argument specifies the ASA serial number.
• The hostname argument specifies the ASA hostname.
• The ipaddress keyword specifies the IP address of the specified interface. If the interface name is not
specified, it uses the IP address of the interface used to communicate with the Auto Update Server.
• The mac-address keyword specifies the MAC address of the specified interface. If the interface name
is not specified, it uses the MAC address of the interface used to communicate with the Auto Update
Server.
• The string keyword specifies the specified text identifier, which cannot include white space or the
characters ‘, “, , >, & and ?.
Step 3 (Optional) To specify how often to poll the Auto Update Server for configuration or image updates, enter the
following command:
auto-update poll-period poll-period [retry-count [retry-period]]
The poll-period argument specifies how often (in minutes) to check for an update. The default is 720 minutes
(12 hours).
The retry-count argument specifies how many times to try reconnecting to the server if the first attempt fails.
The default is zero.
The retry-period argument specifies how long to wait (in minutes) between retries. The default is five minutes.
Step 4 (Optional) To schedule a specific time for the ASA to poll the Auto Update Server, enter the following
command:
auto-update poll-at days-of-the-week time [randomize minutes] [retry_count [retry_period]]
The days-of-the-week argument is any single day or combination of days: Monday, Tuesday, Wednesday,
Thursday, Friday, Saturday, and Sunday. Other possible values are daily (Monday through Sunday), weekdays
(Monday through Friday), and weekends (Saturday and Sunday).
The time argument specifies the time in the format HH:MM at which to start the poll. For example, 8:00 is
8:00 a.m. and 20:00 is 8:00 p.m.
The randomize minutes keyword and argument specify the period to randomize the poll time following the
specified start time. The range is from 1 to 1439 minutes.
The retry_count argument specifies how many times to try reconnecting to the Auto Update Server if the first
attempt fails. The default is zero.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
871
Configure Auto Update
The retry_period argument specifies how long to wait between connection attempts. The default is five
minutes. The range is from 1 to 35791 minutes.
Step 5 (Optional) If the Auto Update Server has not been contacted for a certain period of time, entering the following
command causes it to stop passing traffic:
auto-update timeout period
The period argument specifies the timeout period in minutes between 1 and 35791. The default is to never
time out (zero minutes). To restore the default, enter the no form of this command.
Use the auto-update timeout command to be sure that the ASA has the most recent image and configuration.
This condition is reported with system log message 201008.
Example
In the following example, an ASA is configured to poll an Auto Update Server with the IP address
209.165.200.224, at port number 1742, from the outside interface, with certificate verification.
The ASA is also configured to use the hostname as the device ID and to poll an Auto Update Server every
Friday and Saturday night at a random time between 10:00 p.m. and 11:00 p.m. On a failed polling attempt,
the ASA will try to reconnect to the Auto Update Server ten times, and will wait three minutes between
attempts at reconnecting, as shown in the following example:
Procedure
Step 2 Configure the following parameters for the client-update command that you want to apply to the ASAs:
client-update {component {asdm | image} | device-id dev_string | family family_name | type type} url
url-string rev-nums rev-nums}
The component {asdm | image} parameter specifies the software component, either ASDM or the boot image
of the ASA.
The device-id dev_string parameter specifies a unique string that the Auto Update client uses to identify itself.
The maximum length is 63 characters.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
872
Configure Auto Update
The family family_name parameter specifies the family name that the Auto Update client uses to identify
itself. It can be asa, pix, or a text string with a maximum length of seven characters.
The rev-nums rev-nums parameter specifies the software or firmware images for this client. Enter up to four,
in any order, separated by commas.
The type type parameter specifies the type of clients to notify of a client update. Because this command is
also used to update Windows clients, the list of clients includes several Windows operating systems.
The url url-string parameter specifies the URL for the software/firmware image. This URL must point to a
file appropriate for this client. For all Auto Update clients, you must use the protocol “http://” or “https://” as
the prefix for the URL.
Configure the parameters for the client update that you want to apply to all ASAs of a particular type. That
is, specify the type of ASA and the URL or IP address from which to get the updated image. In addition, you
must specify a revision number. If the revision number of the remote ASA matches one of the specified
revision numbers, there is no need to update the client, and the update is ignored.
To configure a client update for Cisco 5525-X ASAs, enter the following command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
873
Configure Auto Update
The following syslog message is generated if the Auto Update process fails:
The file is “image”, “asdm”, or “configuration”, depending on which update failed. The version is the version
number of the update. And the reason is the reason that the update failed.
Server: https://********@209.165.200.224:1742/management.cgi?1276
Certificate will be verified
Poll period: 720 minutes, retry count: 2, retry period: 5 minutes
Timeout: none
Device ID: host name [corporate]
Next poll in 4.93 minutes
Last poll: 11:36:46 PST Tue Nov 13 2004
Last PDM update: 23:36:46 PST Tue Nov 12 2004
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
874
History for Software and Configurations
Platform
Feature Name Releases Feature Information
Secure Copy client 9.1(5)/9.2(1) The ASA now supports the Secure Copy (SCP) client to
transfer files to and from a SCP server.
We introduced the following commands: ssh pubkey-chain,
server (ssh pubkey-chain), key-string, key-hash, ssh
stricthostkeycheck.
We modified the following command: copy scp.
Auto Update server certificate verification enabled 9.2(1) The Auto Update server certificate verification is now enabled
by default by default; for new configurations, you must explicitly disable
certificate verification. If you are upgrading from an earlier
release, and you did not enable certificate verification, then
certificate verification is not enabled, and you see the following
warning:
System backup and restore using the CLI 9.3(2) You can now back up and restore complete system
configurations, including images and certificates, using the
CLI.
We introduced the following commands: backup and restore.
Recovering and loading a new ASA 5506W-X 9.4(1) We now support the recovery and loading of a new ASA
image 5506W-X image.
We introduced the following command: hw-module module
wlan recover image.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
875
History for Software and Configurations
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
876
CHAPTER 35
Response Automation for System Events
This chapter describes how to configure the Embedded Event Manager (EEM).
Supported Events
The EEM supports the following events:
• Syslog—The ASA uses syslog message IDs to identify syslog messages that trigger an event manager
applet. You may configure multiple syslog events, but the syslog message IDs may not overlap within
a single event manager applet.
• Timers—You may use timers to trigger events. You may configure each timer only once for each event
manager applet. Each event manager applet may have up to three timers. The three types of timers are
the following:
◦Watchdog (periodic) timers trigger an event manager applet after the specified time period following
the completion of the applet actions and restart automatically.
◦Countdown (one-shot) timers trigger an event manager applet once after the specified time period
and do not restart unless they are removed, then re-added.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
877
Guidelines for the EEM
◦Absolute (once-a-day) timers cause an event to occur once a day at a specified time, and restart
automatically. The time-of-day format is in hh:mm:ss.
You may configure only one timer event of each type for each event manager applet.
• None—The none event is triggered when you run an event manager applet manually using the CLI or
ASDM.
• Crash—The crash event is triggered when the ASA crashes. Regardless of the value of the output
command, the action commands are directed to the crashinfo file. The output is generated before the
show tech command.
Output Destinations
You may send the output from the actions to a specified location using the output command. Only one output
value may be enabled at any one time. The default value is output none. This value discards any output from
the action commands. The command runs in global configuration mode as a user with privilege level 15 (the
highest). The command may not accept any input, because it is disabled. You may send the output of the
action CLI commands to one of three locations:
• None, which is the default and discards the output
• Console, which sends the output to the ASA console
• File, which sends the output to a file. The following four file options are available:
◦Create a unique file, which creates a new, uniquely named file each time that an event manager
applet is invoked
◦Create/overwrite a file, which overwrites a specified file each time that an event manager applet
is invoked.
◦Create/append to a file, which appends to a specified file each time that an event manager applet
is invoked. If the file does not yet exist, it is created.
◦Create a set of files, which creates a set of uniquely named files that are rotated each time that an
event manager applet is invoked.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
878
Configure the EEM
Additional Guidelines
• During a crash, the state of the ASA is generally unknown. Some commands may not be safe to run
during this condition.
• The name of an event manager applet may not contain spaces.
• You cannot modify the None event and Crashinfo event parameters.
• Performance may be affected because syslog messages are sent to the EEM for processing.
• The default output is output none for each event manager applet. To change this setting, you must enter
a different output value.
• You may have only one output option defined for each event manager applet.
Procedure
Step 1 Create an Event Manager Applet and Configure Events, on page 879.
Step 2 Configure an Action and Destinations for Output from an Action, on page 881.
Step 3 Run an Event Manager Applet, on page 883.
Step 4 Track Memory Allocation and Memory Usage, on page 883.
Procedure
Step 1 Create an event manager applet and enter event manager applet configuration mode.
event manager applet name
Example:
ciscoasa(config)# event manager applet exampleapplet1
The name argument may be up to 32 alphanumeric characters long. Spaces are not allowed.
To remove an event manager applet, enter the no form of this command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
879
Configure the EEM
Example:
ciscoasa(config-applet)# description applet1example
The text argument may be up to 256 characters long. You may include spaces in description text if it is placed
within quotes.
Step 3 To configure a specified event, enter one of the following commands. To remove the configured event, enter
the no form of each of the commands.
• To configure a syslog event, identify a single syslog message or a range of syslog messages that trigger
an event manager applet.
event syslog id nnnnnn [-nnnnnn] [occurs n] [period seconds]
Example:
The nnnnnn argument identifies the syslog message ID. The occurs n keyword-argument pair indicates
the number of times that the syslog message must occur for an event manager applet to be invoked. The
default is 1 occurrence every 0 seconds. Valid values are from 1 - 4294967295. The period seconds
keyword-argument pair indicates the number of seconds in which the event must occur, and limits how
frequently an event manager applet is invoked to at most once in the configured period. Valid values
are from 0 - 604800. A value of 0 means that no period is defined.
• To configure an event to occur once per configured period and restart automatically.
event timer watchdog time seconds
Example:
The number of seconds may range from 1 - 604800. Use the no form of this command remove a
countdown timer event.
Note This timer reruns when you reboot if it is the startup configuration.
• To configure an event to occur once a day at a specified time and restart automatically.
event timer absolute time hh:mm:ss
Example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
880
Configure the EEM
The time-of-day format is in hh:mm:ss. The time range is from 00:00:00 (midnight) to 23:59:59.
• Trigger a crash event when the ASA crashes.
event crashinfo
Example:
Regardless of the value of the output command, the action commands are directed to the crashinfo file.
The output is generated before the show tech command.
Procedure
Example:
ciscoasa(config-applet)# action 1 cli command “show version”
The n option is an action ID. Valid IDs range from 0 - 4294967295. The value of the command option must
be in quotes; otherwise, an error occurs if the command consists of more than one word. The command runs
in global configuration mode as a user with privilege level 15 (the highest). The command may not accept
any input, because it is disabled. Use the noconfirm option if the command has it available.
Step 2 Choose one of the available output destination options. Use the no form of each command to remove an output
destination,
• The None option discards any output from the action commands, which is the default setting:
output none
Example:
• The Console option sends the output of the action commands to the console.
output console
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
881
Configure the EEM
Example:
The filename has the format of eem-applet-timestamp.log, in which applet is the name of the event
manager applet and timestamp is a dated time stamp in the format of YYYYMMDD-hhmmss.
• The New Set of Rotated Files option creates a set of files that are rotated. When a new file is to be
written, the oldest file is deleted, and all subsequent files are renumbered before the first file is written.
output file rotate n
Example:
The newest file is indicated by 0, and the oldest file is indicated by the highest number (n-1). The n
option is the rotate value. Valid values range from 2 - 100. The filename format is eem-applet-x.log, in
which applet is the name of the applet, and x is the file number.
• The Single Overwritten File option writes the action command output to a single file, which is
overwritten every time.
output file overwrite filename
Example:
The filename argument is a local (to the ASA) filename. This command may also use FTP, TFTP, and
SMB targeted files.
• The Single Appended File option writes the action command output to a single file, but that file is
appended to every time.
output file append filename
Example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
882
Configure the EEM
Procedure
Example:
ciscoasa# event manager run exampleapplet1
If you run an event manager applet that has not been configured with the event none command, an error
occurs. The applet argument is the name of the event manager applet.
Procedure
Example:
ciscoasa(config)# memory logging 202980
The only required argument is the number of entries in the memory logging buffer. The wrap option tells the
memory logging utility to save the buffer when it wraps. It can only be saved once.
If the memory logging buffer wraps multiple times, it can be overwritten. When the buffer wraps, a trigger
is sent to the event manager to enable saving of the data. The size option monitors a particular size. The
process option monitors a particular process.
Note The Checkheaps process is completely ignored as a process because it uses the memory allocator in
a non-standard way.
The context option records memory logging for a given virtual context by the given name.
To change memory logging parameters, you must disable it, then reenable it.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
883
Configure the EEM
Example:
ciscoasa# show memory logging
Number of free 6
Number of calloc 0
Number of malloc 8
Number of realloc-new 0
Number of realloc-free 0
Number of realloc-null 0
Number of realloc-same 0
Number of calloc-fail 0
Number of malloc-fail 0
Number of realloc-fail 0
Total operations 14
Buffer size: 50 (3688 x2 bytes)
process=[ci/console] time=[13:26:33.407] oper=[malloc]
addr=0x00007fff2cd0a6c0 size=72 @ 0x00000000016466ea 0x0000000002124542
0x000000000131911a 0x0000000000442bfd process=[ci/console] time=[13:26:33.407] oper=[free]
addr=0x00007fff2cd0a6c0 size=72 @ 0x00000000021246ef 0x00000000013193e8
0x0000000000443455 0x0000000001318f5b
process=[CMGR Server Process] time=[13:26:35.964] oper=[malloc]
addr=0x00007fff2cd0aa00 size=16 @ 0x00000000016466ea 0x0000000002124542
0x000000000182774d 0x000000000182cc8a process=[CMGR Server Process]
time=[13:26:35.964] oper=[malloc]
addr=0x00007fff224bb9f0 size=512 @ 0x00000000016466ea 0x0000000002124542
0x0000000000bfef9a 0x0000000000bff606 process=[CMGR Server Process]
time=[13:26:35.964] oper=[free]
addr=0x00007fff224bb9f0 size=512 @ 0x00000000021246ef 0x0000000000bff3d8
0x0000000000bff606 0x000000000182ccb0
process=[CMGR Server Process] time=[13:26:35.964] oper=[malloc]
addr=0x00007fff224b9460 size=40 @ 0x00000000016466ea 0x0000000002124542
0x0000000001834188 0x000000000182ce83
process=[CMGR Server Process] time=[13:26:37.964] oper=[free]
addr=0x00007fff2cd0aa00 size=16 @ 0x00000000021246ef 0x0000000001827098
0x000000000182c08d 0x000000000182c262 process=[CMGR Server Process]
time=[13:26:37.964] oper=[free]
addr=0x00007fff224b9460 size=40 @ 0x00000000021246ef 0x000000000182711b
0x000000000182c08d 0x000000000182c262 process=[CMGR Server Process]
time=[13:26:38.464] oper=[malloc]
addr=0x00007fff2cd0aa00 size=16 @ 0x00000000016466ea 0x0000000002124542
0x000000000182774d 0x000000000182cc8a process=[CMGR Server Process]
time=[13:26:38.464] oper=[malloc]
addr=0x00007fff224bb9f0 size=512 @ 0x00000000016466ea 0x0000000002124542
0x0000000000bfef9a 0x0000000000bff606 process=[CMGR Server Process]
time=[13:26:38.464] oper=[free]
addr=0x00007fff224bb9f0 size=512 @ 0x00000000021246ef 0x0000000000bff3d8
0x0000000000bff606 0x000000000182ccb0
process=[CMGR Server Process] time=[13:26:38.464] oper=[malloc]
addr=0x00007fff224b9460 size=40 @ 0x00000000016466ea 0x0000000002124542
0x0000000001834188 0x000000000182ce83
process=[ci/console] time=[13:26:38.557] oper=[malloc]
addr=0x00007fff2cd0a6c0 size=72 @ 0x00000000016466ea 0x0000000002124542
0x000000000131911a 0x0000000000442bfd process=[ci/console] time=[13:26:38.557] oper=[free]
addr=0x00007fff2cd0a6c0 size=72 @ 0x00000000021246ef 0x00000000013193e8
0x0000000000443455 0x0000000001318f5b
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
884
Configure the EEM
Without any options, show memory logging displays statistics and then the recorded operations. The brief
option shows only statistics. The wrap option shows the buffer upon wrap, then purges the data so that
duplicate data does not appear or get saved. The include option includes only the specified fields in the output.
You can specify the fields in any order, but they always appear in the following order:
1 Process
2 Time
3 Context (unless in single mode)
4 Operation (free/malloc/etc.)
5 Address
6 Size
7 Callers
Example:
ciscoasa(config)# event manager applet memlog
ciscoasa(config)# event memory-logging-wrap
ciscoasa(config)# action 0 cli command "show memory logging wrap"
ciscoasa(config)# output file append disk0:/memlog.log
The example shows an applet that records all memory allocations. When wrap is enabled for memory logging,
the memory logger sends an event to the event manager to trigger configured applets.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
885
Examples for the EEM
The following example shows an event manager applet that reboots the ASA every day at 1 am, saving the
configuration as needed:
The following example shows event manager applets that disable the given interface between midnight and
3 am.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
886
History for the EEM
This command shows information about the configured event manager applets, including hit counts and
when the event manager applets were last invoked.
• show memory logging, show memory logging include
These commands show statistics about the memory allocations and memory usage.
• show running-config event manager
This command shows the running configuration of the event manager.
Memory tracking for the 9.4(1) We have added a new debugging feature to log memory allocations and memory
EEM usage, and to respond to memory logging wrap events.
We introduced or modified the following commands: memory logging, show memory
logging, show memory logging include, event memory-logging-wrap.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
887
History for the EEM
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
888
CHAPTER 36
Testing and Troubleshooting
This chapter describes how to troubleshoot the Cisco ASA and test basic connectivity.
Capture Packets
Capturing packets may be useful when troubleshooting connectivity problems or monitoring suspicious
activity. We recommend that you contact Cisco TAC if you want to use the packet capture service.
To capture packets, perform the following steps:
Procedure
Enable packet capture capabilities for packet sniffing and network fault isolation.
[cluster exec] capture capture_name [type {asp-drop all [drop-code] | tls-proxy | raw-data | lacp | isakmp
[ikev1 | ikev2] | inline-tag [tag] |webvpn user webvpn-user}] [access-list access_list_name] [interface
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
889
Capture Packets
Example:
ciscoasa# capture captest interface inside
For the complete syntax description, see the command reference or the CLI help (help capture). Not all
options can be specified in one command. See the CLI help for allowed combinations.
Use the same capture_name on multiple capture statements to capture multiple types of traffic.
The type asp-drop keyword captures packets dropped by the accelerated security path. In a cluster, dropped
forwarded data packets from one unit to another are also captured. In multiple context mode, when this option
is issued in system context, all dropped data packets are captured; when this option is issued in a user context,
only dropped data packets that enter from interfaces belonging to the user context are captured.
The inline-tag tag keyword-argument pair specifies a tag for a particular SGT value or leaves it unspecified
to capture a tagged packet with any SGT value.
The buffer keyword defines the buffer size used to store the packet. When the byte buffer is full, packet
capture stops. When used in a cluster, this is the per-unit size, not the sum of all units. The circular-buffer
keyword overwrites the buffer, starting from the beginning, when the buffer is full.
The interface keyword sets the name of the interface on which to use packet capture. You must configure an
interface for any packets to be captured.
To capture packets on the dataplane, use the asa_dataplane keyword. To filter packets captured on the ASA
CX backplane, use the asa_dataplane option and follow these guidelines. In single mode, the backplane
control packets bypass the access list and are captured. In multiple context mode, only control packets are
captured in the system context. Data packets are captured in the user context. The access-list and match
options are only available in the user context.
To capture the traffic on the cluster control link, use the cluster keyword. If you configure type lacp, specify
the physical interface ID instead of the nameif name.
The match keyword captures matching the protocol and source and destination IP addresses and optional
ports. You can use this keyword up to three times in one command. The operator can be one of the following:
• lt—less than
• gt—greater than
• eq—equal to
The type raw-data keywords capture inbound and outbound packets. This setting is the default.
The real-time keyword displays the captured packets continuously in real-time. To terminate real-time packet
capture, enter Ctrl + c. To permanently remove the capture, use the no form of this command. This option
applies only to raw-data and asp-drop captures. This option is not supported when you use the cluster exec
capture command.
The reinject-hide keyword specifies that no reinjected packets will be captured and applies only in a clustering
environment.
Note If ACL optimization is configured, you cannot use the access-list command in capture. You can only
use the access-group command. An error appears if you try to use the access-list command in this
case.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
890
Capture Packets
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
891
Capture Packets
◦All traffic that enters the interface to which the capture is attached is captured, including traffic to
other contexts on the shared VLAN.
◦Therefore, if you enable a capture in Context A for a VLAN that is also used by Context B, both
Context A and Context B ingress traffic are captured.
• For egress traffic, only the traffic of the context with the active capture is captured. The only exception
is when you do not enable the ICMP inspection (therefore the ICMP traffic does not have a session in
the accelerated path). In this case, both ingress and egress ICMP traffic for all contexts on the shared
VLAN is captured.
• Configuring a capture typically involves configuring an ACL that matches the traffic that needs to be
captured. After an ACL that matches the traffic pattern is configured, then you need to define a capture
and associate this ACL to the capture, along with the interface on which the capture needs to be
configured.
• After you have performed a cluster-wide capture, to copy the same cluster-wide capture file to a TFTP
server, enter the following command on the master unit:
ciscoasa (cfg-cluster)# cluster exec copy/pcap capture: cap_name tftp://location/path/filename.pcap
• Multiple PCAP files, one from each unit, are copied to the TFTP server. The destination capture file
name is automatically attached with the unit name, such as filename_A.pcap, filename_B.pcap, and so
on. In this example, A and B are cluster unit names. A different destination name is generated if you
add the unit name at the end of the filename.
• To enable cluster-wide capture on a specified interface, you can add the cluster exec keywords in front
of each of the commands shown in the examples. These capture commands can only be replicated from
the master unit to the slave units. However, you can still configure a capture on the specified interface
for the local unit using any of these capture commands.
The following example shows how to create a capture for control path packets in the clustering link:
ciscoasa (config)# capture cp interface cluster match udp any eq 49495 any
ciscoasa (config)# capture cp interface cluster match udp any any eq 49495
The following example shows how to create a capture for data path packets in the clustering link:
ciscoasa (config)# access-list cc1 extended permit udp any any eq 4193
ciscoasa (config)# access-list cc1 extended permit udp any any eq 4193 4193 any
ciscoasa (config)# capture dp interface cluster access-list cc1
The following example shows how to capture data path traffic through the cluster:
ciscoasa (config)# capture abc interface inside match tcp host 1.1.1.1 host 2.2.2.2 eq www
ciscoasa (config)# capture abc interface inside match ucp host 1.1.1.1 any
ciscoasa (config)# capture abc interface inside access-list xxx
The following example shows how to capture logical update messages for flows that match the real source to
the real destination, and capture packets forwarded over CCL that match the real source to the real destination:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
892
View the Crash Dump
The following example shows how to capture a certain type of data plane message, such as icmp echo
request/response, that is forwarded from one ASA to another ASA using the match keyword or the ACL for
the message type:
ciscoasa (config)# capture capture_name interface cluster access-list match icmp any any
The following example shows how to create a capture by using ACL 103 on a cluster control link:
In the previous example, if A and B are IP addresses for the CCL interface, only the packets that are sent
between these two units are captured.
If A and B are IP addresses for through-device traffic, then the following is true:
• Forwarded packets are captured as usual, provided the source and destination IP addresses are matched
with the ACL.
• The data path logic update message is captured provided it is for the flow between A and B or for an
ACL (for example, access-list 103). The capture matches the five-tuple of the embedded flow.
Although the source and destination addresses in the UDP packet are CCL addresses, if this packet is to update
a flow that is associated with addresses A and B, then it is also captured. That is, as long as addresses A and
B that are embedded in the packet are matched, it is also captured.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
893
vCPU Usage in the ASAv
The overhead is used to perform hypervisor functions and to move packets between NICs and vNICs using
the vSwitch.
Usage can exceed 100% because the ESXi server can use additional compute resources for overhead on behalf
of the ASAv.
The terms “%CPU utilization” and “%CPU usage” mean different things:
• CPU utilization provides statistics for physical CPUs.
• CPU usage provides statistics for logical CPUs, which is based on CPU hyperthreading. But because
only one vCPU is used, hyperthreading is not turned on.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
894
Test Your Configuration
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
895
Test Your Configuration
However, some networks prohibit ICMP. If this is true of your network, you can instead use TCP ping to test
network connectivity. With TCP ping, the ping sends TCP SYN packets, and considers the ping a success if
it receives a SYN-ACK in response. With TCP ping, you can ping IPv4 addresses or host names, but you
cannot ping IPv6 addresses.
Keep in mind that a successful ICMP or TCP ping simply means that the address you are using is alive and
responding to that specific type of traffic. This means that basic connectivity is working. Other policies running
on a device could prevent specific types of traffic from successfully getting through a device.
Enable ICMP
By default, you can ping from a high security interface to a low security interface. You just need to enable
ICMP inspection to allow returning traffic through. If you want to ping from low to high, then you need to
apply an ACL to allow traffic.
When pinging an ASA interface, any ICMP rules applied to the interface must allow Echo Request and Echo
Response packets. ICMP rules are optional: if you do not configure them, all ICMP traffic to an interface is
allowed.
This procedure explains all of ICMP configuration you might need to complete to enable ICMP pinging of
ASA interfaces, or for pinging through an ASA.
Procedure
If you do not have access rules, you will need to also allow the other type of traffic you want, because applying
any access rules to an interface adds an implicit deny, so all other traffic will be dropped. Use the access-group
command to apply the ACL to an interface or globally.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
896
Test Your Configuration
If you are simply adding the rule for testing purposes, you can use the no form of the access-list command
to remove the rule from the ACL. If the entire ACL is simply for testing purposes, use the no access-group
command to remove the ACL from the interface.
Ping Hosts
To ping any device, you simply enter ping with the IP address or host name, such as ping 10.1.1.1 or ping
www.example.com. For TCP ping, you include the tcp keyword and the destination port, such as ping tcp
www.example.com 80. That is usually the extent of any test you need to run.
Example output for a successful ping:
If the ping fails, the output indicates ? for each failed attempt, and the success rate is less than 100 percent
(complete failure is 0 percent):
However, you can also add parameters to control some aspects of the ping. Following are your basic options:
• ICMP ping.
ping [if_name] host [repeat count] [timeout seconds] [data pattern] [size bytes] [validate]
Where:
◦if_name is the name of the interface by which the host is accessible. If you do not include a name,
the routing table is used to determine the interface to use.
◦host is the IPv4, IPv6, or host name of the host you are pinging.
◦repeat count is how many packets to send. The default is 5.
◦timeout seconds is the number of seconds for each packet to time out if no response occurs. The
default is 2.
◦data pattern is the hexadecimal pattern to use in the packets sent. The default is 0xabcd.
◦size bytes is the length of the packet sent. The default is 100 bytes.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
897
Test Your Configuration
• TCP ping.
ping tcp [if_name] host [port] [repeat count] [timeout seconds] [source host [ports]
Where:
◦if_name is the interface through which the source sends the ping. If you do not include a name,
the routing table is used.
◦host is the IPv4 address or host name of the destination you are pinging. You cannot use TCP ping
with IPv6 addresses.
◦port is the TCP port on the host you are pinging.
◦repeat and timeout have the same meaning as above.
◦source host port indicates the source host and port for the ping. Use port 0 to get a random port.
• Interactive ping.
ping
By entering ping without parameters, you are prompted for interface, destination, and other parameters,
including extended parameters not available as keywords. Use this method if you have need for extensive
control over the ping packets.
With this configuration, you would see something like the following for a successful ping from an external
host (209.165.201.2) to the ASA outside interface (209.165.201.1):
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
898
Test Your Configuration
Inbound ICMP echo reply (len 32 id 1 seq 768) 209.165.201.1 > 209.165.201.2
Outbound ICMP echo request (len 32 id 1 seq 1024) 209.165.201.2 > 209.165.201.1
Inbound ICMP echo reply (len 32 id 1 seq 1024) 209.165.201.1 > 209.165.201.2
The output shows the ICMP packet length (32 bytes), the ICMP packet identifier (1), and the ICMP sequence
number (the ICMP sequence number starts at 0, and is incremented each time that a request is sent).
When you are finished testing, disable debugging. Leaving the configuration in place can pose performance
and security risks. If you enabled logging just for testing, you can disable it also.
Procedure
Step 1 Draw a diagram of your single-mode ASA or security context that shows the interface names, security levels,
and IP addresses. The diagram should also include any directly connected routers and a host on the other side
of the router from which you will ping the ASA.
Step 2 Ping each ASA interface from the directly connected routers. For transparent mode, ping the management IP
address. This test ensures that the ASA interfaces are active and that the interface configuration is correct.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
899
Test Your Configuration
A ping might fail if the ASA interface is not active, the interface configuration is incorrect, or if a switch
between the ASA and a router is down (see the following figure). In this case, no debugging messages or
syslog messages appear, because the packet never reaches the ASA.
If the ping reply does not return to the router, then a switch loop or redundant IP addresses might exist (see
the following figure).
Step 3 Ping each ASA interface from a remote host. For transparent mode, ping the management IP address. This
test checks whether the directly connected router can route the packet between the host and the ASA, and
whether the ASA can correctly route the packet back to the host.
A ping might fail if the ASA does not have a return route to the host through the intermediate router (see the
following figure). In this case, the debugging messages show that the ping was successful, but syslog message
110001 appears, indicating a routing failure has occurred.
Figure 51: Ping Failure Because the ASA Has No Return Route
Step 4 Ping from an ASA interface to a network device that you know is functioning correctly.
• If the ping is not received, a problem with the transmitting hardware or interface configuration may
exist.
• If the ASA interface is configured correctly and it does not receive an echo reply from the “known good”
device, problems with the interface hardware receiving function may exist. If a different interface with
“known good” receiving capability can receive an echo after pinging the same “known good” device, the
hardware receiving problem of the first interface is confirmed.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
900
Test Your Configuration
Step 5 Ping from the host or router through the source interface to another host or router on another interface. Repeat
this step for as many interface pairs as you want to check. If you use NAT, this test shows that NAT is operating
correctly.
If the ping succeeds, a syslog message appears to confirm the address translation for routed mode (305009
or 305011) and that an ICMP connection was established (302020). You can also enter either the show xlate
or show conns command to view this information.
The ping might fail because NAT is not configured correctly. In this case, a syslog message appears, showing
that the NAT failed (305005 or 305006). If the ping is from an outside host to an inside host, and you do not
have a static translation, you get message 106010.
Figure 52: Ping Failure Because the ASA is Not Translating Addresses
Procedure
Procedure
Step 1 Create an L3/L4 class map to identify the traffic for which you want to customize connection settings.
class-map name
match parameter
Example:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
901
Test Your Configuration
For information on matching statements, see the Service Policy chapter in the firewall configuration guide.
Step 2 Add or edit a policy map that sets the actions to take with the class map traffic, and identify the class map.
policy-map name class name
Example:
In the default configuration, the global_policy policy map is assigned globally to all interfaces. If you want
to edit the global_policy, enter global_policy as the policy name. For the class map, specify the class you
created earlier in this procedure.
Example:
The global keyword applies the policy map to all interfaces, and interface applies the policy to one interface.
Only one global policy is allowed. You can override the global policy on an interface by applying a service
policy to that interface. You can only apply one policy map to each interface.
Step 5 Increase the rate limit on ICMP Unreachable messages so that the ASA will appear on trace route output.
icmp unreachable rate-limit rate burst-size size
Example:
The rate limit can be 1-100, with 1 being the default. The burst size is meaningless, but must be 1-10.
Example
The following example decrements TTL for all traffic globally and increase the ICMP unreachable limit to
50.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
902
Test Your Configuration
nn msec For each node, the round-trip time (in milliseconds) for the specified number of probes.
!P ICMP unreachable.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
903
Test Your Configuration
• ttl min_ttl max_ttl—The minimum and maximum time-to-live values for the probes. The minimum
default is one, but you can set it to a higher value to suppress the display of known hops. The maximum
default is 30. The traceroute terminates when the packet reaches the destination or when the maximum
value is reached.
• port port_value—The UDP port to use. The default is 33434.
• use-icmp—Send ICMP packets instead of UDP packets for probes.
Example:
ciscoasa# traceroute 209.165.200.225
Procedure
Step 1 The command is complicated, so we divided it into parts. Start by choosing the interface and protocol for the
trace:
packet-tracer input ifc_name {icmp | tcp | udp | rawip | sctp} [inline-tag tag] ...
Where:
• input ifc_name—The name of the interface from which to start the trace.
• icmp, tcp, udp, rawip, sctp—The protocol to use. “rawip” is raw IP, that is, IP packets that are not
TCP/UDP.
• inline-tag tag—(Optional.) The security group tag value embedded in the Layer 2 CMD header. Valid
values range from 0 - 65533.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
904
Test Your Configuration
Step 4 Finally, type in the destination address criteria, destination port for TCP/UDP traces, and optional keywords,
and press Enter.
...{dip | security-group {name name | tag tag} | fqdn fqdn-string} dport [detailed] [xml]
Where:
• dip—The destination IPv4 or IPv6 address for the packet trace.
• security-group {name name | tag tag}—The destination security group based on the IP-SGT lookup
for Trustsec. You can specify a security group name or a tag number.
• fqdn fqdn-string—The fully qualified domain name of the destination host, IPv4 only.
• dport—The destination port for TCP/UDP/SCTP traces. Do not include this value for ICMP or raw IP
traces.
• detailed—Provides detailed trace results information in addition to the normal output.
• xml—Displays the trace results in XML format.
Example
The following example traces a TCP packet for the HTTP port from 10.100.10.10 to 10.100.11.11. The result
indicates that the packet will be dropped by the implicit deny access rule.
ciscoasa(config)# packet-tracer input outside tcp 10.100.10.10 80 10.100.11.11 80
Phase: 1
Type: ROUTE-LOOKUP
Subtype: Resolve Egress Interface
Result: ALLOW
Config:
Additional Information:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
905
Monitoring Connections
Phase: 2
Type: ACCESS-LIST
Subtype:
Result: DROP
Config:
Implicit Rule
Additional Information:
Result:
input-interface: outside
input-status: up
input-line-status: up
output-interface: NP Identity Ifc
output-status: up
output-line-status: up
Action: drop
Drop-reason: (acl-drop) Flow is denied by configured rule
Monitoring Connections
To view current connections with information about source, destination, protocol, and so forth, use the show
conn all detail command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
906
PART VIII
Logging, SNMP, and Smart Call Home
• Logging, page 909
• SNMP, page 933
• Anonymous Reporting and Smart Call Home, page 975
CHAPTER 37
Logging
This chapter describes how to log system messages and use them for troubleshooting.
About Logging
System logging is a method of collecting messages from devices to a server running a syslog daemon. Logging
to a central syslog server helps in aggregation of logs and alerts. Cisco devices can send their log messages
to a UNIX-style syslog service. A syslog service accepts messages and stores them in files, or prints them
according to a simple configuration file. This form of logging provides protected long-term storage for logs.
Logs are useful both in routine troubleshooting and in incident handling.
The ASA system logs provide you with information for monitoring and troubleshooting the ASA. With the
logging feature, you can do the following:
• Specify which syslog messages should be logged.
• Disable or change the severity level of a syslog message.
• Specify one or more locations where syslog messages should be sent, including:
• An internal buffer
• One or more syslog servers
• ASDM
• An SNMP management station
• Specified e-mail addresses
• Console
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
909
About Logging
• Configure and manage syslog messages in groups, such as by severity level or class of message.
• Specify whether or not a rate-limit is applied to syslog generation.
• Specify what happens to the contents of the internal log buffer when it becomes full: overwrite the buffer,
send the buffer contents to an FTP server, or save the contents to internal flash memory.
• Filter syslog messages by locations, severity level, class, or a custom message list.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
910
About Logging
ASA The syslog message facility code for messages that are generated by the ASA and
ASASM. This value is always ASA.
Level 1 through 7. The level reflects the severity of the condition described by the syslog
message—the lower the number, the more severe the condition.
Message_text A text string that describes the condition. This portion of the syslog message sometimes
includes IP addresses, port numbers, or usernames.
Severity Levels
The following table lists the syslog message severity levels. You can assign custom colors to each of the
severity levels to make it easier to distinguish them in the ASDM log viewers. To configure syslog message
color settings, either choose the Tools > Preferences > Syslog tab or, in the log viewer itself, click Color
Settings on the toolbar.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
911
About Logging
Note ASA does not generate syslog messages with a severity level of zero (emergencies).
You customize these criteria by creating a message list that you can specify when you set the output destination.
Alternatively, you can configure the ASA to send a particular message class to each type of output destination
independently of the message list.
The syslog message class provides a method of categorizing syslog messages by type, equivalent to a feature
or function of the device. For example, the rip class denotes RIP routing.
All syslog messages in a particular class share the same initial three digits in their syslog message ID numbers.
For example, all syslog message IDs that begin with the digits 611 are associated with the vpnc (VPN client)
class. Syslog messages associated with the VPN client feature range from 611101 to 611323.
In addition, most of the ISAKMP syslog messages have a common set of prepended objects to help identify
the tunnel. These objects precede the descriptive text of a syslog message when available. If the object is not
known at the time that the syslog message is generated, the specific heading = value combination does not
appear.
The objects are prefixed as follows:
Group = groupname, Username = user, IP = IP_address
Where the group is the tunnel-group, the username is the username from the local database or AAA server,
and the IP address is the public IP address of the remote access client or Layer 2 peer.
The following table lists the message classes and the range of message IDs in each class.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
912
About Logging
session User Session 106, 108, 201, 202, 204, 302, 303, 304, 305, 314, 405, 406, 407,
500, 502, 607, 608, 609, 616, 620, 703, 710
sys System 199, 211, 214, 216, 306, 307, 315, 414, 604, 605, 606, 610, 612,
614, 615,701, 711
vpn IKE and IPsec 316, 320, 402, 404, 501, 602, 702, 713, 714, 715
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
913
Guidelines for Logging
A message list can include multiple criteria for selecting messages. However, you must add each message
selection criterion with a new command entry. It is possible to create a message list that includes overlapping
message selection criteria. If two criteria in a message list select the same message, the message is logged
only once.
Clustering
Syslog messages are an invaluable tool for accounting, monitoring, and troubleshooting in a clustering
environment. Each ASA unit in the cluster (up to eight units are allowed) generates syslog messages
independently; certain logging commands then enable you to control header fields, which include a time stamp
and device ID. The syslog server uses the device ID to identify the syslog generator. You can use the logging
device-id command to generate syslog messages with identical or different device IDs to make messages
appear to come from the same or different units in the cluster.
IPv6 Guidelines
Does not support IPv6.
Additional Guidelines
• The syslog server must run a server program called syslogd. Windows provides a syslog server as part
of its operating system.
• To view logs generated by the ASA, you must specify a logging output destination. If you enable logging
without specifying a logging output destination, the ASA generates messages but does not save them to
a location from which you can view them. You must specify each different logging output destination
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
914
Configure Logging
separately. For example, to designate more than one syslog server as an output destination, enter a new
command for each syslog server.
• Sending syslogs over TCP is not supported on a standby device.
• You can configure up to 16 syslog servers. However, in multiple context mode, the limitation is 4 servers
per context.
• The syslog server should be reachable through the ASA. You should configure the device to deny ICMP
unreachable messages on the interface through which the syslog server is reachable and to send syslogs
to the same server. Make sure that you have enabled logging for all severity levels. To prevent the syslog
server from crashing, suppress the generation of syslogs 313001, 313004, and 313005.
• When you use a custom message list to match only access list hits, the access list logs are not generated
for access lists that have had their logging severity level increased to debugging (level 7). The default
logging severity level is set to 6 for the logging list command. This default behavior is by design. When
you explicitly change the logging severity level of the access list configuration to debugging, you must
also change the logging configuration itself.
The following is sample output from the show running-config logging command that does not include
access list hits, because their logging severity level has been changed to debugging:
The following is sample output from the show running-config logging command that does include
access list hits:
In this case, the access list configuration does not change and the number of access list hits appears, as
shown in the following example:
• When the ASA sends syslogs via TCP, the connection takes about one minute to initiate after the syslogd
service restarts.
Configure Logging
This section describes how to configure logging.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
915
Configure Logging
Procedure
Enable Logging
To enable logging, perform the following steps:
Procedure
Enable logging.
logging enable
Example:
ciscoasa(config)# logging enable
Procedure
Step 1 Configure the ASA and ASASM to send messages to a syslog server.
logging host interface_name syslog_ip [tcp[/port] | udp [/port] [format emblem]]
Example:
ciscoasa(config)# logging host dmz1 192.168.1.5 udp 1026 format emblem
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
916
Configure Logging
The format emblem keyword enables EMBLEM format logging for the syslog server with UDP only. The
interface_name argument specifies the interface through which you access the syslog server. The syslog_ip
argument specifies the IP address of the syslog server. The tcp[/port] or udp[/port] keyword-argument pair
specify that the ASA and ASASM should use TCP or UDP to send syslog messages to the syslog server.
You can configure the ASA to send data to a syslog server using either UDP or TCP, but not both. The default
protocol is UDP if you do not specify a protocol.
If you specify TCP, the ASA and ASASM discover when the syslog server fails and as a security protection,
new connections through the ASA and ASA Services Module are blocked. To allow new connections regardless
of connectivity to a TCP syslog server, see Step 3. If you specify UDP, the ASA and ASASM continue to
allow new connections whether or not the syslog server is operational. Valid port values for either protocol
are 1025 through 65535. The default UDP port is 514. The default TCP port is 1470.
Step 2 Specify which syslog messages should be sent to the syslog server.
logging trap {severity_level | message_list}
Example:
ciscoasa(config)# logging trap errors
You can specify the severity level number (1 through 7) or name. For example, if you set the severity level
to 3, then the ASA and ASASM send syslog messages for severity levels 3, 2, and 1. You can specify a custom
message list that identifies the syslog messages to send to the syslog server.
Step 3 (Optional) Disable the feature to block new connections when a TCP-connected syslog server is down.
logging permit-hostdown
Example:
ciscoasa(config)# logging permit-hostdown
If the ASA or ASASM is configured to send syslog messages to a TCP-based syslog server, and if either the
syslog server is down or the log queue is full, then new connections are blocked. New connections are allowed
again after the syslog server is back up and the log queue is no longer full.
Step 4 (Optional) Set the logging facility to a value other than 20, which is what most UNIX systems expect.
logging facility number
Example:
ciscoasa(config)# logging facility 21
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
917
Configure Logging
Procedure
Step 1 Specify which syslog messages should be sent to the internal log buffer, which serves as a temporary storage
location.
logging buffered {severity_level | message_list}
Example:
ciscoasa(config)# logging buffered critical
ciscoasa(config)# logging buffered level 2
ciscoasa(config)# logging buffered notif-list
New messages are appended to the end of the list. When the buffer is full, that is, when the buffer wraps, old
messages are overwritten as new messages are generated, unless you configure the ASA and ASASM to save
the full buffer to another location. To empty the internal log buffer, enter the clear logging buffer command.
Step 2 Change the size of the internal log buffer. The default buffer size is 4 KB.
logging buffer-size bytes
Example:
ciscoasa(config)# logging buffer-size 16384
• Save new messages to the internal log buffer and save the full log buffer content to an FTP server.
logging ftp-bufferwrap
Example:
When saving the buffer content to another location, the ASA and ASASM create log files with names
that use the following time-stamp format:
LOG-YYYY-MM-DD-HHMMSS.TXT
where YYYY is the year, MM is the month, DD is the day of the month, and HHMMSS is the time in
hours, minutes, and seconds.
• Identify the FTP server on which you want to store log buffer content.
logging ftp-server server pathusername password
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
918
Configure Logging
Example:
The server argument specifies the IP address of the external FTP server. The path argument specifies
the directory path on the FTP server where the log buffer data is to be saved. This path is relative to the
FTP root directory. The username argument specifies a username that is valid for logging into the FTP
server. The password argument indicates the password for the username specified.
• Save the current log buffer content to the internal flash memory.
logging savelog [savefile]
Example:
Procedure
Example:
ciscoasa(config)# logging mail high-priority
When sent by e-mail, a syslog message appears in the subject line of the e-mail message. For this reason, we
recommend configuring this option to notify administrators of syslog messages with high severity levels, such
as critical, alert, and emergency.
Step 2 Specify the source e-mail address to be used when sending syslog messages to an e-mail address.
logging from-address email_address
Example:
ciscoasa(config)# logging from-address [email protected]
Step 3 Specify the recipient e-mail address to be used when sending syslog messages to an e-mail address.
logging recipient-address e-mail_address[severity_level]
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
919
Configure Logging
Example:
ciscoasa(config)# logging recipient-address [email protected]
Step 4 Specify the SMTP server to be used when sending syslog messages to an e-mail address.
smtp-server ip_address
Example:
ciscoasa(config)# smtp-server 10.1.1.1
Procedure
Example:
ciscoasa(config)# logging asdm 2
The ASA or ASASM sets aside a buffer area for syslog messages waiting to be sent to ASDM and saves
messages in the buffer as they occur. The ASDM log buffer is a different buffer than the internal log buffer.
When the ASDM log buffer is full, the ASA or ASASM deletes the oldest syslog message to make room in
the buffer for new ones. Deletion of the oldest syslog message to make room for new ones is the default setting
in ASDM. To control the number of syslog messages retained in the ASDM log buffer, you can change the
size of the buffer.
Step 2 Specify the number of syslog messages to be retained in the ASDM log buffer.
logging asdm-buffer-size num_of_msgs
Example:
ciscoasa(config)# logging asdm-buffer-size 200
Enter the clear logging asdm command to empty the current content of the ASDM log buffer.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
920
Configure Logging
Procedure
Example:
ciscoasa(config)# logging console errors
Procedure
Enable SNMP logging and specify which messages are to be sent to SNMP servers.
logging history [logging_list | level]
Example:
ciscoasa(config)# logging history errors
Procedure
Step 1 Specify which syslog messages should be sent to a Telnet or SSH session.
logging monitor {severity_level | message_list}
Example:
ciscoasa(config)# logging monitor 6
Example:
ciscoasa(config)# terminal monitor
If you log out and then log in again, you need to reenter this command. Enter the terminal no monitor
command to disable logging to the current session.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
921
Configure Logging
To create a custom event list to send to a specific logging destination (for example, an SNMP server), perform
the following steps:
Procedure
Step 1 Specify criteria for selecting messages to be saved in the internal log buffer. For example, if you set the severity
level to 3, then the ASA sends syslog messages for severity levels 3, 2, and 1.
logging list name {level level [class message_class] | message start_id[-end_id]}
Example:
ciscoasa(config)# logging list notif-list level 3
The name argument specifies the name of the list. The level level keyword and argument pair specify the
severity level. The class message_class keyword-argument pair specify a particular message class. The
message start_id [-end_id] keyword-argument pair specify an individual syslog message number or a range
of numbers.
Note Do not use the names of severity levels as the name of a syslog message list. Prohibited names include
emergencies, alert, critical, error, warning, notification, informational, and debugging. Similarly, do
not use the first three characters of these words at the beginning of an event list name. For example,
do not use an event list name that starts with the characters “err.”
Step 2 (Optional) Add more criteria for message selection to the list.
logging list name {level level [class message_class] | message start_id[-end_id]}
Example:
ciscoasa(config)# logging list notif-list message 104024-105999
ciscoasa(config)# logging list notif-list level critical
ciscoasa(config)# logging list notif-list level warning class ha
Enter the same command as in the previous step, specifying the name of the existing message list and the
additional criterion. Enter a new command for each criterion that you want to add to the list. For example,
you can specify criteria for syslog messages to be included in the list as the following:
• Syslog message IDs that fall into the range of 104024 to 105999.
• All syslog messages with the critical severity level or higher (emergency, alert, or critical).
• All ha class syslog messages with the warning severity level or higher (emergency, alert, critical, error,
or warning).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
922
Configure Logging
Note A syslog message is logged if it satisfies any of these conditions. If a syslog message satisfies more
than one of the conditions, the message is logged only once.
Procedure
Send syslog messages in EMBLEM format to a syslog server over UDP using port 514.
logging host interface_name ip_address{tcp [/port] | udp [/ port]] [format emblem]
Example:
ciscoasa(config)# logging host interface_1 127.0.0.1 udp format emblem
The format emblem keyword enables EMBLEM format logging for the syslog server (UDP only). The
interface_name argument specifies the interface through which you access the syslog server. The ip_address
argument specifies the IP address of the syslog server. The tcp[/port] or udp[/port] keyword and argument
pair specify that the ASA and ASASM should use TCP or UDP to send syslog messages to the syslog server.
You can configure the ASA and ASASM to send data to a syslog server using either UDP or TCP, but not
both. The default protocol is UDP if you do not specify a protocol.
You can use multiple logging host commands to specify additional servers that would all receive syslog
messages. If you configure two or more logging servers, make sure that you limit the logging severity level
to warnings for all logging servers.
If you specify TCP, the ASA or ASASM discovers when the syslog server fails and as a security protection,
new connections through the ASA are blocked. If you specify UDP, the ASA or ASASM continues to allow
new connections whether or not the syslog server is operational. Valid port values for either protocol are 1025
through 65535. The default UDP port is 514. The default TCP port is 1470.
Note Sending syslogs over TCP is not supported on a standby
ASA.
Procedure
Send syslog messages in EMBLEM format to output destinations other than a syslog server, such as Telnet
or SSH sessions.
logging emblem
Example:
ciscoasa(config)# logging emblem
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
923
Configure Logging
Procedure
Step 1 Specify the maximum amount of internal flash memory available for saving log files.
logging flash-maximum-allocation kbytes
Example:
ciscoasa(config)# logging flash-maximum-allocation 1200
By default, the ASA can use up to 1 MB of internal flash memory for log data. The minimum amount of
internal flash memory that must be free for the ASA and ASASM to save log data is 3 MB.
If a log file being saved to internal flash memory would cause the amount of free internal flash memory to
fall below the configured minimum limit, the ASA or ASASM deletes the oldest log files to ensure that the
minimum amount of memory remains free after saving the new log file. If there are no files to delete or if,
after all old files have been deleted, free memory is still below the limit, the ASA or ASASM fails to save the
new log file.
Step 2 Specify the minimum amount of internal flash memory that must be free for the ASA or ASASM to save a
log file.
logging flash-minimum-free kbytes
Example:
ciscoasa(config)# logging flash-minimum-free 4000
Procedure
Specify the number of syslog messages that the ASA and ASASM can hold in its queue before sending them
to the configured output destination.
logging queue message_count
Example:
ciscoasa(config)# logging queue 300
The ASA and ASASM have a fixed number of blocks in memory that can be allocated for buffering syslog
messages while they are waiting to be sent to the configured output destination. The number of blocks required
depends on the length of the syslog message queue and the number of syslog servers specified. The default
queue size is 512 syslog messages. The queue size is limited only by block memory availability. Valid values
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
924
Configure Logging
are from 0 to 8192 messages, depending on the platform. If the logging queue is set to zero, the queue is the
maximum configurable size (8192 messages).
Procedure
Override the configuration in the specified output destination command. For example, if you specify that
messages at severity level 7 should go to the internal log buffer and that ha class messages at severity level 3
should go to the internal log buffer, then the latter configuration takes precedence.
logging class message_class {buffered | console | history | mail | monitor | trap} [severity_level]
Example:
ciscoasa(config)# logging class ha buffered alerts
The buffered, history, mail, monitor, and trap keywords specify the output destination to which syslog
messages in this class should be sent. The history keyword enables SNMP logging. The monitor keyword
enables Telnet and SSH logging. The trap keyword enables syslog server logging. Select one destination per
command line entry. To specify that a class should go to more than one destination, enter a new command
for each output destination.
Procedure
Example:
ciscoasa(config)# logging host inside 10.0.0.1 TCP/1500 secure
The interface_name argument specifies the interface on which the syslog server resides. The syslog_ip argument
specifies the IP address of the syslog server. The port argument specifies the port (TCP or UDP) that the
syslog server listens to for syslog messages. The tcp keyword specifies that the ASA or ASASM should use
TCP to send syslog messages to the syslog server. The udp keyword specifies that the ASA or ASASM should
use UDP to send syslog messages to the syslog server. The format emblem keyword enables EMBLEM
format logging for the syslog server. The secure keyword specifies that the connection to the remote logging
host should use SSL/TLS for TCP only.
Note Secure logging does not support UDP; an error occurs if you try to use this protocol.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
925
Configure Logging
Procedure
Configure the ASA or ASASM to include a device ID in non-EMBLEM-format syslog messages. You can
specify only one type of device ID for syslog messages.
logging device-id {cluster-id | context-name | hostname | ipaddress interface_name [system] | string text}
Example:
ciscoasa(config)# logging device-id hostname
ciscoasa(config)# logging device-id context-name
The context-name keyword indicates that the name of the current context should be used as the device ID
(applies to multiple context mode only). If you enable the logging device ID for the admin context in multiple
context mode, messages that originate in the system execution space use a device ID of system, and messages
that originate in the admin context use the name of the admin context as the device ID.
Note In an ASA cluster, always use the master unit IP address for the selected interface.
The cluster-id keyword specifies the unique name in the boot configuration of an individual ASA unit in the
cluster as the device ID. The hostname keyword specifies that the hostname of the ASA should be used as
the device ID. The ipaddress interface_name keyword-argument pair specifies that the interface IP address
specified as interface_name should be used as the device ID. If you use the ipaddress keyword, the device
ID becomes the specified ASA interface IP address, regardless of the interface from which the syslog message
is sent. In the cluster environment, the system keyword dictates that the device ID becomes the system IP
address on the interface. This keyword provides a single, consistent device ID for all syslog messages that
are sent from the device. The string text keyword-argument pair specifies that the text string should be used
as the device ID. The string can include as many as 16 characters.
You cannot use blank spaces or any of the following characters:
• & (ampersand)
• ‘ (single quote)
• “ (double quote)
• < (less than)
• > (greater than)
• ? (question mark)
Note If enabled, the device ID does not appear in EMBLEM-formatted syslog messages nor in SNMP
traps.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
926
Configure Logging
Procedure
Specify that syslog messages should include the date and time that they were generated.
logging timestamp
Example:
ciscoasa(config)# logging timestamp
LOG-2008-10-24-081856.TXT
To remove the date and time from syslog messages, enter the no logging timestamp command.
Procedure
Example:
ciscoasa(config)# no logging message 113019
To reenable a disabled syslog message, enter the logging message syslog_id command (for example, logging
message 113019). To reenable logging of all disabled syslog messages, enter the clear configure logging
disabled command.
Procedure
Example:
ciscoasa(config)# logging message 113019 level 5
To reset the severity level of a syslog message to its setting, enter the no logging message syslog_id level
severity_level command (for example, no logging message 113019 level 5). To reset the severity level of all
modified syslog messages to their settings, enter the clear configure logging level command.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
927
Configure Logging
Procedure
Unblock a specific syslog message that was previously blocked from being generated on a standby unit.
logging message syslog-id standby
Example:
ciscoasa(config)# logging message 403503 standby
To block a specific syslog message from being generated on a standby unit, use the no form of this command.
Use the logging standby command to ensure that the syslog messages of the failover standby ASA stay
synchronized if failover occurs.
Note Using the logging standby command causes twice as much traffic on shared logging destinations,
such as syslog servers, SNMP servers, and FTP servers.
Procedure
Apply a specified severity level (1 through 7) to a set of messages or to an individual message (not the
destination) within a specified time period.
logging rate-limit {unlimited | {num [interval]}} message syslog_id | level severity_level
Example:
ciscoasa(config)# logging rate-limit 1000 600 level 6
Rate limits affect the volume of messages being sent to all configured destinations. To reset the logging rate
limit to the default value, enter the clear running-config logging rate-limit command. To reset the logging
rate limit, enter the clear configure logging rate-limit command.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
928
Monitoring the Logs
Note The maximum number of syslog messages that are available to view is 1000, which is
the default setting. The maximum number of syslog messages that are available to view
is 2000.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
929
History for Logging
The following examples show how to control both whether a syslog message is enabled and the severity level
of the specified syslog message:
Rate limit 7.0(4) Limits the rate at which syslog messages are generated.
We introduced the following command: logging rate-limit.
Logging list 7.2(1) Creates a logging list to use in other commands to specify messages by various criteria
(logging level, event class, and message IDs).
We introduced the following command: logging list.
Secure logging 8.0(2) Specifies that the connection to the remote logging host should use SSL/TLS. This
option is valid only if the protocol selected is TCP.
We modified the following command: logging host.
Logging class 8.0(4), 8.1(1) Added support for the ipaa event class of logging messages.
We modified the following command: logging class.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
930
History for Logging
Log viewers 8.3(1) The source and destination IP addresses were added to the log viewers.
Enhanced logging and 8.3(2) When you configure a syslog server to use TCP, and the syslog server is unavailable,
connection blocking the ASA blocks new connections that generate syslog messages until the server
becomes available again (for example, VPN, firewall, and cut-through-proxy
connections). This feature has been enhanced to also block new connections when
the logging queue on the ASA is full; connections resume when the logging queue
is cleared.
This feature was added for compliance with Common Criteria EAL4+. Unless
required, we recommended allowing connections when syslog messages cannot be
sent or received. To allow connections, continue to use the logging permit-hostdown
command.
We introduced the following syslog messages: 414005, 414006, 414007, and 414008.
We modified the following command: show logging.
Syslog message filtering and 8.4(1) Support has been added for the following:
sorting
• Syslog message filtering based on multiple text strings that correspond to various
columns
• Creation of custom filters
• Column sorting of messages. For detailed information, see the ASDM
configuration guide.
Clustering 9.0(1) Added support for syslog message generation in a clustering environment on the
ASA 5580 and 5585-X.
We modified the following command: logging device-id.
Blocking syslogs on a 9.4(1) We added support for blocking the generation of specific syslog messages on the
standby unit standby unit in a failover configuration.
We introduced the following command: logging message syslog-id standby.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
931
History for Logging
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
932
CHAPTER 38
SNMP
This chapter describes how to configure Simple Network Management Protocol (SNMP) to monitor the
Cisco ASA.
About SNMP
SNMP is an application-layer protocol that facilitates the exchange of management information between
network devices and is part of the TCP/IP protocol suite. The ASA provide support for network monitoring
using SNMP Versions 1, 2c, and 3, and support the use of all three versions simultaneously. The SNMP agent
running on the ASA interface lets you monitor the network devices through network management systems
(NMSes), such as HP OpenView. The ASA support SNMP read-only access through issuance of a GET
request. SNMP write access is not allowed, so you cannot make changes with SNMP. In addition, the SNMP
SET request is not supported.
You can configure the ASAto send traps, which are unsolicited messages from the managed device to the
management station for certain events (event notifications) to an NMS, or you can use the NMS to browse
the Management Information Bases (MIBs) on the security devices. MIBs are a collection of definitions, and
the ASA maintain a database of values for each definition. Browsing a MIB means issuing a series of
GET-NEXT or GET-BULK requests of the MIB tree from the NMS to determine values.
The ASA have an SNMP agent that notifies designated management stations if events occur that are predefined
to require a notification, for example, when a link in the network goes up or down. The notification it sends
includes an SNMP OID, which identifies itself to the management stations. The ASA agent also replies when
a management station asks for information.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
933
About SNMP
SNMP Terminology
The following table lists the terms that are commonly used when working with SNMP.
Term Description
Agent The SNMP server running on the ASA. The SNMP agent has the following features:
• Responds to requests for information and actions from the network management station.
• Controls access to its Management Information Base, the collection of objects that the SNMP manager can
view or change.
• Does not allow SET operations.
Browsing Monitoring the health of a device from the network management station by polling required information from
the SNMP agent on the device. This activity may include issuing a series of GET-NEXT or GET-BULK requests
of the MIB tree from the network management station to determine values.
Management Standardized data structures for collecting information about packets, connections, buffers, failovers, and so on.
Information MIBs are defined by the product, protocols, and hardware standards used by most network devices. SNMP
Bases (MIBs) network management stations can browse MIBs and request specific data or events be sent as they occur.
Network The PCs or workstations set up to monitor SNMP events and manage devices, such as the ASA.
management
stations (NMSs)
Object identifier The system that identifies a device to its NMS and indicates to users the source of information monitored and
(OID) displayed.
Trap Predefined events that generate a message from the SNMP agent to the NMS. Events include alarm conditions
such as linkup, linkdown, coldstart, warmstart, authentication, or syslog messages.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
934
About SNMP
Note In software versions 7.2(1), 8.0(2), and later, the interface information accessed through SNMP refreshes
about every 5 seconds. As a result, we recommend that you wait for at least 5 seconds between consecutive
polls.
Not all OIDs in MIBs are supported. To obtain a list of the supported SNMP MIBs and OIDs for a specific
ASA or ASASM, enter the following command:
Note Although the oidlist keyword does not appear in the options list for the show snmp-server command
help, it is available. However, this command is for Cisco TAC use only. Contact the Cisco TAC before
using this command.
The following is sample output from the show snmp-server oidlist command:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
935
About SNMP
ASA 5506 Adaptive Security Appliance ciscoASA5506sc (ciscoProducts 2115) ASA 5506-X security context
Security Context
ASA 5506 Adaptive Security Appliance ciscoASA5506sy (ciscoProducts 2116) ASA 5506-X system context
System Context
ASA 5506W Adaptive Security Appliance ciscoASA5506W (ciscoProducts 2117) ASA 5506W-X
ASA 5506W Adaptive Security Appliance ciscoASA5506Wsc (ciscoProducts 2118) ASA 5506W-X security context
Security Context
ASA 5506W Adaptive Security Appliance ciscoASA5506Wsy (ciscoProducts 2119) ASA 5506W-X system context
System Context
ASA 5508 Adaptive Security Appliance ciscoASA5508 (ciscoProducts 2120) ASA 5508-X
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
936
About SNMP
ASA 5508 Adaptive Security Appliance ciscoASA5508sy (ciscoProducts 2122) ASA 5508-X system context
System Context
ASA 5506 Adaptive Security Appliance ciscoASA5506K7 (ciscoProducts 2123) ASA 5506-X Adaptive Security Appliance
with No Payload Encryption with No Payload Encryption
ASA 5506 Adaptive Security Appliance ciscoASA5506K7sc (ciscoProducts 2124) ASA 5506-X Adaptive Security Appliance
Security Context with No Payload Security Context with No Payload
Encryption Encryption
ASA 5506 Adaptive Security Appliance ciscoASA5506K7sy (ciscoProducts 2125) ASA 5506-X Adaptive Security Appliance
System Context with No Payload System Context with No Payload
Encryption Encryption
ASA 5508 Adaptive Security Appliance ciscoASA5508K7 (ciscoProducts 2126) ASA 5508-X Adaptive Security Appliance
with No Payload Encryption System Context with No Payload
Encryption
ASA 5508 Adaptive Security Appliance ciscoASA5508K7sc (ciscoProducts 2127) ASA 5508-X Adaptive Security Appliance
Security Context with No Payload Security Context with No Payload
Encryption Encryption
ASA 5508 Adaptive Security Appliance ciscoASA5508K7sy (ciscoProducts 2128) ASA 5508-X Adaptive Security Appliance
System Context with No Payload System Context with No Payload
Encryption Encryption
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
937
About SNMP
ASA Services Module for Catalyst ciscoAsaSm1 (ciscoProducts 1277) Adaptive Security Appliance (ASA)
switches/7600 routers Services Module for Catalyst switches/7600
routers
ASA Services Module for Catalyst ciscoAsaSm1sc (ciscoProducts 1275) Adaptive Security Appliance (ASA)
switches/7600 routers security context Services Module for Catalyst switches/7600
routers security context
ASA Services Module for Catalyst ciscoAsaSm1K7sc (ciscoProducts 1334) Adaptive Security Appliance (ASA)
switches/7600 routers security context with Services Module for Catalyst switches/7600
No Payload Encryption routers security context with No Payload
Encryption
ASA Services Module for Catalyst ciscoAsaSm1sy (ciscoProducts 1276) Adaptive Security Appliance (ASA)
switches/7600 routers system context Services Module for Catalyst switches/7600
routers system context
ASA Services Module for Catalyst ciscoAsaSm1K7sy (ciscoProducts 1335) Adaptive Security Appliance (ASA)
switches system context/7600 routers with Services Module for Catalyst switches/7600
No Payload Encryption routers system context with No Payload
Encryption
ASA Services Module for Catalyst ciscoAsaSm1K7 (ciscoProducts 1336) Adaptive Security Appliance (ASA)
switches/7600 routers system context with Services Module for Catalyst switches/7600
No Payload Encryption routers with No Payload Encryption
ASA 5512 ciscoASA5512 (ciscoProducts 1407) ASA 5512 Adaptive Security Appliance
ASA 5525 ciscoASA5525 (ciscoProducts 1408) ASA 5525 Adaptive Security Appliance
ASA 5545 ciscoASA5545 (ciscoProducts 1409) ASA 5545 Adaptive Security Appliance
ASA 5555 ciscoASA5555 (ciscoProducts 1410) ASA 5555 Adaptive Security Appliance
ASA 5512 Security Context ciscoASA5512sc (ciscoProducts 1411) ASA 5512 Adaptive Security Appliance
Security Context
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
938
About SNMP
ASA 5545 Security Context ciscoASA5545sc (ciscoProducts 1413) ASA 5545 Adaptive Security Appliance
Security Context
ASA 5555 Security Context ciscoASA5555sc (ciscoProducts 1414) ASA 5555 Adaptive Security Appliance
Security Context
ASA 5512 System Context ciscoASA5512sy (ciscoProducts 1415) ASA 5512 Adaptive Security Appliance
System Context
ASA 5515 System Context ciscoASA5515sy (ciscoProducts 1416) ASA 5515 Adaptive Security Appliance
System Context
ASA 5525 System Context ciscoASA5525sy (ciscoProducts1417) ASA 5525 Adaptive Security Appliance
System Context
ASA 5545 System Context ciscoASA5545sy (ciscoProducts 1418) ASA 5545 Adaptive Security Appliance
System Context
ASA 5555 System Context ciscoASA5555sy (ciscoProducts 1419) ASA 5555 Adaptive Security Appliance
System Context
ASA 5515 Security Context ciscoASA5515sc (ciscoProducts 1420) ASA 5515 Adaptive Security Appliance
System Context
ASA 5515 ciscoASA5515 (ciscoProducts 1421) ASA 5515 Adaptive Security Appliance
ASAv System Context ciscoASAvsy (ciscoProducts 1903) Cisco Adaptive Security Virtual Appliance
(ASAv) System Context
ASAv Security Context ciscoASAvsc (ciscoProducts 1904) Cisco Adaptive Security Virtual Appliance
(ASAv) Security Contex
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
939
About SNMP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
940
About SNMP
ASA Services Module for Catalyst switches/7600 routers with cevCat6kWsSvcAsaSm1K7 (cevModuleCat6000Type 186)
No Payload Encryption
Accelerator for 5506 with No Payload Encryption Adaptive cevAcceleratorAsa5506K7 (cevOther 13)
Security Appliance
Accelerator for 5508 with No Payload Encryption Adaptive cevAcceleratorAsa5508K7 (cevOther 14)
Security Appliance
Cisco Adaptive Security Appliance (ASA) 5506 Chassis cevChassisAsa5506 (cevChassis 1600)
Cisco Adaptive Security Appliance (ASA) 5506W Chassis cevChassisAsa5506W (cevChassis 1601)
Cisco Adaptive Security Appliance (ASA) 5508 Chassis cevChassisAsa5508 (cevChassis 1602)
Cisco Adaptive Security Appliance (ASA) 5506 Chassis with No cevChassisAsa5506K7 (cevChassis 1603)
Payload Encryption
Cisco Adaptive Security Appliance (ASA) 5508 Chassis with No cevChassisAsa5508K7 (cevChassis 1604)
Payload Encryption
Central Processing Unit for 5506 Adaptive Security Appliance cevCpuAsa5506 (cevModuleCpuType 312)
Central Processing Unit for 5506W Adaptive Security Appliance cevCpuAsa5506W (cevModuleCpuType 313)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
941
About SNMP
Central Processing Unit for 5506 with No Payload Encryption cevCpuAsa5506K7 (cevModuleCpuType 315)
Adaptive Security Appliance
Central Processing Unit for 5508 with No Payload Encryption cevCpuAsa5508K7 (cevModuleCpuType 316)
Adaptive Security Appliance
Chassis Cooling Fan for Adaptive Security Appliance 5508 cevFanAsa5508ChassisFan (cevFan 247)
Chassis Cooling Fan for Adaptive Security Appliance 5508 with cevFanAsa5508K7ChassisFan (cevFan 248)
No Payload Encryption
Chassis Cooling Fan Sensor for Adaptive Security Appliance cevSensorAsa5508ChassisFanSensor (cevSensor 162)
5508
Chassis Cooling Fan Sensor for Adaptive Security Appliance cevSensorAsa5508K7ChassisFanSensor (cevSensor 163)
5508 with No Payload Encryption
Central Processing Unit Temperature Sensor for 5506 Adaptive cevSensorAsa5506CpuTempSensor (cevSensor 164)
Security Appliance
Central Processing Unit Temperature Sensor for 5506W Adaptive cevSensorAsa5506WCpuTempSensor (cevSensor 165)
Security Appliance
Central Processing Unit Temperature Sensor for 5508 Adaptive cevSensorAsa5508CpuTempSensor (cevSensor 166)
Security Appliance
Central Processing Unit Temperature Sensor for 5506 with No cevSensorAsa5506K7CpuTempSensor (cevSensor 167)
Payload Encryption Adaptive Security Appliance
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
942
About SNMP
Accelerator Temperature Sensor for 5506 Adaptive Security cevSensorAsa5506AcceleratorTempSensor (cevSensor 169)
Appliance
Accelerator Temperature Sensor for 5506W Adaptive Security cevSensorAsa5506WAcceleratorTempSensor (cevSensor 170)
Appliance
Accelerator Temperature Sensor for 5508 Adaptive Security cevSensorAsa5508AcceleratorTempSensor (cevSensor 171)
Appliance
Accelerator Temperature Sensor for 5506 with No Payload cevSensorAsa5506K7AcceleratorTempSensor (cevSensor 172)
Encryption Adaptive Security Appliance
Accelerator Temperature Sensor for 5508 with No Payload cevSensorAsa5508K7AcceleratorTempSensor (cevSensor 173)
Encryption Adaptive Security Appliance
Chassis Ambient Temperature Sensor for 5506 Adaptive Security cevSensorAsa5506ChassisTempSensor (cevSensor 174)
Appliance
Chassis Ambient Temperature Sensor for 5506W Adaptive cevSensorAsa5506WChassisTempSensor (cevSensor 175)
Security Appliance
Chassis Ambient Temperature Sensor for 5508 Adaptive Security cevSensorAsa5508ChassisTempSensor (cevSensor 176)
Appliance
Chassis Ambient Temperature Sensor for 5506 with No Payload cevSensorAsa5506K7ChassisTempSensor (cevSensor 177)
Encryption Adaptive Security Appliance
Chassis Ambient Temperature Sensor for 5508 with No Payload cevSensorAsa5508K7ChassisTempSensor (cevSensor 178)
Encryption Adaptive Security Appliance
Cisco Adaptive Security Appliance (ASA) 5512 Adaptive Security cevChassisASA5512 (cevChassis 1113)
Appliance
Cisco Adaptive Security Appliance (ASA) 5512 Adaptive Security cevChassisASA5512K7 (cevChassis 1108 )
Appliance with No Payload Encryption
Cisco Adaptive Security Appliance (ASA) 5515 Adaptive Security cevChassisASA5515 (cevChassis 1114)
Appliance
Cisco Adaptive Security Appliance (ASA) 5515 Adaptive Security cevChassisASA5515K7 (cevChassis 1109 )
Appliance with No Payload Encryption
Cisco Adaptive Security Appliance (ASA) 5525 Adaptive Security cevChassisASA5525 (cevChassis 1115)
Appliance
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
943
About SNMP
Cisco Adaptive Security Appliance (ASA) 5545 Adaptive Security cevChassisASA5545 (cevChassis 1116)
Appliance
Cisco Adaptive Security Appliance (ASA) 5545 Adaptive Security cevChassisASA5545K7 (cevChassis 1111 )
Appliance with No Payload Encryption
Cisco Adaptive Security Appliance (ASA) 5555 Adaptive Security cevChassisASA5555 (cevChassis 1117)
Appliance
Cisco Adaptive Security Appliance (ASA) 5555 Adaptive Security cevChassisASA5555K7 (cevChassis 1112 )
Appliance with No Payload Encryption
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5512 (cevModuleCpuType 229)
5512
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5512K7 (cevModuleCpuType 224)
5512 with no Payload Encryption
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5515 (cevModuleCpuType 230)
5515
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5515K7 (cevModuleCpuType 225)
5515 with no Payload Encryption
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5525 (cevModuleCpuType 231)
5525
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5525K7 (cevModuleCpuType 226)
5525 with no Payload Encryption
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5545 (cevModuleCpuType 232)
5545
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5545K7 (cevModuleCpuType 227)
5545 with no Payload Encryption
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5555 (cevModuleCpuType 233)
5555
Central Processing Unit for Cisco Adaptive Security Appliance cevCpuAsa5555K7 (cevModuleCpuType 228)
5555 with no Payload Encryption
CPU for ASA 5585 SSP-10 No Payload Encryption cevCpuAsa5585Ssp10K7 ( cevModuleCpuType 205)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
944
About SNMP
CPU for ASA 5585 SSP-20 No Payload Encryption cevCpuAsa5585Ssp20K7 (cevModuleCpuType 207)
CPU for ASA 5585 SSP-40 No Payload Encryption cevCpuAsa5585Ssp40K7 (cevModuleCpuType 209)
CPU for ASA 5585 SSP-60 No Payload Encryption cevCpuAsa5585Ssp60K (cevModuleCpuType 211)
CPU for Cisco ASA Services Module for Catalyst switches/7600 cevCpuAsaSm1 (cevModuleCpuType 222)
routers
CPU for Cisco ASA Services Module with No Payload Encryption cevCpuAsaSm1K7 (cevModuleCpuType 223)
for Catalyst switches/7600 routers
Chassis Cooling Fan in Adaptive Security Appliance 5512 cevFanASA5512ChassisFan (cevFan 163)
Chassis Cooling Fan in Adaptive Security Appliance 5512 with cevFanASA5512K7ChassisFan (cevFan 172)
No Payload Encryption
Chassis Cooling Fan in Adaptive Security Appliance 5515 cevFanASA5515ChassisFan (cevFan 164)
Chassis Cooling Fan in Adaptive Security Appliance 5515 with cevFanASA5515K7ChassisFan (cevFan 171)
No Payload Encryption
Chassis Cooling Fan in Adaptive Security Appliance 5525 cevFanASA5525ChassisFan (cevFan 165)
Chassis Cooling Fan in Adaptive Security Appliance 5525 with cevFanASA5525K7ChassisFan (cevFan 170)
No Payload Encryption
Chassis Cooling Fan in Adaptive Security Appliance 5545 cevFanASA5545ChassisFan (cevFan 166)
Chassis Cooling Fan in Adaptive Security Appliance 5545 with cevFanASA5545K7ChassisFan (cevFan 169)
No Payload Encryption
Power Supply Fan in Adaptive Security Appliance 5545 with No cevFanASA5545K7PSFan (cevFan 161)
Payload Encryption
Power Supply Fan in Adapative Security Appliance 5545 cevFanASA5545PSFan (cevFan 159)
Chassis Cooling Fan in Adaptive Security Appliance 5555 cevFanASA5555ChassisFan (cevFan 167)
Chassis Cooling Fan in Adaptive Security Appliance 5555 with cevFanASA5555K7ChassisFan (cevFan 168)
No Payload Encryption
Power Supply Fan in Adaptive Security Appliance 5555 cevFanASA5555PSFan (cevFan 160)
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
945
About SNMP
Power Supply unit in Adaptive Security Appliance 5545 cevPowerSupplyASA5545PSInput (cevPowerSupply 323)
Presence Sensor for Power Supply input in Adaptive Security cevPowerSupplyASA5545PSPresence (cevPowerSupply 321)
Appliance 5545
Power Supply unit in Adaptive Security Appliance 5555 cevPowerSupplyASA5555PSInput (cevPowerSupply 324)
Presence Sensor for Power Supply input in Adaptive Security cevPowerSupplyASA5555PSPresence (cevPowerSupply 322)
Appliance 5555
Cisco Adaptive Security Appliance (ASA) 5512 Chassis Fan cevSensorASA5512ChassisFanSensor (cevSensor 120)
sensor
Chassis Ambient Temperature Sensor for Cisco Adaptive Security cevSensorASA5512ChassisTemp (cevSensor 107)
Appliance 5512
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5512CPUTemp (cevSensor 96)
Security Appliance 5512
Cisco Adaptive Security Appliance (ASA) 5512 with No Payload cevSensorASA5512K7ChassisFanSensor (cevSensor 125)
Encryption Chassis Fan sensor
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5512K7CPUTemp (cevSensor 102)
Security Appliance 5512 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5512K7PSFanSensor (cevSensor 116)
5512 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5512PSFanSensor (cevSensor 119)
5512
Cisco Adaptive Security Appliance (ASA) 5515 Chassis Fan cevSensorASA5515ChassisFanSensor (cevSensor 121)
sensor
Chassis Ambient Temperature Sensor for Cisco Adaptive Security cevSensorASA5515ChassisTemp (cevSensor 98)
Appliance 5515
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
946
About SNMP
Cisco Adaptive Security Appliance (ASA) 5515 with No Payload cevSensorASA5515K7ChassisFanSensor (cevSensor 126)
Encryption Chassis Fan sensor
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5515K7CPUTemp (cevSensor 103)
Security Appliance 5515 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5515K7PSFanSensor (cevSensor 115)
5515 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5515PSFanSensor (cevSensor 118)
5515
Cisco Adaptive Security Appliance (ASA) 5525 Chassis Fan cevSensorASA5525ChassisFanSensor (cevSensor 122)
sensor
Chassis Ambient Temperature Sensor for Cisco Adaptive Security cevSensorASA5525ChassisTemp (cevSensor 108)
Appliance 5525
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5525CPUTemp (cevSensor 99)
Security Appliance 5525
Cisco Adaptive Security Appliance (ASA) 5525 with No Payload cevSensorASA5525K7ChassisFanSensor (cevSensor 127)
Encryption Chassis Fan sensor
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5525K7CPUTemp (cevSensor 104)
Security Appliance 5525 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5525K7PSFanSensor (cevSensor 114)
5525 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5525PSFanSensor (cevSensor 117)
5525
Cisco Adaptive Security Appliance (ASA) 5545 Chassis Fan cevSensorASA5545ChassisFanSensor (cevSensor 123)
sensor
Chassis Ambient Temperature Sensor for Cisco Adaptive Security cevSensorASA5545ChassisTemp (cevSensor 109)
Appliance 5545
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5545CPUTemp (cevSensor 100)
Security Appliance 5545
Cisco Adaptive Security Appliance (ASA) 5545 with No Payload cevSensorASA5545K7ChassisFanSensor (cevSensor 128)
Encryption Chassis Fan sensor
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
947
About SNMP
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5545K7CPUTemp (cevSensor 105)
Security Appliance 5545 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5545K7PSFanSensor (cevSensor 113)
5545 with No Payload Encryption
Presence Sensor for Power Supply input in Adaptive Security cevSensorASA5545K7PSPresence (cevSensor 87)
Appliance 5545 with No Payload Encryption
Temperature Sensor for Power Supply Fan in Adaptive Security cevSensorASA5545K7PSTempSensor (cevSensor 94)
Appliance 5545 with No Payload Encryption
Sensor for Power Supply Fan in Adaptive Security Appliance cevSensorASA5545PSFanSensor (cevSensor 89)
5545 with No Payload Encryption
Presence Sensor for Power Supply input in Adaptive Security cevSensorASA5545PSPresence (cevSensor 130)
Appliance 5545
Presence Sensor for Power Supply input in Adaptive Security cevSensorASA5545PSPresence (cevSensor 131)
Appliance 5555
Temperature Sensor for Power Supply Fan in Adaptive Security cevSensorASA5545PSTempSensor (cevSensor 92)
Appliance 5545
Cisco Adaptive Security Appliance (ASA) 5555 Chassis Fan cevSensorASA5555ChassisFanSensor (cevSensor 124)
sensor
Chassis Ambient Temperature Sensor for Cisco Adaptive Security cevSensorASA5555ChassisTemp (cevSensor 110)
Appliance 5555
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5555CPUTemp (cevSensor 101)
Security Appliance 5555
Cisco Adaptive Security Appliance (ASA) 5555 with No Payload cevSensorASA5555K7ChassisFanSensor (cevSensor 129)
Encryption Chassis Fan sensor
Chassis Ambient Temperature Sensor for Cisco Adaptive Security cevSensorASA5555K7ChassisTemp (cevSensor 111)
Appliance 5555 with No Payload Encryption
Central Processing Unit Temperature Sensor for Cisco Adaptive cevSensorASA5555K7CPUTemp (cevSensor 106)
Security Appliance 5555 with No Payload Encryption
Sensor for Chassis Cooling Fan in Adaptive Security Appliance cevSensorASA5555K7PSFanSensor (cevSensor 112)
5555 with No Payload Encryption
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
948
About SNMP
Temperature Sensor for Power Supply Fan in Adaptive Security cevSensorASA5555K7PSTempSensor (cevSensor 95)
Appliance 5555 with No Payload Encryption
Sensor for Power Supply Fan in Adaptive Security Appliance cevSensorASA5555PSFanSensor (cevSensor 91)
5555
Temperature Sensor for Power Supply Fan in Adaptive Security cevSensorASA5555PSTempSensor (cevSensor 93)
Appliance 5555
Sensor for power supply fan for ASA 5585-X cevSensorASA5585PSFanSensor (cevSensor 86)
Sensor for power supply input for ASA 5585-X cevSensorASA5585PSInput (cevSensor 85)
CPU temperature sensor for ASA 5585 SSP-10 cevSensorASA5585SSp10CPUTemp (cevSensor 77)
CPU temperature sensor for ASA 5585 SSP-10 No Payload cevSensorASA5585SSp10K7CPUTemp (cevSensor 78)
Encryption
CPU temperature sensor for ASA 5585 SSP-20 cevSensorASA5585SSp20CPUTemp (cevSensor 79)
CPU temperature sensor for ASA 5585 SSP-20 No Payload cevSensorASA5585SSp20K7CPUTemp (cevSensor 80)
Encryption
CPU temperature sensor for ASA 5585 SSP-40 cevSensorASA5585SSp40CPUTemp (cevSensor 81)
CPU temperature sensor for ASA 5585 SSP-40 No Payload cevSensorASA5585SSp40K7CPUTemp (cevSensor 82)
Encryption
CPU temperature sensor for ASA 5585 SSP-60 cevSensorASA5585SSp60CPUTemp (cevSensor 83)
CPU temperature sensor for ASA 5585 SSP-60 No Payload cevSensorASA5585SSp60K7CPUTemp (cevSensor 84)
Encryption
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
949
About SNMP
CISCO-ENTITY-SENSOR-EXT-MIB ceSensorExtThresholdTable
Note Not supported on the ASA Services Module
for Catalyst 6500 switches/7600 routers.
CISCO-L4L7MODULE-RESOURCE-LIMIT-MIB ciscoL4L7ResourceLimitTable
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
950
About SNMP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
951
About SNMP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
952
About SNMP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
953
About SNMP
Note For a physical interface that has multiple VLAN interfaces associated with it, be aware
that SNMP counters for ifInOctets and ifOutoctets OIDs match the aggregate traffic
counters for that physical interface.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
954
About SNMP
The examples in the following table show the differences in SNMP traffic statistics. Example 1 shows the
difference in physical and logical output statistics for the show interface command and the show traffic
command. Example 2 shows output statistics for a VLAN-only interface for the show interface command
and the show traffic command. The example shows that the statistics are close to the output that appears for
the show traffic command.
Table 65: SNMP Traffic Statistics for Physical and VLAN Interfaces
Example 1 Example 2
IF-MIB::ifInOctets.6 = Counter32:3246
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
955
About SNMP
groups and users, as well as hosts, which is required to enable transport authentication and encryption for
secure SNMP communications.
Security Models
For configuration purposes, the authentication and privacy options are grouped together into security models.
Security models apply to users and groups, which are divided into the following three types:
• NoAuthPriv—No Authentication and No Privacy, which means that no security is applied to messages.
• AuthNoPriv—Authentication but No Privacy, which means that messages are authenticated.
• AuthPriv—Authentication and Privacy, which means that messages are authenticated and encrypted.
SNMP Groups
An SNMP group is an access control policy to which users can be added. Each SNMP group is configured
with a security model, and is associated with an SNMP view. A user within an SNMP group must match the
security model of the SNMP group. These parameters specify what type of authentication and privacy a user
within an SNMP group uses. Each SNMP group name and security model pair must be unique.
SNMP Users
SNMP users have a specified username, a group to which the user belongs, authentication password, encryption
password, and authentication and encryption algorithms to use. The authentication algorithm options are MD5
and SHA. The encryption algorithm options are DES, 3DES, and AES (which is available in 128, 192, and
256 versions). When you create a user, you must associate it with an SNMP group. The user then inherits the
security model of the group.
SNMP Hosts
An SNMP host is an IP address to which SNMP notifications and traps are sent. To configure SNMP Version
3 hosts, along with the target IP address, you must configure a username, because traps are only sent to a
configured user. SNMP target IP addresses and target parameter names must be unique on the ASA and
ASA Services Module. Each SNMP host can have only one username associated with it. To receive SNMP
traps, after you have added the snmp-server host command, make sure that you configure the user credentials
on the NMS to match the credentials for the ASA and ASASM.
Implementation Differences Between the ASA, ASA Services Module, and the Cisco IOS Software
The SNMP Version 3 implementation in the ASA and ASASM differs from the SNMP Version 3
implementation in the Cisco IOS software in the following ways:
• The local-engine and remote-engine IDs are not configurable. The local engine ID is generated when
the ASA or ASASM starts or when a context is created.
• No support exists for view-based access control, which results in unrestricted MIB browsing.
• Support is restricted to the following MIBs: USM, VACM, FRAMEWORK, and TARGET.
• You must create users and groups with the correct security model.
• You must remove users, groups, and hosts in the correct sequence.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
956
Guidelines for SNMP
• Use of the snmp-server host command creates an ASA, ASAv, or ASASM rule to allow incoming SNMP
traffic.
Note SNMP polling fails if SNMP syslog messages exceed a high rate (approximately 4000 per second).
Failover Guidelines
The SNMP client in each ASA, ASAv, or ASASM shares engine data with its peer. Engine data includes the
engineID, engineBoots, and engineTime objects of the SNMP-FRAMEWORK-MIB. Engine data is written
as a binary file to flash:/snmp/contextname.
IPv6 Guidelines
Does not support IPv6.
Additional Guidelines
• You must have Cisco Works for Windows or another SNMP MIB-II compliant browser to receive SNMP
traps or browse a MIB.
• Does not support view-based access control, but the VACM MIB is available for browsing to determine
default view settings.
• The ENTITY-MIB is not available in the non-admin context. Use the IF-MIB instead to perform queries
in the non-admin context.
• Does not support SNMP Version 3 for the AIP SSM or AIP SSC.
• Does not support SNMP debugging.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
957
Guidelines for SNMP
• The creation of custom views to restrict user access to a subset of MIB objects is not supported.
• All requests and traps are available in the default Read/Notify View only.
• The connection-limit-reached trap is generated in the admin context. To generate this trap. you must
have at least one SNMP server host configured in the user context in which the connection limit has
been reached.
• You cannot query for the chassis temperature on the ASA 5585 SSP-40 (NPE).
• You can add up to 4000 hosts. However, only 128 of this number can be for traps.
• The total number of supported active polling destinations is 128.
• You can specify a network object to indicate the individual hosts that you want to add as a host group.
• You can associate more than one user with one host.
• You can specify overlapping network objects in different host-group commands. The values that you
specify for the last host group take effect for the common set of hosts in the different network objects.
• If you delete a host group or hosts that overlap with other host groups, the hosts are set up again using
the values that have been specified in the configured host groups.
• The values that the hosts acquire depend on the specified sequence that you use to run the commands.
• The limit on the message size that SNMP sends is 1472 bytes.
• Members of a cluster do not synchronize their SNMPv3 engine IDs. Because of this, each unit in the
cluster should have a unique SNMPv3 user configuration.
• With Version 9.4(1), the ASA supports an unlimited number of SNMP server trap hosts per context.The
show snmp-server host command output displays only the active hosts that are polling the ASA, as
well as the statically configured hosts.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
958
Guidelines for SNMP
Troubleshooting Tips
• To ensure that the SNMP process that receives incoming packets from the NMS is running, enter the
following command:
• To capture syslog messages from SNMP and have them appear on the ASA, ASAv, or ASASM console,
enter the following commands:
• To make sure that the SNMP process is sending and receiving packets, enter the following commands:
• If the NMS cannot request objects successfully or is not handing incoming traps from the ASA, ASAv,
or ASASM correctly, use a packet capture to isolate the problem, by entering the following commands:
• If the ASA, ASAv, or ASASM is not performing as expected, obtain information about network topology
and traffic by doing the following:
◦For the NMS configuration, obtain the following information:
Number of timeouts
Retry count
Engine ID caching
Username and password used
◦Issue the following commands:
show block
show interface
show process
show cpu
show vm
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
959
Configure SNMP
• If a fatal error occurs, to help in reproducing the error, send a traceback file and the output of the show
tech-support command to Cisco TAC.
• If SNMP traffic is not being allowed through the ASA, ASAv, or ASASM interfaces, you might also
need to permit ICMP traffic from the remote SNMP server using the icmp permit command.
• For additional troubleshooting information, see the following URL: http://www.cisco.com/c/en/us/
support/docs/security/asa-5500-x-series-next-generation-firewalls/116423-troubleshoot-asa-snmp.html
Configure SNMP
This section describes how to configure SNMP.
Procedure
Procedure
Enable the SNMP agent and SNMP server on the ASA, ASAv, or ASASM. By default, the SNMP server is
enabled.
snmp-server enable
Example:
ciscoasa(config)# snmp-server enable
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
960
Configure SNMP
Example:
ciscoasa(config)# snmp-server enable traps snmp authentication linkup linkdown coldstart
warmstart
This command enables syslog messages to be sent as traps to the NMS. The default configuration has all
SNMP standard traps enabled, as shown in the example. To disable these traps, use the no snmp-server
enable traps snmp command. If you enter this command and do not specify a trap type, the default is the
syslog trap. By default, the syslog trap is enabled. The default SNMP traps continue to be enabled with the
syslog trap. You need to configure both the logging history command and the snmp-server enable traps
syslog command to generate traps from the syslog MIB. To restore the default enabling of SNMP traps, use
the clear configure snmp-server command. All other traps are disabled by default.
Traps available in the admin context only:
• connection-limit-reached
• entity
• memory-threshold
Traps generated through the admin context only for physically connected interfaces in the system context:
• interface-threshold
Note The interface-threshold trap is not supported on the ASA Services Module for Catalyst 6500
switches/7600 routers.
All other traps are available in the admin and user contexts in single mode.
In multiple context mode, the fan-failure trap, the power-supply-failure trap, and the cpu-temperature trap
are generated only from the admin context, and not the user contexts (applies only to the ASA 5512-X, 5515-X,
5525-X, 5545-X, and 5555-X).
The accelerator-temperature threshold trap applies only to the ASA 5506-X and ASA 5508-X.
The chassis-fan-failure trap does not apply to the ASA 5506-X.
The config trap enables the ciscoConfigManEvent notification and the ccmCLIRunningConfigChanged
notification, which are generated after you have exited configuration mode.
The following traps do not apply to the ASA 5506-X and ASA 5508-X: fan-failure, fru-insert, fru-remove,
power-supply, power-supply-failure, power-supply-presence, and power-supply-temperature.
If the CPU usage is greater than the configured threshold value for the configured monitoring period, the cpu
threshold rising trap is generated.
When the used system context memory reaches 80 percent of the total system memory, the memory-threshold
trap is generated from the admin context. For all other user contexts, this trap is generated when the used
memory reaches 80 percent of the total system memory in that particular context.
Note SNMP does not monitor voltage
sensors.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
961
Configure SNMP
Procedure
Configure the threshold value for a high CPU threshold and the threshold monitoring period.
snmp cpu threshold rising threshold_value monitoring_period
Example:
ciscoasa(config)# snmp cpu threshold rising 75% 30 minutes
To clear the threshold value and monitoring period of the CPU utilization, use the no form of this command.
If the snmp cpu threshold rising command is not configured, the default for the high threshold level is over
70 percent, and the default for the critical threshold level is over 95 percent. The default monitoring period
is set to 1 minute.
You cannot configure the critical CPU threshold level, which is maintained at a constant 95 percent. Valid
threshold values for a high CPU threshold range from 10 to 94 percent. Valid values for the monitoring period
range from 1 to 60 minutes.
Procedure
Example:
ciscoasa(config)# snmp interface threshold 75%
To clear the threshold value for an SNMP physical interface, use the no form of this command. The threshold
value is defined as a percentage of interface bandwidth utilization. Valid threshold values range from 30 to
99 percent. The default value is 70 percent.
The snmp interface threshold command is available only in the admin context.
Physical interface usage is monitored in single mode and multimode, and traps for physical interfaces in the
system context are sent through the admin context. Only physical interfaces are used to compute threshold
usage.
Note This command is not supported on the ASA Services Module for Catalyst 6500 switches/7600 routers.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
962
Configure SNMP
Procedure
Step 1 Specify the recipient of an SNMP notification, indicate the interface from which traps are sent, and identify
the name and IP address of the NMS or SNMP manager that can connect to the ASA.
snmp-server host{interface hostname | ip_address} [trap| poll] [community community-string] [version
{1 2c| username}] [udp-port port]
Example:
ciscoasa(config)# snmp-server host mgmt 10.7.14.90 version 2
ciscoasa(config)# snmp-server host corp 172.18.154.159 community public
The trap keyword limits the NMS to receiving traps only. The poll keyword limits the NMS to sending
requests (polling) only. By default, SNMP traps are enabled. By default, the UDP port is 162. The community
string is a shared secret key between the ASA, ASAv, or ASASM and the NMS. The key is a case-sensitive
value up to 32 alphanumeric characters long. Spaces are not permitted. The default community string is public.
The ASA uses this key to determine whether or not the incoming SNMP request is valid. For example, you
could designate a site with a community string and then configure the ASA and the management station with
the same string. The ASA, ASAv, and ASASM use the specified string and do not respond to requests with
an invalid community string. After you have used an encrypted community string, only the encrypted form
is visible to all systems (for example, CLI, ASDM, CSM, and so on). The clear text password is not visible.
The encrypted community string is always generated by the ASA; you normally enter the clear text form.
Note If you downgrade from version 8.3(1) to a lower version of the ASA software and have configured
encrypted passwords, you must first revert the encrypted passwords to clear text using the no key
config-key password encryption command, then save the results.
To receive traps after you have added the snmp-server host command, make sure that you configure the user
on the NMS with the same credentials as the credentials configured on the ASA, ASAv, and ASASM.
Step 2 Set the community string, which is for use only with SNMP Version 1 or 2c.
snmp-server community community-string
Example:
ciscoasa(config)# snmp-server community onceuponatime
Example:
ciscoasa(config)# snmp-server location building 42
ciscoasa(config)# snmp-server contact EmployeeA
The text argument specifies the name of the contact person or the ASA system administrator. The name is
case sensitive and can be up to 127 characters. Spaces are accepted, but multiple spaces are shortened to a
single space.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
963
Configure SNMP
Example:
ciscoasa(config)# snmp-server lport 192
The lport argument is the port on which incoming requests are accepted. The default listening port is 161.
The snmp-server listen-port command is only available in admin context, and is not available in the system
context. If you configure the snmp-server listen-port command on a port that is currently in use, the following
message appears:
The UDP port port is in use by another feature. SNMP requests to the device
will fail until the snmp-server listen-port command is configured to use a different port.
The existing SNMP thread continues to poll every 60 seconds until the port is available, and issues syslog
message %ASA-1-212001 if the port is still in use.
Procedure
Step 1 Specify a new SNMP group, which is for use only with SNMP Version 3.
snmp-server group group-namev3 [auth | noauth | priv]
Example:
ciscoasa(config)# snmp-server group testgroup1 v3 auth
When a community string is configured, two additional groups with the name that matches the community
string are autogenerated: one for the Version 1 security model and one for the Version 2 security model. The
auth keyword enables packet authentication. The noauth keyword indicates no packet authentication or
encryption is being used. The priv keyword enables packet encryption and authentication. No default values
exist for the auth or priv keywords.
Step 2 Configure a new user for an SNMP group, which is for use only with SNMP Version 3.
snmp-server userusername group-name {v3 [encrypted]] [auth {md5 | sha]} auth-password [priv] [des |
3des | aes] [128 | 192| 256] priv-password
Example:
ciscoasa(config)# snmp-server user testuser1 testgroup1 v3 auth md5 testpassword
aes 128 mypassword
ciscoasa(config)# snmp-server user testuser1 public v3 encrypted auth md5
00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF
The username argument is the name of the user on the host that belongs to the SNMP agent. The group-name
argument is the name of the group to which the user belongs. The v3 keyword specifies that the SNMP Version
3 security model should be used and enables the use of the encrypted, priv, and the auth keywords. The
encrypted keyword specifies the password in encrypted format. Encrypted passwords must be in hexadecimal
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
964
Configure SNMP
format. The auth keyword specifies which authentication level (md5 or sha) should be used. The priv keyword
specifies the encryption level. No default values for the auth or priv keywords, or default passwords exist.
For the encryption algorithm, you can specify either the des, 3des, or aes keyword. You can also specify
which version of the AES encryption algorithm to use: 128, 192, or 256. The auth-password argument specifies
the authentication user password. The priv-password argument specifies the encryption user password.
Note If you forget a password, you cannot recover it and you must reconfigure the user. You can specify
a plain-text password or a localized digest. The localized digest must match the authentication
algorithm selected for the user, which can be either MD5 or SHA. When the user configuration is
displayed on the console or is written to a file (for example, the startup-configuration file), the
localized authentication and privacy digests are always displayed instead of a plain-text password
(see the second example). The minimum length for a password is 1 alphanumeric character; however,
we recommend that you use at least 8 alphanumeric characters for security.
In clustering, you must manually update each clustered ASA with SNMPv3 users. You can do this by entering
the snmp-server user username group-name v3 command on the master unit with the priv-password option
and auth-password option in their non-localized forms.
An error message appears to inform you that the SNMPv3 user commands will not be replicated during
clustering replication or configuration. You may then configure SNMPv3 user and group commands on slave
ASAs independently. This also means that existing SNMPv3 user and group commands are not cleared during
replication, and you may enter SNMPv3 user and group commands on all slaves in the cluster. For example:
On a master unit using commands entered with keys that have already been localized:
On a slave unit during cluster replication (appears only if an snmp-server user commands exist in the
configuration):
ciscoasa(cfg-cluster)#
Detected Cluster Master.
Beginning configuration replication from Master.
WARNING: existing snmp-server user CLI will not be cleared.
Step 3 Specify the recipient of an SNMP notification. Indicate the interface from which traps are sent. Identify the
name and IP address of the NMS or SNMP manager that can connect to the ASA.
snmp-server host interface {hostname | ip_address} [trap| poll] [community community-string] [version
{1 | 2c | 3 username}] [udp-port port]
Example:
ciscoasa(config)# snmp-server host mgmt 10.7.14.90 version 3 testuser1
ciscoasa(config)# snmp-server host mgmt 10.7.26.5 version 3 testuser2
The trap keyword limits the NMS to receiving traps only. The poll keyword limits the NMS to sending
requests (polling) only. By default, SNMP traps are enabled. By default, the UDP port is 162. The community
string is a shared secret key between the ASA and the NMS. The key is a case-sensitive value up to 32
alphanumeric characters. Spaces are not permitted. The default community-string is public. The ASA, ASAv,
and ASASM use this key to determine whether the incoming SNMP request is valid. For example, you could
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
965
Configure SNMP
designate a site with a community string and then configure the ASA, ASAv, or ASASM and the NMS with
the same string. The ASA, ASAv, and ASASM use the specified string and do not respond to requests with
an invalid community string. After you have used an encrypted community string, only the encrypted form
is visible to all systems (for example, CLI, ASDM, CSM, and so on). The clear text password is not visible.
The encrypted community string is always generated by the ASA; you normally enter the clear text form.
Note If you downgrade from version 8.3(1) to a lower version of the ASA software and have configured
encrypted passwords, you must first revert the encrypted passwords to clear text using the no key
config-key password encryption command, then save the results.
The version keyword specifies the SNMP trap version. The ASA does not support filtering based on SNMP
requests (polling).
When SNMP Version 3 hosts are configured on the ASA, ASAv, and ASASM, a user must be associated
with that host.
To receive traps after you have added the snmp-server host command, make sure that you configure the user
on the NMS with the same credentials as the credentials configured on the ASA, ASAv, or ASASM.
Example:
ciscoasa(config)# snmp-server location building 42
ciscoasa(config)# snmp-server contact EmployeeA
The text argument specifies the name of the contact person or the ASA system administrator. The name is
case sensitive and can be up to 127 characters. Spaces are accepted, but multiple spaces are shortened to a
single space.
Example:
ciscoasa(config)# snmp-server lport 192
The lport argument is the port on which incoming requests are accepted. The default listening port is 161.
The snmp-server listen-port command is only available in admin context, and is not available in the system
context. If you configure the snmp-server listen-port command on a port that is currently in use, the following
message appears:
The UDP port port is in use by another feature. SNMP requests to the device
will fail until the snmp-server listen-port command is configured to use a different port.
The existing SNMP thread continues to poll every 60 seconds until the port is available, and issues syslog
message %ASA-1-212001 if the port is still in use.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
966
Monitoring SNMP
Procedure
Example:
ciscoasa(config)# snmp-server user-list engineering username user1
The listname argument specifies the name of the user list, which may be up to 33 characters long. The username
user_name keyword-argument pair specifies the users who may be configured in the user list. You configure
the users in the user list with the snmp-server user username command, which is available only if you are
using SNMP Version 3. The user list must have more than one user in it and can be associated with a hostname
or a range of IP addresses.
Procedure
Associate a single user or a group of users in a user list with a network object.
snmp-server host-group net_obj_name [trap| poll] [community community-string] [version {1 | 2c | 3
{username | user-list list_name}] [udp-port port]
Example:
ciscoasa(config)# snmp-server host-group inside net1 trap community public version 1
ciscoasa(config)# snmp-server host-group inside net1 trap community public version 2c
ciscoasa(config)# snmp-server host-group inside net1 trap version 3 user1
ciscoasa(config)# snmp-server host-group inside net1 trap version 3 user-list engineering
The net_obj_name argument specifies the interface network object name with which a user or group of users
is associated. The trap keyword specifies that only traps can be sent, and that this host is not allowed to browse
(poll). The poll keyword specifies that the host is allowed to browse (poll), but no traps can be sent. The
community keyword specifies that a non-default string is required for requests from the NMS, or when
generating traps sent to the NMS. You can use this keyword only for SNMP Version 1 or 2c. The
community-string argument specifies the password-like community string that is sent with the notification or
in a request from the NMS. The community string can have a maximum of 32 characters. The version keyword
sets the SNMP notification version to Version 1, 2c, or 3 to use for sending traps. The username argument
specifies the name of the user if you are using SNMP Version 3. The user-list list_name keyword-argument
pair specifies the name of the user list. The udp-port port keyword-argument pair specifies that SNMP traps
must be sent to an NMS host on a non-default port and sets the UDP port number of the NMS host. The default
UDP port is 162. The default version is 1. SNMP traps are enabled by default.
Monitoring SNMP
See the following commands for monitoring SNMP.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
967
Monitoring SNMP
Examples
The following example shows how to display SNMP server statistics:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
968
Examples for SNMP
The following example shows how to display the SNMP server running configuration:
SNMP Version 3
The following example shows how the ASA can receive SNMP requests using the SNMP Version 3 security
model, which requires that the configuration follow this specific order: group, followed by user, followed by
host:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
969
History for SNMP
SNMP traps and MIBs 8.4(1) Supports the following additional keywords: connection-limit-reached, cpu threshold
rising, entity cpu-temperature, entity fan-failure, entity power-supply, ikev2 stop |
start, interface-threshold, memory-threshold, nat packet-discard, warmstart.
The entPhysicalTable reports entries for sensors, fans, power supplies, and related
components.
Supports the following additional MIBs: CISCO-ENTITY-SENSOR-EXT-MIB,
CISCO-ENTITY-FRU-CONTROL-MIB, CISCO-PROCESS-MIB,
CISCO-ENHANCED-MEMPOOL-MIB,
CISCO-L4L7MODULE-RESOURCE-LIMIT-MIB, DISMAN-EVENT-MIB,
DISMAN-EXPRESSION-MIB, ENTITY-SENSOR-MIB, NAT-MIB.
Supports the following additional traps: ceSensorExtThresholdNotification,
clrResourceLimitReached, cpmCPURisingThreshold, mteTriggerFired, natPacketDiscard,
warmStart.
We introduced or modified the following commands: snmp cpu threshold rising, snmp
interface threshold, snmp-server enable traps.
IF-MIB ifAlias OID 8.2(5)/8.4(2) The ASA now supports the ifAlias OID. When you browse the IF-MIB, the ifAlias OID
support will be set to the value that has been set for the interface description.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
970
History for SNMP
SNMP traps 8.6(1) Supports the following additional keywords for the ASA 5512-X, 5515-X, 5525-X,
5545-X, and 5555-X: entity power-supply-presence, entity power-supply-failure,
entity chassis-temperature, entity chassis-fan-failure, entity
power-supply-temperature.
We modified the following command: snmp-server enable traps.
VPN-related MIBs 9.0(1) An updated version of the CISCO-IPSEC-FLOW-MONITOR-MIB.my MIB has been
implemented to support the next generation encryption feature.
The following MIBs have been enabled for the ASASM:
• ALTIGA-GLOBAL-REG.my
• ALTIGA-LBSSF-STATS-MIB.my
• ALTIGA-MIB.my
• ALTIGA-SSL-STATS-MIB.my
• CISCO-IPSEC-FLOW-MONITOR-MIB.my
• CISCO-REMOTE-ACCESS-MONITOR-MIB.my
Cisco TrustSec MIB 9.0(1) Support for the following MIB was added: CISCO-TRUSTSEC-SXP-MIB.
SNMP OIDs 9.1(1) Five new SNMP Physical Vendor Type OIDs have been added to support the ASA 5512-X,
5515-X, 5525-X, 5545-X, and 5555-X.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
971
History for SNMP
SNMP hosts, host 9.1(5) You can now add up to 4000 hosts. The number of supported active polling destinations
groups, and user lists is 128. You can specify a network object to indicate the individual hosts that you want to
add as a host group. You can associate more than one user with one host.
We introduced or modified the following commands: snmp-server host-group,
snmp-server user-list, show running-config snmp-server, clear configure snmp-server.
SNMP message size 9.2(1) The limit on the message size that SNMP sends has been increased to 1472 bytes.
SNMP OIDs and MIBs 9.2(1) The ASA now supports the cpmCPUTotal5minRev OID.
The ASAv has been added as a new product to the SNMP sysObjectID OID and
entPhysicalVendorType OID.
The CISCO-PRODUCTS-MIB and CISCO-ENTITY-VENDORTYPE-OID-MIB have
been updated to support the new ASAv platform.
A new SNMP MIB for monitoring VPN shared license usage has been added.
SNMP OIDs and MIBs 9.3(1) CISCO-REMOTE-ACCESS-MONITOR-MIB (OID 1.3.6.1.4.1.9.9.392) support has been
added for the ASASM.
SNMP MIBs and traps 9.3(2) The CISCO-PRODUCTS-MIB and CISCO-ENTITY-VENDORTYPE-OID-MIB have
been updated to support the ASA 5506-X.
The ASA 5506-X has been added as new products to the SNMP sysObjectID OID and
entPhysicalVendorType OID tables.
The ASA now supports the CISCO-CONFIG-MAN-MIB, which enables you to do the
following:
• Know which commands have been entered for a specific configuration.
• Notify the NMS when a change has occurred in the running configuration.
• Track the time stamps associated with the last time that the running configuration
was changed or saved.
• Track other changes to commands, such as terminal details and command sources.
SNMP MIBs and traps 9.4(1) The ASA 5506W-X, ASA 5506H-X, ASA 5508-X, and ASA 5516-X have been added
as a new product to the SNMP sysObjectID OID and entPhysicalVendorType OID tables.
Unlimited SNMP 9.4(1) The ASA supports unlimited SNMP server trap hosts per context. The show snmp-server
server trap hosts per host command output displays only the active hosts that are polling the ASA, as well as
context the statically configured hosts.
We modified the following command: show snmp-server host.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
972
History for SNMP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
973
History for SNMP
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
974
CHAPTER 39
Anonymous Reporting and Smart Call Home
This chapter describes how to configure the Anonymous Reporting and Smart Call Home services.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
975
About Smart Call Home
Note When you enable Anonymous Reporting, you acknowledge your consent to transfer the specified data to
Cisco or to vendors operating on Cisco’s behalf (including countries outside of the U.S.). Cisco maintains
the privacy of all customers. For information about Cisco’s treatment of personal information, see the
Cisco Privacy Statement at the following URL: http://www.cisco.com/web/siteassets/legal/privacy.html
When the ASA configures Smart Call Home anonymous reporting in the background, the ASA automatically
creates a trustpoint containing the certificate of the CA that issues the Call Home server certificate. The
ASA now supports validation of the certificate if the issuing hierarchy of the server certificate changes,
without the need for customer involvement to make certificate hierarchy changes. You can also
automatically import the trustpool certificates so that ASA renews the certificate hierarchy without any
manual intervention.
DNS Requirement
A DNS server must be configured correctly for the ASA to reach the Cisco Smart Call Home server and send
messages to Cisco. Because it is possible that the ASA resides in a private network and does not have access
to the public network, Cisco verifies your DNS configuration and then configures it for you, if necessary, by
doing the following:
1 Performing a DNS lookup for all DNS servers configured.
2 Getting the DNS server from the DHCP server by sending DHCPINFORM messages on the highest
security-level interface.
3 Using the Cisco DNS servers for lookup.
4 Randomly using a static IP addresses for tools.cisco.com.
These tasks are performed without changing the current configuration. (For example, the DNS server that
was learned from DHCP will not be added to the configuration.)
If there is no DNS server configured, and the ASA cannot reach the Cisco Smart Call Home Server, Cisco
generates a syslog message with the warning severity level for each Smart Call Home message that is sent to
remind you to configure DNS correctly.
See the syslog messages guide for information about syslog messages.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
976
About Smart Call Home
• Generating service requests to Cisco TAC automatically (if you have a service contract), routed to the
appropriate support team, which provides detailed diagnostic information that speeds problem resolution.
The Smart Call Home Portal offers quick access to required information that enables you to do the following:
• Review all Smart Call Home messages, diagnostics, and recommendations in one place.
• Check service request status.
• View the most up-to-date inventory and configuration information for all Smart Call Home-enabled
devices.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
977
About Smart Call Home
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
978
About Smart Call Home
• show tech-support no-config—Displays the information that is used for diagnosis by technical
support analysts.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
979
About Smart Call Home
• show phone-proxy secure-phones count—Displays the number of phones capable of secure mode
stored in the database.
• show route—Displays the routing table.
• show xlate count—Shows the number of NAT sessions (xlates).
Syslog Severity
Level Message Severity Level Level Description
9 Catastrophic N/A Network-wide catastrophic failure.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
980
About Smart Call Home
Syslog Severity
Level Message Severity Level Level Description
2 Notification 5 Basic notification and informational messages.
Possibly independently insignificant.
Subscription Profiles
A subscription profile allows you to associate the destination recipients with interested groups. When an event
registered with a subscribed group in a profile is triggered, the message associated with the event is sent to
the configured recipients. Subscription profiles have the following attributes:
• You can create and configure multiple profiles.
• A profile may configure multiple e-mail or HTTPS recipients.
• A profile may subscribe multiple groups to a specified severity level.
• A profile supports three message formats: short text, long text, and XML.
• You can enable and disable a specific profile. Profiles are disabled by default.
• You can specify the maximum message size. The default is 3 MB.
A default profile, “Cisco TAC,” has been provided. The default profile has a predefined set of groups (diagnostic,
environment, inventory, configuration, and telemetry) to monitor and predefined destination e-mail and HTTPS
URLs. The default profile is created automatically when you initially configure Smart Call Home. The
destination e-mail is [email protected] and the destination URL is
https://tools.cisco.com/its/service/oddce/services/DDCEService.
Note You cannot change the destination e-mail or the destination URL of the default profile.
When you subscribe a destination profile to the configuration, inventory, telemetry, or snapshot alert groups,
you can choose to receive the alert group messages asynchronously or periodically at a specified time.
The following table maps the default alert group to its severity level subscription and period (if applicable):
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
981
Guidelines for Anonymous Reporting and Smart Call Home
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
982
Configure Anonymous Reporting and Smart Call Home
Procedure
Step 1 Enable the Anonymous Reporting feature and create a new anonymous profile.
call-home reporting anonymous
Example:
ciscoasa(config)# call-home reporting anonymous
Entering this command creates a trust point and installs a certificate that is used to verify the identity of the
Cisco web server.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
983
Configure Anonymous Reporting and Smart Call Home
Step 2 (Optional) Make sure that you have connectivity to the server and that your system can send messages.
call-home test reporting anonymous
Example:
ciscoasa(config)# call-home test reporting anonymous
INFO: Succeeded
Procedure
Step 1 Enable the Smart Call Home service. See Enable Smart Call Home, on page 984.
Step 2 Configure the mail server through which Smart Call Home messages are delivered to subscribers. See Configure
the Mail Server, on page 989.
Step 3 Set up contact information for the Smart Call Home messages. See Configure Customer Contact Information,
on page 987.
Step 4 Define alert processing parameters, such as the maximum rate of events that can be handled. See Configure
Alert Group Subscription, on page 986.
Step 5 Set up alert subscription profiles. See Configure a Destination Profile, on page 991.
Each alert subscription profile identifies the following:
• The subscribers to whom the Smart Call Home messages are sent, such as a Smart Call Home server at
Cisco or a list of e-mail recipients.
• Information categories for which you want to receive alerts, such as configuration or inventory
information.
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
984
Configure Anonymous Reporting and Smart Call Home
Example:
ciscoasa(config)# service call-home
Example:
ciscoasa(config)# call home
Note You should set the trust point for no client-types/no validation-usage to prevent it from being used for
VPN validation.
To declare and authenticate the Cisco server security certificate and establish communication with the Cisco
HTTPS server for Smart Call Home service, perform the following steps:
Procedure
Step 1 (Multiple Context Mode only) Install the certificate in the admin context.
changeto context admincontext
Example:
ciscoasa(config)# changeto context contextA
Example:
ciscoasa(config)# crypto ca trustpoint cisco
Note If you use HTTP as the transport method, you must install a security certificate through a trust point,
which is required for HTTPS. Find the specific certificate to install at the following URL:
http://www.cisco.com/en/US/docs/switches/lan/smart_call_home/SCH31_Ch6.html#wp1035380
Step 3 Specify a manual cut-and-paste method of certificate enrollment.
enroll terminal
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
985
Configure Anonymous Reporting and Smart Call Home
Example:
ciscoasa(ca-trustpoint)# enroll terminal
Step 4 Authenticate the named CA. The CA name should match the trust point name specified in the crypto ca
trustpoint command. At the prompt, paste the security certificate text.
crypto ca authenticate trustpoint
Example:
ciscoasa(ca-trustpoint)# crypto ca authenticate cisco
Step 5 Specify the end of the security certificate text and confirm acceptance of the entered security certificate.
quit
Example:
ciscoasa(ca-trustpoint)# quit
yes
Procedure
Example:
ciscoasa(config)# alert-group-config environment
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
986
Configure Anonymous Reporting and Smart Call Home
Example:
ciscoasa(config)# call-home
Example:
ciscoasa(cfg-call-home)# alert-group syslog
Use the all keyword to enable all alert groups. By default, all alert groups are enabled.
Step 3 Enter the profile configuration mode for the specified destination profile.
profile profile-name
Example:
ciscoasa(cfg-call-home)# profile CiscoTAC-1
Example:
ciscoasa(cfg-call-home-profile)# subscribe-to-alert-group all
Example:
ciscoasa(cfg-call-home-profile)# subscribe-to-alert-group configuration periodic weekly
Wednesday 23:30
The periodic keyword configures the configuration alert group for periodic notification. The default period
is daily.
The daily keyword specifies the time of the day to send, in the hh:mm format, with a 24-hour clock (for
example, 14:30).
The weekly keyword specifies the day of the week and time of day in the day hh:mm format, where the day
of the week is spelled out (for example, Monday).
The monthly keyword specifies the numeric date, from 1 to 31, and the time of day, in the date hh:mm format.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
987
Configure Anonymous Reporting and Smart Call Home
Procedure
Example:
ciscoasa(config)# call-home
Step 2 Specify the customer phone number. Spaces are allowed, but you must use quotes around the string if it
includes spaces.
phone-number phone-number-string
Example:
ciscoasa(cfg-call-home)# phone-number 8005551122
Step 3 Specify the customer address, which is a free-format string that may be up to 255 characters long. Spaces are
allowed, but you must use quotes around the string if it includes spaces.
street-address street-address
Example:
ciscoasa(cfg-call-home)# street-address “1234 Any Street, Any city, Any state, 12345”
Step 4 Specify the customer name, which may be up to 128 characters long. Spaces are allowed, but you must use
quotes around the string if it includes spaces.
contact-name contact-name
Example:
ciscoasa(cfg-call-home)# contact-name contactname1234
Step 5 Specify the Cisco customer ID, which may be up to 64 characters long. Spaces are allowed, but you must use
quotes around the string if it includes spaces.
customer-id customer-id-string
Example:
ciscoasa(cfg-call-home)# customer-id customer1234
Step 6 Specify the customer site ID, which may be up to 64 characters long. Spaces are allowed, but you must use
quotes around the string if it includes spaces.
site-id site-id-string
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
988
Configure Anonymous Reporting and Smart Call Home
Example:
ciscoasa(cfg-call-home)# site-id site1234
Step 7 Specify the customer contract identification, which may be up to 128 characters long. Spaces are allowed,
but you must use quotes around the string if it includes spaces.
contract-id contract-id-string
Example:
ciscoasa(cfg-call-home)# contract-id contract1234
Example
The following example shows how to configure contact information:
ciscoasa(config)# call-home
ciscoasa(cfg-call-home)# contact-email-addr [email protected]
ciscoasa(cfg-call-home)# phone-number 8005551122
ciscoasa(cfg-call-home)# street-address “1234 Any Street, Any city, Any state, 12345”
ciscoasa(cfg-call-home)# contact-name contactname1234
ciscoasa(cfg-call-home)# customer-id customer1234
ciscoasa(cfg-call-home)# site-id site1234
ciscoasa(cfg-call-home)# contract-id contract1234
Procedure
Example:
ciscoasa(config)# call-home
Example:
ciscoasa(cfg-call-home)# mail-server 10.10.1.1 smtp.example.com priority 1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
989
Configure Anonymous Reporting and Smart Call Home
You can specify up to five mail servers, using five separate commands. You must configure at least one mail
server for using e-mail transport of Smart Call Home messages.
The lower the number, the higher the priority of the mail server.
The ip-address argument can be an IPv4 or IPv6 mail server address.
Example
The following example shows how to configure a primary mail server (named ”smtp.example.com”) and a
secondary mail server at IP address 10.10.1.1:
ciscoasa(config)# call-home
ciscoasa(cfg-call-home)# mail-server smtp.example.com priority 1
ciscoasa(cfg-call-home)# mail-server 10.10.1.1 priority 2
ciscoasa(cfg-call-home)# exit
ciscoasa(config)#
Procedure
Example:
ciscoasa(config)# call-home
Step 2 Specify the number of messages that Smart Call Home can send per minute. The default value is 10 messages
per minute.
rate-limit msg-count
Example:
ciscoasa(cfg-call-home)# rate-limit 5
Procedure
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
990
Configure Anonymous Reporting and Smart Call Home
• Option 2—Send an alert group message to one destination profile, if specified. If no profile is specified,
send messages to all profiles that are subscribed to the inventory, configuration, snapshot, or telemetry
alert groups.
call-home send alert-group inventory { | configuration | snapshot | telemetry} [profile profile-name]
Example:
• Option 3—Send command output to an e-mail address. The specified CLI command can be any command,
including commands for all registered modules.
call-home sendcli command [email email]
Example:
If you specify an e-mail address, the command output is sent to that address. If no e-mail address is
specified, the output is sent to Cisco TAC. The e-mail is sent in log text format with the service number,
if specified, in the subject line.
The service number is required only if no e-mail address is specified, or if a Cisco TAC e-mail address
is specified.
Procedure
Example:
ciscoasa(config)# call-home
Step 2 Enter the profile configuration mode for the specified destination profile. If the specified destination profile
does not exist, it is created.
profile profile-name
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
991
Configure Anonymous Reporting and Smart Call Home
Example:
ciscoasa(cfg-call-home)# profile newprofile
You can create a maximum of 10 active profiles. The default profile is to report back to Cisco TAC. If you
want to send call home information to a different location (for example, your own server), you can configure
a separate profile.
Step 3 Configure the destination, message size, message format, and transport method for the Smart Call Home
message receiver. The default message format is XML, and the default enabled transport method is e-mail.
destination {email address | http url} | message-size-limit size | preferred-msg-format {long-text | short-text
| xml} transport-method {email | http}}
Example:
ciscoasa(cfg-call-home-profile)# destination address email [email protected]
The e-mail-address is the e-mail address of the Smart Call Home message receiver, which can be up to 100
characters long. By default, the maximum URL size is 5 MB.
Use the short-text format to send and read a message on a mobile device, and use the long text format to send
and read a message on a computer.
If the message receiver is the Smart Call Home back-end server, ensure that the preferred-msg-format value
is XML because the back-end server can accept messages in XML format only.
Use this command to change the transport method back to e-mail.
Procedure
Example:
ciscoasa(config)# call-home
Example:
ciscoasa(cfg-call-home)# profile newprofile
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
992
Configure Anonymous Reporting and Smart Call Home
Example:
ciscoasa(cfg-call-home)# copy profile newprofile profile1
The existing profile (src-profile-name) and the new profile (dest-profile-name) may be up to 23 characters
long.
Example
The following example shows how to copy an existing profile:
ciscoasa(config)# call-home
ciscoasa(cfg-call-home)# profile newprofile
ciscoasa(cfg-call-home-profile)# copy profile newprofile profile1
Procedure
Example:
ciscoasa(config)# call-home
Example:
ciscoasa(cfg-call-home)# profile newprofile
Example:
ciscoasa(cfg-call-home)# rename profile newprofile profile1
The existing profile (src-profile-name) and the new profile (dest-profile-name) may be up to 23 characters
long.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
993
Monitoring Anonymous Reporting and Smart Call Home
Example
The following example shows how to rename an existing profile:
ciscoasa(config)# call-home
ciscoasa(cfg-call-home)# profile newprofile
ciscoasa(cfg-call-home-profile)# rename profile newprofile profile1
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
994
History for Anonymous Reporting and Smart Call Home
Anonymous Reporting 9.0(1) You can help to improve the ASA platform by enabling
Anonymous Reporting, which allows Cisco to securely receive
minimal error and health information from a device.
We introduced the following commands: call-home reporting
anonymous, call-home test reporting anonymous.
Smart Call Home 9.1(2) The show local-host command was changed to the show
local-host | include interface command for telemetry alert
group reporting.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
995
History for Anonymous Reporting and Smart Call Home
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
996
PART IX
Reference
• Using the Command-Line Interface, page 999
• Addresses, Protocols, and Ports, page 1007
CHAPTER 40
Using the Command-Line Interface
This chapter describes how to use the CLI on the Cisco ASA.
Note The CLI uses similar syntax and other conventions to the Cisco IOS CLI, but the ASA operating system
is not a version of Cisco IOS software. Do not assume that a Cisco IOS CLI command works with or has
the same function on the ASA.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
999
Command Modes and Prompts
Note The various types of prompts are all default prompts and when configured, they can be different.
• When you are in the system configuration or in single context mode, the prompt begins with the hostname:
ciscoasa
• When printing the prompt string, the prompt configuration is parsed and the configured keyword values
are printed in the order in which you have set the prompt command. The keyword arguments can be any
of the following and in any order: hostname, domain, context, priority, state.
prompt hostname context priority state
• When you are within a context, the prompt begins with the hostname followed by the context name:
ciscoasa/context
ciscoasa>
ciscoasa/context>
ciscoasa#
ciscoasa/context#
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1000
Syntax Formatting
ciscoasa(config)#
ciscoasa/context(config)#
ciscoasa(config-if)#
ciscoasa/context(config-if)#
Syntax Formatting
Command syntax descriptions use the conventions listed in the following table.
Convention Description
bold Bold text indicates commands and keywords that you enter literally as shown.
italics Italic text indicates arguments for which you supply values.
[x {y | z}] Nested sets of square brackets or braces indicate optional or required choices within
optional or required elements. Braces and a vertical bar within square brackets indicate a
required choice within an optional element.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1001
Abbreviate Commands
Abbreviate Commands
You can abbreviate most commands down to the fewest unique characters for a command; for example, you
can enter wr t to view the configuration instead of entering the full command write terminal, or you can
enter en to start privileged mode and conf t to start configuration mode. In addition, you can enter 0 to
represent 0.0.0.0.
Command-Line Editing
The ASA uses the same command-line editing conventions as Cisco IOS software. You can view all previously
entered commands with the show history command or individually with the up arrow or ^p command. Once
you have examined a previously entered command, you can move forward in the list with the down arrow or
^n command. When you reach a command you wish to reuse, you can edit it or press the Enter key to start
it. You can also delete the word to the left of the cursor with ^w, or erase the line with ^u.
The ASA permits up to 512 characters in a command; additional characters are ignored.
Command Completion
To complete a command or keyword after entering a partial string, press the Tab key. The ASA only completes
the command or keyword if the partial string matches only one command or keyword. For example, if you
enter s and press the Tab key, the ASA does not complete the command because it matches more than one
command. However, if you enter dis, the Tab key completes the disable command.
Command Help
Help information is available from the command line by entering the following commands:
• help command_name
Shows help for the specific command.
• command_name ?
Shows a list of arguments available.
• string? (no space)
Lists the possible commands that start with the string.
• ? and +?
Lists all commands available. If you enter ?, the ASA shows only commands available for the current
mode. To show all commands available, including those for lower modes, enter +?.
Note If you want to include a question mark (?) in a command string, you must press Ctrl-V before typing the
question mark so that you do not inadvertently invoke CLI help.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1002
View the Running Configuration
Note Many passwords are shown as *****. To view the passwords in plain text, or in encrypted
form if you have a master passphrase enabled, use the more command.
• more system:running-config
Note Entering the more command allows you to view the contents of any file, not just the running configuration;
see the command reference for more information.
In this command string, the first vertical bar (|) is the operator and must be included in the command. This
operator directs the output of the show command to the filter. In the syntax diagram, the other vertical bars
(|) indicate alternative options and are not part of the command.
The include option includes all output lines that match the regular expression. The grep option without -v
has the same effect. The exclude option excludes all output lines that match the regular expression. The grep
option with-v has the same effect. The begin option shows all the output lines starting with the line that
matches the regular expression.
Replace regexp with any Cisco IOS regular expression. The regular expression is not enclosed in quotes or
double-quotes, so be careful with trailing white spaces, which will be taken as part of the regular expression.
When creating regular expressions, you can use any letter or number that you want to match. In addition,
certain keyboard characters called metacharacters have special meaning when used in regular expressions.
Use Ctrl+V to escape all of the special characters in the CLI, such as a question mark (?) or a tab. For example,
type d[Ctrl+V]?g to enter d?g in the configuration.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1003
Command Output Paging
The More prompt uses syntax similar to the UNIX more command:
• Press the Space bar to view another screen.
• Press the Enter key to view the next line.
• Press the q key to return to the command line.
Add Comments
You can precede a line with a colon ( : ) to create a comment. However, the comment only appears in the
command history buffer and not in the configuration. Therefore, you can view the comment with the show
history command or by pressing an arrow key to retrieve a previous command, but because the comment is
not in the configuration, the write terminal command does not display it.
ciscoasa(config)# context a
In the text configuration file you are not prompted to enter commands, so the prompt is omitted:
context a
interface gigabitethernet0/0
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1004
Text Configuration Files
nameif inside
interface gigabitethernet0/1
nameif outside
Line Order
For the most part, commands can be in any order in the file. However, some lines, such as ACEs, are processed
in the order they appear, and the order can affect the function of the access list. Other commands might also
have order requirements. For example, you must enter the nameif command for an interface first because
many subsequent commands use the name of the interface. Also, commands in a command-specific
configuration mode must directly follow the main command.
Passwords
The login, enable, and user passwords are automatically encrypted before they are stored in the configuration.
For example, the encrypted form of the password “cisco” might look like jMorNbK0514fadBh. You can copy
the configuration passwords to another ASA in its encrypted form, but you cannot unencrypt the passwords
yourself.
If you enter an unencrypted password in a text file, the ASA does not automatically encrypt it when you copy
the configuration to the ASA. The ASA only encrypts it when you save the running configuration from the
command line using the copy running-config startup-config or write memory command.
Each context is similar to a single context mode configuration. The system configuration differs from a context
configuration in that the system configuration includes system-only commands (such as a list of all contexts)
while other typical commands are not present (such as many interface parameters).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1005
Supported Character Sets
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1006
CHAPTER 41
Addresses, Protocols, and Ports
This chapter provides a quick reference for IP addresses, protocols, and applications.
Classes
IP host addresses are divided into three different address classes: Class A, Class B, and Class C. Each class
fixes the boundary between the network prefix and the host number at a different point within the 32-bit
address. Class D addresses are reserved for multicast IP.
• Class A addresses (1.xxx.xxx.xxx through 126.xxx.xxx.xxx) use only the first octet as the network
prefix.
• Class B addresses (128.0.xxx.xxx through 191.255.xxx.xxx) use the first two octets as the network
prefix.
• Class C addresses (192.0.0.xxx through 223.255.255.xxx) use the first three octets as the network prefix.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1007
IPv4 Addresses and Subnet Masks
Because Class A addresses have 16,777,214 host addresses, and Class B addresses 65,534 hosts, you can use
subnet masking to break these huge networks into smaller subnets.
Private Networks
If you need large numbers of addresses on your network, and they do not need to be routed on the Internet,
you can use private IP addresses that the Internet Assigned Numbers Authority (IANA) recommends (see
RFC 1918). The following address ranges are designated as private networks that should not be advertised:
• 10.0.0.0 through 10.255.255.255
• 172.16.0.0 through 172.31.255.255
• 192.168.0.0 through 192.168.255.255
Subnet Masks
A subnet mask lets you convert a single Class A, B, or C network into multiple networks. With a subnet mask,
you can create an extended network prefix that adds bits from the host number to the network prefix. For
example, a Class C network prefix always consists of the first three octets of the IP address. But a Class C
extended network prefix uses part of the fourth octet as well.
Subnet masking is easy to understand if you use binary notation instead of dotted decimal. The bits in the
subnet mask have a one-to-one correspondence with the Internet address:
• The bits are set to 1 if the corresponding bit in the IP address is part of the extended network prefix.
• The bits are set to 0 if the bit is part of the host number.
Example 1: If you have the Class B address 129.10.0.0 and you want to use the entire third octet as part of
the extended network prefix instead of the host number, then you must specify a subnet mask of
11111111.11111111.11111111.00000000. This subnet mask converts the Class B address into the equivalent
of a Class C address, where the host number consists of the last octet only.
Example 2: If you want to use only part of the third octet for the extended network prefix, then you must
specify a subnet mask like 11111111.11111111.11111000.00000000, which uses only 5 bits of the third octet
for the extended network prefix.
You can write a subnet mask as a dotted-decimal mask or as a /bits (“slash bits”) mask. In Example 1, for a
dotted-decimal mask, you convert each binary octet into a decimal number: 255.255.255.0. For a /bits mask,
you add the number of 1s: /24. In Example 2, the decimal number is 255.255.248.0 and the /bits is /21.
You can also supernet multiple Class C networks into a larger network by using part of the third octet for the
extended network prefix. For example, 192.168.0.0/20.
Note The first and last number of a subnet are reserved, except for /32, which identifies a single host.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1008
IPv4 Addresses and Subnet Masks
64 /26 255.255.255.192
32 /27 255.255.255.224
16 /28 255.255.255.240
8 /29 255.255.255.248
4 /30 255.255.255.252
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1009
IPv4 Addresses and Subnet Masks
Note The first and last address of a subnet are reserved. In the first subnet example, you cannot use 192.168.0.0
or 192.168.0.7.
— —
Note The first and last address of a subnet are reserved. In the first subnet example, you cannot use 10.1.0.0 or
10.1.15.255.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1010
IPv6 Addresses
— —
IPv6 Addresses
IPv6 is the next generation of the Internet Protocol after IPv4. It provides an expanded address space, a
simplified header format, improved support for extensions and options, flow labeling capability, and
authentication and privacy capabilities. IPv6 is described in RFC 2460. The IPv6 addressing architecture is
described in RFC 3513.
This section describes the IPv6 address format and architecture.
You do not need to include the leading zeros in an individual field of the address, but each field must contain
at least one digit. So the example address 2001:0DB8:0000:0000:0008:0800:200C:417A can be shortened to
2001:0DB8:0:0:8:800:200C:417A by removing the leading zeros from the third through sixth fields from the
left. The fields that contained all zeros (the third and fourth fields from the left) were shortened to a single
zero. The fifth field from the left had the three leading zeros removed, leaving a single 8 in that field, and the
sixth field from the left had the one leading zero removed, leaving 800 in that field.
It is common for IPv6 addresses to contain several consecutive hexadecimal fields of zeros. You can use two
colons (::) to compress consecutive fields of zeros at the beginning, middle, or end of an IPv6 address (the
colons represent the successive hexadecimal fields of zeros). The following table shows several examples of
address compression for different types of IPv6 address.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1011
IPv6 Addresses
Unspecified 0:0:0:0:0:0:0:0 ::
Note Two colons (::) can be used only once in an IPv6 address to represent successive fields of zeros.
An alternative form of the IPv6 format is often used when dealing with an environment that contains both
IPv4 and IPv6 addresses. This alternative has the format x:x:x:x:x:x:y.y.y.y, where x represent the hexadecimal
values for the six high-order parts of the IPv6 address and y represent decimal values for the 32-bit IPv4 part
of the address (which takes the place of the remaining two 16-bit parts of the IPv6 address). For example, the
IPv4 address 192.168.1.1 could be represented as the IPv6 address 0:0:0:0:0:0:FFFF:192.168.1.1 or
::FFFF:192.168.1.1.
Note There are no broadcast addresses in IPv6. Multicast addresses provide the broadcast functionality.
Unicast Addresses
This section describes IPv6 unicast addresses. Unicast addresses identify an interface on a network node.
Global Address
The general format of an IPv6 global unicast address is a global routing prefix followed by a subnet ID
followed by an interface ID. The global routing prefix can be any prefix not reserved by another IPv6 address
type.
All global unicast addresses, other than those that start with binary 000, have a 64-bit interface ID in the
Modified EUI-64 format.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1012
IPv6 Addresses
Global unicast address that start with the binary 000 do not have any constraints on the size or structure of
the interface ID portion of the address. One example of this type of address is an IPv6 address with an embedded
IPv4 address.
Site-Local Address
Site-local addresses are used for addressing within a site. They can be used to address an entire site without
using a globally unique prefix. Site-local addresses have the prefix FEC0::/10, followed by a 54-bit subnet
ID, and end with a 64-bit interface ID in the modified EUI-64 format.
Site-local routers do not forward any packets that have a site-local address for a source or destination outside
of the site. Therefore, site-local addresses can be considered private addresses.
Link-Local Address
All interfaces are required to have at least one link-local address. You can configure multiple IPv6 addresses
per interfaces, but only one link-local address.
A link-local address is an IPv6 unicast address that can be automatically configured on any interface using
the link-local prefix FE80::/10 and the interface identifier in modified EUI-64 format. Link-local addresses
are used in the neighbor discovery protocol and the stateless autoconfiguration process. Nodes with a link-local
address can communicate; they do not need a site-local or globally unique address to communicate.
Routers do not forward any packets that have a link-local address for a source or destination. Therefore,
link-local addresses can be considered private addresses.
Note The IPv4 address used in the IPv4-compatible IPv6 address must be a globally unique IPv4 unicast address.
The second type of IPv6 address, which holds an embedded IPv4 address, is called the IPv4-mapped IPv6
address. This address type is used to represent the addresses of IPv4 nodes as IPv6 addresses. This type of
address has the format ::FFFF:y.y.y.y, where y.y.y.y is an IPv4 unicast address.
Unspecified Address
The unspecified address, 0:0:0:0:0:0:0:0, indicates the absence of an IPv6 address. For example, a newly
initialized node on an IPv6 network may use the unspecified address as the source address in its packets until
it receives its IPv6 address.
Note The IPv6 unspecified address cannot be assigned to an interface. The unspecified IPv6 addresses must
not be used as destination addresses in IPv6 packets or the IPv6 routing header.
Loopback Address
The loopback address, 0:0:0:0:0:0:0:1, may be used by a node to send an IPv6 packet to itself. The loopback
address in IPv6 functions the same as the loopback address in IPv4 (127.0.0.1).
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1013
IPv6 Addresses
Note The IPv6 loopback address cannot be assigned to a physical interface. A packet that has the IPv6 loopback
address as its source or destination address must remain within the node that created the packet. IPv6
routers do not forward packets that have the IPv6 loopback address as their source or destination address.
Interface Identifiers
Interface identifiers in IPv6 unicast addresses are used to identify the interfaces on a link. They need to be
unique within a subnet prefix. In many cases, the interface identifier is derived from the interface link-layer
address. The same interface identifier may be used on multiple interfaces of a single node, as long as those
interfaces are attached to different subnets.
For all unicast addresses, except those that start with the binary 000, the interface identifier is required to be
64 bits long and to be constructed in the Modified EUI-64 format. The Modified EUI-64 format is created
from the 48-bit MAC address by inverting the universal/local bit in the address and by inserting the hexadecimal
number FFFE between the upper three bytes and lower three bytes of the of the MAC address.
For example, and interface with the MAC address of 00E0.b601.3B7A would have a 64-bit interface ID of
02E0:B6FF:FE01:3B7A.
Multicast Address
An IPv6 multicast address is an identifier for a group of interfaces, typically on different nodes. A packet sent
to a multicast address is delivered to all interfaces identified by the multicast address. An interface may belong
to any number of multicast groups.
An IPv6 multicast address has a prefix of FF00::/8 (1111 1111). The octet following the prefix defines the
type and scope of the multicast address. A permanently assigned (well known) multicast address has a flag
parameter equal to 0; a temporary (transient) multicast address has a flag parameter equal to 1. A multicast
address that has the scope of a node, link, site, or organization, or a global scope has a scope parameter of 1,
2, 5, 8, or E, respectively. For example, a multicast address with the prefix FF02::/16 is a permanent multicast
address with a link scope. The following figure shows the format of the IPv6 multicast address.
IPv6 nodes (hosts and routers) are required to join the following multicast groups:
• The All Nodes multicast addresses:
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1014
IPv6 Addresses
◦FF01:: (interface-local)
◦FF02:: (link-local)
• The Solicited-Node Address for each IPv6 unicast and anycast address on the node:
FF02:0:0:0:0:1:FFXX:XXXX/104, where XX:XXXX is the low-order 24-bits of the unicast or anycast
address.
Note There are no broadcast addresses in IPv6. IPv6 multicast addresses are used instead of broadcast addresses.
Anycast Address
The IPv6 anycast address is a unicast address that is assigned to more than one interface (typically belonging
to different nodes). A packet that is routed to an anycast address is routed to the nearest interface having that
address, the nearness being determined by the routing protocol in effect.
Anycast addresses are allocated from the unicast address space. An anycast address is simply a unicast address
that has been assigned to more than one interface, and the interfaces must be configured to recognize the
address as an anycast address.
The following restrictions apply to anycast addresses:
• An anycast address cannot be used as the source address for an IPv6 packet.
• An anycast address cannot be assigned to an IPv6 host; it can only be assigned to an IPv6 router.
Required Addresses
IPv6 hosts must, at a minimum, be configured with the following addresses (either automatically or manually):
• A link-local address for each interface
• The loopback address
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1015
Protocols and Applications
IPv6 routers must, at a minimum, be configured with the following addresses (either automatically or manually):
• The required host addresses
• The Subnet-Router anycast addresses for all interfaces for which it is configured to act as a router
• The All-Routers multicast addresses
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1016
TCP and UDP Ports
ip 0 Internet Protocol.
ipsec 50 IP Security. Entering the ipsec protocol literal is equivalent to entering the esp
protocol literal.
pptp 47 Point-to-Point Tunneling Protocol. Entering the pptp protocol literal is equivalent
to entering the gre protocol literal.
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1017
TCP and UDP Ports
• The ASA uses port 1521 for SQL*Net. This is the default port used by Oracle for SQL*Net. This value,
however, does not agree with IANA port assignments.
• The ASA listens for RADIUS on ports 1645 and 1646. If your RADIUS server uses the standard ports
1812 and 1813, you can configure the ASA to listen to those ports using the authentication-port and
accounting-port commands.
• To assign a port for DNS access, use the domain literal value, not dns. If you use dns, the ASA assumes
you meant to use the dnsix literal value.
biff UDP 512 Used by mail system to notify users that new mail is
received
cmd TCP 514 Similar to exec except that cmd has automatic
authentication
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1018
TCP and UDP Ports
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1019
TCP and UDP Ports
pim-auto-rp TCP, UDP 496 Protocol Independent Multicast, reverse path flooding,
dense mode
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1020
Local Ports and Protocols
HTTP TCP 80 —
ICMP 1 N/A —
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1021
ICMP Types
IPsec over TCP (CTCP) TCP — No default port is used. You must specify the
port number when configuring IPsec over
TCP.
SSH TCP 22 —
Telnet TCP 23 —
VPN Individual User UDP 1645, 1646 Port accessible only over VPN tunnel.
Authentication Proxy
ICMP Types
The following table lists the ICMP type numbers and names that you can enter in ASA commands.
3 unreachable
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1022
ICMP Types
5 redirect
6 alternate-address
8 echo
9 router-advertisement
10 router-solicitation
11 time-exceeded
12 parameter-problem
13 timestamp-request
14 timestamp-reply
15 information-request
16 information-reply
17 mask-request
18 mask-reply
31 conversion-error
32 mobile-redirect
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1023
ICMP Types
CLI Book 1: Cisco ASA Series General Operations CLI Configuration Guide, 9.5
1024