Cisco Systems Asa5515K9 Users Manual _asacfg_cli

ASA 5500 to the manual 70242a1d-7de2-47db-bb39-a0524b4b647c

2015-01-05

: Cisco-Systems Cisco-Systems-Asa5515K9-Users-Manual-202749 cisco-systems-asa5515k9-users-manual-202749 cisco-systems pdf

Open the PDF directly: View PDF PDF.
Page Count: 1994

DownloadCisco-Systems Cisco-Systems-Asa5515K9-Users-Manual- _asacfg_cli  Cisco-systems-asa5515k9-users-manual
Open PDF In BrowserView PDF
Cisco ASA 5500 Series Configuration
Guide using the CLI
Software Version 8.4 and 8.6 for the ASA 5505, ASA 5510, ASA 5520, ASA
5540, ASA 5550, ASA 5580, ASA 5512-X, ASA 5515-X, ASA 5525-X, ASA
5545-X, ASA 5555-X, and ASA 5585-X
Released: January 31, 2011
Updated: October 31, 2012

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

Text Part Number: N/A, Online only

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.
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: 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)

Cisco ASA 5500 Series Configuration Guide using the CLI
Copyright © 2011-2012 Cisco Systems, Inc. All rights reserved.

CONTENTS
About This Guide

lxv

Document Objectives
Audience

lxv

lxv

Related Documentation
Conventions

lxv

lxvi

Obtaining Documentation and Submitting a Service Request

PART

Getting Started with the ASA

1

CHAPTER

lxvii

1

Introduction to the Cisco ASA 5500 Series
Hardware and Software Compatibility
VPN Specifications

1-1

1-1

1-1

New Features 1-1
New Features in Version 8.6(1)
New Features in Version 8.4(5)
New Features in Version 8.4(4.1)
New Features in Version 8.4(3)
New Features in Version 8.4(2)
New Features in Version 8.4(1)

1-2
1-4
1-6
1-9
1-12
1-19

Firewall Functional Overview 1-24
Security Policy Overview 1-24
Permitting or Denying Traffic with Access Lists 1-25
Applying NAT 1-25
Protecting from IP Fragments 1-25
Using AAA for Through Traffic 1-25
Applying HTTP, HTTPS, or FTP Filtering 1-25
Applying Application Inspection 1-25
Sending Traffic to the IPS Module 1-26
Sending Traffic to the Content Security and Control Module
Applying QoS Policies 1-26
Applying Connection Limits and TCP Normalization 1-26
Enabling Threat Detection 1-26
Enabling the Botnet Traffic Filter 1-27
Configuring Cisco Unified Communications 1-27

1-26

Cisco ASA 5500 Series Configuration Guide using the CLI

iii

Contents

Firewall Mode Overview 1-27
Stateful Inspection Overview 1-27
VPN Functional Overview
Security Context Overview

CHAPTER

2

Getting Started

1-28
1-29

2-1

Accessing the Appliance Command-Line Interface

2-1

Configuring ASDM Access for Appliances 2-2
Accessing ASDM Using the Factory Default Configuration 2-2
Accessing ASDM Using a Non-Default Configuration (ASA 5505) 2-3
Accessing ASDM Using a Non-Default Configuration (ASA 5510 and Higher)
Starting ASDM 2-6
Connecting to ASDM for the First Time 2-7
Starting ASDM from the ASDM-IDM Launcher 2-8
Starting ASDM from the Java Web Start Application
Using ASDM in Demo Mode 2-9

2-8

Factory Default Configurations 2-10
Restoring the Factory Default Configuration 2-11
ASA 5505 Default Configuration 2-11
ASA 5505 Routed Mode Default Configuration 2-11
ASA 5505 Transparent Mode Sample Configuration 2-13
ASA 5510 and Higher Default Configuration 2-15
Working with the Configuration 2-15
Saving Configuration Changes 2-16
Saving Configuration Changes in Single Context Mode 2-16
Saving Configuration Changes in Multiple Context Mode 2-16
Copying the Startup Configuration to the Running Configuration 2-17
Viewing the Configuration 2-18
Clearing and Removing Configuration Settings 2-18
Creating Text Configuration Files Offline 2-19
Applying Configuration Changes to Connections

CHAPTER

3

Managing Feature Licenses

3-1

Supported Feature Licenses Per Model 3-1
Licenses Per Model 3-1
License Notes 3-16
VPN License and Feature Compatibility 3-20
Information About Feature Licenses

Cisco ASA 5500 Series Configuration Guide using the CLI

iv

3-20

2-19

2-5

Contents

Preinstalled License 3-21
Permanent License 3-21
Time-Based Licenses 3-21
Time-Based License Activation Guidelines 3-21
How the Time-Based License Timer Works 3-21
How Permanent and Time-Based Licenses Combine 3-22
Stacking Time-Based Licenses 3-23
Time-Based License Expiration 3-23
Shared AnyConnect Premium Licenses 3-23
Information About the Shared Licensing Server and Participants
Communication Issues Between Participant and Server 3-25
Information About the Shared Licensing Backup Server 3-25
Failover and Shared Licenses 3-25
Maximum Number of Participants 3-27
Failover Licenses (8.3(1) and Later) 3-28
Failover License Requirements and Exceptions 3-28
How Failover Licenses Combine 3-28
Loss of Communication Between Failover Units 3-29
Upgrading Failover Pairs 3-30
No Payload Encryption Models 3-30
Licenses FAQ 3-30
Guidelines and Limitations

3-24

3-31

Configuring Licenses 3-32
Obtaining an Activation Key 3-33
Activating or Deactivating Keys 3-33
Configuring a Shared License 3-35
Configuring the Shared Licensing Server 3-35
Configuring the Shared Licensing Backup Server (Optional)
Configuring the Shared Licensing Participant 3-37

3-37

Monitoring Licenses 3-38
Viewing Your Current License 3-38
Monitoring the Shared License 3-44
Feature History for Licensing

PART

Configuring Firewall and Security Context Modes

2

CHAPTER

3-46

4

Configuring the Transparent or Routed Firewall
Configuring the Firewall Mode 4-1
Information About the Firewall Mode

4-1

4-1

Cisco ASA 5500 Series Configuration Guide using the CLI

v

Contents

Information About Routed Firewall Mode 4-2
Information About Transparent Firewall Mode 4-2
Licensing Requirements for the Firewall Mode 4-6
Default Settings 4-6
Guidelines and Limitations 4-6
Setting the Firewall Mode 4-8
Feature History for Firewall Mode 4-9
Configuring ARP Inspection for the Transparent Firewall 4-9
Information About ARP Inspection 4-10
Licensing Requirements for ARP Inspection 4-10
Default Settings 4-10
Guidelines and Limitations 4-10
Configuring ARP Inspection 4-11
Task Flow for Configuring ARP Inspection 4-11
Adding a Static ARP Entry 4-11
Enabling ARP Inspection 4-12
Monitoring ARP Inspection 4-12
Feature History for ARP Inspection 4-13
Customizing the MAC Address Table for the Transparent Firewall
Information About the MAC Address Table 4-14
Licensing Requirements for the MAC Address Table 4-14
Default Settings 4-14
Guidelines and Limitations 4-14
Configuring the MAC Address Table 4-15
Adding a Static MAC Address 4-15
Setting the MAC Address Timeout 4-15
Disabling MAC Address Learning 4-16
Monitoring the MAC Address Table 4-16
Feature History for the MAC Address Table 4-17

4-13

Firewall Mode Examples 4-17
How Data Moves Through the ASA in Routed Firewall Mode 4-17
An Inside User Visits a Web Server 4-18
An Outside User Visits a Web Server on the DMZ 4-19
An Inside User Visits a Web Server on the DMZ 4-20
An Outside User Attempts to Access an Inside Host 4-21
A DMZ User Attempts to Access an Inside Host 4-22
How Data Moves Through the Transparent Firewall 4-23
An Inside User Visits a Web Server 4-24
An Inside User Visits a Web Server Using NAT 4-25

Cisco ASA 5500 Series Configuration Guide using the CLI

vi

Contents

An Outside User Visits a Web Server on the Inside Network
An Outside User Attempts to Access an Inside Host 4-27

CHAPTER

5

Configuring Multiple Context Mode

4-26

5-1

Information About Security Contexts 5-1
Common Uses for Security Contexts 5-2
Context Configuration Files 5-2
Context Configurations 5-2
System Configuration 5-2
Admin Context Configuration 5-2
How the ASA Classifies Packets 5-3
Valid Classifier Criteria 5-3
Classification Examples 5-4
Cascading Security Contexts 5-6
Management Access to Security Contexts 5-7
System Administrator Access 5-7
Context Administrator Access 5-8
Information About Resource Management 5-8
Resource Limits 5-8
Default Class 5-9
Class Members 5-10
Information About MAC Addresses 5-11
Default MAC Address 5-11
Interaction with Manual MAC Addresses 5-11
Failover MAC Addresses 5-12
MAC Address Format 5-12
Licensing Requirements for Multiple Context Mode
Guidelines and Limitations
Default Settings

5-12

5-13

5-14

Configuring Multiple Contexts 5-14
Task Flow for Configuring Multiple Context Mode 5-14
Enabling or Disabling Multiple Context Mode 5-15
Enabling Multiple Context Mode 5-15
Restoring Single Context Mode 5-16
Configuring a Class for Resource Management 5-16
Configuring a Security Context 5-18
Automatically Assigning MAC Addresses to Context Interfaces
Changing Between Contexts and the System Execution Space
Managing Security Contexts

5-22

5-23

5-23
Cisco ASA 5500 Series Configuration Guide using the CLI

vii

Contents

Removing a Security Context 5-24
Changing the Admin Context 5-24
Changing the Security Context URL 5-25
Reloading a Security Context 5-26
Reloading by Clearing the Configuration 5-26
Reloading by Removing and Re-adding the Context
Monitoring Security Contexts 5-27
Viewing Context Information 5-27
Viewing Resource Allocation 5-29
Viewing Resource Usage 5-32
Monitoring SYN Attacks in Contexts 5-33
Viewing Assigned MAC Addresses 5-35
Viewing MAC Addresses in the System Configuration
Viewing MAC Addresses Within a Context 5-37
Configuration Examples for Multiple Context Mode
Feature History for Multiple Context Mode

PART

5-36

5-38

5-39

Configuring Interfaces

3

CHAPTER

5-27

6

Starting Interface Configuration (ASA 5510 and Higher)

6-1

Information About Starting ASA 5510 and Higher Interface Configuration 6-1
Auto-MDI/MDIX Feature 6-2
Interfaces in Transparent Mode 6-2
Management Interface 6-2
Management Interface Overview 6-2
Management Slot/Port Interface 6-2
Using Any Interface for Management-Only Traffic 6-3
Management Interface for Transparent Mode 6-3
No Support for Redundant Management Interfaces 6-4
Management 0/0 Interface on the ASA 5512-X through ASA 5555-X 6-4
Redundant Interfaces 6-4
Redundant Interface MAC Address 6-4
EtherChannels 6-5
Channel Group Interfaces 6-5
Connecting to an EtherChannel on Another Device 6-5
Link Aggregation Control Protocol 6-6
Load Balancing 6-7
EtherChannel MAC Address 6-7
Licensing Requirements for ASA 5510 and Higher Interfaces
Cisco ASA 5500 Series Configuration Guide using the CLI

viii

6-8

Contents

Guidelines and Limitations
Default Settings

6-9

6-11

Starting Interface Configuration (ASA 5510 and Higher) 6-12
Task Flow for Starting Interface Configuration 6-12
Converting In-Use Interfaces to a Redundant or EtherChannel Interface 6-13
Enabling the Physical Interface and Configuring Ethernet Parameters 6-22
Configuring a Redundant Interface 6-25
Configuring a Redundant Interface 6-25
Changing the Active Interface 6-27
Configuring an EtherChannel 6-27
Adding Interfaces to the EtherChannel 6-27
Customizing the EtherChannel 6-29
Configuring VLAN Subinterfaces and 802.1Q Trunking 6-30
Enabling Jumbo Frame Support (Supported Models) 6-32
Monitoring Interfaces

6-33

Configuration Examples for ASA 5510 and Higher Interfaces
Physical Interface Parameters Example 6-33
Subinterface Parameters Example 6-33
Multiple Context Mode Example 6-34
EtherChannel Example 6-34
Where to Go Next

6-34

Feature History for ASA 5510 and Higher Interfaces

CHAPTER

7

6-33

Starting Interface Configuration (ASA 5505)

6-35

7-1

Information About ASA 5505 Interfaces 7-1
Understanding ASA 5505 Ports and Interfaces 7-2
Maximum Active VLAN Interfaces for Your License 7-2
VLAN MAC Addresses 7-4
Power over Ethernet 7-4
Monitoring Traffic Using SPAN 7-4
Auto-MDI/MDIX Feature 7-4
Licensing Requirements for ASA 5505 Interfaces
Guidelines and Limitations
Default Settings

7-4

7-5

7-5

Starting ASA 5505 Interface Configuration 7-6
Task Flow for Starting Interface Configuration 7-6
Configuring VLAN Interfaces 7-6
Configuring and Enabling Switch Ports as Access Ports

7-7

Cisco ASA 5500 Series Configuration Guide using the CLI

ix

Contents

Configuring and Enabling Switch Ports as Trunk Ports
Monitoring Interfaces

7-11

Configuration Examples for ASA 5505 Interfaces
Access Port Example 7-11
Trunk Port Example 7-12
Where to Go Next

8

7-11

7-13

Feature History for ASA 5505 Interfaces

CHAPTER

7-9

7-13

Completing Interface Configuration (Routed Mode)

8-1

Information About Completing Interface Configuration in Routed Mode
Security Levels 8-1
Dual IP Stack (IPv4 and IPv6) 8-2

8-1

Licensing Requirements for Completing Interface Configuration in Routed Mode
Guidelines and Limitations
Default Settings

8-5

8-5

Completing Interface Configuration in Routed Mode 8-5
Task Flow for Completing Interface Configuration 8-6
Configuring General Interface Parameters 8-6
Configuring the MAC Address and MTU 8-9
Configuring IPv6 Addressing 8-11
Information About IPv6 8-12
Configuring a Global IPv6 Address and Other Options
Allowing Same Security Level Communication 8-15
Monitoring Interfaces

Feature History for Interfaces in Routed Mode
9

8-13

8-16

Configuration Examples for Interfaces in Routed Mode
ASA 5505 Example 8-16

CHAPTER

8-2

8-16

8-17

Completing Interface Configuration (Transparent Mode)

9-1

Information About Completing Interface Configuration in Transparent Mode
Bridge Groups in Transparent Mode 9-1
Security Levels 9-2

9-1

Licensing Requirements for Completing Interface Configuration in Transparent Mode
Guidelines and Limitations
Default Settings

9-5

9-6

Completing Interface Configuration in Transparent Mode 9-6
Task Flow for Completing Interface Configuration 9-6

Cisco ASA 5500 Series Configuration Guide using the CLI

x

9-2

Contents

Configuring Bridge Groups 9-7
Configuring General Interface Parameters 9-8
Configuring a Management Interface (ASA 5510 and Higher) 9-11
Configuring the MAC Address and MTU 9-12
Configuring IPv6 Addressing 9-15
Information About IPv6 9-15
Configuring a Global IPv6 Address and Other Options 9-17
Allowing Same Security Level Communication 9-18
Monitoring Interfaces

9-19

Configuration Examples for Interfaces in Transparent Mode
Feature History for Interfaces in Transparent Mode

PART

9-20

Configuring Basic Settings

4

CHAPTER

9-19

10

Configuring Basic Settings

10-1

Configuring the Hostname, Domain Name, and Passwords
Changing the Login Password 10-1
Changing the Enable Password 10-2
Setting the Hostname 10-2
Setting the Domain Name 10-3

10-1

Setting the Date and Time 10-3
Setting the Time Zone and Daylight Saving Time Date Range
Setting the Date and Time Using an NTP Server 10-4
Setting the Date and Time Manually 10-6
Configuring the Master Passphrase 10-6
Information About the Master Passphrase 10-6
Licensing Requirements for the Master Passphrase
Guidelines and Limitations 10-7
Adding or Changing the Master Passphrase 10-7
Disabling the Master Passphrase 10-9
Recovering the Master Passphrase 10-10
Feature History for the Master Passphrase 10-11
Configuring the DNS Server

10-7

10-11

Monitoring DNS Cache 10-12
DNS Cache Monitoring Commands
Feature History for DNS Cache

10-3

10-12

10-12

Cisco ASA 5500 Series Configuration Guide using the CLI

xi

Contents

CHAPTER

11

Configuring DHCP

11-1

Information About DHCP

11-1

Licensing Requirements for DHCP
Guidelines and Limitations

11-1

11-2

Configuring a DHCP Server 11-2
Enabling the DHCP Server 11-3
Configuring DHCP Options 11-4
Options that Return an IP Address 11-4
Options that Return a Text String 11-4
Options that Return a Hexadecimal Value 11-5
Using Cisco IP Phones with a DHCP Server 11-6
Configuring DHCP Relay Services
DHCP Monitoring Commands

CHAPTER

12

11-7

11-8

Feature History for DHCP

11-8

Configuring Dynamic DNS

12-1

Information About DDNS

12-1

Licensing Requirements for DDNS
Guidelines and Limitations
Configuring DDNS

12-2

12-2

12-2

Configuration Examples for DDNS 12-3
Example 1: Client Updates Both A and PTR RRs for Static IP Addresses 12-3
Example 2: Client Updates Both A and PTR RRs; DHCP Server Honors Client Update Request; FQDN
Provided Through Configuration 12-3
Example 3: Client Includes FQDN Option Instructing Server Not to Update Either RR; Server Overrides
Client and Updates Both RRs. 12-4
Example 4: Client Asks Server To Perform Both Updates; Server Configured to Update PTR RR Only;
Honors Client Request and Updates Both A and PTR RR 12-5
Example 5: Client Updates A RR; Server Updates PTR RR 12-5
DDNS Monitoring Commands
Feature History for DDNS

PART

12-6

Configuring Objects and Access Lists

5

CHAPTER

12-6

13

Configuring Objects

13-1

Configuring Objects and Groups 13-1
Information About Objects and Groups
Information About Objects 13-2
Cisco ASA 5500 Series Configuration Guide using the CLI

xii

13-1

Contents

Information About Object Groups 13-2
Licensing Requirements for Objects and Groups 13-2
Guidelines and Limitations for Objects and Groups 13-3
Configuring Objects 13-3
Configuring a Network Object 13-3
Configuring a Service Object 13-4
Configuring Object Groups 13-6
Adding a Protocol Object Group 13-6
Adding a Network Object Group 13-7
Adding a Service Object Group 13-8
Adding an ICMP Type Object Group 13-9
Nesting Object Groups 13-10
Removing Object Groups 13-11
Monitoring Objects and Groups 13-11
Feature History for Objects and Groups 13-12
Configuring Regular Expressions
13-12
Creating a Regular Expression 13-12
Creating a Regular Expression Class Map

13-15

Scheduling Extended Access List Activation 13-16
Information About Scheduling Access List Activation 13-16
Licensing Requirements for Scheduling Access List Activation 13-16
Guidelines and Limitations for Scheduling Access List Activation 13-16
Configuring and Applying Time Ranges 13-17
Configuration Examples for Scheduling Access List Activation 13-18
Feature History for Scheduling Access List Activation 13-18

CHAPTER

14

Information About Access Lists
Access List Types

14-1

14-1

Access Control Entry Order

14-2

Access Control Implicit Deny

14-3

IP Addresses Used for Access Lists When You Use NAT
Where to Go Next

CHAPTER

15

14-3

Adding an Extended Access List

15-1

Information About Extended Access Lists

15-1

Licensing Requirements for Extended Access Lists
Default Settings

14-3

15-1

15-2

Configuring Extended Access Lists

15-2

Cisco ASA 5500 Series Configuration Guide using the CLI

xiii

Contents

Adding an Extended Access List
Adding Remarks to Access Lists
Monitoring Extended Access Lists

15-3
15-5
15-5

Configuration Examples for Extended Access Lists 15-5
Configuration Examples for Extended Access Lists (No Objects) 15-6
Configuration Examples for Extended Access Lists (Using Objects) 15-6
Where to Go Next

15-7

Feature History for Extended Access Lists

CHAPTER

16

Adding an EtherType Access List

15-7

16-1

Information About EtherType Access Lists

16-1

Licensing Requirements for EtherType Access Lists
Guidelines and Limitations
Default Settings

16-1

16-2

16-2

Configuring EtherType Access Lists 16-2
Task Flow for Configuring EtherType Access Lists
Adding EtherType Access Lists 16-3
Adding Remarks to Access Lists 16-4
What to Do Next

16-4

Monitoring EtherType Access Lists

16-4

Configuration Examples for EtherType Access Lists
Feature History for EtherType Access Lists

CHAPTER

17

Adding a Standard Access List

16-5

16-5

17-1

Information About Standard Access Lists

17-1

Licensing Requirements for Standard Access Lists
Guidelines and Limitations
Default Settings

17-1

17-1

17-2

Adding Standard Access Lists 17-3
Task Flow for Configuring Extended Access Lists
Adding a Standard Access List 17-3
Adding Remarks to Access Lists 17-4
What to Do Next

17-3

17-4

Monitoring Access Lists

17-4

Configuration Examples for Standard Access Lists
Feature History for Standard Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

xiv

16-2

17-5

17-4

Contents

CHAPTER

18

Adding a Webtype Access List

18-1

Licensing Requirements for Webtype Access Lists
Guidelines and Limitations
Default Settings

18-1

18-1

18-2

Using Webtype Access Lists 18-2
Task Flow for Configuring Webtype Access Lists 18-2
Adding Webtype Access Lists with a URL String 18-3
Adding Webtype Access Lists with an IP Address 18-4
Adding Remarks to Access Lists 18-5
What to Do Next

18-5

Monitoring Webtype Access Lists

18-5

Configuration Examples for Webtype Access Lists
Feature History for Webtype Access Lists

CHAPTER

19

Adding an IPv6 Access List

18-7

19-1

Information About IPv6 Access Lists

19-1

Licensing Requirements for IPv6 Access Lists
Prerequisites for Adding IPv6 Access Lists
Guidelines and Limitations
Default Settings

19-1
19-2

19-2

19-3

Configuring IPv6 Access Lists 19-4
Task Flow for Configuring IPv6 Access Lists
Adding IPv6 Access Lists 19-5
Adding Remarks to Access Lists 19-6
Monitoring IPv6 Access Lists

CHAPTER

20

19-4

19-7

Configuration Examples for IPv6 Access Lists
Where to Go Next

18-5

19-7

19-7

Feature History for IPv6 Access Lists

19-7

Configuring Logging for Access Lists

20-1

Configuring Logging for Access Lists 20-1
Information About Logging Access List Activity 20-1
Licensing Requirements for Access List Logging 20-2
Guidelines and Limitations 20-2
Default Settings 20-3
Configuring Access List Logging 20-3
Monitoring Access Lists 20-4
Cisco ASA 5500 Series Configuration Guide using the CLI

xv

Contents

Configuration Examples for Access List Logging
Feature History for Access List Logging 20-5
Managing Deny Flows 20-5
Information About Managing Deny Flows 20-6
Licensing Requirements for Managing Deny Flows
Guidelines and Limitations 20-6
Default Settings 20-7
Managing Deny Flows 20-7
Monitoring Deny Flows 20-7
Feature History for Managing Deny Flows 20-8

PART

Configuring IP Routing

6

CHAPTER

21

Routing Overview

21-1

Information About Routing 21-1
Switching 21-2
Path Determination 21-2
Supported Route Types 21-2
Static Versus Dynamic 21-3
Single-Path Versus Multipath 21-3
Flat Versus Hierarchical 21-3
Link-State Versus Distance Vector 21-4
How Routing Behaves Within the ASA 21-4
Egress Interface Selection Process 21-4
Next Hop Selection Process 21-4
Supported Internet Protocols for Routing

21-5

Information About the Routing Table 21-6
Displaying the Routing Table 21-6
How the Routing Table Is Populated 21-6
Backup Routes 21-8
How Forwarding Decisions Are Made 21-8
Dynamic Routing and Failover 21-9
Information About IPv6 Support 21-9
Features That Support IPv6 21-9
IPv6-Enabled Commands 21-10
Entering IPv6 Addresses in Commands
Disabling Proxy ARPs

21-11

Cisco ASA 5500 Series Configuration Guide using the CLI

xvi

21-11

20-4

20-6

Contents

CHAPTER

22

Configuring Static and Default Routes

22-1

Information About Static and Default Routes

22-1

Licensing Requirements for Static and Default Routes
Guidelines and Limitations

22-2

22-2

Configuring Static and Default Routes 22-2
Configuring a Static Route 22-3
Adding or Editing a Static Route 22-3
Configuring a Default Static Route 22-4
Limitations on Configuring a Default Static Route
Configuring IPv6 Default and Static Routes 22-5
Monitoring a Static or Default Route

22-6

Configuration Examples for Static or Default Routes
Feature History for Static and Default Routes

CHAPTER

23

Defining Route Maps

22-4

22-8

22-8

23-1

Information About Route Maps 23-1
Permit and Deny Clauses 23-2
Match and Set Clause Values 23-2
Licensing Requirements for Route Maps
Guidelines and Limitations
Defining a Route Map

23-3

23-3

23-4

Customizing a Route Map 23-4
Defining a Route to Match a Specific Destination Address
Configuring the Metric Values for a Route Action 23-5
Configuration Example for Route Maps
Feature History for Route Maps

CHAPTER

24

Configuring OSPF

23-6

23-6

24-1

Information About OSPF

24-1

Licensing Requirements for OSPF
Guidelines and Limitations
Configuring OSPF

23-4

24-2

24-3

24-3

Customizing OSPF 24-4
Redistributing Routes Into OSPF 24-4
Configuring Route Summarization When Redistributing Routes Into OSPF
Configuring Route Summarization Between OSPF Areas 24-7
Configuring OSPF Interface Parameters 24-8

24-6

Cisco ASA 5500 Series Configuration Guide using the CLI

xvii

Contents

Configuring OSPF Area Parameters 24-10
Configuring OSPF NSSA 24-11
Defining Static OSPF Neighbors 24-12
Configuring Route Calculation Timers 24-13
Logging Neighbors Going Up or Down 24-13
Restarting the OSPF Process

24-14

Configuration Example for OSPF
Monitoring OSPF

24-16

Feature History for OSPF

CHAPTER

25

Configuring RIP

24-14

24-17

25-1

Information About RIP 25-1
Routing Update Process 25-2
RIP Routing Metric 25-2
RIP Stability Features 25-2
RIP Timers 25-2
Licensing Requirements for RIP
Guidelines and Limitations

25-3

25-3

Configuring RIP 25-4
Enabling RIP 25-4
Customizing RIP 25-4
Configuring the RIP Version 25-5
Configuring Interfaces for RIP 25-6
Configuring the RIP Send and Receive Version on an Interface
Configuring Route Summarization 25-7
Filtering Networks in RIP 25-8
Redistributing Routes into the RIP Routing Process 25-8
Enabling RIP Authentication 25-9
. Restarting the RIP Process 25-10
Monitoring RIP

25-11

Configuration Example for RIP
Feature History for RIP

CHAPTER

26

25-11

25-11

Configuring Multicast Routing

26-1

Information About Multicast Routing
Stub Multicast Routing 26-2
PIM Multicast Routing 26-2
Multicast Group Concept 26-2
Cisco ASA 5500 Series Configuration Guide using the CLI

xviii

26-1

25-6

Contents

Multicast Addresses

26-2

Licensing Requirements for Multicast Routing
Guidelines and Limitations

26-3

Enabling Multicast Routing

26-3

26-2

Customizing Multicast Routing 26-4
Configuring Stub Multicast Routing and Forwarding IGMP Messages
Configuring a Static Multicast Route 26-4
Configuring IGMP Features 26-5
Disabling IGMP on an Interface 26-6
Configuring IGMP Group Membership 26-6
Configuring a Statically Joined IGMP Group 26-6
Controlling Access to Multicast Groups 26-7
Limiting the Number of IGMP States on an Interface 26-7
Modifying the Query Messages to Multicast Groups 26-8
Changing the IGMP Version 26-9
Configuring PIM Features 26-9
Enabling and Disabling PIM on an Interface 26-10
Configuring a Static Rendezvous Point Address 26-10
Configuring the Designated Router Priority 26-11
Configuring and Filtering PIM Register Messages 26-11
Configuring PIM Message Intervals 26-12
Filtering PIM Neighbors 26-12
Configuring a Bidirectional Neighbor Filter 26-13
Configuring a Multicast Boundary 26-14
Configuration Example for Multicast Routing

26-4

26-14

Additional References 26-15
Related Documents 26-15
RFCs 26-15
Feature History for Multicast Routing

CHAPTER

27

Configuring EIGRP

27-1

Information About EIGRP

27-1

Licensing Requirements for EIGRP
Guidelines and Limitations

27-2

27-2

Configuring EIGRP 27-3
Enabling EIGRP 27-3
Enabling EIGRP Stub Routing
Customizing EIGRP

26-15

27-3

27-4

Cisco ASA 5500 Series Configuration Guide using the CLI

xix

Contents

Defining a Network for an EIGRP Routing Process 27-5
Configuring Interfaces for EIGRP 27-6
Configuring Passive Interfaces 27-7
Configuring the Summary Aggregate Addresses on Interfaces
Changing the Interface Delay Value 27-9
Enabling EIGRP Authentication on an Interface 27-9
Defining an EIGRP Neighbor 27-10
Redistributing Routes Into EIGRP 27-11
Filtering Networks in EIGRP 27-12
Customizing the EIGRP Hello Interval and Hold Time 27-13
Disabling Automatic Route Summarization 27-14
Configuring Default Information in EIGRP 27-15
Disabling EIGRP Split Horizon 27-16
Restarting the EIGRP Process 27-17
Monitoring EIGRP

27-17

Configuration Example for EIGRP
Feature History for EIGRP

CHAPTER

28

27-18

27-19

Configuring IPv6 Neighbor Discovery

28-1

Information About IPv6 Neighbor Discovery 28-1
Neighbor Solicitation Messages 28-2
Neighbor Reachable Time 28-3
Router Advertisement Messages 28-3
Static IPv6 Neighbors 28-4
Licensing Requirements for IPv6 Neighbor Discovery
Guidelines and Limitations

28-4

28-4

Default Settings for IPv6 Neighbor Discovery

28-6

Configuring the Neighbor Solicitation Message Interval
Configuring the Neighbor Reachable Time

28-7

28-7

Configuring the Router Advertisement Transmission Interval
Configuring the Router Lifetime Value
Configuring DAD Settings

28-8

28-9

Configuring IPv6 Addresses on an Interface
Suppressing Router Advertisement Messages
Configuring the IPv6 Prefix

28-11

Configuring a Static IPv6 Neighbor
Monitoring IPv6 Neighbor Discovery

Cisco ASA 5500 Series Configuration Guide using the CLI

xx

28-12
28-13

28-9
28-10

28-8

27-8

Contents

Additional References 28-13
Related Documents for IPv6 Prefixes 28-14
RFCs for IPv6 Prefixes and Documentation 28-14
Feature History for IPv6 Neighbor Discovery

PART

Configuring Network Address Translation

7

CHAPTER

28-14

29

Information About NAT
Why Use NAT?

29-1

29-1

NAT Terminology

29-2

NAT Types 29-3
NAT Types Overview 29-3
Static NAT 29-3
Information About Static NAT 29-3
Information About Static NAT with Port Translation 29-4
Information About One-to-Many Static NAT 29-6
Information About Other Mapping Scenarios (Not Recommended)
Dynamic NAT 29-8
Information About Dynamic NAT 29-9
Dynamic NAT Disadvantages and Advantages 29-10
Dynamic PAT 29-10
Information About Dynamic PAT 29-10
Dynamic PAT Disadvantages and Advantages 29-11
Identity NAT 29-11

29-7

NAT in Routed and Transparent Mode 29-12
NAT in Routed Mode 29-13
NAT in Transparent Mode 29-13
NAT for VPN

29-14

How NAT is Implemented 29-16
Main Differences Between Network Object NAT and Twice NAT
Information About Network Object NAT 29-17
Information About Twice NAT 29-17
NAT Rule Order

29-20

NAT Interfaces

29-21

Routing NAT Packets 29-21
Mapped Addresses and Routing 29-22
Transparent Mode Routing Requirements for Remote Networks
Determining the Egress Interface 29-24

29-16

29-24

Cisco ASA 5500 Series Configuration Guide using the CLI

xxi

Contents

DNS and NAT

29-24

Where to Go Next

CHAPTER

30

29-27

Configuring Network Object NAT

30-1

Information About Network Object NAT

30-1

Licensing Requirements for Network Object NAT
Prerequisites for Network Object NAT
Guidelines and Limitations
Default Settings

30-2

30-2

30-2

30-3

Configuring Network Object NAT 30-3
Configuring Dynamic NAT 30-4
Configuring Dynamic PAT (Hide) 30-6
Configuring Static NAT or Static NAT-with-Port-Translation
Configuring Identity NAT 30-12
Monitoring Network Object NAT

30-10

30-14

Configuration Examples for Network Object NAT 30-15
Providing Access to an Inside Web Server (Static NAT) 30-15
NAT for Inside Hosts (Dynamic NAT) and NAT for an Outside Web Server (Static NAT) 30-16
Inside Load Balancer with Multiple Mapped Addresses (Static NAT, One-to-Many) 30-17
Single Address for FTP, HTTP, and SMTP (Static NAT-with-Port-Translation) 30-18
DNS Server on Mapped Interface, Web Server on Real Interface (Static NAT with DNS
Modification) 30-19
DNS Server and Web Server on Mapped Interface, Web Server is Translated (Static NAT with DNS
Modification) 30-21
Feature History for Network Object NAT

CHAPTER

31

Configuring Twice NAT

31-1

Information About Twice NAT

31-1

Licensing Requirements for Twice NAT
Prerequisites for Twice NAT
Guidelines and Limitations
Default Settings

30-22

31-2

31-2
31-2

31-3

Configuring Twice NAT 31-3
Configuring Dynamic NAT 31-4
Configuring Dynamic PAT (Hide) 31-8
Configuring Static NAT or Static NAT-with-Port-Translation
Configuring Identity NAT 31-20
Monitoring Twice NAT

31-24

Cisco ASA 5500 Series Configuration Guide using the CLI

xxii

31-15

Contents

Configuration Examples for Twice NAT 31-24
Different Translation Depending on the Destination (Dynamic PAT) 31-24
Different Translation Depending on the Destination Address and Port (Dynamic PAT)
Feature History for Twice NAT

PART

31-28

Configuring Service Policies Using the Modular Policy Framework

8

CHAPTER

31-26

32

Configuring a Service Policy Using the Modular Policy Framework

32-1

Information About Service Policies 32-1
Supported Features for Through Traffic 32-2
Supported Features for Management Traffic 32-2
Feature Directionality 32-2
Feature Matching Within a Service Policy 32-3
Order in Which Multiple Feature Actions are Applied 32-4
Incompatibility of Certain Feature Actions 32-5
Feature Matching for Multiple Service Policies 32-6
Licensing Requirements for Service Policies
Guidelines and Limitations

32-6

32-6

Default Settings 32-7
Default Configuration 32-7
Default Class Maps 32-8
Task Flows for Configuring Service Policies 32-9
Task Flow for Using the Modular Policy Framework 32-9
Task Flow for Configuring Hierarchical Policy Maps for QoS Traffic Shaping

32-11

Identifying Traffic (Layer 3/4 Class Maps) 32-12
Creating a Layer 3/4 Class Map for Through Traffic 32-12
Creating a Layer 3/4 Class Map for Management Traffic 32-14
Defining Actions (Layer 3/4 Policy Map)

32-15

Applying Actions to an Interface (Service Policy)
Monitoring Modular Policy Framework

32-17

32-18

Configuration Examples for Modular Policy Framework 32-18
Applying Inspection and QoS Policing to HTTP Traffic 32-19
Applying Inspection to HTTP Traffic Globally 32-19
Applying Inspection and Connection Limits to HTTP Traffic to Specific Servers
Applying Inspection to HTTP Traffic with NAT 32-21
Feature History for Service Policies

32-20

32-21

Cisco ASA 5500 Series Configuration Guide using the CLI

xxiii

Contents

CHAPTER

33

Configuring Special Actions for Application Inspections (Inspection Policy Map)
Information About Inspection Policy Maps
Guidelines and Limitations

PART

33-2

Defining Actions in an Inspection Policy Map

33-2

Identifying Traffic in an Inspection Class Map

33-6

33-7

Configuring Access Control

9

CHAPTER

33-1

33-2

Default Inspection Policy Maps

Where to Go Next

33-1

34

Configuring Access Rules

34-1

Information About Access Rules 34-1
General Information About Rules 34-2
Implicit Permits 34-2
Information About Interface Access Rules and Global Access Rules 34-2
Using Access Rules and EtherType Rules on the Same Interface 34-2
Implicit Deny 34-3
Inbound and Outbound Rules 34-3
Information About Extended Access Rules 34-4
Access Rules for Returning Traffic 34-4
Allowing Broadcast and Multicast Traffic through the Transparent Firewall Using Access
Rules 34-5
Management Access Rules 34-5
Information About EtherType Rules 34-5
Supported EtherTypes and Other Traffic 34-6
Access Rules for Returning Traffic 34-6
Allowing MPLS 34-6
Licensing Requirements for Access Rules
Prerequisites

34-6

34-7

Guidelines and Limitations
Default Settings

34-7

34-7

Configuring Access Rules

34-7

Monitoring Access Rules

34-8

Configuration Examples for Permitting or Denying Network Access
Feature History for Access Rules

Cisco ASA 5500 Series Configuration Guide using the CLI

xxiv

34-10

34-9

Contents

CHAPTER

35

Configuring AAA Servers and the Local Database

35-1

Information About AAA 35-1
Information About Authentication 35-2
Information About Authorization 35-2
Information About Accounting 35-3
Summary of Server Support 35-3
RADIUS Server Support 35-4
Authentication Methods 35-4
Attribute Support 35-4
RADIUS Authorization Functions 35-5
TACACS+ Server Support 35-5
RSA/SDI Server Support 35-5
RSA/SDI Version Support 35-5
Two-step Authentication Process 35-5
RSA/SDI Primary and Replica Servers 35-6
NT Server Support 35-6
Kerberos Server Support 35-6
LDAP Server Support 35-6
Authentication with LDAP 35-6
LDAP Server Types 35-7
HTTP Forms Authentication for Clientless SSL VPN 35-8
Local Database Support, Including as a Falback Method 35-8
How Fallback Works with Multiple Servers in a Group 35-8
Using Certificates and User Login Credentials 35-9
Using User Login Credentials 35-9
Using Certificates 35-9
Licensing Requirements for AAA Servers
Guidelines and Limitations

35-10

35-10

Configuring AAA 35-10
Task Flow for Configuring AAA 35-11
Configuring AAA Server Groups
35-11
Configuring Authorization with LDAP for VPN 35-16
Configuring LDAP Attribute Maps
35-18
Adding a User Account to the Local Database
35-20
Guidelines 35-20
Limitations 35-21
Managing User Passwords 35-25
.Changing User Passwords 35-27
Authenticating Users with a Public Key for SSH 35-28
Cisco ASA 5500 Series Configuration Guide using the CLI

xxv

Contents

Differentiating User Roles Using AAA 35-28
Using Local Authentication 35-28
Using RADIUS Authentication 35-29
Using LDAP Authentication 35-29
Using TACACS+ Authentication 35-30
Monitoring AAA Servers
Additional References
RFCs 35-31

35-30
35-31

Feature History for AAA Servers

CHAPTER

36

Configuring the Identity Firewall

35-31

36-1

Information About the Identity Firewall 36-1
Overview of the Identity Firewall 36-1
Architecture for Identity Firewall Deployments 36-2
Features of the Identity Firewall 36-3
Deployment Scenarios 36-4
Cut-through Proxy and VPN Authentication 36-7
Licensing for the Identity Firewall
Guidelines and Limitations
Prerequisites

36-8

36-8

36-9

Configuring the Identity Firewall

36-10

Task Flow for Configuring the Identity Firewall 36-10
Configuring the Active Directory Domain 36-11
Configuring Active Directory Agents 36-13
Configuring Identity Options 36-14
Configuring Identity-based Access Rules 36-20
Configuring Cut-through Proxy Authentication 36-22
Configuring VPN Authentication 36-24
Monitoring the Identity Firewall 36-25
Monitoring AD Agents 36-26
Monitoring Groups 36-26
Monitoring Memory Usage for the Identity Firewall
Monitoring Users for the Identity Firewall 36-27
Feature History for the Identity Firewall

CHAPTER

37

Configuring Management Access

36-26

36-28

37-1

Configuring ASA Access for ASDM, Telnet, or SSH
37-1
Licensing Requirements for ASA Access for ASDM, Telnet, or SSH
Cisco ASA 5500 Series Configuration Guide using the CLI

xxvi

37-2

Contents

Guidelines and Limitations 37-2
Configuring Telnet Access 37-3
Using a Telnet Client 37-4
Configuring SSH Access 37-4
Using an SSH Client 37-5
Configuring HTTPS Access for ASDM

37-6

Configuring CLI Parameters 37-6
Licensing Requirements for CLI Parameters
Guidelines and Limitations 37-7
Configuring a Login Banner 37-7
Customizing a CLI Prompt 37-8
Changing the Console Timeout 37-9
Configuring ICMP Access 37-10
Information About ICMP Access 37-10
Licensing Requirements for ICMP Access
Guidelines and Limitations 37-10
Default Settings 37-11
Configuring ICMP Access 37-11

37-7

37-10

Configuring Management Access Over a VPN Tunnel 37-12
Licensing Requirements for a Management Interface 37-12
Guidelines and Limitations 37-12
Configuring a Management Interface 37-13
Configuring AAA for System Administrators 37-13
Information About AAA for System Administrators 37-14
Information About Management Authentication 37-14
Information About Command Authorization 37-14
Licensing Requirements for AAA for System Administrators 37-17
Prerequisites 37-17
Guidelines and Limitations 37-18
Default Settings 37-18
Configuring Authentication for CLI and ASDM Access 37-19
Configuring Authentication to Access Privileged EXEC Mode (the enable Command)
Configuring Authentication for the enable Command 37-20
Authenticating Users with the login Command 37-20
Limiting User CLI and ASDM Access with Management Authorization 37-21
Configuring Command Authorization 37-22
Configuring Local Command Authorization 37-23
Viewing Local Command Privilege Levels 37-26
Configuring Commands on the TACACS+ Server 37-26

37-19

Cisco ASA 5500 Series Configuration Guide using the CLI

xxvii

Contents

Configuring TACACS+ Command Authorization 37-29
Configuring Management Access Accounting 37-30
Viewing the Currently Logged-In User 37-30
Recovering from a Lockout 37-31
Setting a Management Session Quota 37-32
Feature History for Management Access

CHAPTER

38

37-33

Configuring AAA Rules for Network Access
AAA Performance

38-1

38-1

Licensing Requirements for AAA Rules
Guidelines and Limitations

38-1

38-2

Configuring Authentication for Network Access 38-2
Information About Authentication 38-2
One-Time Authentication 38-2
Applications Required to Receive an Authentication Challenge 38-2
ASA Authentication Prompts 38-3
Static PAT and HTTP 38-4
Configuring Network Access Authentication 38-4
Enabling Secure Authentication of Web Clients 38-6
Authenticating Directly with the ASA 38-7
Authenticating HTTP(S) Connections with a Virtual Server 38-8
Authenticating Telnet Connections with a Virtual Server 38-9
Configuring Authorization for Network Access 38-11
Configuring TACACS+ Authorization 38-11
Configuring RADIUS Authorization 38-14
Configuring a RADIUS Server to Send Downloadable Access Control Lists 38-14
Configuring a RADIUS Server to Download Per-User Access Control List Names 38-18
Configuring Accounting for Network Access

38-18

Using MAC Addresses to Exempt Traffic from Authentication and Authorization
Feature History for AAA Rules

CHAPTER

39

Configuring Filtering Services

38-21

39-1

Information About Web Traffic Filtering

39-1

Configuring ActiveX Filtering 39-2
Information About ActiveX Filtering

39-2

Licensing Requirements for ActiveX Filtering 39-2
Guidelines and Limitations for ActiveX Filtering
Configuring ActiveX Filtering 39-3
Cisco ASA 5500 Series Configuration Guide using the CLI

xxviii

39-3

38-20

Contents

Configuration Examples for ActiveX Filtering
Feature History for ActiveX Filtering 39-4

39-3

Configuring Java Applet Filtering 39-4
Information About Java Applet Filtering 39-4
Licensing Requirements for Java Applet Filtering 39-4
Guidelines and Limitations for Java Applet Filtering 39-5
Configuring Java Applet Filtering 39-5
Configuration Examples for Java Applet Filtering 39-5
Feature History for Java Applet Filtering 39-6
Filtering URLs and FTP Requests with an External Server 39-6
Information About URL Filtering 39-6
Licensing Requirements for URL Filtering 39-7
Guidelines and Limitations for URL Filtering 39-7
Identifying the Filtering Server 39-8
Configuring Additional URL Filtering Settings 39-10
Buffering the Content Server Response 39-10
Caching Server Addresses 39-11
Filtering HTTP URLs 39-11
Filtering HTTPS URLs 39-13
Filtering FTP Requests 39-14
Monitoring Filtering Statistics 39-15
Feature History for URL Filtering 39-17

CHAPTER

40

Configuring Web Cache Services Using WCCP
Information About WCCP
Guidelines and Limitations

40-1
40-1

Licensing Requirements for WCCP
Enabling WCCP Redirection

CHAPTER

41

40-2

40-3

WCCP Monitoring Commands
Feature History for WCCP

40-1

40-4

40-4

Configuring Digital Certificates

41-1

Information About Digital Certificates
Public Key Cryptography 41-2
Certificate Scalability 41-2
Key Pairs 41-2
Trustpoints 41-3
Certificate Enrollment 41-3

41-1

Cisco ASA 5500 Series Configuration Guide using the CLI

xxix

Contents

Proxy for SCEP Requests 41-3
Revocation Checking 41-4
Supported CA Servers 41-4
CRLs 41-4
OCSP 41-5
The Local CA 41-6
Storage for Local CA Files 41-6
The Local CA Server 41-6
Licensing Requirements for Digital Certificates
Prerequisites for Local Certificates 41-7
Prerequisites for SCEP Proxy Support
Guidelines and Limitations

41-7

41-7

41-8

Configuring Digital Certificates 41-9
Configuring Key Pairs 41-9
Removing Key Pairs 41-10
Configuring Trustpoints 41-10
Configuring CRLs for a Trustpoint 41-13
Exporting a Trustpoint Configuration 41-15
Importing a Trustpoint Configuration 41-16
Configuring CA Certificate Map Rules 41-17
Obtaining Certificates Manually 41-18
Obtaining Certificates Automatically with SCEP 41-20
Configuring Proxy Support for SCEP Requests 41-21
Enabling the Local CA Server 41-22
Configuring the Local CA Server 41-23
Customizing the Local CA Server 41-25
Debugging the Local CA Server 41-26
Disabling the Local CA Server 41-26
Deleting the Local CA Server 41-26
Configuring Local CA Certificate Characteristics 41-27
Configuring the Issuer Name 41-28
Configuring the CA Certificate Lifetime 41-28
Configuring the User Certificate Lifetime 41-29
Configuring the CRL Lifetime 41-30
Configuring the Server Keysize 41-30
Setting Up External Local CA File Storage 41-31
Downloading CRLs 41-33
Storing CRLs 41-34
Setting Up Enrollment Parameters 41-35

Cisco ASA 5500 Series Configuration Guide using the CLI

xxx

Contents

Adding and Enrolling Users 41-36
Renewing Users 41-38
Restoring Users 41-39
Removing Users 41-39
Revoking Certificates 41-40
Maintaining the Local CA Certificate Database 41-40
Rolling Over Local CA Certificates 41-40
Archiving the Local CA Server Certificate and Keypair 41-41
Monitoring Digital Certificates

41-41

Feature History for Certificate Management

PART

Configuring Application Inspection

10

CHAPTER

41-43

42

Getting Started with Application Layer Protocol Inspection
Information about Application Layer Protocol Inspection
How Inspection Engines Work 42-1
When to Use Application Protocol Inspection 42-2
Guidelines and Limitations
Default Settings

43

42-1

42-3

42-4

Configuring Application Layer Protocol Inspection

CHAPTER

42-1

Configuring Inspection of Basic Internet Protocols

42-6

43-1

DNS Inspection 43-1
How DNS Application Inspection Works 43-2
How DNS Rewrite Works 43-2
Configuring DNS Rewrite 43-3
Configuring DNS Rewrite with Two NAT Zones 43-4
Overview of DNS Rewrite with Three NAT Zones 43-4
Configuring DNS Rewrite with Three NAT Zones 43-6
Configuring a DNS Inspection Policy Map for Additional Inspection Control
Verifying and Monitoring DNS Inspection 43-10
FTP Inspection 43-11
FTP Inspection Overview 43-11
Using the strict Option 43-11
Configuring an FTP Inspection Policy Map for Additional Inspection Control
Verifying and Monitoring FTP Inspection 43-16
HTTP Inspection 43-16
HTTP Inspection Overview

43-7

43-12

43-16

Cisco ASA 5500 Series Configuration Guide using the CLI

xxxi

Contents

Configuring an HTTP Inspection Policy Map for Additional Inspection Control
ICMP Inspection

43-17

43-20

ICMP Error Inspection

43-21

Instant Messaging Inspection 43-21
IM Inspection Overview 43-21
Configuring an Instant Messaging Inspection Policy Map for Additional Inspection Control
IP Options Inspection 43-24
IP Options Inspection Overview 43-25
Configuring an IP Options Inspection Policy Map for Additional Inspection Control
IPsec Pass Through Inspection 43-26
IPsec Pass Through Inspection Overview 43-27
Example for Defining an IPsec Pass Through Parameter Map
IPv6 Inspection 43-27
Configuring an IPv6 Inspection Policy Map

43-27

43-28

NetBIOS Inspection 43-28
NetBIOS Inspection Overview 43-28
Configuring a NetBIOS Inspection Policy Map for Additional Inspection Control
PPTP Inspection

CHAPTER

44

43-32

43-34

Configuring Inspection for Voice and Video Protocols
CTIQBE Inspection 44-1
CTIQBE Inspection Overview 44-1
Limitations and Restrictions 44-2
Verifying and Monitoring CTIQBE Inspection

44-1

44-2

H.323 Inspection 44-3
H.323 Inspection Overview 44-4
How H.323 Works 44-4
H.239 Support in H.245 Messages 44-5
Limitations and Restrictions 44-5
Configuring an H.323 Inspection Policy Map for Additional Inspection Control
Configuring H.323 and H.225 Timeout Values 44-9
Verifying and Monitoring H.323 Inspection 44-9
Monitoring H.225 Sessions 44-9
Monitoring H.245 Sessions 44-10
Cisco ASA 5500 Series Configuration Guide using the CLI

xxxii

43-29

43-30

SMTP and Extended SMTP Inspection 43-31
SMTP and ESMTP Inspection Overview 43-31
Configuring an ESMTP Inspection Policy Map for Additional Inspection Control
TFTP Inspection

43-25

44-6

43-21

Contents

Monitoring H.323 RAS Sessions

44-10

MGCP Inspection 44-11
MGCP Inspection Overview 44-11
Configuring an MGCP Inspection Policy Map for Additional Inspection Control
Configuring MGCP Timeout Values 44-14
Verifying and Monitoring MGCP Inspection 44-14
RTSP Inspection 44-15
RTSP Inspection Overview 44-15
Using RealPlayer 44-16
Restrictions and Limitations 44-16
Configuring an RTSP Inspection Policy Map for Additional Inspection Control
SIP Inspection 44-19
SIP Inspection Overview 44-19
SIP Instant Messaging 44-19
Configuring a SIP Inspection Policy Map for Additional Inspection Control
Configuring SIP Timeout Values 44-24
Verifying and Monitoring SIP Inspection 44-24

44-13

44-16

44-20

Skinny (SCCP) Inspection 44-25
SCCP Inspection Overview 44-25
Supporting Cisco IP Phones 44-26
Restrictions and Limitations 44-26
Configuring a Skinny (SCCP) Inspection Policy Map for Additional Inspection Control
Verifying and Monitoring SCCP Inspection 44-28

CHAPTER

45

Configuring Inspection of Database and Directory Protocols
ILS Inspection

45-2

Sun RPC Inspection 45-3
Sun RPC Inspection Overview 45-3
Managing Sun RPC Services 45-4
Verifying and Monitoring Sun RPC Inspection
46

45-1

45-1

SQL*Net Inspection

CHAPTER

44-26

45-4

Configuring Inspection for Management Application Protocols

46-1

DCERPC Inspection 46-1
DCERPC Overview 46-1
Configuring a DCERPC Inspection Policy Map for Additional Inspection Control
GTP Inspection 46-3
GTP Inspection Overview

46-2

46-3

Cisco ASA 5500 Series Configuration Guide using the CLI

xxxiii

Contents

Configuring a GTP Inspection Policy Map for Additional Inspection Control
Verifying and Monitoring GTP Inspection 46-8

46-4

RADIUS Accounting Inspection 46-9
RADIUS Accounting Inspection Overview 46-9
Configuring a RADIUS Inspection Policy Map for Additional Inspection Control
RSH Inspection

46-11

SNMP Inspection 46-11
SNMP Inspection Overview 46-11
Configuring an SNMP Inspection Policy Map for Additional Inspection Control
XDMCP Inspection

PART

46-12

47

Information About Cisco Unified Communications Proxy Features

47-1

Information About the Adaptive Security Appliance in Cisco Unified Communications
TLS Proxy Applications in Cisco Unified Communications

47-3

Licensing for Cisco Unified Communications Proxy Features

CHAPTER

48

Configuring the Cisco Phone Proxy

47-4

48-1

Information About the Cisco Phone Proxy 48-1
Phone Proxy Functionality 48-1
Supported Cisco UCM and IP Phones for the Phone Proxy
Licensing Requirements for the Phone Proxy

48-3

48-4

Prerequisites for the Phone Proxy 48-6
Media Termination Instance Prerequisites 48-6
Certificates from the Cisco UCM 48-7
DNS Lookup Prerequisites 48-7
Cisco Unified Communications Manager Prerequisites 48-7
Access List Rules 48-7
NAT and PAT Prerequisites 48-8
Prerequisites for IP Phones on Multiple Interfaces 48-9
7960 and 7940 IP Phones Support 48-9
Cisco IP Communicator Prerequisites 48-10
Prerequisites for Rate Limiting TFTP Requests 48-11
Rate Limiting Configuration Example 48-11
About ICMP Traffic Destined for the Media Termination Address
End-User Phone Provisioning 48-12
Ways to Deploy IP Phones to End Users 48-12

Cisco ASA 5500 Series Configuration Guide using the CLI

xxxiv

46-11

Configuring Unified Communications

11

CHAPTER

46-10

48-11

47-1

Contents

Phone Proxy Guidelines and Limitations 48-12
General Guidelines and Limitations 48-13
Media Termination Address Guidelines and Limitations

48-14

Configuring the Phone Proxy 48-14
Task Flow for Configuring the Phone Proxy in a Non-secure Cisco UCM Cluster 48-15
Importing Certificates from the Cisco UCM 48-15
Task Flow for Configuring the Phone Proxy in a Mixed-mode Cisco UCM Cluster 48-17
Creating Trustpoints and Generating Certificates 48-17
Creating the CTL File 48-18
Using an Existing CTL File 48-20
Creating the TLS Proxy Instance for a Non-secure Cisco UCM Cluster 48-20
Creating the TLS Proxy for a Mixed-mode Cisco UCM Cluster 48-21
Creating the Media Termination Instance 48-22
Creating the Phone Proxy Instance 48-23
Enabling the Phone Proxy with SIP and Skinny Inspection 48-25
Configuring Linksys Routers with UDP Port Forwarding for the Phone Proxy 48-26
Configuring Your Router 48-27
Troubleshooting the Phone Proxy 48-27
Debugging Information from the Security Appliance 48-27
Debugging Information from IP Phones 48-31
IP Phone Registration Failure 48-32
TFTP Auth Error Displays on IP Phone Console 48-32
Configuration File Parsing Error 48-33
Configuration File Parsing Error: Unable to Get DNS Response 48-33
Non-configuration File Parsing Error 48-34
Cisco UCM Does Not Respond to TFTP Request for Configuration File 48-34
IP Phone Does Not Respond After the Security Appliance Sends TFTP Data 48-35
IP Phone Requesting Unsigned File Error 48-36
IP Phone Unable to Download CTL File 48-36
IP Phone Registration Failure from Signaling Connections 48-37
SSL Handshake Failure 48-39
Certificate Validation Errors 48-40
Media Termination Address Errors 48-40
Audio Problems with IP Phones 48-41
Saving SAST Keys 48-41
Configuration Examples for the Phone Proxy 48-43
Example 1: Nonsecure Cisco UCM cluster, Cisco UCM and TFTP Server on Publisher 48-43
Example 2: Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on Publisher 48-45
Example 3: Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on Different Servers 48-46

Cisco ASA 5500 Series Configuration Guide using the CLI

xxxv

Contents

Example 4: Mixed-mode Cisco UCM cluster, Primary Cisco UCM, Secondary and TFTP Server on
Different Servers 48-47
Example 5: LSC Provisioning in Mixed-mode Cisco UCM cluster; Cisco UCM and TFTP Server on
Publisher 48-49
Example 6: VLAN Transversal 48-51
Feature History for the Phone Proxy

CHAPTER

49

48-53

Configuring the TLS Proxy for Encrypted Voice Inspection

49-1

Information about the TLS Proxy for Encrypted Voice Inspection 49-1
Decryption and Inspection of Unified Communications Encrypted Signaling
CTL Client Overview 49-3
Licensing for the TLS Proxy

49-5

Prerequisites for the TLS Proxy for Encrypted Voice Inspection

49-7

Configuring the TLS Proxy for Encrypted Voice Inspection 49-7
Task flow for Configuring the TLS Proxy for Encrypted Voice Inspection
Creating Trustpoints and Generating Certificates 49-9
Creating an Internal CA 49-10
Creating a CTL Provider Instance 49-11
Creating the TLS Proxy Instance 49-12
Enabling the TLS Proxy Instance for Skinny or SIP Inspection 49-13
Monitoring the TLS Proxy

50

49-8

49-15

Feature History for the TLS Proxy for Encrypted Voice Inspection

CHAPTER

49-2

Configuring Cisco Mobility Advantage

50-1

Information about the Cisco Mobility Advantage Proxy Feature
Cisco Mobility Advantage Proxy Functionality 50-1
Mobility Advantage Proxy Deployment Scenarios 50-2
Mobility Advantage Proxy Using NAT/PAT 50-4
Trust Relationships for Cisco UMA Deployments 50-5
Licensing for the Cisco Mobility Advantage Proxy Feature
Configuring Cisco Mobility Advantage 50-6
Task Flow for Configuring Cisco Mobility Advantage
Installing the Cisco UMA Server Certificate 50-7
Creating the TLS Proxy Instance 50-8
Enabling the TLS Proxy for MMP Inspection 50-9
Monitoring for Cisco Mobility Advantage

49-17

50-1

50-6

50-7

50-10

Configuration Examples for Cisco Mobility Advantage 50-11
Example 1: Cisco UMC/Cisco UMA Architecture – Security Appliance as Firewall with TLS Proxy and
MMP Inspection 50-11
Cisco ASA 5500 Series Configuration Guide using the CLI

xxxvi

Contents

Example 2: Cisco UMC/Cisco UMA Architecture – Security Appliance as TLS Proxy Only
Feature History for Cisco Mobility Advantage

CHAPTER

51

Configuring Cisco Unified Presence

50-12

50-14

51-1

Information About Cisco Unified Presence 51-1
Architecture for Cisco Unified Presence for SIP Federation Deployments 51-1
Trust Relationship in the Presence Federation 51-4
Security Certificate Exchange Between Cisco UP and the Security Appliance 51-5
XMPP Federation Deployments 51-5
Configuration Requirements for XMPP Federation 51-6
Licensing for Cisco Unified Presence

51-7

Configuring Cisco Unified Presence Proxy for SIP Federation 51-8
Task Flow for Configuring Cisco Unified Presence Federation Proxy for SIP Federation
Creating Trustpoints and Generating Certificates 51-9
Installing Certificates 51-10
Creating the TLS Proxy Instance 51-12
Enabling the TLS Proxy for SIP Inspection 51-13
Monitoring Cisco Unified Presence

51-9

51-14

Configuration Example for Cisco Unified Presence 51-14
Example Configuration for SIP Federation Deployments 51-15
Example Access List Configuration for XMPP Federation 51-17
Example NAT Configuration for XMPP Federation 51-18
Feature History for Cisco Unified Presence

CHAPTER

52

51-20

Configuring Cisco Intercompany Media Engine Proxy

52-1

Information About Cisco Intercompany Media Engine Proxy 52-1
Features of Cisco Intercompany Media Engine Proxy 52-1
How the UC-IME Works with the PSTN and the Internet 52-2
Tickets and Passwords 52-3
Call Fallback to the PSTN 52-5
Architecture and Deployment Scenarios for Cisco Intercompany Media Engine
Architecture 52-5
Basic Deployment 52-6
Off Path Deployment 52-7
Licensing for Cisco Intercompany Media Engine
Guidelines and Limitations

52-5

52-8

52-9

Configuring Cisco Intercompany Media Engine Proxy 52-11
Task Flow for Configuring Cisco Intercompany Media Engine

52-11

Cisco ASA 5500 Series Configuration Guide using the CLI

xxxvii

Contents

Configuring NAT for Cisco Intercompany Media Engine Proxy 52-12
Configuring PAT for the Cisco UCM Server 52-14
Creating Access Lists for Cisco Intercompany Media Engine Proxy 52-16
Creating the Media Termination Instance 52-17
Creating the Cisco Intercompany Media Engine Proxy 52-18
Creating Trustpoints and Generating Certificates 52-21
Creating the TLS Proxy 52-24
Enabling SIP Inspection for the Cisco Intercompany Media Engine Proxy 52-25
(Optional) Configuring TLS within the Local Enterprise 52-27
(Optional) Configuring Off Path Signaling 52-30
Configuring the Cisco UC-IMC Proxy by using the UC-IME Proxy Pane 52-31
Configuring the Cisco UC-IMC Proxy by using the Unified Communications Wizard
Troubleshooting Cisco Intercompany Media Engine Proxy
Feature History for Cisco Intercompany Media Engine Proxy

PART

52-34
52-37

Configuring Connection Settings and QoS

12

CHAPTER

53

Configuring Connection Settings

53-1

Information About Connection Settings 53-1
TCP Intercept and Limiting Embryonic Connections 53-2
Disabling TCP Intercept for Management Packets for Clientless SSL Compatibility
Dead Connection Detection (DCD) 53-2
TCP Sequence Randomization 53-3
TCP Normalization 53-3
TCP State Bypass 53-3
Licensing Requirements for Connection Settings
Guidelines and Limitations 53-5
TCP State Bypass Guidelines and Limitations
Default Settings

53-4

53-5

53-5

Configuring Connection Settings 53-6
Task Flow For Configuring Configuration Settings (Except Global Timeouts)
Customizing the TCP Normalizer with a TCP Map 53-6
Configuring Connection Settings 53-10
Monitoring Connection Settings 53-14
Monitoring TCP State Bypass 53-14
Configuration Examples for Connection Settings 53-14
Configuration Examples for Connection Limits and Timeouts
Configuration Examples for TCP State Bypass 53-15

Cisco ASA 5500 Series Configuration Guide using the CLI

xxxviii

52-33

53-15

53-6

53-2

Contents

Configuration Examples for TCP Normalization
Feature History for Connection Settings

CHAPTER

54

Configuring QoS

53-15

53-16

54-1

Information About QoS 54-1
Supported QoS Features 54-2
What is a Token Bucket? 54-2
Information About Policing 54-3
Information About Priority Queuing 54-3
Information About Traffic Shaping 54-4
How QoS Features Interact 54-4
DSCP and DiffServ Preservation 54-5
Licensing Requirements for QoS
Guidelines and Limitations

54-5

54-5

Configuring QoS 54-6
Determining the Queue and TX Ring Limits for a Standard Priority Queue 54-6
Configuring the Standard Priority Queue for an Interface 54-7
Configuring a Service Rule for Standard Priority Queuing and Policing 54-9
Configuring a Service Rule for Traffic Shaping and Hierarchical Priority Queuing
(Optional) Configuring the Hierarchical Priority Queuing Policy 54-12
Configuring the Service Rule 54-13

54-12

Monitoring QoS 54-15
Viewing QoS Police Statistics 54-15
Viewing QoS Standard Priority Statistics 54-16
Viewing QoS Shaping Statistics 54-16
Viewing QoS Standard Priority Queue Statistics 54-17
Feature History for QoS

PART

Configuring Advanced Network Protection

13

CHAPTER

54-18

55

Configuring the Botnet Traffic Filter

55-1

Information About the Botnet Traffic Filter 55-1
Botnet Traffic Filter Address Types 55-2
Botnet Traffic Filter Actions for Known Addresses 55-2
Botnet Traffic Filter Databases 55-2
Information About the Dynamic Database 55-2
Information About the Static Database 55-3
Information About the DNS Reverse Lookup Cache and DNS Host Cache

55-4

Cisco ASA 5500 Series Configuration Guide using the CLI

xxxix

Contents

How the Botnet Traffic Filter Works

55-5

Licensing Requirements for the Botnet Traffic Filter
Guidelines and Limitations
Default Settings

55-6

55-6

55-6

Configuring the Botnet Traffic Filter 55-6
Task Flow for Configuring the Botnet Traffic Filter 55-7
Configuring the Dynamic Database 55-7
Adding Entries to the Static Database 55-9
Enabling DNS Snooping 55-10
Enabling Traffic Classification and Actions for the Botnet Traffic Filter
Blocking Botnet Traffic Manually 55-15
Searching the Dynamic Database 55-16
Monitoring the Botnet Traffic Filter 55-17
Botnet Traffic Filter Syslog Messaging 55-17
Botnet Traffic Filter Commands 55-17
Configuration Examples for the Botnet Traffic Filter
Recommended Configuration Example 55-19
Other Configuration Examples 55-20
Where to Go Next

55-21

Feature History for the Botnet Traffic Filter

CHAPTER

56

55-19

Configuring Threat Detection

55-22

56-1

Information About Threat Detection

56-1

Licensing Requirements for Threat Detection

56-1

Configuring Basic Threat Detection Statistics 56-2
Information About Basic Threat Detection Statistics 56-2
Guidelines and Limitations 56-3
Default Settings 56-3
Configuring Basic Threat Detection Statistics 56-4
Monitoring Basic Threat Detection Statistics 56-5
Feature History for Basic Threat Detection Statistics 56-6
Configuring Advanced Threat Detection Statistics 56-6
Information About Advanced Threat Detection Statistics 56-6
Guidelines and Limitations 56-6
Default Settings 56-7
Configuring Advanced Threat Detection Statistics 56-7
Monitoring Advanced Threat Detection Statistics 56-9
Feature History for Advanced Threat Detection Statistics 56-14
Cisco ASA 5500 Series Configuration Guide using the CLI

xl

55-12

Contents

Configuring Scanning Threat Detection 56-15
Information About Scanning Threat Detection 56-15
Guidelines and Limitations 56-16
Default Settings 56-16
Configuring Scanning Threat Detection 56-17
Monitoring Shunned Hosts, Attackers, and Targets 56-17
Feature History for Scanning Threat Detection 56-18
Configuration Examples for Threat Detection

CHAPTER

57

Using Protection Tools
Preventing IP Spoofing

57-1
57-1

Configuring the Fragment Size

57-2

Blocking Unwanted Connections

57-2

Configuring IP Audit for Basic IPS Support
Configuring IP Audit 57-3
IP Audit Signature List 57-4

PART

57-3

Configuring Modules

14

CHAPTER

56-19

58

Configuring the ASA IPS Module

58-1

Information About the ASA IPS module 58-1
How the ASA IPS module Works with the ASA 58-2
Operating Modes 58-2
Using Virtual Sensors (ASA 5510 and Higher) 58-3
Information About Management Access 58-4
Licensing Requirements for the ASA IPS module
Guidelines and Limitations
Default Settings

58-5

58-5

58-6

Configuring the ASA IPS module 58-6
Task Flow for the ASA IPS Module 58-7
Connecting Management Interface Cables 58-7
Sessioning to the Module from the ASA 58-9
Configuring Basic IPS Module Network Settings 58-10
(ASA 5510 and Higher) Configuring Basic Network Settings 58-10
(ASA 5505) Configuring Basic Network Settings 58-11
(ASA 5512-X through ASA 5555-X) Installing the Software Module 58-14
Configuring the Security Policy on the ASA IPS module 58-14
Assigning Virtual Sensors to a Security Context (ASA 5510 and Higher) 58-15

Cisco ASA 5500 Series Configuration Guide using the CLI

xli

Contents

Diverting Traffic to the ASA IPS module
Monitoring the ASA IPS module

58-17

58-20

Troubleshooting the ASA IPS module 58-21
Installing an Image on the Module 58-21
Uninstalling a Software Module Image 58-23
Resetting the Password 58-23
Reloading or Resetting the Module 58-24
Shutting Down the Module 58-24
Configuration Examples for the ASA IPS module
Feature History for the ASA IPS module

CHAPTER

59

Configuring the ASA CX Module

58-25

58-25

59-1

Information About the ASA CX Module 59-1
How the ASA CX Module Works with the ASA 59-2
Information About ASA CX Management 59-2
Initial Configuration 59-3
Policy Configuration and Management 59-3
Information About Authentication Proxy 59-3
Information About VPN and the ASA CX Module 59-4
Compatibility with ASA Features 59-4
Licensing Requirements for the ASA CX Module
Guidelines and Limitations
Default Settings

59-4

59-4

59-5

Configuring the ASA CX Module 59-5
Task Flow for the ASA CX Module 59-6
Connecting Management Interface Cables 59-6
Configuring the ASA CX Management IP Address 59-7
Configuring Basic ASA CX Settings at the ASA CX CLI 59-7
Configuring the Security Policy on the ASA CX Module Using PRSM
(Optional) Configuring the Authentication Proxy Port 59-10
Redirecting Traffic to the ASA CX Module 59-11
Monitoring the ASA CX Module 59-12
Showing Module Status 59-12
Showing Module Statistics 59-13
Monitoring Module Connections 59-14
Capturing Module Traffic 59-17
Troubleshooting the ASA CX Module 59-17
General Recovery Procedures 59-17

Cisco ASA 5500 Series Configuration Guide using the CLI

xlii

59-9

Contents

Resetting the Password 59-17
Reloading or Resetting the Module
Shutting Down the Module 59-19
Debugging the Module 59-19
Problems with the Authentication Proxy

59-18

59-20

Configuration Examples for the ASA CX Module
Feature History for the ASA CX Module

CHAPTER

60

Configuring the ASA CSC Module

59-21

59-22

60-1

Information About the CSC SSM 60-1
Determining What Traffic to Scan 60-3
Licensing Requirements for the CSC SSM
Prerequisites for the CSC SSM
Guidelines and Limitations
Default Settings

60-5

60-5

60-6

60-6

Configuring the CSC SSM 60-7
Before Configuring the CSC SSM 60-7
Connecting to the CSC SSM 60-8
Diverting Traffic to the CSC SSM 60-10
Monitoring the CSC SSM

60-13

Troubleshooting the CSC Module 60-14
Installing an Image on the Module 60-14
Resetting the Password 60-15
Reloading or Resetting the Module 60-16
Shutting Down the Module 60-16
Configuration Examples for the CSC SSM
Where to Go Next

60-18

Additional References

60-18

Feature History for the CSC SSM

PART

60-18

Configuring High Availability

15

CHAPTER

60-16

61

Information About High Availability

61-1

Introduction to Failover and High Availability

61-1

Failover System Requirements 61-2
Hardware Requirements 61-2
Software Requirements 61-2

Cisco ASA 5500 Series Configuration Guide using the CLI

xliii

Contents

License Requirements

61-2

Failover and Stateful Failover Links 61-3
Failover Link 61-3
Stateful Failover Link 61-4
Failover Interface Speed for Stateful Links
Avoiding Interrupted Failover Links 61-5

61-5

Active/Active and Active/Standby Failover 61-8
Determining Which Type of Failover to Use 61-8
Stateless (Regular) and Stateful Failover
Stateless (Regular) Failover 61-9
Stateful Failover 61-10
Transparent Firewall Mode Requirements

61-9

61-11

Auto Update Server Support in Failover Configurations
Auto Update Process Overview 61-12
Monitoring the Auto Update Process 61-13

61-12

Failover Health Monitoring 61-14
Unit Health Monitoring 61-14
Interface Monitoring 61-15
Failover Times

61-16

Failover Messages 61-16
Failover System Messages
Debug Messages 61-16
SNMP 61-17

CHAPTER

62

61-16

Configuring Active/Standby Failover

62-1

Information About Active/Standby Failover 62-1
Active/Standby Failover Overview 62-1
Primary/Secondary Status and Active/Standby Status 62-2
Device Initialization and Configuration Synchronization 62-2
Command Replication 62-3
Failover Triggers 62-4
Failover Actions 62-4
Optional Active/Standby Failover Settings 62-6
Licensing Requirements for Active/Standby Failover
Prerequisites for Active/Standby Failover
Guidelines and Limitations

62-6

62-6

Configuring Active/Standby Failover 62-7
Task Flow for Configuring Active/Standby Failover
Cisco ASA 5500 Series Configuration Guide using the CLI

xliv

62-6

62-8

Contents

Configuring the Primary Unit 62-8
Configuring the Secondary Unit 62-11
Configuring Optional Active/Standby Failover Settings 62-12
Enabling HTTP Replication with Stateful Failover 62-13
Disabling and Enabling Interface Monitoring 62-13
Configuring Failover Criteria 62-14
Configuring the Unit and Interface Health Poll Times 62-14
Configuring Virtual MAC Addresses 62-15
Controlling Failover 62-16
Forcing Failover 62-16
Disabling Failover 62-17
Restoring a Failed Unit 62-17
Testing the Failover Functionality
Monitoring Active/Standby Failover

62-17
62-18

Feature History for Active/Standby Failover

CHAPTER

63

Configuring Active/Active Failover

62-18

63-1

Information About Active/Active Failover 63-1
Active/Active Failover Overview 63-1
Primary/Secondary Status and Active/Standby Status 63-2
Device Initialization and Configuration Synchronization 63-3
Command Replication 63-3
Failover Triggers 63-4
Failover Actions 63-5
Optional Active/Active Failover Settings 63-6
Licensing Requirements for Active/Active Failover
Prerequisites for Active/Active Failover
Guidelines and Limitations

63-6

63-7

63-7

Configuring Active/Active Failover 63-8
Task Flow for Configuring Active/Active Failover 63-8
Configuring the Primary Failover Unit 63-8
Configuring the Secondary Failover Unit 63-11
Configuring Optional Active/Active Failover Settings 63-12
Configuring Failover Group Preemption 63-12
Enabling HTTP Replication with Stateful Failover 63-14
Disabling and Enabling Interface Monitoring 63-14
Configuring Interface Health Monitoring 63-15
Configuring Failover Criteria 63-16
Configuring Virtual MAC Addresses 63-16
Cisco ASA 5500 Series Configuration Guide using the CLI

xlv

Contents

Configuring Support for Asymmetrically Routed Packets
Remote Command Execution 63-21
Changing Command Modes 63-22
Security Considerations 63-23
Limitations of Remote Command Execution

63-18

63-23

Controlling Failover 63-23
Forcing Failover 63-23
Disabling Failover 63-24
Restoring a Failed Unit or Failover Group 63-24
Testing the Failover Functionality 63-24
Monitoring Active/Active Failover

63-25

Feature History for Active/Active Failover

PART

Configuring VPN

16

CHAPTER

63-25

64

Configuring IPsec and ISAKMP

64-1

Information About Tunneling, IPsec, and ISAKMP
IPsec Overview 64-2
ISAKMP and IKE Overview 64-2

64-1

Licensing Requirements for Remote Access IPsec VPNs
Guidelines and Limitations

64-3

64-8

Configuring ISAKMP 64-8
Configuring IKEv1 and IKEv2 Policies 64-9
Enabling IKE on the Outside Interface 64-13
Disabling IKEv1 Aggressive Mode 64-13
Determining an ID Method for IKEv1 and IKEv2 ISAKMP Peers 64-13
Enabling IPsec over NAT-T 64-14
Using NAT-T 64-15
Enabling IPsec with IKEv1 over TCP 64-15
Waiting for Active Sessions to Terminate Before Rebooting 64-16
Alerting Peers Before Disconnecting 64-16
Configuring Certificate Group Matching for IKEv1 64-17
Creating a Certificate Group Matching Rule and Policy 64-17
Using the Tunnel-group-map default-group Command 64-19
Configuring IPsec 64-19
Understanding IPsec Tunnels 64-19
Understanding IKEv1 Transform Sets and IKEv2 Proposals
Defining Crypto Maps 64-20

Cisco ASA 5500 Series Configuration Guide using the CLI

xlvi

64-19

Contents

Applying Crypto Maps to Interfaces 64-26
Using Interface Access Lists 64-26
Changing IPsec SA Lifetimes 64-29
Creating a Basic IPsec Configuration 64-29
Using Dynamic Crypto Maps 64-31
Providing Site-to-Site Redundancy 64-34
Viewing an IPsec Configuration 64-34
Clearing Security Associations

64-34

Clearing Crypto Map Configurations
Supporting the Nokia VPN Client

CHAPTER

65

Configuring L2TP over IPsec

64-35

64-35

65-1

Information About L2TP over IPsec/IKEv1 65-1
IPsec Transport and Tunnel Modes 65-2
Licensing Requirements for L2TP over IPsec

65-3

Prerequisites for Configuring L2TP over IPsec
Guidelines and Limitations

65-7

65-7

Configuring L2TP over IPsec 65-8
Configuration Example for L2TP over IPsec Using ASA 8.2.5 65-17
Configuration Example for L2TP over IPsec Using ASA 8.4.1 and later
Feature History for L2TP over IPsec

CHAPTER

66

Setting General VPN Parameters

65-18

66-1

Configuring VPNs in Single, Routed Mode
Configuring IPsec to Bypass ACLs

65-17

66-1

66-1

Permitting Intra-Interface Traffic (Hairpinning) 66-2
NAT Considerations for Intra-Interface Traffic 66-3
Setting Maximum Active IPsec or SSL VPN Sessions

66-3

Using Client Update to Ensure Acceptable IPsec Client Revision Levels
Understanding Load Balancing 66-6
Comparing Load Balancing to Failover
Load Balancing 66-7
Failover 66-7
Implementing Load Balancing 66-7
Prerequisites 66-8
Eligible Platforms 66-8
Eligible Clients 66-8
VPN Load-Balancing Algorithm 66-8

66-4

66-7

Cisco ASA 5500 Series Configuration Guide using the CLI

xlvii

Contents

VPN Load-Balancing Cluster Configurations 66-9
Some Typical Mixed Cluster Scenarios 66-10
Scenario 1: Mixed Cluster with No SSL VPN Connections 66-10
Scenario 2: Mixed Cluster Handling SSL VPN Connections 66-10
Configuring Load Balancing 66-11
Configuring the Public and Private Interfaces for Load Balancing 66-11
Configuring the Load Balancing Cluster Attributes 66-12
Enabling Redirection Using a Fully Qualified Domain Name 66-13
Frequently Asked Questions About Load Balancing 66-14
IP Address Pool Exhaustion 66-14
Unique IP Address Pools 66-14
Using Load Balancing and Failover on the Same Device 66-15
Load Balancing on Multiple Interfaces 66-15
Maximum Simultaneous Sessions for Load Balancing Clusters 66-15
Viewing Load Balancing 66-15
Configuring VPN Session Limits

CHAPTER

67

66-16

Configuring Connection Profiles, Group Policies, and Users
Overview of Connection Profiles, Group Policies, and Users

67-1
67-1

Connection Profiles 67-2
General Connection Profile Connection Parameters 67-3
IPsec Tunnel-Group Connection Parameters 67-4
Connection Profile Connection Parameters for SSL VPN Sessions

67-5

Configuring Connection Profiles 67-6
Maximum Connection Profiles 67-6
Default IPsec Remote Access Connection Profile Configuration 67-7
Configuring IPsec Tunnel-Group General Attributes 67-7
Configuring Remote-Access Connection Profiles 67-7
Specifying a Name and Type for the Remote Access Connection Profile 67-8
Configuring Remote-Access Connection Profile General Attributes 67-8
Configuring Double Authentication 67-12
Configuring Remote-Access Connection Profile IPsec IKEv1 Attributes 67-13
Configuring IPsec Remote-Access Connection Profile PPP Attributes 67-15
Configuring LAN-to-LAN Connection Profiles 67-17
Default LAN-to-LAN Connection Profile Configuration 67-17
Specifying a Name and Type for a LAN-to-LAN Connection Profile 67-17
Configuring LAN-to-LAN Connection Profile General Attributes 67-17
Configuring LAN-to-LAN IPsec IKEv1 Attributes 67-18
Configuring Connection Profiles for Clientless SSL VPN Sessions 67-20
Cisco ASA 5500 Series Configuration Guide using the CLI

xlviii

Contents

Configuring General Tunnel-Group Attributes for Clientless SSL VPN Sessions 67-20
Configuring Tunnel-Group Attributes for Clientless SSL VPN Sessions 67-23
Customizing Login Windows for Users of Clientless SSL VPN sessions 67-27
Configuring Microsoft Active Directory Settings for Password Management 67-28
Using Active Directory to Force the User to Change Password at Next Logon 67-29
Using Active Directory to Specify Maximum Password Age 67-30
Using Active Directory to Override an Account Disabled AAA Indicator 67-31
Using Active Directory to Enforce Minimum Password Length 67-32
Using Active Directory to Enforce Password Complexity 67-33
Configuring the Connection Profile for RADIUS/SDI Message Support for the AnyConnect
Client 67-34
AnyConnect Client and RADIUS/SDI Server Interaction 67-34
Configuring the Security Appliance to Support RADIUS/SDI Messages 67-35
Group Policies 67-36
Default Group Policy 67-37
Configuring Group Policies 67-39
Configuring an External Group Policy 67-39
Configuring an Internal Group Policy 67-40
Configuring Group Policy Attributes 67-40
Configuring WINS and DNS Servers 67-40
Configuring VPN-Specific Attributes 67-42
Configuring Security Attributes 67-46
Configuring the Banner Message 67-48
Configuring IPsec-UDP Attributes for IKEv1 67-49
Configuring Split-Tunneling Attributes 67-49
Configuring Domain Attributes for Tunneling 67-51
Configuring Attributes for VPN Hardware Clients 67-53
Configuring Backup Server Attributes 67-56
Configuring Browser Client Parameters 67-57
Configuring Network Admission Control Parameters 67-59
Configuring Address Pools 67-62
Configuring Firewall Policies 67-63
Supporting a Zone Labs Integrity Server 67-64
Overview of the Integrity Server and ASA Interaction 67-64
Configuring Integrity Server Support 67-65
Setting Client Firewall Parameters 67-66
Configuring Client Access Rules 67-68
Configuring Group-Policy Attributes for Clientless SSL VPN Sessions 67-70
Configuring Group-Policy Attributes for AnyConnect Secure Mobility Client Connections
Configuring User Attributes

67-77

67-79
Cisco ASA 5500 Series Configuration Guide using the CLI

xlix

Contents

Viewing the Username Configuration 67-79
Configuring Attributes for Specific Users 67-79
Setting a User Password and Privilege Level 67-80
Configuring User Attributes 67-80
Configuring VPN User Attributes 67-81
Configuring Clientless SSL VPN Access for Specific Users

CHAPTER

68

Configuring IP Addresses for VPNs

68-1

Configuring an IP Address Assignment Method
Configuring Local IP Address Pools 68-2
Configuring AAA Addressing 68-2
Configuring DHCP Addressing 68-3

CHAPTER

69

Configuring Remote Access IPsec VPNs

68-1

69-1

Information About Remote Access IPsec VPNs

69-1

Licensing Requirements for Remote Access IPsec VPNs
Guidelines and Limitations

67-85

69-2

69-7

Configuring Remote Access IPsec VPNs 69-7
Configuring Interfaces 69-7
Configuring ISAKMP Policy and Enabling ISAKMP on the Outside Interface
Configuring an Address Pool 69-9
Adding a User 69-10
Creating an IKEv1 Transform Set or IKEv2 Proposal 69-10
Defining a Tunnel Group 69-11
Creating a Dynamic Crypto Map 69-12
Creating a Crypto Map Entry to Use the Dynamic Crypto Map 69-13
Saving the Security Appliance Configuration 69-14
Configuration Examples for Remote Access IPsec VPNs
Feature History for Remote Access VPNs

CHAPTER

70

Configuring Network Admission Control

69-15

70-1

Information about Network Admission Control
Licensing Requirements
Prerequisites for NAC

70-1

70-2
70-4

Guidelines and Limitations

70-4

Viewing the NAC Policies on the Security Appliance
Adding, Accessing, or Removing a NAC Policy
Configuring a NAC Policy

70-8

Cisco ASA 5500 Series Configuration Guide using the CLI

l

69-14

70-7

70-5

69-8

Contents

Specifying the Access Control Server Group 70-8
Setting the Query-for-Posture-Changes Timer 70-9
Setting the Revalidation Timer 70-10
Configuring the Default ACL for NAC 70-10
Configuring Exemptions from NAC 70-11
Assigning a NAC Policy to a Group Policy

70-13

Changing Global NAC Framework Settings 70-13
Changing Clientless Authentication Settings 70-13
Enabling and Disabling Clientless Authentication 70-14
Changing the Login Credentials Used for Clientless Authentication
Changing NAC Framework Session Attributes 70-15

CHAPTER

71

Configuring Easy VPN Services on the ASA 5505

71-1

Specifying the Client/Server Role of the Cisco ASA 5505
Specifying the Primary and Secondary Servers
Specifying the Mode 71-3
NEM with Multiple Interfaces

71-1

71-2

71-3

Configuring Automatic Xauth Authentication
Configuring IPsec Over TCP

71-4

71-4

Comparing Tunneling Options

71-5

Specifying the Tunnel Group or Trustpoint
Specifying the Tunnel Group 71-7
Specifying the Trustpoint 71-7
Configuring Split Tunneling

71-6

71-8

Configuring Device Pass-Through

71-8

Configuring Remote Management

71-9

Guidelines for Configuring the Easy VPN Server 71-10
Group Policy and User Attributes Pushed to the Client
Authentication Options 71-12

CHAPTER

72

Configuring the PPPoE Client
PPPoE Client Overview

71-10

72-1

72-1

Configuring the PPPoE Client Username and Password
Enabling PPPoE

70-14

72-2

72-3

Using PPPoE with a Fixed IP Address

72-3

Monitoring and Debugging the PPPoE Client
Clearing the Configuration

72-4

72-5

Cisco ASA 5500 Series Configuration Guide using the CLI

li

Contents

Using Related Commands

CHAPTER

73

72-5

Configuring LAN-to-LAN IPsec VPNs
Summary of the Configuration
Configuring Interfaces

73-1

73-1

73-2

Configuring ISAKMP Policy and Enabling ISAKMP on the Outside Interface
Configuring ISAKMP Policies for IKEv1 Connections 73-4
Configuring ISAKMP Policies for IKEv2 Connections 73-4
Creating an IKEv1 Transform Set
Creating an IKEv2 Proposal
Configuring an ACL

73-5

73-6

73-7

Defining a Tunnel Group

73-7

Creating a Crypto Map and Applying It To an Interface
Applying Crypto Maps to Interfaces 73-10

CHAPTER

74

73-3

Configuring Clientless SSL VPN

74-1

Information About Clientless SSL VPN
Licensing Requirements

74-1

74-2

Prerequisites for Clientless SSL VPN
Guidelines and Limitations

73-9

74-4

74-4

Observing Clientless SSL VPN Security Precautions
Disabling URL on the Portal Page 74-6

74-5

Using SSL to Access the Central Site 74-6
Using HTTPS for Clientless SSL VPN Sessions 74-7
Configuring Clientless SSL VPN and ASDM Ports 74-7
Configuring Support for Proxy Servers 74-8
Configuring SSL/TLS Encryption Protocols 74-10
Authenticating with Digital Certificates 74-11
Enabling Cookies on Browsers for Clientless SSL VPN 74-11
Configuring Application Helper 74-11
Managing Passwords 74-12
Using Single Sign-on with Clientless SSL VPN 74-13
Configuring SSO with HTTP Basic or NTLM Authentication 74-14
Configuring SSO Authentication Using SiteMinder 74-15
Adding the Cisco Authentication Scheme to SiteMinder 74-16
Configuring SSO Authentication Using SAML Browser Post Profile 74-17
Configuring the SAML POST SSO Server 74-19
Configuring SSO with the HTTP Form Protocol 74-20
Cisco ASA 5500 Series Configuration Guide using the CLI

lii

Contents

Gathering HTTP Form Data 74-24
Configuring SSO for Plug-ins 74-28
Configuring SSO with Macro Substitution
Encoding 74-29
Authenticating with Digital Certificates

74-28

74-31

Creating and Applying Clientless SSL VPN Policies for Accessing Resources
Assigning Users to Group Policies 74-31
Using the Security Appliance Authentication Server
Using a RADIUS Server 74-31
Using an LDAP Server 74-32

74-31

74-31

Configuring Connection Profile Attributes for Clientless SSL VPN

74-32

Configuring Group Policy and User Attributes for Clientless SSL VPN

74-33

Configuring Browser Access to Plug-ins 74-34
Preparing the Security Appliance for a Plug-in 74-36
Installing Plug-ins Redistributed By Cisco 74-36
Providing Access to Third-Party Plug-ins 74-38
Configuring and Applying the POST URL 74-39
Providing Access to a Citrix Java Presentation Server 74-40
Preparing the Citrix MetraFrame Server for Clientless SSL VPN Access
Creating and Installing the Citrix Plug-in 74-40
Viewing the Plug-ins Installed on the Security Appliance 74-41
Why a Microsoft Kerberos Constrained Delegation Solution

74-40

74-41

Understanding How KCD Works 74-42
Authentication Flow with KCD 74-43
Before Configuring KCD 74-44
Configuring KCD 74-45
Showing KCD Status Information 74-46
Showing Cached Kerberos Tickets 74-47
Clearing Cached Kerberos Tickets 74-48
Configuring Application Access 74-48
Logging Off Smart TunnelConfiguring Smart Tunnel Access 74-48
About Smart Tunnels 74-49
Why Smart Tunnels? 74-49
Adding Applications to Be Eligible for Smart Tunnel Access 74-51
Assigning a Smart Tunnel List 74-55
Configuring and Applying Smart Tunnel Policy 74-56
Configuring and Applying a Smart Tunnel Tunnel Policy 74-57
Specifying Servers for Smart Tunnel Auto Sign-on 74-58
Adding or Editing a Smart Tunnel Auto Sign-on Server Entry 74-60
Cisco ASA 5500 Series Configuration Guide using the CLI

liii

Contents

Automating Smart Tunnel Access 74-61
Enabling and Disabling Smart Tunnel Access
Logging Off Smart Tunnel 74-63
When Its Parent Process Terminates 74-63
With A Notification Icon 74-64

74-62

Configuring Port Forwarding 74-64
Information About Port Forwarding 74-65
Configuring DNS for Port Forwarding 74-66
Adding Applications to Be Eligible for Port Forwarding
Assigning a Port Forwarding List 74-69
Automating Port Forwarding 74-70
Enabling and Disabling Port Forwarding 74-70

74-67

Application Access User Notes 74-71
Using Application Access on Vista 74-71
Closing Application Access to Prevent hosts File Errors 74-71
Recovering from hosts File Errors When Using Application Access 74-72
Understanding the hosts File 74-72
Stopping Application Access Improperly 74-73
Reconfiguring a Host’s File Automatically Using Clientless SSL VPN 74-73
Reconfiguring hosts File Manually 74-73
Configuring File Access 74-74
CIFS File Access Requirement and Limitation
Adding Support for File Access 74-75
Ensuring Clock Accuracy for SharePoint Access
Using Clientless SSL VPN with PDAs

74-75

74-78

74-78

Using E-Mail over Clientless SSL VPN 74-79
Configuring E-mail Proxies 74-79
Configuring Web E-mail: MS Outlook Web App
Configuring Portal Access Rules

74-80

74-80

Optimizing Clientless SSL VPN Performance 74-81
Configuring Caching 74-81
Configuring Content Transformation 74-82
Configuring a Certificate for Signing Rewritten Java Content 74-82
Disabling Content Rewrite 74-83
Using Proxy Bypass 74-83
Configuring Application Profile Customization Framework 74-84
APCF Syntax 74-85
Clientless SSL VPN End User Setup 74-87
Defining the End User Interface 74-88
Cisco ASA 5500 Series Configuration Guide using the CLI

liv

Contents

Viewing the Clientless SSL VPN Home Page 74-88
Viewing the Clientless SSL VPN Application Access Panel
Viewing the Floating Toolbar 74-89

74-88

Customizing Clientless SSL VPN Pages 74-90
Information About Customization 74-90
Exporting a Customization Template 74-91
Editing the Customization Template 74-91
Importing a Customization Object 74-97
Applying Customizations to Connection Profiles, Group Policies and Users
Login Screen Advanced Customization 74-99
Modifying Your HTML File 74-101

74-97

Configuring Browser Access to Client-Server Plug-ins 74-102
About Installing Browser Plug-ins 74-103
RDP Plug-in ActiveX Debug Quick Reference 74-104
Preparing the Security Appliance for a Plug-in 74-105
Configuring the ASA to Use the New HTML File 74-105
Customizing Help 74-106
Customizing a Help File Provided By Cisco 74-107
Creating Help Files for Languages Not Provided by Cisco 74-108
Importing a Help File to Flash Memory 74-108
Exporting a Previously Imported Help File from Flash Memory 74-108
Requiring Usernames and Passwords 74-109
Communicating Security Tips

74-109

Configuring Remote Systems to Use Clientless SSL VPN Features
Starting Clientless SSL VPN 74-110
Using the Clientless SSL VPN Floating Toolbar 74-111
Browsing the Web 74-111
Browsing the Network (File Management) 74-112
Using Port Forwarding 74-112
Using E-mail Via Port Forwarding 74-113
Using E-mail Via Web Access 74-114
Using E-mail Via E-mail Proxy 74-114
Using Smart Tunnel 74-114

74-110

Translating the Language of User Messages 74-115
Understanding Language Translation 74-115
Creating Translation Tables 74-116
Referencing the Language in a Customization Object 74-118
Changing a Group Policy or User Attributes to Use the Customization Object
Capturing Data

74-120

74-121

Cisco ASA 5500 Series Configuration Guide using the CLI

lv

Contents

Creating a Capture File 74-121
Using a Browser to Display Capture Data

CHAPTER

75

74-122

Configuring AnyConnect VPN Client Connections

75-1

Information About AnyConnect VPN Client Connections
Licensing Requirements for AnyConnect Connections

75-1
75-2

Guidelines and Limitations 75-5
Remote PC System Requirements 75-5
Remote HTTPS Certificates Limitation 75-5
Configuring AnyConnect Connections 75-5
Configuring the ASA to Web-Deploy the Client 75-6
Enabling Permanent Client Installation 75-7
Configuring DTLS 75-8
Prompting Remote Users 75-8
Enabling AnyConnect Client Profile Downloads 75-10
Enabling Additional AnyConnect Client Features 75-11
Enabling Start Before Logon 75-11
Translating Languages for AnyConnect User Messages 75-12
Understanding Language Translation 75-12
Creating Translation Tables 75-12
Configuring Advanced AnyConnect Features 75-14
Enabling Rekey 75-14
Enabling and Adjusting Dead Peer Detection 75-15
Enabling Keepalive 75-16
Using Compression 75-16
Adjusting MTU Size 75-17
Configuring Session Timeouts 75-17
Updating AnyConnect Client Images 75-18
Enabling IPv6 VPN Access 75-18
Monitoring AnyConnect Connections

75-19

Logging Off AnyConnect VPN Sessions

75-20

Configuration Examples for Enabling AnyConnect Connections
Feature History for AnyConnect Connections

CHAPTER

76

Configuring AnyConnect Host Scan

75-21

76-1

Host Scan Dependencies and System Requirements
Dependencies 76-1
System Requirements 76-2

Cisco ASA 5500 Series Configuration Guide using the CLI

lvi

76-1

75-21

Contents

Licensing

76-2

Host Scan Packaging

76-2

Installing and Enabling Host Scan on the ASA 76-3
Installing or Upgrading Host Scan 76-3
Enabling or Disabling a Host Scan 76-4
Viewing the Host Scan Version Enabled on the ASA 76-5
Uninstalling Host Scan 76-5
Assigning AnyConnect Feature Modules to Group Policies 76-6
Other Important Documentation Addressing Host Scan

PART

Configuring Logging, SNMP, and Smart Call Home

17

CHAPTER

76-7

77

Configuring Logging

77-1

Information About Logging 77-1
Logging in Multiple Context Mode 77-2
Analyzing Syslog Messages 77-2
Syslog Message Format 77-3
Severity Levels 77-3
Message Classes and Range of Syslog IDs
Filtering Syslog Messages 77-4
Using Custom Message Lists 77-4
Licensing Requirements for Logging
Prerequisites for Logging
Guidelines and Limitations

77-4

77-5

77-5
77-5

Configuring Logging 77-6
Enabling Logging 77-6
Configuring an Output Destination 77-6
Sending Syslog Messages to an External Syslog Server 77-8
Sending Syslog Messages to the Internal Log Buffer 77-9
Sending Syslog Messages to an E-mail Address 77-10
Sending Syslog Messages to ASDM 77-11
Sending Syslog Messages to the Console Port 77-11
Sending Syslog Messages to an SNMP Server 77-11
Sending Syslog Messages to a Telnet or SSH Session 77-12
Creating a Custom Event List 77-13
Generating Syslog Messages in EMBLEM Format to a Syslog Server 77-14
Generating Syslog Messages in EMBLEM Format to Other Output Destinations
Changing the Amount of Internal Flash Memory Available for Logs 77-15
Configuring the Logging Queue 77-15

77-14

Cisco ASA 5500 Series Configuration Guide using the CLI

lvii

Contents

Sending All Syslog Messages in a Class to a Specified Output Destination
Enabling Secure Logging 77-16
Including the Device ID in Non-EMBLEM Format Syslog Messages 77-17
Including the Date and Time in Syslog Messages 77-18
Disabling a Syslog Message 77-18
Changing the Severity Level of a Syslog Message 77-18
Limiting the Rate of Syslog Message Generation 77-19
Monitoring the Logs

77-19

Configuration Examples for Logging
Feature History for Logging

CHAPTER

78

77-20

77-20

Configuring NetFlow Secure Event Logging (NSEL)
Information About NSEL 78-1
Using NSEL and Syslog Messages
Licensing Requirements for NSEL
Prerequisites for NSEL

78-1

78-2

78-3

78-3

Guidelines and Limitations

78-4

Configuring NSEL 78-4
Configuring NSEL Collectors 78-5
Configuring Flow-Export Actions Through Modular Policy Framework 78-5
Configuring Template Timeout Intervals 78-7
Changing the Time Interval for Sending Flow-Update Events to a Collector 78-8
Delaying Flow-Create Events 78-9
Disabling and Reenabling NetFlow-related Syslog Messages 78-9
Clearing Runtime Counters 78-10
Monitoring NSEL 78-10
NSEL Monitoring Commands

78-10

Configuration Examples for NSEL

78-12

Where to Go Next

78-13

Additional References 78-13
Related Documents 78-14
RFCs 78-14
Feature History for NSEL

CHAPTER

79

Configuring SNMP

78-14

79-1

Information About SNMP 79-1
Information About SNMP Terminology 79-2
Information About MIBs and Traps 79-2
Cisco ASA 5500 Series Configuration Guide using the CLI

lviii

77-16

Contents

SNMP Object Identifiers 79-3
SNMP Physical Vendor Type Values 79-5
Supported Tables in MIBs 79-11
Supported Traps (Notifications) 79-12
SNMP Version 3 79-15
SNMP Version 3 Overview 79-15
Security Models 79-16
SNMP Groups 79-16
SNMP Users 79-16
SNMP Hosts 79-16
Implementation Differences Between the ASA, ASA Services Module, and the Cisco IOS
Software 79-16
Licensing Requirements for SNMP
Prerequisites for SNMP

79-17

79-17

Guidelines and Limitations

79-17

Configuring SNMP 79-18
Enabling SNMP 79-18
Configuring SNMP Traps 79-20
Configuring a CPU Usage Threshold 79-21
Configuring a Physical Interface Threshold 79-21
Using SNMP Version 1 or 2c 79-22
Using SNMP Version 3 79-23
Troubleshooting Tips 79-24
Interface Types and Examples

79-25

Monitoring SNMP 79-26
SNMP Syslog Messaging 79-27
SNMP Monitoring 79-27
Configuration Examples for SNMP 79-28
Configuration Example for SNMP Versions 1 and 2c
Configuration Example for SNMP Version 3 79-28
Where to Go Next

79-28

79-29

Additional References 79-29
RFCs for SNMP Version 3 79-29
MIBs 79-29
Application Services and Third-Party Tools
Feature History for SNMP

79-31

79-31

Cisco ASA 5500 Series Configuration Guide using the CLI

lix

Contents

CHAPTER

80

Configuring Anonymous Reporting and Smart Call Home

80-1

Information About Anonymous Reporting and Smart Call Home 80-1
Information About Anonymous Reporting 80-2
What is Sent to Cisco? 80-2
DNS Requirement 80-3
Anonymous Reporting and Smart Call Home Prompt 80-3
Information About Smart Call Home 80-4
Licensing Requirements for Anonymous Reporting and Smart Call Home
Prerequisites for Smart Call Home and Anonymous Reporting
Guidelines and Limitations

80-5

80-5

Configuring Anonymous Reporting and Smart Call Home 80-6
Configuring Anonymous Reporting 80-6
Configuring Smart Call Home 80-7
Enabling Smart Call Home 80-7
Declaring and Authenticating a CA Trust Point 80-8
Configuring DNS 80-8
Subscribing to Alert Groups 80-9
Testing Call Home Communications 80-11
Optional Configuration Procedures 80-13
Monitoring Smart Call Home

80-19

Configuration Example for Smart Call Home

80-19

Feature History for Anonymous Reporting and Smart Call Home

PART

System Administration

18

CHAPTER

80-20

81

Managing Software and Configurations

81-1

Managing the Flash File System 81-1
Viewing Files in Flash Memory 81-1
Deleting Files from Flash Memory 81-2
Downloading Software or Configuration Files to Flash Memory 81-2
Downloading a File to a Specific Location 81-3
Downloading a File to the Startup or Running Configuration 81-3
Configuring the Application Image and ASDM Image to Boot
Configuring the File to Boot as the Startup Configuration
Deleting Files from a USB Drive on the ASA 5500-X Series

81-4

81-5
81-5

Performing Zero Downtime Upgrades for Failover Pairs 81-6
Upgrading an Active/Standby Failover Configuration 81-6
Upgrading an Active/Active Failover Configuration 81-7
Cisco ASA 5500 Series Configuration Guide using the CLI

lx

80-4

Contents

Backing Up Configuration Files or Other Files 81-8
Backing up the Single Mode Configuration or Multiple Mode System Configuration
Backing Up a Context Configuration or Other File in Flash Memory 81-8
Backing Up a Context Configuration within a Context 81-9
Copying the Configuration from the Terminal Display 81-9
Backing Up Additional Files Using the Export and Import Commands 81-9
Using a Script to Back Up and Restore Files 81-10
Prerequisites 81-10
Running the Script 81-10
Sample Script 81-11

81-8

Configuring Auto Update Support 81-16
Configuring Communication with an Auto Update Server 81-16
Configuring Client Updates as an Auto Update Server 81-18
Viewing Auto Update Status 81-19
Downgrading Your Software 81-19
Information About Activation Key Compatibility
Performing the Downgrade 81-20

CHAPTER

82

Troubleshooting

81-20

82-1

Testing Your Configuration 82-1
Enabling ICMP Debugging Messages and Syslog Messages
Pinging ASA Interfaces 82-3
Passing Traffic Through the ASA 82-5
Disabling the Test Configuration 82-7
Determining Packet Routing with Traceroute 82-7
Tracing Packets with Packet Tracer 82-7
Handling TCP Packet Loss 82-8
Reloading the ASA

82-2

82-8

Performing Password Recovery 82-8
Recovering Passwords for the ASA 82-9
Disabling Password Recovery 82-10
Resetting the Password on the SSM Hardware Module
Using the ROM Monitor to Load a Software Image
Erasing the Flash File System

82-11

82-11

82-12

Other Troubleshooting Tools 82-13
Viewing Debugging Messages 82-13
Capturing Packets 82-14
Viewing the Crash Dump 82-14
Coredump 82-14
Cisco ASA 5500 Series Configuration Guide using the CLI

lxi

Contents

Monitoring Per-Process CPU Usage
Common Problems

PART

82-14

Reference

19

APPENDIX

82-14

A

Using the Command-Line Interface

A-1

Firewall Mode and Security Context Mode
Command Modes and Prompts
Syntax Formatting

A-2

A-3

Abbreviating Commands

A-3

Command-Line Editing

A-3

Command Completion

A-4

Command Help

A-4

Filtering show Command Output
Command Output Paging
Adding Comments

A-1

A-4

A-5

A-5

Text Configuration Files A-5
How Commands Correspond with Lines in the Text File A-6
Command-Specific Configuration Mode Commands A-6
Automatic Text Entries A-7
Line Order A-7
Commands Not Included in the Text Configuration A-7
Passwords A-7
Multiple Security Context Files A-7
Supported Character Sets

APPENDIX

B

A-8

Addresses, Protocols, and Ports

B-1

IPv4 Addresses and Subnet Masks B-1
Classes B-1
Private Networks B-2
Subnet Masks B-2
Determining the Subnet Mask B-3
Determining the Address to Use with the Subnet Mask
IPv6 Addresses B-5
IPv6 Address Format B-5
IPv6 Address Types B-6
Unicast Addresses B-6
Multicast Address B-8
Cisco ASA 5500 Series Configuration Guide using the CLI

lxii

B-3

Contents

Anycast Address B-9
Required Addresses B-10
IPv6 Address Prefixes B-10
Protocols and Applications
TCP and UDP Ports

B-11

Local Ports and Protocols
ICMP Types

APPENDIX

C

B-11

B-14

B-15

Configuring an External Server for Authorization and Authentication
Understanding Policy Enforcement of Permissions and Attributes

C-1

C-1

Configuring an External LDAP Server C-2
Organizing the ASA for LDAP Operations C-3
Searching the LDAP Hierarchy C-3
Binding the ASA to the LDAP Server C-4
Defining the ASA LDAP Configuration C-5
Supported Cisco Attributes for LDAP Authorization C-5
Cisco AV Pair Attribute Syntax C-13
Cisco AV Pairs ACL Examples C-14
Active Directory/LDAP VPN Remote Access Authorization Examples C-16
User-Based Attributes Policy Enforcement C-16
Placing LDAP Users in a Specific Group Policy C-18
Enforcing Static IP Address Assignment for AnyConnect Tunnels C-20
Enforcing Dial-in Allow or Deny Access C-22
Enforcing Logon Hours and Time-of-Day Rules C-25
Configuring an External RADIUS Server C-27
Reviewing the RADIUS Configuration Procedure C-27
ASA RADIUS Authorization Attributes C-27
ASA IETF RADIUS Authorization Attributes C-36
RADIUS Accounting Disconnect Reason Codes C-37
Configuring an External TACACS+ Server

C-38

GLOSSARY

INDEX

Cisco ASA 5500 Series Configuration Guide using the CLI

lxiii

Contents

Cisco ASA 5500 Series Configuration Guide using the CLI

lxiv

About This Guide
This preface introduces Cisco ASA 5500 Series Configuration Guide using the CLI and includes the
following sections:
•

Document Objectives, page lxv

•

Audience, page lxv

•

Related Documentation, page lxv

•

Conventions, page lxvi

•

Obtaining Documentation and Submitting a Service Request, page lxvii

Document Objectives
The purpose of this guide is to help you configure the ASA 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 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.
This guide applies to the Cisco ASA 5500 series . Throughout this guide, the term “ASA” applies
generically to supported models, unless specified otherwise.

Audience
This guide is for network managers who perform any of the following tasks:
•

Manage network security

•

Install and configure firewalls/ASAs

•

Configure VPNs

•

Configure intrusion detection software

Related Documentation
For more information, see Navigating the Cisco ASA 5500 Series Documentation at
http://www.cisco.com/en/US/docs/security/asa/roadmap/asaroadmap.html.

Cisco ASA 5500 Series Configuration Guide using the CLI

lxv

About This Guide

Conventions
This document uses the following conventions:
Convention

Indication

bold font

Commands and keywords and user-entered text appear in bold font.

italic font

Document titles, new or emphasized terms, and arguments for which you supply
values are in italic font.

[ ]

Elements in square brackets are optional.

{x | y | z }

Required alternative keywords are grouped in braces and separated by
vertical bars.

[x|y|z]

Optional alternative keywords are grouped in brackets and separated by
vertical bars.

string

A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.

courier

font

Terminal sessions and information the system displays appear in courier font.

< >

Nonprinting characters such as passwords are in angle brackets.

[ ]

Default responses to system prompts are in square brackets.

!, #

An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.

Note

Means reader take note.

Tip

Means the following information will help you solve a problem.

Caution

Timesaver

Warning

Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.

Means the described action saves time. You can save time by performing the action described in
the paragraph.

Means reader be warned. In this situation, you might perform an action that could result in
bodily injury.

Cisco ASA 5500 Series Configuration Guide using the CLI

lxvi

About This Guide

Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as an RSS feed and set content to be
delivered directly to your desktop using a reader application. The RSS feeds are a free service. Cisco currently
supports RSS Version 2.0.

Cisco ASA 5500 Series Configuration Guide using the CLI

lxvii

About This Guide

Cisco ASA 5500 Series Configuration Guide using the CLI

lxviii

PA R T

1

Getting Started with the ASA

CH A P T E R

1

Introduction to the Cisco ASA 5500 Series
The ASA provides advanced Stateful Firewall and VPN concentrator functionality in one device, and for
some models, an integrated Intrusion Prevention System (IPS) module or an integrated Content Security
and Control (CSC) module. The ASA includes many advanced features, such as multiple security
contexts (similar to virtualized firewalls), transparent (Layer 2) firewall or routed (Layer 3) firewall
operation, advanced inspection engines, IPsec VPN, SSL VPN, clientless SSL VPN support, and many
more features.
This chapter includes the following sections:
•

Hardware and Software Compatibility, page 1-1

•

VPN Specifications, page 1-1

•

New Features, page 1-1

•

Firewall Functional Overview, page 1-24

•

VPN Functional Overview, page 1-28

•

Security Context Overview, page 1-29

Hardware and Software Compatibility
For a complete list of supported hardware and software, see the Cisco ASA Compatibility:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asamatrx.html

VPN Specifications
See Supported VPN Platforms, Cisco ASA 5500 Series:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asa-vpn-compatibility.html

New Features
This section includes the following topics:
•

New Features in Version 8.6(1), page 1-2

•

New Features in Version 8.4(5), page 1-4

Cisco ASA 5500 Series Configuration Guide using the CLI

1-1

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

•

New Features in Version 8.4(4.1), page 1-6

•

New Features in Version 8.4(3), page 1-9

•

New Features in Version 8.4(2), page 1-12

•

New Features in Version 8.4(1), page 1-19

Note

New, changed, and deprecated syslog messages are listed in syslog message guide.

Note

Version 8.4(4) was removed from Cisco.com due to build issues; please upgrade to Version 8.4(4.1) or
later.

New Features in Version 8.6(1)
Released: February 28, 2012

Table 1-1 lists the new features for ASA Version 8.6(1). This ASA software version is only supported
on the ASA 5512-X, ASA 5515-X, ASA 5525-X, ASA 5545-X, and ASA 5555-X.

Note

Version 8.6(1) includes all features in 8.4(2), plus the features listed in this table.
Features added in 8.4(3) are not included in 8.6(1) unless they are explicitly listed in thisw table.

Table 1-1

New Features forASA Version 8.6(1)

Feature

Description

Hardware Features

Support for the ASA 5512-X We introduced support for the ASA 5512-X, ASA 5515-X, ASA 5525-X, ASA 5545-X, and
through ASA 5555-X
ASA 5555-X.
IPS Features

Support for the IPS SSP for
the ASA 5512-X through
ASA 5555-X

We introduced support for the IPS SSP software module for the ASA 5512-X, ASA 5515-X,
ASA 5525-X, ASA 5545-X, and ASA 5555-X.
We introduced or modified the following commands: session, show module, sw-module.

Remote Access Features

Clientless SSL VPN browser The ASA now supports clientless SSL VPN with Microsoft Internet Explorer 9 and Firefox 4.
support
Also available in Version 8.4(3).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-2

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-1

New Features forASA Version 8.6(1) (continued)

Feature

Description

Compression for DTLS and
TLS

To improve throughput, Cisco now supports compression for DTLS and TLS on AnyConnect
3.0 or later. Each tunneling method configures compression separately, and the preferred
configuration is to have both SSL and DTLS compression as LZS. This feature enhances
migration from legacy VPN clients.
Note

Using data compression on high speed remote access connections passing highly
compressible data requires significant processing power on the ASA. With other
activity and traffic on the ASA, the number of sessions that can be supported on the
platform is reduced.

We introduced or modified the following commands: anyconnect dtls compression [lzs |
none] and anyconnect ssl compression [deflate | lzs | none].
Also available in Version 8.4(3).
Clientless SSL VPN Session Allows you to create custom messages to alert users that their VPN session is about to end
Timeout Alerts
because of inactivity or a session timeout.
We introduced the following commands: vpn-session-timeout alert-interval,
vpn-idle-timeout alert-interval.
Also available in Version 8.4(3).
Multiple Context Mode Features

Automatic generation of a
MAC address prefix

In multiple context mode, the ASA now converts the automatic MAC address generation
configuration to use a default prefix. The ASA auto-generates the prefix based on the last two
bytes of the interface MAC address. This conversion happens automatically when you reload,
or if you reenable MAC address generation. The prefix method of generation provides many
benefits, including a better guarantee of unique MAC addresses on a segment. You can view
the auto-generated prefix by entering the show running-config mac-address command. If you
want to change the prefix, you can reconfigure the feature with a custom prefix. The legacy
method of MAC address generation is no longer available.
Note

To maintain hitless upgrade for failover pairs, the ASA does not convert the MAC
address method in an existing configuration upon a reload if failover is enabled.
However, we strongly recommend that you manually change to the prefix method of
generation. After upgrading, to use the prefix method of MAC address generation,
reenable MAC address generation to use the default prefix.

We modified the following command: mac-address auto.
AAA Features

Increased maximum LDAP
values per attribute

The maximum number of values that the ASA can receive for a single attribute was increased
from 1000 (the default) to 5000, with an allowed range of 500 to 5000. If a response message
is received that exceeds the configured limit, the ASA rejects the authentication. If the ASA
detects that a single attribute has more than 1000 values, then the ASA generates informational
syslog 109036. For more than 5000 attributes, the ASA generates error level syslog 109037.
We introduced the following command: ldap-max-value-range number (Enter this command
in aaa-server host configuration mode).
Also available in Version 8.4(3).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-3

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-1

New Features forASA Version 8.6(1) (continued)

Feature

Description

Support for sub-range of
LDAP search results

When an LDAP search results in an attribute with a large number of values, depending on the
server configuration, it might return a sub-range of the values and expect the ASA to initiate
additional queries for the remaining value ranges. The ASA now makes multiple queries for
the remaining ranges, and combines the responses into a complete array of attribute values.
Also available in Version 8.4(3).

Troubleshooting Features

Regular expression
matching for the show asp
table classifier and show
asp table filter commands

You can now enter the show asp table classifier and show asp table filter commands with a
regular expression to filter output.
We modified the following commands: show asp table classifier match regex, show asp table
filter match regex.
Also available in Version 8.4(3).

New Features in Version 8.4(5)
Released: October 31, 2012

Table 1-2 lists the new features for ASA interim Version 8.4(5)/ASDM Version 7.0(2).
Table 1-2

New Features for ASA Version 8.4(5)/ASDM Version 7.0(2)

Feature

Description

Firewall Features

EtherType ACL support for
IS-IS traffic (transparent
firewall mode)

In transparent firewall mode, the ASA can now pass IS-IS traffic using an EtherType ACL.
We modified the following command: access-list ethertype {permit | deny} is-is.
We modified the following screen: Configuration > Device Management > Management
Access > EtherType Rules.
This feature is not available in 8.5(1), 8.6(1), or 9.0(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-4

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-2

New Features for ASA Version 8.4(5)/ASDM Version 7.0(2) (continued)

Feature

Description

ARP cache additions for
non-connected subnets

The ASA ARP cache only contains entries from directly-connected subnets by default. You can
now enable the ARP cache to also include non-directly-connected subnets. We do not
recommend enabling this feature unless you know the security risks. This feature could
facilitate denial of service (DoS) attack against the ASA; a user on any interface could send out
many ARP replies and overload the ASA ARP table with false entries.
You may want to use this feature if you use:
•

Secondary subnets.

•

Proxy ARP on adjacent routes for traffic forwarding.

We introduced the following command: arp permit-nonconnected.
We modified the following screen: Configuration > Device Management > Advanced > ARP >
ARP Static Table.
This feature is not available in 8.5(1), 8.6(1), or 9.0(1).
Increased maximum
The maximum number of connections for service policy rules was increased from 65535 to
connection limits for service 2000000.
policy rules
We modified the following commands: set connection conn-max, set connection
embryonic-conn-max, set connection per-client-embryonic-max, set connection
per-client-max.
We modified the following screen: Configuration > Firewall > Service Policy Rules >
Connection Settings.
This feature is not available in 8.5(1) or 8.6(1).
Remote Access Features

Host Scan support for low
bandwith or high latency
networks

Host Scan now contacts the ASA periodically while it compiles and sends its dynamic access
policy report to the ASA. The ASA has increased its timers to wait for Host Scan to send its
DAP report. This results in more successful VPN connections especially over high latency
networks such as dial-up or slow broadband.
This feature is not available in 8.5(1), 8.6(1), or 9.0(1).

Monitoring Features

NAT-MIB
cnatAddrBindNumberOfEnt
ries and
cnatAddrBindSessionCount
OIDs to allow polling for
Xlate count.

Support was added for the NAT-MIB cnatAddrBindNumberOfEntries and
cnatAddrBindSessionCount OIDs to support xlate_count and max_xlate_count for SNMP.

NSEL

Flow-update events have been introduced to provide periodic byte counters for flow traffic. You
can change the time interval at which flow-update events are sent to the NetFlow collector. You
can filter to which collectors flow-update records will be sent.

This data is equivalent to the show xlate count command.
This feature is not available in 8.5(1), 8.6(1), or 9.0(1).

We introduced the following command: flow-export active refresh-interval.
We modified the following command: flow-export event-type.
This feature is not available in 8.5(1), 8.6(1), or 9.0(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-5

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-2

New Features for ASA Version 8.4(5)/ASDM Version 7.0(2) (continued)

Feature

Description

Hardware Features

ASA 5585-X DC power
supply support

Support was added for the ASA 5585-X DC power supply.
This feature is not available in 8.5(1), 8.6(1), or 9.0(1).

New Features in Version 8.4(4.1)
Released: June 18, 2012

Table 1-3 lists the new features for ASA Version 8.4(4.1).

Note

Version 8.4(4) was removed from Cisco.com due to build issues; please upgrade to Version 8.4(4.1) or
later.

Table 1-3

New Features for ASA Version 8.4(4.1)

Feature

Description

Certification Features

FIPS and Common Criteria
certifications

The FIPS 140-2 Non-Proprietary Security Policy was updated as part of the Level 2 FIPS 140-2
validation for the Cisco ASA 5500 series adaptive security appliances, which includes the
Cisco ASA 5505, ASA 5510, ASA 5520, ASA 5540, ASA 5550, and ASA 5585-X.
The Common Criteria Evaluation Assurance Level 4 (EAL4) was updated, which provides the
basis for a specific Target of Evaluation (TOE) of the Cisco ASA and VPN platform solutions.
This feature is not available in 8.5(1) or 8.6(1).

Remote Access Features

Clientless SSL VPN:
Enhanced quality for
rewriter engines

The clientless SSL VPN rewriter engines were significantly improved to provide better quality
and efficacy. As a result, you can expect a better end-user experience for clientless SSL VPN
users.
We did not add or modify any commands for this feature.
This feature is not available in 8.5(1) or 8.6(1).

Authentication and Encryption Features

Support for password policy, The ASA enables administrators with the necessary privileges to do the following for users in
password change, and SSH the current context: modify password policy, change passwords, and authenticate using an SSH
public key authentication
public key.
We introduced or modified the following commands: password-policy lifetime,
password-policy minimum changes, password-policy minimum-length, password-policy
minimum-lowercase, password-policy minimum-uppercase, password-policy
minimum-numeric, password-policy minimum-special, password-policy authenticate
enable, username, username attributes, clear configure username, change-password,
clear configure password-policy, show running-config password-policy.
This feature is not available in 8.5(1) or 8.6(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-6

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-3

New Features for ASA Version 8.4(4.1) (continued)

Feature

Description

Support for maximum
number of management
sessions allowed and
Diffie-Hellman Key
Exchange Group 14 support
for SSH

The maximum number of simultaneous ASDM, SSH, and Telnet sessions allowed was added.
Support for Diffie-Hellman Key Exchange Group 14 for SSH was added.

Additional ephemeral
Diffie-Hellman ciphers for
SSL encryption

We introduced or modified the following commands: quota management-session, show
running-config quota management-session, show quota management-session, ssh.
This feature is not available in 8.5(1) or 8.6(1).
The ASA now supports the following ephemeral Diffie-Hellman (DHE) SSL cipher suites:
•

DHE-AES128-SHA1

•

DHE-AES256-SHA1

These cipher suites are specified in RFC 3268, Advanced Encryption Standard (AES)
Ciphersuites for Transport Layer Security (TLS).
When supported by the client, DHE is the preferred cipher because it provides Perfect Forward
Secrecy. See the following limitations:
•

DHE is not supported on SSL 3.0 connections, so make sure to also enable TLS 1.0 for the
SSL server.
!! set server version
hostname(config)# ssl server-version tlsv1 sslv3
!! set client version
hostname(config) # ssl client-version any

•

Some popular applications do not support DHE, so include at least one other SSL
encryption method to ensure that a cipher suite common to both the SSL client and server
can be used.

•

Some clients may not support DHE, including AnyConnect 2.5 and 3.0, Cisco Secure
Desktop, and Internet Explorer 9.0.

We modified the following command: ssl encryption.
This feature is not available in 8.5(1) or 8.6(1).
File System Features

Image verification

Support for SHA-512 image integrity checking was added.
We modified the following command: verify.
This feature is not available in 8.5(1) or 8.6(1).

Failover Features

Configure the connection
You can now configure the rate at which the ASA replicates connections to the standby unit
replication rate during a bulk when using Stateful Failover. By default, connections are replicated to the standby unit during
sync
a 15 second period. However, when a bulk sync occurs (for example, when you first enable
failover), 15 seconds may not be long enough to sync large numbers of connections due to a
limit on the maximum connections per second. For example, the maximum connections on the
ASA is 8 million; replicating 8 million connections in 15 seconds means creating 533 K
connections per second. However, the maximum connections allowed per second is 300 K. You
can now specify the rate of replication to be less than or equal to the maximum connections per
second, and the sync period will be adjusted until all the connections are synced.
We introduced the following command: failover replication rate rate.
This feature is not available in 8.6(1). This feature is also in 8.5(1.7).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-7

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-3

New Features for ASA Version 8.4(4.1) (continued)

Feature

Description

Application Inspection Features

SunRPC change from
dynamic ACL to pin-hole
mechanism

Previously, Sun RPC inspection does not support outbound access lists because the inspection
engine uses dynamic access lists instead of secondary connections.
In this release, when you configure dynamic access lists on the ASA, they are supported on the
ingress direction only and the ASA drops egress traffic destined to dynamic ports. Therefore,
Sun RPC inspection implements a pinhole mechanism to support egress traffic. Sun RPC
inspection uses this pinhole mechanism to support outbound dynamic access lists.
This feature is not available in 8.5(1) or 8.6(1).

Inspection reset action
change

Previously, when the ASA dropped a packet due to an inspection engine rule, the ASA sent
only one RST to the source device of the dropped packet. This behavior could cause resource
issues.
In this release, when you configure an inspection engine to use a reset action and a packet
triggers a reset, the ASA sends a TCP reset under the following conditions:
•

The ASA sends a TCP reset to the inside host when the service resetoutbound command
is enabled. (The service resetoutbound command is disabled by default.)

•

The ASA sends a TCP reset to the outside host when the service resetinbound command
is enabled. (The service resetinbound command is disabled by default.)

For more information, see the service command in the ASA command reference.
This behavior ensures that a reset action will reset the connections on the ASA and on inside
servers; therefore countering denial of service attacks. For outside hosts, the ASA does not
send a reset by default and information is not revealed through a TCP reset.
This feature is not available in 8.5(1) or 8.6(1).
Platform Features

Improved pseudo-random
number generation

Hardware-based noise for additional entropy was added to the software-based random number
generation process. This change makes pseudo-random number generation (PRNG) more
random and more difficult for attackers to get a repeatable pattern or guess the next random
number to be used for encryption and decryption operations. Two changes were made to
improve PRNG:
•

Use the current hardware-based RNG for random data to use as one of the parameters for
software-based RNG.

•

If the hardware-based RNG is not available, use additional hardware noise sources for
software-based RNG. Depending on your model, the following hardware sensors are used:
– ASA 5505—Voltage sensors.
– ASA 5510 and 5550—Fan speed sensors.
– ASA 5520, 5540, and 5580—Temperature sensors.
– ASA 5585-X—Fan speed sensors.

We introduced the following commands: show debug menu cts [128 | 129]
This feature is not available in 8.5(1) or 8.6(1).
Module Features

Cisco ASA 5500 Series Configuration Guide using the CLI

1-8

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-3

New Features for ASA Version 8.4(4.1) (continued)

Feature

Description

ASA 5585-X support for the The ASA CX module lets you enforce security based on the complete context of a situation.
ASA CX SSP-10 and -20
This context includes the identity of the user (who), the application or website that the user is
trying to access (what), the origin of the access attempt (where), the time of the attempted
access (when), and the properties of the device used for the access (how). With the ASA CX
module, you can extract the full context of a flow and enforce granular policies such as
permitting access to Facebook but denying access to games on Facebook or permitting finance
employees access to a sensitive enterprise database but denying the same to other employees.
We introduced or modified the following commands: capture, cxsc, cxsc auth-proxy, debug
cxsc, hw-module module password-reset, hw-module module reload, hw-module module
reset, hw-module module shutdown, session do setup host ip, session do get-config, session
do password-reset, show asp table classify domain cxsc, show asp table classify domain
cxsc-auth-proxy, show capture, show conn, show module, show service-policy.
This feature is not available in 8.6(1).
ASA 5585-X support for
network modules

The ASA 5585-X now supports additional interfaces on network modules in slot 1. You can
install one or two of the following optional network modules:
•

ASA 4-port 10G Network Module

•

ASA 8-port 10G Network Module

•

ASA 20-port 1G Network Module

This feature is not available in 8.6(1).

New Features in Version 8.4(3)
Released: January 9, 2012

Table 1-4 lists the new features for ASA Version 8.4(3).
Table 1-4

New Features for ASA Version 8.4(3)

Feature

Description

NAT Features

Round robin PAT pool
allocation uses the same IP
address for existing hosts

When using a PAT pool with round robin allocation, if a host has an existing connection, then
subsequent connections from that host will use the same PAT IP address if ports are available.
We did not modify any commands.
This feature is not available in 8.5(1) or 8.6(1).

Flat range of PAT ports for a If available, the real source port number is used for the mapped port. However, if the real port
PAT pool
is not available, by default the mapped ports are chosen from the same range of ports as the real
port number: 0 to 511, 512 to 1023, and 1024 to 65535. Therefore, ports below 1024 have only
a small PAT pool.
If you have a lot of traffic that uses the lower port ranges, when using a PAT pool, you can now
specify a flat range of ports to be used instead of the three unequal-sized tiers: either 1024 to
65535, or 1 to 65535.
This feature is not available in 8.5(1) or 8.6(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-9

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-4

New Features for ASA Version 8.4(3) (continued)

Feature

Description

Extended PAT for a PAT pool Each PAT IP address allows up to 65535 ports. If 65535 ports do not provide enough
translations, you can now enable extended PAT for a PAT pool. Extended PAT uses 65535 ports
per service, as opposed to per IP address, by including the destination address and port in the
translation information.
This feature is not available in 8.5(1) or 8.6(1).
Configurable timeout for
PAT xlate

When a PAT xlate times out (by default after 30 seconds), and the ASA reuses the port for a
new translation, some upstream routers might reject the new connection because the previous
connection might still be open on the upstream device. The PAT xlate timeout is now
configurable, to a value between 30 seconds and 5 minutes.
This feature is not available in 8.5(1) or 8.6(1).

Automatic NAT rules to
translate a VPN peer’s local
IP address back to the peer’s
real IP address

In rare situations, you might want to use a VPN peer’s real IP address on the inside network
instead of an assigned local IP address. Normally with VPN, the peer is given an assigned local
IP address to access the inside network. However, you might want to translate the local IP
address back to the peer’s real public IP address if, for example, your inside servers and
network security is based on the peer’s real IP address.
You can enable this feature on one interface per tunnel group. Object NAT rules are
dynamically added and deleted when the VPN session is established or disconnected. You can
view the rules using the show nat command.
Because of routing issues, we do not recommend using this feature unless you know
you need this feature; contact Cisco TAC to confirm feature compatibility with your
network. See the following limitations:

Note

•

Only supports Cisco IPsec and AnyConnect Client.

•

Return traffic to the public IP addresses must be routed back to the ASA so the NAT
policy and VPN policy can be applied.

•

Does not support load-balancing (because of routing issues).

•

Does not support roaming (public IP changing).

We introduced the following command: nat-assigned-to-public-ip interface (tunnel-group
general-attributes configuration mode).
Remote Access Features

Clientless SSL VPN browser The ASA now supports clientless SSL VPN with Microsoft Internet Explorer 9 and Firefox 4.
support

Cisco ASA 5500 Series Configuration Guide using the CLI

1-10

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-4

New Features for ASA Version 8.4(3) (continued)

Feature

Description

Compression for DTLS and
TLS

To improve throughput, Cisco now supports compression for DTLS and TLS on AnyConnect
3.0 or later. Each tunneling method configures compression separately, and the preferred
configuration is to have both SSL and DTLS compression as LZS. This feature enhances
migration from legacy VPN clients.
Note

Using data compression on high speed remote access connections passing highly
compressible data requires significant processing power on the ASA. With other
activity and traffic on the ASA, the number of sessions that can be supported on the
platform is reduced.

We introduced or modified the following commands: anyconnect dtls compression [lzs |
none] and anyconnect ssl compression [deflate | lzs | none].
VPN Session Timeout Alerts Allows you to create custom messages to alert users that their VPN session is about to end
because of inactivity or a session timeout.
We introduced the following commands: vpn-session-timeout alert-interval,
vpn-idle-timeout alert-interval.
AAA Features

Increased maximum LDAP
values per attribute

The maximum number of values that the ASA can receive for a single attribute was increased
from 1000 (the default) to 5000, with an allowed range of 500 to 5000. If a response message
is received that exceeds the configured limit, the ASA rejects the authentication. If the ASA
detects that a single attribute has more than 1000 values, then the ASA generates informational
syslog 109036. For more than 5000 attributes, the ASA generates error level syslog 109037.
We introduced the following command: ldap-max-value-range number (Enter this command
in aaa-server host configuration mode).

Support for sub-range of
LDAP search results

When an LDAP search results in an attribute with a large number of values, depending on the
server configuration, it might return a sub-range of the values and expect the ASA to initiate
additional queries for the remaining value ranges. The ASA now makes multiple queries for
the remaining ranges, and combines the responses into a complete array of attribute values.

Key vendor-specific
attributes (VSAs) sent in
RADIUS access request and
accounting request packets
from the ASA

Four New VSAs—Tunnel Group Name (146) and Client Type (150) are sent in RADIUS access
request packets from the ASA. Session Type (151) and Session Subtype (152) are sent in
RADIUS accounting request packets from the ASA. All four attributes are sent for all
accounting request packet types: Start, Interim-Update, and Stop. The RADIUS server (for
example, ACS and ISE) can then enforce authorization and policy attributes or use them for
accounting and billing purposes.

Troubleshooting Features

Regular expression
matching for the show asp
table classifier and show
asp table filter commands

You can now enter the show asp table classifier and show asp table filter commands with a
regular expression to filter output.
We modified the following commands: show asp table classifier match regex, show asp table
filter match regex.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-11

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

New Features in Version 8.4(2)
Released: June 20, 2011

Table 1-5 lists the new features for ASA Version 8.4(2).
Table 1-5

New Features for ASA Version 8.4(2)

Feature

Description

Firewall Features

Identity Firewall

Typically, a firewall is not aware of the user identities and, therefore, cannot apply security
policies based on identity.
The Identity Firewall in the ASA provides more granular access control based on users’
identities. You can configure access rules and security policies based on usernames and user
groups name rather than through source IP addresses. The ASA applies the security policies
based on an association of IP addresses to Windows Active Directory login information and
reports events based on the mapped usernames instead of network IP addresses.
The Identity Firewall integrates with Window Active Directory in conjunction with an external
Active Directory (AD) Agent that provides the actual identity mapping. The ASA uses
Windows Active Directory as the source to retrieve the current user identity information for
specific IP addresses.
In an enterprise, some users log onto the network by using other authentication mechanisms,
such as authenticating with a web portal (cut-through proxy) or by using a VPN. You can
configure the Identity Firewall to allow these types of authentication in connection with
identity-based access policies.

Identity NAT configurable
In earlier releases for identity NAT, proxy ARP was disabled, and a route lookup was always
proxy ARP and route lookup used to determine the egress interface. You could not configure these settings. In 8.4(2) and
later, the default behavior for identity NAT was changed to match the behavior of other static
NAT configurations: proxy ARP is enabled, and the NAT configuration determines the egress
interface (if specified) by default. You can leave these settings as is, or you can enable or
disable them discretely. Note that you can now also disable proxy ARP for regular static NAT.
For pre-8.3 configurations, the migration of NAT exempt rules (the nat 0 access-list command)
to 8.4(2) and later now includes the following keywords to disable proxy ARP and to use a
route lookup: no-proxy-arp and route-lookup. The unidirectional keyword that was used for
migrating to 8.3(2) and 8.4(1) is no longer used for migration. When upgrading to 8.4(2) from
8.3(1), 8.3(2), and 8.4(1), all identity NAT configurations will now include the no-proxy-arp
and route-lookup keywords, to maintain existing functionality. The unidirectional keyword
is removed.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-12

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-5

New Features for ASA Version 8.4(2) (continued)

Feature

Description

PAT pool and round robin
address assignment

You can now specify a pool of PAT addresses instead of a single address. You can also
optionally enable round-robin assignment of PAT addresses instead of first using all ports on a
PAT address before using the next address in the pool. These features help prevent a large
number of connections from a single PAT address from appearing to be part of a DoS attack
and makes configuration of large numbers of PAT addresses easy.
Note

IPv6 Inspection

Currently in 8.4(2), the PAT pool feature is not available as a fallback method for
dynamic NAT or PAT. You can only configure the PAT pool as the primary method for
dynamic PAT (CSCtq20634).

You can configure IPv6 inspection by configuring a service policy to selectively block IPv6
traffic based on the extension header. IPv6 packets are subjected to an early security check. The
ASA always passes hop-by-hop and destination option types of extension headers while
blocking router header and no next header.
You can enable default IPv6 inspection or customize IPv6 inspection. By defining a policy map
for IPv6 inspection you can configure the ASA to selectively drop IPv6 packets based on
following types of extension headers found anywhere in the IPv6 packet:
•

Hop-by-Hop Options

•

Routing (Type 0)

•

Fragment

•

Destination Options

•

Authentication

•

Encapsulating Security Payload

Remote Access Features

Portal Access Rules

This enhancement allows customers to configure a global clientless SSL VPN access policy to
permit or deny clientless SSL VPN sessions based on the data present in the HTTP header. If
denied, an error code is returned to the clients. This denial is performed before user
authentication and thus minimizes the use of processing resources.
Also available in Version 8.2(5).

Clientless support for
The ASA 8.4(2) clientless SSL VPN core rewriter now supports Microsoft Outlook Web App
Microsoft Outlook Web App 2010.
2010
Secure Hash Algorithm
SHA-2 Support for IPsec
IKEv2 Integrity and PRF

This release supports the Secure Hash Algorithm SHA-2 for increased cryptographic hashing
security for IPsec/IKEv2 AnyConnect Secure Mobility Client connections to the ASA. SHA-2
includes hash functions with digests of 256, 384, or 512 bits, to meet U.S. government
requirements.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-13

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-5

New Features for ASA Version 8.4(2) (continued)

Feature

Description

Secure Hash Algorithm
SHA-2 Support for Digital
Signature over IPsec IKEv2

This release supports the use of SHA-2 compliant signature algorithms to authenticate IPsec
IKEv2 VPN connections that use digital certificates, with the hash sizes SHA-256, SHA-384,
and SHA-512.
SHA-2 digital signature for IPsec IKEv2 connections is supported with the AnyConnect Secure
Mobility Client, Version 3.0.1 or later.

Split Tunnel DNS policy for This release includes a new policy pushed down to the AnyConnect Secure Mobility Client for
AnyConnect
resolving DNS addresses over split tunnels. This policy applies to VPN connections using the
SSL or IPsec/IKEv2 protocol and instructs the AnyConnect client to resolve all DNS addresses
through the VPN tunnel. If DNS resolution fails, the address remains unresolved and the
AnyConnect client does not try to resolve the address through public DNS servers.
By default, this feature is disabled. The client sends DNS queries over the tunnel according to
the split tunnel policy: tunnel all networks, tunnel networks specified in a network list, or
exclude networks specified in a network list.
Also available in Version 8.2(5).
Mobile Posture
(formerly referred to as
AnyConnect Identification
Extensions for Mobile
Device Detection)

You can now configure the ASA to permit or deny VPN connections to mobile devices, enable
or disable mobile device access on a per group bases, and gather information about connected
mobile devices based on a mobile device’s posture data. The following mobile platforms
support this capability: AnyConnect for iPhone/iPad/iPod Versions 2.5.x and AnyConnect for
Android Version 2.4.x.
Licensing Requirements

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. You receive the following functionality based on the license
you install:
•

AnyConnect Premium License Functionality
Enterprises that install the AnyConnect Premium license will be able to enforce DAP
policies, on supported mobile devices, based on these DAP attributes and any other
existing endpoint attributes. This includes allowing or denying remote access from a
mobile device.

•

AnyConnect Essentials License Functionality
Enterprises that install the AnyConnect Essentials license will be able to do the following:
– Enable or disable mobile device access on a per group basis and to configure that

feature using ASDM.
– Display information about connected mobile devices via CLI or ASDM without

having the ability to enforce DAP policies or deny or allow remote access to those
mobile devices.
Also available in Version 8.2(5).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-14

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-5

New Features for ASA Version 8.4(2) (continued)

Feature

Description

SSL SHA-2 digital signature You can now use of SHA-2 compliant signature algorithms to authenticate SSL VPN
connections that use digital certificates. Our support for SHA-2 includes all three hash sizes:
SHA-256, SHA-384, and SHA-512. SHA-2 requires AnyConnect 2.5(1) or later (2.5(2) or later
recommended). This release does not support SHA-2 for other uses or products.
Caution: To support failover of SHA-2 connections, the standby ASA must be running the same
image.
Also available in Version 8.2(5).
SHA2 certificate signature
support for Microsoft
Windows 7 and
Android-native VPN clients

ASA supports SHA2 certificate signature support for Microsoft Windows 7 and Android-native
VPN clients when using the L2TP/IPsec protocol.

Enable/disable certificate
mapping to override the
group-url attribute

This feature changes the preference of a connection profile during the connection profile
selection process. By default, if the ASA matches a certificate field value specified in a
connection profile to the field value of the certificate used by the endpoint, the ASA assigns
that profile to the VPN connection. This optional feature changes the preference to a
connection profile that specifies the group URL requested by the endpoint. The new option lets
administrators rely on the group URL preference used by many older ASA software releases.

Also available in Version 8.2(5).

Also available in Version 8.2(5).
ASA 5585-X Features

Support for Dual SSPs for
SSP-40 and SSP-60

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.
Note

When using two SSPs in the chassis, VPN is not supported; note, however, that VPN
has not been disabled.

Support for the IPS SSP-10, We introduced support for the IPS SSP-10, -20, -40, and -60 for the ASA 5585-X. You can only
-20, -40, and -60
install the IPS SSP with a matching-level SSP; for example, SSP-10 and IPS SSP-10.
Also available in Version 8.2(5).
CSC SSM Features

CSC SSM Support

For the CSC SSM, support for the following features has been added:
•

HTTPS traffic redirection: URL filtering and WRS queries for incoming HTTPS
connections.

•

Configuring global approved whitelists for incoming and outgoing SMTP and POP3
e-mail.

•

E-mail notification for product license renewals.

Monitoring Features

Smart Call-Home
Anonymous Reporting

Customers can now help to improve the ASA platform by enabling Anonymous Reporting,
which allows Cisco to securely receive minimal error and health information from the device.
Also available in Version 8.2(5).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-15

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-5

New Features for ASA Version 8.4(2) (continued)

Feature

Description

IF-MIB ifAlias OID support The ASA now supports the ifAlias OID. When you browse the IF-MIB, the ifAlias OID will
be set to the value that has been set for the interface description.
Also available in Version 8.2(5).
Interface Features

Support for Pause Frames
You can now enable pause (XOFF) frames for flow control on 1-Gigabit Ethernet interfaces;
for Flow Control on
support was previously added for 10-Gigabit Ethernet interfaces in 8.2(2).
1-Gigabit Ethernet Interface
Also available in Version 8.2(5).
Management Features

Increased SSH security; the
SSH default username is no
longer supported

Starting in 8.4(2), 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 (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.

Unified Communications Features

ASA-Tandberg
Interoperability with H.323
Inspection

H.323 Inspection now supports uni-directional signaling for two-way video sessions. This
enhancement allows H.323 Inspection of one-way video conferences supported by Tandberg
video phones. Supporting uni-directional signaling allows Tandberg phones to switch video
modes (close their side of an H.263 video session and reopen the session using H.264, the
compression standard for high-definition video).
Also available in Version 8.2(5).

Routing Features

Timeout for connections
using a backup static route

When multiple static routes exist to a network with different metrics, the ASA uses the one with
the best metric at the time of connection creation. If a better route becomes available, then this
timeout lets connections be closed so a connection can be reestablished to use the better route.
The default is 0 (the connection never times out). To take advantage of this feature, change the
timeout to a new value.
Also available in Version 8.2(5).

Released: May 23, 2011

Table 1-6 lists the new features for ASA Version 8.2(5).
Table 1-6

New Features for ASA Version 8.2(5)

Feature

Description

Monitoring Features

Smart Call-Home
Anonymous Reporting

Customers can now help to improve the ASA platform by enabling Anonymous Reporting, which
allows Cisco to securely receive minimal error and health information from the device.
Also available in Version 8.4(2).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-16

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-6

New Features for ASA Version 8.2(5) (continued)

Feature

Description

IF-MIB ifAlias OID
support

The ASA now supports the ifAlias OID. When you browse the IF-MIB, the ifAlias OID will be set
to the value that has been set for the interface description.
Also available in Version 8.4(2).

Remote Access Features

Portal Access Rules

This enhancement allows customers to configure a global clientless SSL VPN access policy to
permit or deny clientless SSL VPN sessions based on the data present in the HTTP header. If
denied, an error code is returned to the clients. This denial is performed before user authentication
and thus minimizes the use of processing resources.
Also available in Version 8.4(2).

Mobile Posture
(formerly referred to as
AnyConnect
Identification
Extensions for Mobile
Device Detection)

You can now configure the ASA to permit or deny VPN connections to mobile devices, enable or
disable mobile device access on a per-group basis, and gather information about connected mobile
devices based on the mobile device posture data. The following mobile platforms support this
capability: AnyConnect for iPhone/iPad/iPod Versions 2.5.x and AnyConnect for Android Version
2.4.x. You do not need to enable CSD to configure these attributes in ASDM.
Licensing Requirements

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. You receive the following functionality based on the license you install:
•

AnyConnect Premium License Functionality
Enterprises that install the AnyConnect Premium license will be able to enforce DAP policies,
on supported mobile devices, based on these DAP attributes and any other existing endpoint
attributes. This includes allowing or denying remote access from a mobile device.

•

AnyConnect Essentials License Functionality
Enterprises that install the AnyConnect Essentials license will be able to do the following:
– Enable or disable mobile device access on a per-group basis and to configure that feature

using ASDM.
– Display information about connected mobile devices via CLI or ASDM without having the

ability to enforce DAP policies or deny or allow remote access to those mobile devices.
Also available in Version 8.4(2).
Split Tunnel DNS policy This release includes a new policy pushed down to the AnyConnect Secure Mobility Client for
for AnyConnect
resolving DNS addresses over split tunnels. This policy applies to VPN connections using the SSL
or IPsec/IKEv2 protocol and instructs the AnyConnect client to resolve all DNS addresses through
the VPN tunnel. If DNS resolution fails, the address remains unresolved and the AnyConnect client
does not try to resolve the address through public DNS servers.
By default, this feature is disabled. The client sends DNS queries over the tunnel according to the
split tunnel policy—tunnel all networks, tunnel networks specified in a network list, or exclude
networks specified in a network list.
Also available in Version 8.4(2).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-17

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-6

New Features for ASA Version 8.2(5) (continued)

Feature

Description

SSL SHA-2 digital
signature

You can now use of SHA-2 compliant signature algorithms to authenticate SSL VPN connections
that use digital certificates. Our support for SHA-2 includes all three hash sizes: SHA-256,
SHA-384, and SHA-512. SHA-2 requires AnyConnect 2.5(1) or later (2.5(2) or later
recommended). This release does not support SHA-2 for other uses or products.
Caution: To support failover of SHA-2 connections, the standby ASA must be running the same
image.
Also available in Version 8.4(2).

L2TP/IPsec support for
Android

We now support VPN connections between Android mobile devices and ASA 5500 series devices,
when using the L2TP/IPsec protocol and the native Android VPN client. Mobile devices must be
using the Android 2.1 or later operating system.
Also available in Version 8.4(1).

SHA2 certificate
signature support for
Microsoft Windows 7
and Android-native
VPN clients

ASA supports SHA2 certificate signature support for Microsoft Windows 7 and Android-native
VPN clients when using the L2TP/IPsec protocol.

Enable/disable
certificate mapping to
override the group-url
attribute

This feature changes the preference of a connection profile during the connection profile selection
process. By default, if the ASA matches a certificate field value specified in a connection profile
to the field value of the certificate used by the endpoint, the ASA assigns that profile to the VPN
connection. This optional feature changes the preference to a connection profile that specifies the
group URL requested by the endpoint. The new option lets administrators rely on the group URL
preference used by many older ASA software releases.

Also available in Version 8.4(2).

Also available in Version 8.4(2).
Interface Features

You can now enable pause (XOFF) frames for flow control on 1-Gigabit Ethernet interfaces;
Support for Pause
Frames for Flow Control support was previously added for 10-Gigabit Ethernet interfaces in 8.2(2).
on 1-Gigabit Ethernet
Also available in Version 8.4(2).
Interface
Unified Communications Features

ASA-Tandberg
Interoperability with
H.323 Inspection

H.323 Inspection now supports uni-directional signaling for two-way video sessions. This
enhancement allows H.323 Inspection of one-way video conferences supported by Tandberg video
phones. Supporting uni-directional signaling allows Tandberg phones to switch video modes (close
their side of an H.263 video session and reopen the session using H.264, the compression standard
for high-definition video).
Also available in Version 8.4(2).

Routing Features

Timeout for connections When multiple static routes exist to a network with different metrics, the ASA uses the one with
using a backup static
the best metric at the time of connection creation. If a better route becomes available, then this
route
timeout lets connections be closed so a connection can be reestablished to use the better route. The
default is 0 (the connection never times out). To take advantage of this feature, change the timeout
to a new value.
Also available in Version 8.4(2).

Cisco ASA 5500 Series Configuration Guide using the CLI

1-18

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

New Features in Version 8.4(1)
Released: January 31, 2011

Table 1-7 lists the new features for ASA Version 8.4(1).
Table 1-7

New Features for ASA Version 8.4(1)

Feature

Description

Hardware Features

Support for the ASA 5585-X We introduced support for the ASA 5585-X with Security Services Processor (SSP)-10, -20,
-40, and -60.
Note

No Payload Encryption
hardware for export

Support was previously added in 8.2(3) and 8.2(4); the ASA 5585-X is not supported
in 8.3(x).

You can purchase the ASA 5585-X with No Payload Encryption. For export to some countries,
payload encryption cannot be enabled on the Cisco ASA 5500 series. The ASA software senses
a No Payload Encryption model, and disables the following features:
•

Unified Communications

•

VPN

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 Filer (which uses SSL).
Remote Access Features

L2TP/IPsec Support on
Android Platforms

We now support VPN connections between Android mobile devices and ASA 5500 series
devices, when using the L2TP/IPsec protocol and the native Android VPN client. Mobile
devices must be using the Android 2.1, or later, operating system.
Also available in Version 8.2(5).

UTF-8 Character Support
for AnyConnect Passwords

AnyConnect 3.0 used with ASA 8.4(1), supports UTF-8 characters in passwords sent using
RADIUS/MSCHAP and LDAP protocols.

IPsec VPN Connections with Internet Key Exchange Version 2 (IKEv2) is the latest key exchange protocol used to establish
IKEv2
and control Internet Protocol Security (IPsec) tunnels. The ASA now supports IPsec with
IKEv2 for the AnyConnect Secure Mobility Client, Version 3.0(1), for all client operating
systems.
On the ASA, you enable IPsec connections for users in the group policy. For the AnyConnect
client, you specify the primary protocol (IPsec or SSL) for each ASA in the server list of the
client profile.
IPsec remote access VPN using IKEv2 was added to the AnyConnect Essentials and
AnyConnect Premium licenses.
Site-to-site sessions were added to the Other VPN license (formerly IPsec VPN). The Other
VPN license is included in the Base license.
We modified the following commands: vpn-tunnel-protocol, crypto ikev2 policy, crypto
ikev2 enable, crypto ipsec ikev2, crypto dynamic-map, crypto map.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-19

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-7

New Features for ASA Version 8.4(1) (continued)

Feature

Description

SSL SHA-2 digital signature This release supports the use of SHA-2 compliant signature algorithms to authenticate SSL
VPN connections that use digital certificates. Our support for SHA-2 includes all three hash
sizes: SHA-256, SHA-384, and SHA-512. SHA-2 requires AnyConnect 2.5.1 or later (2.5.2 or
later recommended). This release does not support SHA-2 for other uses or products. This
feature does not involve configuration changes.
Caution: To support failover of SHA-2 connections, the standby ASA must be running the
same image. To support this feature, we added the Signature Algorithm field to the show
crypto ca certificate command to identify the digest algorithm used when generating the
signature.
SCEP Proxy

SCEP Proxy provides the AnyConnect Secure Mobility Client with support for automated
third-party certificate enrollment. Use this feature to support AnyConnect with zero-touch,
secure deployment of device certificates to authorize endpoint connections, enforce policies
that prevent access by non-corporate assets, and track corporate assets. This feature requires
an AnyConnect Premium license and will not work with an Essentials license.
We introduced or modified the following commands: crypto ikev2 enable, scep-enrollment
enable, scep-forwarding-url, debug crypto ca scep-proxy,
secondary-username-from-certificate, secondary-pre-fill-username.

Host Scan Package Support

This feature provides the necessary support for the ASA to install or upgrade a Host Scan
package and enable or disable Host Scan. This package may either be a standalone Host Scan
package or one that ASA extracts from an AnyConnect Next Generation package.
In previous releases of AnyConnect, an endpoint’s posture was determined by Cisco Secure
Desktop (CSD). Host Scan was one of many features bundled in CSD. Unbundling Host Scan
from CSD gives AnyConnect administrators greater freedom to update and install Host Scan
separately from the other features of CSD.
We introduced the following command: csd hostscan image path.

Kerberos Constrained
Delegation (KCD)

This release implements the KCD protocol transition and constrained delegation extensions on
the ASA. KCD provides Clientless SSL VPN (also known as WebVPN) users with SSO access
to any web services protected by Kerberos. Examples of such services or applications include
Outlook Web Access (OWA), Sharepoint, and Internet Information Server (IIS).
Implementing protocol transition allows the ASA to obtain Kerberos service tickets on behalf
of remote access users without requiring them to authenticate to the KDC (through Kerberos).
Instead, a user authenticates to ASA using any of the supported authentication mechanisms,
including digital certificates and Smartcards, for Clientless SSL VPN (also known as
WebVPN). When user authentication is complete, the ASA requests and obtains an
impersonate ticket, which is a service ticket for ASA on behalf of the user. The ASA may then
use the impersonate ticket to obtain other service tickets for the remote access user.
Constrained delegation provides a way for domain administrators to limit the network
resources that a service trusted for delegation (for example, the ASA) can access. This task is
accomplished by configuring the account under which the service is running to be trusted for
delegation to a specific instance of a service running on a specific computer.
We modified the following commands: kcd-server, clear aaa, show aaa, test aaa-server
authentication.

Clientless SSL VPN browser The ASA now supports clientless SSL VPN with Apple Safari 5.
support

Cisco ASA 5500 Series Configuration Guide using the CLI

1-20

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-7

New Features for ASA Version 8.4(1) (continued)

Feature

Description

Clientless VPN Auto
Sign-on Enhancement

Smart tunnel now supports HTTP-based auto sign-on on Firefox as well as Internet Explorer.
Similar to when Internet Explorer is used, the administrator decides to which hosts a Firefox
browser will automatically send credentials. For some authentication methods, if may be
necessary for the administrator to specify a realm string on the ASA to match that on the web
application (in the Add Smart Tunnel Auto Sign-on Server window). You can now use
bookmarks with macro substitutions for auto sign-on with Smart tunnel as well.
The POST plug-in is now obsolete. The former POST plug-in was created so that
administrators could specify a bookmark with sign-on macros and receive a kick-off page to
load prior to posting the the POST request. The POST plug-in approach allows requests that
required the presence of cookies, and other header items, fetched ahead of time to go through.
The administrator can now specify pre-load pages when creating bookmarks to achieve the
same functionality. Same as the POST plug-in, the administrator specifies the pre-load page
URL and the URL to send the POST request to.
You can now replace the default preconfigured SSL VPN portal with your own portal. The
administrators do this by specifying a URL as an External Portal. Unlike the group-policy
home page, the External Portal supports POST requests with macro substitution (for auto
sign-on) as well as pre-load pages.
We introduced or modified the following command: smart-tunnel auto-signon.

Expanded Smart Tunnel
application support

Smart Tunnel adds support for the following applications:
•

Microsoft Outlook Exchange Server 2010 (native support).
Users can now use Smart Tunnel to connect Microsoft Office Outlook to a Microsoft
Exchange Server.

•

Microsoft Sharepoint/Office 2010.
Users can now perform remote file editing using Microsoft Office 2010 Applications and
Microsoft Sharepoint by using Smart Tunnel.

Interface Features

EtherChannel support (ASA You can configure up to 48 802.3ad EtherChannels of eight active interfaces each.
5510 and higher)
Note
You cannot use interfaces on the 4GE SSM, including the integrated 4GE SSM in slot 1
on the ASA 5550, as part of an EtherChannel.
We introduced the following commands: channel-group, lacp port-priority, interface
port-channel, lacp max-bundle, port-channel min-bundle, port-channel load-balance,
lacp system-priority, clear lacp counters, show lacp, show port-channel.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-21

Chapter 1

Introduction to the Cisco ASA 5500 Series

New Features

Table 1-7

New Features for ASA Version 8.4(1) (continued)

Feature

Description

Bridge groups for
transparent mode

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.
Scalability Features

Increased contexts for the
ASA 5550, 5580, and
5585-X

For the ASA 5550 and ASA 5585-X with SSP-10, the maximum contexts was increased from
50 to 100. For the ASA 5580 and 5585-X with SSP-20 and higher, the maximum was increased
from 50 to 250.

Increased VLANs for the
ASA 5580 and 5585-X

For the ASA 5580 and 5585-X, the maximum VLANs was increased from 250 to 1024.

Additional platform support Google Chrome has been added as a supported platform for ASA Version 8.4. Both 32-bit and
64-bit platforms are supported on Windows XP, Vista, and 7 and Mac OS X Version 6.0.
Increased connections for
the ASA 5580 and 5585-X

We increased the firewall connection limits:
•

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.

Increased AnyConnect VPN The AnyConnect VPN session limit was increased from 5,000 to 10,000.
sessions for the ASA 5580
Increased Other VPN
sessions for the ASA 5580

The other VPN session limit was increased from 5,000 to 10,000.

High Availability Features

Stateful Failover with
Dynamic Routing Protocols

Routes that are learned through dynamic routing protocols (such as OSPF and EIGRP) on the
active unit are now maintained in a Routing Information Base (RIB) table on the standby unit.
Upon a failover event, traffic on the secondary active unit now passes with minimal disruption
because routes are known.
We modified the following commands: show failover, show route, show route failover.

Unified Communication Features

Cisco ASA 5500 Series Configuration Guide using the CLI

1-22

Chapter 1

Introduction to the Cisco ASA 5500 Series
New Features

Table 1-7

New Features for ASA Version 8.4(1) (continued)

Feature

Description

UC Protocol Inspection
Enhancements

SIP Inspection and SCCP Inspection are enhanced to support new features in the Unified
Communications Solutions; such as, SCCP v2.0 support, support for GETPORT messages in
SCCP Inspection, SDP field support in INVITE messages with SIP Inspection, and QSIG
tunneling over SIP. Additionally, the Cisco Intercompany Media Engine supports Cisco RT
Lite phones and third-party video endpoints (such as, Tandberg).
We did not modify any commands.

Inspection Features

DCERPC Enhancement

DCERPC Inspection was enhanced to support inspection of RemoteCreateInstance RPC
messages.
We did not modify an commands.

Troubleshooting and Monitoring Features

SNMP traps and MIBs

Supports the following additional keywords: connection-limit-reached, entity
cpu-temperature, cpu threshold rising, 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: ENTITY-SENSOR-MIB,
CISCO-ENTITY-SENSOR-EXT-MIB, CISCO-ENTITY-FRU-CONTROL-MIB,
CISCO-PROCESS-MIB, CISCO-ENHANCED-MEMPOOL-MIB,
CISCO-L4L7MODULE-RESOURCE-LIMIT-MIB, NAT-MIB, EVENT-MIB,
EXPRESSION-MIB
Supports the following additional traps: warmstart, cpmCPURisingThreshold,
mteTriggerFired, cirResourceLimitReached, natPacketDiscard,
ciscoEntSensorExtThresholdNotification.
We introduced or modified the following commands: snmp cpu threshold rising, snmp
interface threshold, snmp-server enable traps.

TCP Ping Enhancement

TCP ping allows users whose ICMP echo requests are blocked to check connectivity over TCP.
With the TCP ping enhancement you can specify a source IP address and a port and source
interface to send pings to a hostname or an IPv4 address.
We modified the following command: ping tcp.

Show Top CPU Processes

You can now monitor the processes that run on the CPU to obtain information related to the
percentage of the CPU used by any given process. You can also see information about the load
on the CPU, broken down per process, at 5 minutes, 1 minute, and 5 seconds prior to the log
time. Information is updated automatically every 5 seconds to provide real-time statistics, and
a refresh button in the pane allows a manual data refresh at any time.
We introduced the following command: show process cpu-usage sorted.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-23

Chapter 1

Introduction to the Cisco ASA 5500 Series

Firewall Functional Overview

Table 1-7

New Features for ASA Version 8.4(1) (continued)

Feature

Description

General Features

Password Encryption
Visibility

You can show password encryption in a security context.
We modified the following command: show password encryption.

Firewall Functional Overview
Firewalls protect inside networks from unauthorized access by users on an outside network. A firewall
can also protect inside networks from each other, for example, by keeping a human resources network
separate from a user network. If you have network resources that need to be available to an outside user,
such as a web or FTP server, you can place these resources on a separate network behind the firewall,
called a demilitarized zone (DMZ). The firewall allows limited access to the DMZ, but because the DMZ
only includes the public servers, an attack there only affects the servers and does not affect the other
inside networks. You can also control when inside users access outside networks (for example, access to
the Internet), by allowing only certain addresses out, by requiring authentication or authorization, or by
coordinating with an external URL filtering server.
When discussing networks connected to a firewall, the outside network is in front of the firewall, the
inside network is protected and behind the firewall, and a DMZ, while behind the firewall, allows limited
access to outside users. Because the ASA lets you configure many interfaces with varied security
policies, including many inside interfaces, many DMZs, and even many outside interfaces if desired,
these terms are used in a general sense only.
This section includes the following topics:
•

Security Policy Overview, page 1-24

•

Firewall Mode Overview, page 1-27

•

Stateful Inspection Overview, page 1-27

Security Policy Overview
A security policy determines which traffic is allowed to pass through the firewall to access another
network. By default, the ASA allows traffic to flow freely from an inside network (higher security level)
to an outside network (lower security level). You can apply actions to traffic to customize the security
policy. This section includes the following topics:
•

Permitting or Denying Traffic with Access Lists, page 1-25

•

Applying NAT, page 1-25

•

Protecting from IP Fragments, page 1-25

•

Using AAA for Through Traffic, page 1-25

•

Applying HTTP, HTTPS, or FTP Filtering, page 1-25

•

Applying Application Inspection, page 1-25

•

Sending Traffic to the IPS Module, page 1-26

Cisco ASA 5500 Series Configuration Guide using the CLI

1-24

Chapter 1

Introduction to the Cisco ASA 5500 Series
Firewall Functional Overview

•

Sending Traffic to the Content Security and Control Module, page 1-26

•

Applying QoS Policies, page 1-26

•

Applying Connection Limits and TCP Normalization, page 1-26

•

Enabling Threat Detection, page 1-26

•

Enabling the Botnet Traffic Filter, page 1-27

•

Configuring Cisco Unified Communications, page 1-27

Permitting or Denying Traffic with Access Lists
You can apply an access list to limit traffic from inside to outside, or allow traffic from outside to inside.
For transparent firewall mode, you can also apply an EtherType access list to allow non-IP traffic.

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.

Protecting from IP Fragments
The ASA provides IP fragment protection. This feature performs full reassembly of all ICMP error
messages and virtual reassembly of the remaining IP fragments that are routed through the ASA.
Fragments that fail the security check are dropped and logged. Virtual reassembly cannot be disabled.

Using AAA for Through Traffic
You can require authentication and/or authorization for certain types of traffic, for example, for HTTP.
The ASA also sends accounting information to a RADIUS or TACACS+ server.

Applying HTTP, HTTPS, or FTP Filtering
Although you can use access lists to prevent outbound access to specific websites or FTP servers,
configuring and managing web usage this way is not practical because of the size and dynamic nature of
the Internet. We recommend that you use the ASA in conjunction with a separate server running one of
the following Internet filtering products:
•

Websense Enterprise

•

Secure Computing SmartFilter

Applying Application Inspection
Inspection engines are required for services that embed IP addressing information in the user data packet
or that open secondary channels on dynamically assigned ports. These protocols require the ASA to
perform a deep packet inspection.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-25

Chapter 1

Introduction to the Cisco ASA 5500 Series

Firewall Functional Overview

Sending Traffic to the IPS Module
If your model supports the IPS module for intrusion prevention, then you can send traffic to the module
for inspection. The IPS module monitors and performs real-time analysis of network traffic by looking
for anomalies and misuse based on an extensive, embedded signature library. When the system detects
unauthorized activity, it can terminate the specific connection, permanently block the attacking host, log
the incident, and send an alert to the device manager. Other legitimate connections continue to operate
independently without interruption. For more information, see the documentation for your IPS module.

Sending Traffic to the Content Security and Control Module
If your model supports it, the CSC SSM provides protection against viruses, spyware, spam, and other
unwanted traffic. It accomplishes this by scanning the FTP, HTTP, POP3, and SMTP traffic that you
configure the ASA to send to it.

Applying QoS Policies
Some network traffic, such as voice and streaming video, cannot tolerate long latency times. QoS is a
network feature that lets you give priority to these types of traffic. QoS refers to the capability of a
network to provide better service to selected network traffic.

Applying Connection Limits and TCP Normalization
You can limit TCP and UDP connections and embryonic connections. Limiting the number of
connections and embryonic connections protects you from a DoS attack. The ASA uses the embryonic
limit to trigger TCP Intercept, which protects inside systems from a DoS attack perpetrated by flooding
an interface with TCP SYN packets. An embryonic connection is a connection request that has not
finished the necessary handshake between source and destination.
TCP normalization is a feature consisting of advanced TCP connection settings designed to drop packets
that do not appear normal.

Enabling Threat Detection
You can configure scanning threat detection and basic threat detection, and also how to use statistics to
analyze threats.
Basic threat detection detects activity that might be related to an attack, such as a DoS attack, and
automatically sends a system log message.
A typical scanning attack consists of a host that tests the accessibility of every IP address in a subnet (by
scanning through many hosts in the subnet or sweeping through many ports in a host or subnet). The
scanning threat detection feature determines when a host is performing a scan. Unlike IPS scan detection
that is based on traffic signatures, the ASA scanning threat detection feature maintains an extensive
database that contains host statistics that can be analyzed for scanning activity.
The host database tracks suspicious activity such as connections with no return activity, access of closed
service ports, vulnerable TCP behaviors such as non-random IPID, and many more behaviors.
You can configure the ASA to send system log messages about an attacker or you can automatically shun
the host.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-26

Chapter 1

Introduction to the Cisco ASA 5500 Series
Firewall Functional Overview

Enabling the Botnet Traffic Filter
Malware is malicious software that is installed on an unknowing host. Malware that attempts network
activity such as sending private data (passwords, credit card numbers, key strokes, or proprietary data)
can be detected by the Botnet Traffic Filter when the malware starts a connection to a known bad IP
address. The Botnet Traffic Filter checks incoming and outgoing connections against a dynamic database
of known bad domain names and IP addresses (the blacklist), and then logs any suspicious activity. When
you see syslog messages about the malware activity, you can take steps to isolate and disinfect the host.

Configuring Cisco Unified Communications
The Cisco ASA 5500 series is a strategic platform to provide proxy functions for unified
communications deployments. The purpose of a proxy is to terminate and reoriginate connections
between a client and server. The proxy delivers a range of security functions such as traffic inspection,
protocol conformance, and policy control to ensure security for the internal network. An increasingly
popular function of a proxy is to terminate encrypted connections in order to apply security policies
while maintaining confidentiality of connections.

Firewall Mode Overview
The ASA runs in two different firewall modes:
•

Routed

•

Transparent

In routed mode, the ASA is considered to be a router hop in the network.
In transparent mode, the ASA acts like a “bump in the wire,” or a “stealth firewall,” and is not considered
a router hop. The ASA connects to the same network on its inside and outside interfaces.
You might use a transparent firewall to simplify your network configuration. Transparent mode is also
useful if you want the firewall to be invisible to attackers. You can also use a transparent firewall for
traffic that would otherwise be blocked in routed mode. For example, a transparent firewall can allow
multicast streams using an EtherType access list.

Stateful Inspection Overview
All traffic that goes through the ASA is inspected using the Adaptive Security Algorithm and either
allowed through or dropped. A simple packet filter can check for the correct source address, destination
address, and ports, but it does not check that the packet sequence or flags are correct. A filter also checks
every packet against the filter, which can be a slow process.

Note

The TCP state bypass feature allows you to customize the packet flow. See the “TCP State Bypass”
section on page 53-3.
A stateful firewall like the ASA, however, takes into consideration the state of a packet:
•

Is this a new connection?

Cisco ASA 5500 Series Configuration Guide using the CLI

1-27

Chapter 1

Introduction to the Cisco ASA 5500 Series

VPN Functional Overview

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”

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
– Layer 3 and Layer 4 header adjustments

For UDP or other connectionless protocols, the ASA creates connection state information so that it
can also use the fast path.
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.

VPN Functional Overview
A VPN is a secure connection across a TCP/IP network (such as the Internet) that appears as a private
connection. This secure connection is called a tunnel. The ASA uses tunneling protocols to negotiate
security parameters, create and manage tunnels, encapsulate packets, transmit or receive them through
the tunnel, and unencapsulate them. The ASA functions as a bidirectional tunnel endpoint: it can receive
plain packets, encapsulate them, and send them to the other end of the tunnel where they are
unencapsulated and sent to their final destination. It can also receive encapsulated packets,
unencapsulate them, and send them to their final destination. The ASA invokes various standard
protocols to accomplish these functions.
The ASA performs the following functions:
•

Establishes tunnels

•

Negotiates tunnel parameters

Cisco ASA 5500 Series Configuration Guide using the CLI

1-28

Chapter 1

Introduction to the Cisco ASA 5500 Series
Security Context Overview

•

Authenticates users

•

Assigns user addresses

•

Encrypts and decrypts data

•

Manages security keys

•

Manages data transfer across the tunnel

•

Manages data transfer inbound and outbound as a tunnel endpoint or router

The ASA invokes various standard protocols to accomplish these functions.

Security Context Overview
You can partition a single ASA into multiple virtual devices, known as security contexts. Each context
is an independent device, with its own security policy, interfaces, and administrators. Multiple contexts
are similar to having multiple standalone devices. Many features are supported in multiple context mode,
including routing tables, firewall features, IPS, and management. Some features are not supported,
including VPN and dynamic routing protocols.
In multiple context mode, the ASA includes a configuration for each context that identifies the security
policy, interfaces, and almost all the options you can configure on a standalone device. The system
administrator adds and manages contexts by configuring them 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 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

1-29

Chapter 1
Security Context Overview

Cisco ASA 5500 Series Configuration Guide using the CLI

1-30

Introduction to the Cisco ASA 5500 Series

CH A P T E R

2

Getting Started
This chapter describes how to get started with your ASA. This chapter includes the following sections:
•

Accessing the Appliance Command-Line Interface, page 2-1

•

Configuring ASDM Access for Appliances, page 2-2

•

Starting ASDM, page 2-6

•

Factory Default Configurations, page 2-10

•

Working with the Configuration, page 2-15

•

Applying Configuration Changes to Connections, page 2-19

Accessing the Appliance Command-Line Interface
For initial configuration, access the CLI directly from the console port. Later, you can configure remote
access using Telnet or SSH according to Chapter 37, “Configuring Management Access.” If your system
is already in multiple context mode, then accessing the console port places you in the system execution
space. See Chapter 5, “Configuring Multiple Context Mode,” for more information about multiple
context mode.

Detailed Steps
Step 1

Connect a PC 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.

Step 2

Press the Enter key to see the following prompt:
hostname>
This prompt indicates that you are in user EXEC mode. Only basic commands are available from user
EXEC mode.

Step 3

To access privileged EXEC mode, enter the following command:
hostname> enable

The following prompt appears:
Password:

Cisco ASA 5500 Series Configuration Guide using the CLI

2-1

Chapter 2

Getting Started

Configuring ASDM Access for Appliances

All non-configuration commands are available in privileged EXEC mode. You can also enter
configuration mode from privileged EXEC mode.
Step 4

Enter the enable password at the prompt.
By default, the password is blank, and you can press the Enter key to continue. See the “Configuring
the Hostname, Domain Name, and Passwords” section on page 10-1 to change the enable password.
The prompt changes to the following:
hostname#

To exit privileged mode, enter the disable, exit, or quit command.
Step 5

To access global configuration mode, enter the following command:
hostname# configure terminal

The prompt changes to the following:
hostname(config)#

You can begin to configure the ASA from global configuration mode. To exit global configuration mode,
enter the exit, quit, or end command.

Configuring ASDM Access for Appliances
ASDM access requires some minimal configuration so you can communicate over the network with a
management interface. This section includes the following topics:
•

Accessing ASDM Using the Factory Default Configuration, page 2-2

•

Accessing ASDM Using a Non-Default Configuration (ASA 5505), page 2-3

•

Accessing ASDM Using a Non-Default Configuration (ASA 5510 and Higher), page 2-5

Accessing ASDM Using the Factory Default Configuration
With a factory default configuration (see the “Factory Default Configurations” section on page 2-10),
ASDM connectivity is preconfigured with default network settings. Connect to ASDM using the
following interface and network settings:
•

The management interface depends on your model:
– ASA 5505—The switch port to which you connect to ASDM can be any port, except for

Ethernet 0/0.
– ASA 5510 and higher—The interface to which you connect to ASDM is Management 0/0.
•

The default management address is 192.168.1.1.

•

The clients allowed to access ASDM must be on the 192.168.1.0/24 network. The default
configuration enables DHCP so your management station can be assigned an IP address in this
range. To allow other client IP addresses to access ASDM, see the “Configuring ASA Access for
ASDM, Telnet, or SSH” section on page 37-1.

To launch ASDM, see the “Starting ASDM” section on page 2-6.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-2

Chapter 2

Getting Started
Configuring ASDM Access for Appliances

Note

To change to multiple context mode, see the “Enabling or Disabling Multiple Context Mode” section on
page 5-15. After changing to multiple context mode, you can access ASDM from the admin context
using the network settings above.

Accessing ASDM Using a Non-Default Configuration (ASA 5505)
If you do not have a factory default configuration, or want to change to transparent firewall mode,
perform the following steps. See also the sample configurations in the “ASA 5505 Default
Configuration” section on page 2-11.

Prerequisites
Access the CLI according to the “Accessing the Appliance Command-Line Interface” section on
page 2-1.

Detailed Steps

Command
Step 1

(Optional)
firewall transparent

Purpose
Enables transparent firewall mode. This command clears your
configuration. See the “Configuring the Firewall Mode” section
on page 4-1 for more information.

Example:
hostname(config)# firewall transparent

Step 2

Do one of the following to configure a management interface, depending on your mode:
Routed mode:
interface vlan number
ip address ip_address [mask]
nameif name
security-level level

Configures an interface in routed mode. The security-level is a
number between 1 and 100, where 100 is the most secure.

Example:
hostname(config)# interface vlan 1
hostname(config-if)# ip address
192.168.1.1 255.255.255.0
hostname(config-if)# nameif inside
hostname(config-if)# security-level 100

Cisco ASA 5500 Series Configuration Guide using the CLI

2-3

Chapter 2

Getting Started

Configuring ASDM Access for Appliances

Command

Purpose

Transparent mode:

Configures a bridge virtual interface and assigns a management
VLAN to the bridge group. The security-level is a number
between 1 and 100, where 100 is the most secure.

interface bvi number
ip address ip_address [mask]
interface vlan number
bridge-group bvi_number
nameif name
security-level level

Example:
hostname(config)# interface bvi 1
hostname(config-if)# ip address
192.168.1.1 255.255.255.0
hostname(config)# interface vlan 1
hostname(config-if)# bridge-group 1
hostname(config-if)# nameif inside
hostname(config-if)# security-level 100

Step 3

interface ethernet 0/n
switchport access vlan number
no shutdown

Enables the management switchport and assigns it to the
management VLAN.

Example:
hostname(config)# interface ethernet 0/1
hostname(config-if)# switchport access
vlan 1
hostname(config-if)# no shutdown

Step 4

dhcpd address ip_address-ip_address
interface_name
dhcpd enable interface_name

Example:
hostname(config)# dhcpd address
192.168.1.5-192.168.1.254 inside
hostname(config)# dhcpd enable inside

Step 5

http server enable

Enables DHCP for the management host on the management
interface network. Make sure you do not include the management
address in the range.
Note

By default, the IPS module, if installed, uses 192.168.1.2
for its internal management address, so be sure not to use
this address in the DHCP range. You can later change the
IPS module management address using the ASA if
required.

Enables the HTTP server for ASDM.

Example:
hostname(config)# http server enable

Step 6

http ip_address mask interface_name

Allows the management host to access ASDM.

Example:
hostname(config)# http 192.168.1.0
255.255.255.0 inside

Step 7

write memory

Saves the configuration.

Example:
hostname(config)# write memory

Step 8

To launch ASDM, see the “Starting ASDM”
section on page 2-6.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-4

Launches ASDM.

Chapter 2

Getting Started
Configuring ASDM Access for Appliances

Examples
The following configuration converts the firewall mode to transparent mode, configures the VLAN 1
interface and assigns it to BVI 1, enables a switchport, and enables ASDM for a management host:
firewall transparent
interface bvi 1
ip address 192.168.1.1 255.255.255.0
interface vlan 1
bridge-group 1
nameif inside
security-level 100
interface ethernet 0/1
switchport access vlan 1
no shutdown
dhcpd address 192.168.1.5-192.168.1.254 inside
dhcpd enable inside
http server enable
http 192.168.1.0 255.255.255.0 inside

Accessing ASDM Using a Non-Default Configuration (ASA 5510 and Higher)
If you do not have a factory default configuration, or want to change the firewall or context mode,
perform the following steps.

Prerequisites
Access the CLI according to the “Accessing the Appliance Command-Line Interface” section on
page 2-1.

Detailed Steps

Command
Step 1

(Optional)
firewall transparent

Purpose
Enables transparent firewall mode. This command clears your
configuration. See the “Configuring the Firewall Mode” section
on page 4-1 for more information.

Example:
hostname(config)# firewall transparent

Step 2

interface management 0/0
ip address ip_address mask
nameif name
security-level number
no shutdown

Configures the Management 0/0 interface. The security-level is a
number between 1 and 100, where 100 is the most secure.

Example:
hostname(config)# interface management 0/0
hostname(config-if)# ip address
192.168.1.1 255.255.255.0
hostname(config-if)# nameif management
hostname(config-if)# security-level 100
hostname(config-if)# no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

2-5

Chapter 2

Getting Started

Starting ASDM

Step 3

Command

Purpose

dhcpd address ip_address-ip_address
interface_name
dhcpd enable interface_name

Enables DHCP for the management host on the management
interface network. Make sure you do not include the Management
0/0 address in the range.

Example:
hostname(config)# dhcpd address
192.168.1.2-192.168.1.254 management
hostname(config)# dhcpd enable management

Step 4

http server enable

Enables the HTTP server for ASDM.

Example:
hostname(config)# http server enable

Step 5

http ip_address mask interface_name

Allows the management host to access ASDM.

Example:
hostname(config)# http 192.168.1.0
255.255.255.0 management

Step 6

write memory

Saves the configuration.

Example:
hostname(config)# write memory

Step 7

(Optional)
mode multiple

Example:

Sets the mode to multiple mode. When prompted, confirm that
you want to convert the existing configuration to be the admin
context. You are then prompted to reload the ASASM. See
Chapter 5, “Configuring Multiple Context Mode,” for more
information.

hostname(config)# mode multiple

Step 8

To launch ASDM, see the “Starting ASDM”
section on page 2-6.

Launches ASDM.

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
ip address 192.168.1.1 255.255.255.0
nameif management
security-level 100
no shutdown
dhcpd address 192.168.1.2-192.168.1.254 management
dhcpd enable management
http server enable
http 192.168.1.0 255.255.255.0 management

Starting ASDM
You can start ASDM using two methods:

Cisco ASA 5500 Series Configuration Guide using the CLI

2-6

Chapter 2

Getting Started
Starting ASDM

Note

•

ASDM-IDM Launcher (Windows only)—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 application to your PC;
however you need separate applications 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 application 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 application. This section includes the following topics:

Note

•

Connecting to ASDM for the First Time, page 2-7

•

Starting ASDM from the ASDM-IDM Launcher, page 2-8

•

Starting ASDM from the Java Web Start Application, page 2-8

•

Using ASDM in Demo Mode, page 2-9

ASDM allows multiple PCs or workstations to each have one browser session open with the same ASA
software. A single ASA can support up to five concurrent ASDM sessions in single, routed mode. Only
one session per browser per PC or workstation is supported for a specified ASA. In multiple context
mode, five concurrent ASDM sessions are supported per context, up to a maximum of 32 total connections
for each ASA.

Connecting to ASDM for the First Time
To connect to ASDM for the first time to download the ASDM-IDM Launcher or Java Web Start
application, perform the following steps:
Step 1

From a supported web browser on the ASA network, enter the following URL:
https://interface_ip_address/admin

Where interface_ip_address is the management IP address of the ASA. See the “Configuring ASDM
Access for Appliances” section on page 2-2 for more information about management access.
See the ASDM release notes for your release for the requirements to run ASDM.
The ASDM launch page appears with the following buttons:

Step 2

•

Install ASDM Launcher and Run ASDM (Windows only)

•

Run ASDM

•

Run Startup Wizard

To download the Launcher:
a.

Click Install ASDM Launcher and Run ASDM.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-7

Chapter 2

Getting Started

Starting ASDM

Step 3

b.

Enter the username and password, and click OK. For a factory default configuration, leave these
fields empty. With no HTTPS authentication configured, you can gain access to ASDM with no
username and the enable password, which is blank by default. With HTTPS authentication enabled,
enter your username and associated password.

c.

Save the installer to your PC, and then start the installer. The ASDM-IDM Launcher opens
automatically after installation is complete.

d.

See the “Starting ASDM from the ASDM-IDM Launcher” section on page 2-8 to use the Launcher
to connect to ASDM.

To use the Java Web Start application:
a.

Click Run ASDM or Run Startup Wizard.

b.

Save the application to your PC when prompted. You can optionally open it instead of saving it.

c.

See the “Starting ASDM from the Java Web Start Application” section on page 2-8 to use the Java
Web Start application to connect to ASDM.

Starting ASDM from the ASDM-IDM Launcher
To start ASDM from the ASDM-IDM Launcher, perform the following steps.

Prerequisites
Download the ASDM-IDM Launcher according to the “Connecting to ASDM for the First Time” section
on page 2-7.

Detailed Steps
Step 1

Start the ASDM-IDM Launcher application.

Step 2

Enter or choose the ASA IP address or hostname to which you want to connect. To clear the list of IP
addresses, click the trash can icon next to the Device/IP Address/Name field.

Step 3

Enter your username and your password, and then click OK.
For a factory default configuration, leave these fields empty. With no HTTPS authentication configured,
you can gain access to ASDM with no username and the enable password, which is blank by default.
With HTTPS authentication enabled, enter your username and associated password.
If there is a new version of ASDM on the ASA, the ASDM Launcher automatically downloads the new
version and requests that you update the current version before starting ASDM.
The main ASDM window appears.

Starting ASDM from the Java Web Start Application
To start ASDM from the Java Web Start application, perform the following steps.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-8

Chapter 2

Getting Started
Starting ASDM

Prerequisites
Download the Java Web Start application according to the “Connecting to ASDM for the First Time”
section on page 2-7.

Detailed Steps
Step 1

Start the Java Web Start application.

Step 2

Accept any certificates according to the dialog boxes that appear. The Cisco ASDM-IDM Launcher
appears.

Step 3

Enter the username and password, and click OK. For a factory default configuration, leave these fields
empty. With no HTTPS authentication configured, you can gain access to ASDM with no username and
the enable password, which is blank by default. With HTTPS authentication enabled, enter your
username and associated password.
The main ASDM window appears.

Using ASDM in Demo Mode
The ASDM Demo Mode, a separately installed application, lets you run ASDM without having a live
device available. In this mode, you can do the following:
•

Perform configuration and selected monitoring tasks via ASDM as though you were interacting with
a real device.

•

Demonstrate ASDM or ASA features using the ASDM interface.

•

Perform configuration and monitoring tasks with the CSC SSM.

•

Obtain simulated monitoring and logging data, including real-time syslog messages. The data shown
is randomly generated; however, the experience is identical to what you would see when you are
connected to a real device.

This mode has been updated to support the following features:
•

For global policies, an ASA in single, routed mode and intrusion prevention

•

For object NAT, an ASA in single, routed mode and a firewall DMZ.

•

For the Botnet Traffic Filter, an ASA in single, routed mode and security contexts.

•

Site-to-Site VPN with IPv6 (Clientless SSL VPN and IPsec VPN)

•

Promiscuous IDS (intrusion prevention)

•

Unified Communication Wizard

This mode does not support the following:
•

Saving changes made to the configuration that appear in the GUI.

•

File or disk operations.

•

Historical monitoring data.

•

Non-administrative users.

•

These features:
– File menu:

Cisco ASA 5500 Series Configuration Guide using the CLI

2-9

Chapter 2

Getting Started

Factory Default Configurations

Save Running Configuration to Flash
Save Running Configuration to TFTP Server
Save Running Configuration to Standby Unit
Save Internal Log Buffer to Flash
Clear Internal Log Buffer
– Tools menu:

Command Line Interface
Ping
File Management
Update Software
File Transfer
Upload Image from Local PC
System Reload
– Toolbar/Status bar > Save
– Configuration > Interface > Edit Interface > Renew DHCP Lease
– Configuring a standby device after failover
•

Operations that cause a rereading of the configuration, in which the GUI reverts to the original
configuration:
– Switching contexts
– Making changes in the Interface pane
– NAT pane changes
– Clock pane changes

To run ASDM in Demo Mode, perform the following steps:
Step 1

Download the ASDM Demo Mode installer, asdm-demo-version.msi, from the following location:
http://www.cisco.com/cisco/web/download/index.html.

Step 2

Double-click the installer to install the software.

Step 3

Double-click the Cisco ASDM Launcher shortcut on your desktop, or open it from the Start menu.

Step 4

Check the Run in Demo Mode check box.
The Demo Mode window appears.

Factory Default Configurations
The factory default configuration is the configuration applied by Cisco to new ASAs.
•

ASA 5505—The factory default configuration configures interfaces and NAT so that the ASA is
ready to use in your network immediately.

•

ASA 5510 and higher—The factory default configuration configures an interface for management
so you can connect to it using ASDM, with which you can then complete your configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-10

Chapter 2

Getting Started
Factory Default Configurations

The factory default configuration is available only for routed firewall mode and single context mode. See
Chapter 5, “Configuring Multiple Context Mode,” for more information about multiple context mode.
See Chapter 4, “Configuring the Transparent or Routed Firewall,” for more information about routed and
transparent firewall mode. For the ASA 5505, a sample transparent mode configuration is provided in
this section.

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.
This section includes the following topics:
•

Restoring the Factory Default Configuration, page 2-11

•

ASA 5505 Default Configuration, page 2-11

•

ASA 5510 and Higher Default Configuration, page 2-15

Restoring the Factory Default Configuration
This section describes how to restore the factory default configuration.

Limitations
This feature is available only in routed firewall mode; transparent mode does not support IP addresses
for interfaces. In addition, this feature is available only in single context mode; an ASA with a cleared
configuration does not have any defined contexts to configure automatically using this feature.

Detailed Steps
What to Do Next
See the “Working with the Configuration” section on page 2-15 to start configuring the ASA.

ASA 5505 Default Configuration
The default configuration is available for routed mode only. This section describes the default
configuration and also provides a sample transparent mode configuration that you can copy and paste as
a starting point. This section includes the following topics:
•

ASA 5505 Routed Mode Default Configuration, page 2-11

•

ASA 5505 Transparent Mode Sample Configuration, page 2-13

ASA 5505 Routed Mode Default Configuration
The default factory configuration for the ASA 5505 configures the following:
•

Interfaces—Inside (VLAN 1) and outside (VLAN 2).

•

Switchports enabled and assigned—Ethernet 0/1 through 0/7 switch ports assigned to inside.
Ethernet 0/0 assigned to outside.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-11

Chapter 2

Getting Started

Factory Default Configurations

•

IP addresses— Outside address from DHCP; inside address set manually to 192.168.1.1/24.

•

Network Address Translation (NAT)—All inside IP addresses are translated when accessing the
outside using interface PAT.

•

Traffic flow—IPv4 and IPv6 traffic allowed from inside to outside (this behavior is implicit on the
ASA). Outside users are prevented from accessing the inside.

•

DHCP server—Enabled for inside hosts, so a PC connecting to the inside interface receives an
address between 192.168.1.5 and 192.168.1.254. DNS, WINS, and domain information obtained
from the DHCP client on the outside interface is passed to the DHCP clients on the inside interface.

•

Default route—Derived from DHCP.

•

ASDM access—Inside hosts allowed.

Figure 2-1 shows the traffic flow for an ASA 5505 in routed mode.
Figure 2-1

ASA 5505 Routed Mode

Internet

Internet Gateway Router

outside interface
PAT

outside VLAN 2 (Ethernet 0/0)
(from router DHCP)

inside VLAN 1 (Ethernet 0/1-0/7)
192.168.1.1
ASDM
192.168.1.5
(from ASA DHCP)

330618

IP traffic

The configuration consists of the following commands:
interface Ethernet 0/0
switchport access vlan
no shutdown
interface Ethernet 0/1
switchport access vlan
no shutdown
interface Ethernet 0/2
switchport access vlan
no shutdown
interface Ethernet 0/3
switchport access vlan
no shutdown
interface Ethernet 0/4
switchport access vlan
no shutdown
interface Ethernet 0/5
switchport access vlan
no shutdown
interface Ethernet 0/6
switchport access vlan

2

1

1

1

1

1

1

Cisco ASA 5500 Series Configuration Guide using the CLI

2-12

Chapter 2

Getting Started
Factory Default Configurations

no shutdown
interface Ethernet 0/7
switchport access vlan 1
no shutdown
interface vlan2
nameif outside
no shutdown
ip address dhcp setroute
interface vlan1
nameif inside
ip address 192.168.1.1 255.255.255.0
security-level 100
no shutdown
object network obj_any
subnet 0 0
nat (inside,outside) dynamic interface
http server enable
http 192.168.1.0 255.255.255.0 inside
dhcpd address 192.168.1.5-192.168.1.254 inside
dhcpd auto_config outside
dhcpd enable inside
logging asdm informational

Note

For testing purposes, you can allow ping from inside to outside by enabling ICMP inspection. Add the
following commands to the default configuration:
policy-map global_policy
class inspection_default
inspect icmp

ASA 5505 Transparent Mode Sample Configuration
When you change the mode to transparent mode, the configuration is erased. You can copy and paste the
following sample configuration at the CLI to get started. This configuration uses the default
configuration as a starting point. Note the following areas you may need to modify:
•

IP addresses—The IP addresses configured should be changed to match the network to which you
are connecting.

•

Static routes—For some kinds of traffic, static routes are required. See the “MAC Address vs. Route
Lookups” section on page 4-4.

•

Figure 2-2 shows the traffic flow for an ASA 5505 in transparent mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-13

Chapter 2
Factory Default Configurations

Figure 2-2

ASA 5505 Transparent Mode

Internet

Internet Gateway Router
192.168.1.3
outside VLAN 2 (Ethernet 0/0)
BVI 1 IP
192.168.1.1
inside VLAN 1 (Ethernet 0/1-0/7)
ASDM
192.168.1.5
(from ASA DHCP)

firewall transparent
interface Ethernet 0/0
switchport access vlan 2
no shutdown
interface Ethernet 0/1
switchport access vlan 1
no shutdown
interface Ethernet 0/2
switchport access vlan 1
no shutdown
interface Ethernet 0/3
switchport access vlan 1
no shutdown
interface Ethernet 0/4
switchport access vlan 1
no shutdown
interface Ethernet 0/5
switchport access vlan 1
no shutdown
interface Ethernet 0/6
switchport access vlan 1
no shutdown
interface Ethernet 0/7
switchport access vlan 1
no shutdown
interface bvi 1
ip address 192.168.1.1 255.255.255.0
interface vlan2
nameif outside
security-level 0
bridge-group 1
no shutdown
interface vlan1
nameif inside
security-level 100
bridge-group 1
no shutdown
http server enable
http 192.168.1.0 255.255.255.0 inside
dhcpd address 192.168.1.5-192.168.1.254 inside

Cisco ASA 5500 Series Configuration Guide using the CLI

2-14

330619

IP traffic

Getting Started

Chapter 2

Getting Started
Working with the Configuration

dhcpd enable inside

Note

For testing purposes, you can allow ping from inside to outside by enabling ICMP inspection. Add the
following commands to the sample configuration:
policy-map global_policy
class inspection_default
inspect icmp

ASA 5510 and Higher Default Configuration
The default factory configuration for the ASA 5510 and higher configures the following:
•

Management interface—Management 0/0 (management).

•

IP address—The management address is 192.168.1.1/24.

•

DHCP server—Enabled for management hosts, so a PC connecting to the management interface
receives an address between 192.168.1.2 and 192.168.1.254.

•

ASDM access—Management hosts allowed.

The configuration consists of the following commands:
interface management 0/0
ip address 192.168.1.1 255.255.255.0
nameif management
security-level 100
no shutdown
asdm logging informational 100
asdm history enable
http server enable
http 192.168.1.0 255.255.255.0 management
dhcpd address 192.168.1.2-192.168.1.254 management
dhcpd lease 3600
dhcpd ping_timeout 750
dhcpd enable management

Working with the Configuration
This section describes how to work with the configuration. The ASA loads the configuration from a text
file, called the startup configuration. This file resides by default as a hidden file in internal flash memory.
You can, however, specify a different path for the startup configuration. (For more information, see
Chapter 81, “Managing Software and Configurations.”)
When you enter a command, the change is made only to the running configuration in memory. You must
manually save the running configuration to the startup configuration for your changes to remain after a
reboot.
The information in this section applies to both single and multiple security contexts, except where noted.
Additional information about contexts is in Chapter 5, “Configuring Multiple Context Mode.”
This section includes the following topics:
•

Saving Configuration Changes, page 2-16

•

Copying the Startup Configuration to the Running Configuration, page 2-17

Cisco ASA 5500 Series Configuration Guide using the CLI

2-15

Chapter 2

Getting Started

Working with the Configuration

•

Viewing the Configuration, page 2-18

•

Clearing and Removing Configuration Settings, page 2-18

•

Creating Text Configuration Files Offline, page 2-19

Saving Configuration Changes
This section describes how to save your configuration and includes the following topics:
•

Saving Configuration Changes in Single Context Mode, page 2-16

•

Saving Configuration Changes in Multiple Context Mode, page 2-16

Saving Configuration Changes in Single Context Mode
To save the running configuration to the startup configuration, enter the following command:
Command

Purpose

write memory

Saves the running configuration to the startup configuration.
Note

The copy running-config startup-config command is equivalent
to the write memory command.

Example:
hostname# write memory

Saving Configuration Changes in Multiple Context Mode
You can save each context (and system) configuration separately, or you can save all context
configurations at the same time. This section includes the following topics:
•

Saving Each Context and System Separately, page 2-16

•

Saving All Context Configurations at the Same Time, page 2-17

Saving Each Context and System Separately
To save the system or context configuration, enter the following command within the system or context:
Command

Purpose

write memory

Saves the running configuration to the startup configuration.

Example:
hostname# 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

Cisco ASA 5500 Series Configuration Guide using the CLI

2-16

The copy running-config startup-config command is equivalent
to the write memory command.

Chapter 2

Getting Started
Working with the Configuration

Saving All Context Configurations at the Same Time
To save all context configurations at the same time, as well as the system configuration, enter the
following command in the system execution space:
Command

Purpose

write memory all [/noconfirm]

Saves the running configuration to the startup configuration for all contexts
and the system configuration.
If you do not enter the /noconfirm keyword, you see the following prompt:

Example:
hostname# write memory all /noconfirm

Are you sure [Y/N]:

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
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:
‘Saving context ‘b’ ... ( 1/3 contexts saved ) ’

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

Copying the Startup Configuration to the Running Configuration
Copy a new startup configuration to the running configuration using one of the following options.

Cisco ASA 5500 Series Configuration Guide using the CLI

2-17

Chapter 2

Getting Started

Working with the Configuration

Command

Purpose

copy startup-config running-config

Merges the startup configuration with the running configuration. A merge
adds any new commands from the new configuration to the running
configuration. If the configurations are the same, no changes 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
copy startup-config running-config

Loads the startup configuration and discards the running configuration
without requiring a reload.

Viewing the Configuration
The following commands let you view the running and startup configurations.
Command

Purpose

show running-config

Views the running configuration.

show running-config command

Views the running configuration of a specific command.

show startup-config

Views the startup configuration.

Clearing and Removing Configuration Settings
To erase settings, enter one of the following commands.
Command

Purpose

clear configure configurationcommand
[level2configurationcommand]

Clears all the configuration for a specified command. If you only want to
clear the configuration for a specific version of the command, you can
enter a value for level2configurationcommand.

Example:

For example, to clear the configuration for all aaa commands, enter the
following command:

hostname(config)# clear configure aaa

hostname(config)# clear configure aaa

To clear the configuration for only aaa authentication commands, enter
the following command:
hostname(config)# clear configure aaa authentication
no configurationcommand
[level2configurationcommand] qualifier

Disables the specific parameters or options of a command. In this case, you
use the no command to remove the specific configuration identified by
qualifier.

Example:

For example, to remove a specific nat command, enter enough of the
command to identify it uniquely as follows:

hostname(config)# no nat (inside) 1

hostname(config)# no nat (inside) 1

Cisco ASA 5500 Series Configuration Guide using the CLI

2-18

Chapter 2

Getting Started
Applying Configuration Changes to Connections

Command

Purpose

write erase

Erases the startup configuration.

Example:
hostname(config)# write erase

Erases the running configuration.

clear configure all

Note

Example:
hostname(config)# clear configure all

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.

Creating Text Configuration Files Offline
This guide describes how to use the CLI to configure the ASA; when you save commands, the changes
are written to a text file. Instead of using the CLI, however, you can edit a text file directly on your PC
and paste a configuration at the configuration mode command-line prompt in its entirety, or line by line.
Alternatively, you can download a text file to the ASA internal flash memory. See Chapter 81,
“Managing Software and Configurations,” for information on downloading the configuration file to the
ASA.
In most cases, commands described in this guide are preceded by a CLI prompt. The prompt in the
following example is “hostname(config)#”:
hostname(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 Appendix A, “Using the Command-Line
Interface.”

Applying Configuration Changes to Connections
When you make security policy changes to the configuration, all new connections use the new security
policy. Existing connections continue to use the policy that was configured at the time of the connection
establishment. To ensure that all connections use the new policy, you need to disconnect the current
connections so they can reconnect using the new policy. To disconnect connections, enter one of the
following commands:

Cisco ASA 5500 Series Configuration Guide using the CLI

2-19

Chapter 2

Getting Started

Applying Configuration Changes to Connections

Command

Purpose

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.

Example:
hostname(config)# clear local-host all

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]]

Example:
hostname(config)# clear conn all

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.

clear xlate [arguments]

This command clears dynamic NAT sessions; static sessions are not
affected. As a result, it removes any connections using those NAT sessions.

Example:

With no arguments, this command clears all NAT sessions. See the
command reference for more information about the arguments available.

hostname(config)# clear xlate

Cisco ASA 5500 Series Configuration Guide using the CLI

2-20

CH A P T E R

3

Managing Feature Licenses
A license specifies the options that are enabled on a given ASA. This document describes how to obtain
a license activation key and how to activate it. It also describes the available licenses for each model.

Note

This chapter describes licensing for Version 8.4 and 8.6; for other versions, see the licensing
documentation that applies to your version:
http://www.cisco.com/en/US/products/ps6120/products_licensing_information_listing.html
This chapter includes the following sections:
•

Supported Feature Licenses Per Model, page 3-1

•

Information About Feature Licenses, page 3-20

•

Guidelines and Limitations, page 3-31

•

Configuring Licenses, page 3-32

•

Monitoring Licenses, page 3-38

•

Feature History for Licensing, page 3-46

Supported Feature Licenses Per Model
This section describes the licenses available for each model as well as important notes about licenses.
This section includes the following topics:
•

Licenses Per Model, page 3-1

•

License Notes, page 3-16

•

VPN License and Feature Compatibility, page 3-20

Licenses Per Model
This section lists the feature licenses available for each model:
•

ASA 5505, page 3-2

•

ASA 5510, page 3-3

•

ASA 5520, page 3-4

Cisco ASA 5500 Series Configuration Guide using the CLI

3-1

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

•

ASA 5540, page 3-5

•

ASA 5550, page 3-6

•

ASA 5580, page 3-7

•

ASA 5512-X, page 3-8

•

ASA 5515-X, page 3-8

•

ASA 5525-X, page 3-9

•

ASA 5545-X, page 3-10

•

ASA 5555-X, page 3-11

•

ASA 5585-X with SSP-10, page 3-12

•

ASA 5585-X with SSP-20, page 3-13

•

ASA 5585-X with SSP-40 and -60, page 3-14

Items that are in italics are separate, optional licenses with which that you can replace the Base or
Security Plus license. You can mix and match licenses, for example, the 24 Unified Communications
license plus the Strong Encryption license; or the 500 AnyConnect Premium license plus the GTP/GPRS
license; or all four licenses together. (See Table 4-1.)
For detailed information about licenses, see the “License Notes” section on page 3-16.
ASA 5505
Table 3-1

ASA 5505 License Features

Licenses

Description (Base License in Plain Text)

Description (Security Plus Lic. in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Opt. Time-based lic: Available Disabled

Firewall Conns, Concurrent

10,000

25,000

GTP/GPRS

No support

No support

Intercompany Media Eng.

Disabled

UC Phone Proxy Sessions

2

Optional license: Available

Optional license: 24

Disabled
2

Opt. Time-based lic: Available

Optional license: Available

Optional license: 24

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

Disabled

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available
(25 sessions)

Disabled

Optional license: Available
(25 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Other VPN (sessions)

10

Optional Permanent or
Time-based licenses:
10

Optional Permanent or
Time-based licenses:
10

25
1

Total VPN (sessions),
combined all types

up to 25

VPN Load Balancing

No support

General Licenses

Cisco ASA 5500 Series Configuration Guide using the CLI

3-2

2
25

up to 25
No support

25

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-1

ASA 5505 License Features (continued)

Licenses

Description (Base License in Plain Text)

Description (Security Plus Lic. in Plain Text)

Encryption

Base (DES)

Base (DES)

Failover

No support

Opt. lic.: Strong (3DES/AES)

Active/Standby (no stateful failover)

Interfaces of all types, Max. 52
Security Contexts

120

No support

Inside Hosts, concurrent

2

10

Opt. lic.: Strong (3DES/AES)

3

No support

Opt. licenses:

50

Unlimited

103

Opt. licenses:

50

Unlimited

VLANs, maximum

Routed mode: 3 (2 regular and 1 restricted)
Transparent mode: 2

Routed mode: 20
Transparent mode: 3 (2 regular and 1 failover)

VLAN Trunks, maximum

No support

8 trunks

1. The total number of VPN sessions depends on your licenses. If you enable AnyConnect Essentials, then the total is the model maximum of 25. If you
enable AnyConnect Premium, then the total is the AnyConnect Premium value plus the Other VPN value, not to exceed 25 sessions.
2. In routed mode, hosts on the inside (Business and Home VLANs) count toward the limit when they communicate with the outside (Internet VLAN),
including when the inside initiates a connection to the outside as well as when the outside initiates a connection to the inside. Note that even when the
outside initiates a connection to the inside, outside hosts are not counted toward the limit; only the inside hosts count. Hosts that initiate traffic between
Business and Home are also not counted toward the limit. The interface associated with the default route is considered to be the outside Internet interface.
If there is no default route, hosts on all interfaces are counted toward the limit. In transparent mode, the interface with the lowest number of hosts is counted
toward the host limit. Use the show local-host command to view host limits.
3. For a 10-user license, the max. DHCP clients is 32. For 50 users, the max. is 128. For unlimited users, the max. is 250, which is the max. for other models.

ASA 5510
Table 3-2

ASA 5510 License Features

Licenses

Description (Base License in Plain Text)

Description (Security Plus Lic. in Plain Text)

Disabled

Disabled

Firewall Licenses

Botnet Traffic Filter

Optional Time-based license:
Available

Firewall Conns, Concurrent 50,000

130,000

GTP/GPRS

No support

No support

Intercompany Media Eng.

Disabled

UC Phone Proxy Sessions

2

Optional license: Available

Optional licenses:
24

50

Disabled
2

100

Optional Time-based license:
Available

Optional license: Available

Optional licenses:
24

50

100

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

Disabled

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available
(250 sessions)

Disabled

Optional license: Available
(250 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

Disabled

Optional license: Available

Cisco ASA 5500 Series Configuration Guide using the CLI

3-3

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

Table 3-2

ASA 5510 License Features (continued)

Licenses

Description (Base License in Plain Text)

Description (Security Plus Lic. in Plain Text)

AnyConnect Premium
(sessions)

2

2

Optional Perm. or Time-based lic,:
10

25

50

100

Optional Perm. or Time-based lic:

250

10

25

50

100

250

Optional Shared licenses: Participant or
Server. For the Server:

Optional Shared licenses: Participant or
Server. For the Server:

500-50,000 in
increments of 500

500-50,000 in
increments of 500

50,000-545,000 in
increments of 1000

Total VPN (sessions),
combined all types

250

250

Other VPN (sessions)

250

250

VPN Load Balancing

No support

Supported

50,000-545,000 in
increments of 1000

General Licenses

Encryption

Base (DES)

Failover

No support

Opt. lic.: Strong (3DES/AES)

Base (DES)

Opt. lic.: Strong (3DES/AES)

Active/Standby or Active/Active

Interfaces of all types, Max. 240

440

Interface Speed

All: Fast Ethernet

Ethernet 0/0 and 0/1: Gigabit Ethernet 1
Ethernet 0/2, 0/3, 0/4 (and others): Fast Eth.

Security Contexts

No support

2

VLANs, Maximum

50

100

Optional licenses:

5

1. Although the Ethernet 0/0 and 0/1 ports are Gigabit Ethernet, they are still identified as “Ethernet” in the software.

ASA 5520
Table 3-3

ASA 5520 License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Firewall Conns, Concurrent 280,000
GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional licenses:

24

50

100

250

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (750 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

Cisco ASA 5500 Series Configuration Guide using the CLI

3-4

500

750

1000

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-3

ASA 5520 License Features (continued)

Licenses

Description (Base License in Plain Text)

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

750

Other VPN (sessions)

750

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 640
Security Contexts

2

VLANs, Maximum

150

Optional licenses:

5

10

20

ASA 5540
Table 3-4

ASA 5540 License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Firewall Conns, Concurrent

400,000

GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional licenses:

24

50

100

250

500

750

1000

2500

1000

2000

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (2500 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

5000

Other VPN (sessions)

5000

50,000-545,000 in increments of 1000

Cisco ASA 5500 Series Configuration Guide using the CLI

3-5

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

Table 3-4

ASA 5540 License Features (continued)

Licenses

Description (Base License in Plain Text)

VPN Load Balancing

Supported

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 840
Security Contexts

2

VLANs, Maximum

200

Optional licenses:

5

10

20

50

ASA 5550
Table 3-5

ASA 5550 License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Firewall Conns, Concurrent 650,000
GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional licenses:
24

50

100

250

500

750

1000

2000

3000

1000

2500

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (5000 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

5000

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

5000

Other VPN (sessions)

5000

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 1640

Cisco ASA 5500 Series Configuration Guide using the CLI

3-6

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-5

ASA 5550 License Features (continued)

Licenses

Description (Base License in Plain Text)

Security Contexts

2

VLANs, Maximum

400

Optional licenses:

5

10

20

50

100

ASA 5580
Table 3-6

ASA 5580 License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Firewall Conns, Concurrent 5580-20: 2,000,000

5580-40: 4,000,000

GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional licenses:
24

50

100

250

500

750

1000

2000

3000

5000

10,0001

1000

2500

5000

10,000

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (10000 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

10,000

Other VPN (sessions)

10,000

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 4176
Security Contexts

2

VLANs, Maximum

1024

Optional licenses:

5

10

20

50

100

250

1. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-7

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

ASA 5512-X

If you have a No Payload Encryption model, then some of the features in Table 3-7 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.
Table 3-7

ASA 5512-X License Features

Licenses

Description (Base License in Plain Text)

Description (Security Plus Lic. in Plain Text)

Disabled

Disabled

Firewall Licenses

Botnet Traffic Filter

Optional Time-based license:
Available

Optional Time-based license:
Available

Firewall Conns, Concurrent 100,000

250,000

GTP/GPRS

No support

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional license: Available

Optional licenses:
24

50

100

2
250

500

Optional licenses:
24

50

100

250

500

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

Disabled

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available
(250 sessions)

Disabled

Optional license: Available
(250 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Perm. or Time-based lic,:
10

25

50

100

2

250

Optional Perm. or Time-based lic:
10

25

50

100

250

Optional Shared licenses: Participant or
Server. For the Server:

Optional Shared licenses: Participant or
Server. For the Server:

500-50,000 in
increments of 500

500-50,000 in
increments of 500

50,000-545,000 in
increments of 1000

Total VPN (sessions),
combined all types

250

250

Other VPN (sessions)

250

250

VPN Load Balancing

No support

Supported

50,000-545,000 in
increments of 1000

General Licenses

Encryption

Base (DES)

Failover

No support

Opt. lic.: Strong (3DES/AES)

Base (DES)

Opt. lic.: Strong (3DES/AES)

Active/Standby or Active/Active

Interfaces of all types, Max. 328

528

Security Contexts

No support

2

IPS Module

Disabled

VLANs, Maximum

50

Optional license: Available

Optional licenses:

Disabled

5

Optional license: Available

100

ASA 5515-X

If you have a No Payload Encryption model, then some of the features in Table 3-8 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-8

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-8

ASA 5515-X License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Firewall Conns, Concurrent

250,000

GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional licenses:

24

50

100

250

500

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (250 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

250

Other VPN (sessions)

250

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 528
Security Contexts

2

IPS Module

Disabled

VLANs, Maximum

100

Optional licenses:

5

Optional license: Available

ASA 5525-X

If you have a No Payload Encryption model, then some of the features in Table 3-9 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.
Table 3-9

ASA 5525-X License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Firewall Conns, Concurrent

500,000

GTP/GPRS

Disabled

Optional Time-based license: Available
Optional license: Available
Cisco ASA 5500 Series Configuration Guide using the CLI

3-9

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

Table 3-9

ASA 5525-X License Features (continued)

Licenses

Description (Base License in Plain Text)

Intercompany Media Eng.

Disabled

UC Phone Proxy Sessions

2

Optional license: Available

Optional licenses:

24

50

100

250

500

750

1000

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (750 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

750

Other VPN (sessions)

750

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 928
Security Contexts

2

IPS Module

Disabled

VLANs, Maximum

200

Optional licenses:

5

10

20

Optional license: Available

ASA 5545-X

If you have a No Payload Encryption model, then some of the features in Table 3-10 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.
Table 3-10

ASA 5545-X License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Firewall Conns, Concurrent

750,000

GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional licenses:

24

50

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

Cisco ASA 5500 Series Configuration Guide using the CLI

3-10

100

250

500

750

1000

2000

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-10

ASA 5545-X License Features (continued)

Licenses

Description (Base License in Plain Text)

AnyConnect Essentials

Disabled

Optional license: Available (2500 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

1000

2500

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

2500

Other VPN (sessions)

2500

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 1328
Security Contexts

2

IPS Module

Disabled

VLANs, Maximum

300

Optional licenses:

5

10

20

50

Optional license: Available

ASA 5555-X

If you have a No Payload Encryption model, then some of the features in Table 3-11 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.
Table 3-11

ASA 5555-X License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Firewall Conns, Concurrent

1,000,000

GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

Optional licenses:
24

50

100

250

500

750

1000

2000

3000

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (5000 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

Cisco ASA 5500 Series Configuration Guide using the CLI

3-11

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

Table 3-11

ASA 5555-X License Features (continued)

Licenses

Description (Base License in Plain Text)

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

1000

2500

5000

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

5000

Other VPN (sessions)

5000

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

Encryption

Base (DES)

Optional license: Strong (3DES/AES)

Failover

Active/Standby or Active/Active

Interfaces of all types, Max. 2128
Security Contexts

2

IPS Module

Disabled

VLANs, Maximum

500

Optional licenses:

5

10

20

50

100

Optional license: Available

ASA 5585-X with SSP-10

If you have a No Payload Encryption model, then some of the features in Table 3-12 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.
Table 3-12

ASA 5585-X with SSP-10 License Features

Licenses

Description (Base License in Plain Text)

Description (Security Plus License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Opt. Time-based lic: Available Disabled

Opt. Time-based lic: Available

Firewall Conns, Concurrent

1,000,000

GTP/GPRS

Disabled

Optional license: Available

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

1,000,000

Optional licenses:

2

24

50

100

250

750

1000

2000

3000

500

Optional licenses:
24

50

100

250

750

1000

2000

3000

500

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

Disabled

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available
(5000 sessions)

Disabled

Optional license: Available
(5000 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

Disabled

Optional license: Available

Cisco ASA 5500 Series Configuration Guide using the CLI

3-12

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-12

ASA 5585-X with SSP-10 License Features (continued)

Licenses

Description (Base License in Plain Text)

Description (Security Plus License in Plain Text)

AnyConnect Premium
(sessions)

2

2

Opt. Permanent or Time-based lic.:

Opt. Permanent or Time-based lic.:

10

25

50

100

250

10

25

50

100

250

500

750

1000

2500

5000

500

750

1000

2500

5000

Optional Shared licenses: Participant or
Server. For the Server:

Optional Shared licenses: Participant or Server.
For the Server:

500-50,000 in increments of 500

500-50,000 in increments of 500

50,000-545,000 in increments of 1000

50,000-545,000 in increments of 1000

Total VPN (sessions),
combined all types

5000

5000

Other VPN (sessions)

5000

5000

VPN Load Balancing

Supported

Supported

10 GE I/O

Disabled; fiber ifcs run at 1 GE

Enabled; fiber ifcs run at 10 GE

Encryption

Base (DES)

Base (DES)

Failover

Active/Standby or Active/Active

General Licenses

Opt. lic.: Strong (3DES/AES)

Active/Standby or Active/Active

Interfaces of all types, Max. 4176
Security Contexts

2

4176
Optional licenses:
5

VLANs, Maximum

Opt. lic.: Strong (3DES/AES)

10

20

2
50

100

1024

Optional licenses:
5

10

20

50

100

1024

ASA 5585-X with SSP-20

If you have a No Payload Encryption model, then some of the features in Table 3-13 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.
Table 3-13

ASA 5585-X with SSP-20 License Features

Licenses

Description (Base License in Plain Text)

Description (Security Plus Lic. in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Opt. Time-based lic: Available Disabled

Firewall Conns, Concurrent

2,000,000

GTP/GPRS

Disabled

Optional license: Available

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

2,000,000

Optional licenses:

24

100

750

2000

Opt. Time-based lic: Available

250
3000

500
5000

50
1000

10,000

1

2

Optional licenses:

24

100

750

2000

250
3000

500
5000

10,000

50
1000
1

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

Disabled

Optional license: Available

Cisco ASA 5500 Series Configuration Guide using the CLI

3-13

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

Table 3-13

ASA 5585-X with SSP-20 License Features (continued)

Licenses

Description (Base License in Plain Text)

Description (Security Plus Lic. in Plain Text)

AnyConnect Essentials

Disabled

Optional license: Available
(10,000 sessions)

Disabled

Optional license: Available
(10,000 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or
Time-based licenses:
10

25

Optional Permanent or
Time-based licenses:
10

25

50

100

250

500

750

50

100

250

500

750

1000

2500

5000

10,000

1000

2500

5000

10,000

2

Optional Shared licenses: Participant or
Server. For the Server:

Optional Shared licenses: Participant or
Server. For the Server:

500-50,000 in increments of 500

500-50,000 in increments of 500

50,000-545,000 in increments of 1000

50,000-545,000 in increments of 1000

Total VPN (sessions),
combined all types

10,000

10,000

Other VPN (sessions)

10,000

10,000

VPN Load Balancing

Supported

Supported

10 GE I/O

Disabled; fiber ifcs run at 1 GE

Enabled; fiber ifcs run at 10 GE

Encryption

Base (DES)

Base (DES)

Failover

Active/Standby or Active/Active

General Licenses

Opt. lic.: Strong (3DES/AES)

Active/Standby or Active/Active

Interfaces of all types, Max. 4176
Security Contexts
VLANs, Maximum

2

Opt. lic.: Strong (3DES/AES)

4176
Optional licenses:

5

20

250

50

100

10

1024

2

Optional licenses:

5

20

250

50

100

10

1024

1. 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.

ASA 5585-X with SSP-40 and -60

If you have a No Payload Encryption model, then some of the features in Table 3-14 are not supported.
See the “No Payload Encryption Models” section on page 3-30 for a list of unsupported features.

Note

Table 3-14

(8.4(2) and later) 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.

ASA 5585-X with SSP-40 and -60 License Features

Licenses

Description (Base License in Plain Text)

Firewall Licenses

Botnet Traffic Filter

Disabled

Optional Time-based license: Available

Cisco ASA 5500 Series Configuration Guide using the CLI

3-14

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-14

ASA 5585-X with SSP-40 and -60 License Features (continued)

Licenses

Description (Base License in Plain Text)

Firewall Conns, Concurrent

5585-X with SSP-40: 4,000,000

GTP/GPRS

Disabled

Optional license: Available

Intercompany Media Eng.

Disabled

Optional license: Available

UC Phone Proxy Sessions

2

5585-X with SSP-60: 10,000,000

Optional licenses:
24

50

100

250

500

750

1000

2000

3000

5000

10,0001

1000

2500

5000

10,000

VPN Licenses

Adv. Endpoint Assessment

Disabled

Optional license: Available

AnyConnect for Cisco VPN Disabled
Phone

Optional license: Available

AnyConnect Essentials

Disabled

Optional license: Available (10,000 sessions)

AnyConnect for Mobile

Disabled

Optional license: Available

AnyConnect Premium
(sessions)

2

Optional Permanent or Time-based licenses:
10

25

50

100

250

500

750

Optional Shared licenses: Participant or Server. For the Server:
500-50,000 in increments of 500
Total VPN (sessions),
combined all types

10,000

Other VPN (sessions)

10,000

VPN Load Balancing

Supported

50,000-545,000 in increments of 1000

General Licenses

10 GE I/O

Enabled; fiber ifcs run at 10 GE

Encryption

Base (DES)

Failover

Active/Standby or Active/Active

Optional license: Strong (3DES/AES)

Interfaces of all types, Max. 4176
Security Contexts

2

VLANs, Maximum

1024

Optional licenses:

5

10

20

50

100

250

1. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-15

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

License Notes
Table 3-15 includes common footnotes shared by multiple tables in the “Licenses Per Model” section on
page 3-1.
Table 3-15

License Notes

License

Notes

AnyConnect Essentials

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.
By default, the ASA uses the AnyConnect Essentials license, but you can disable it to use other
licenses by using the no anyconnect-essentials command or in ASDM, using the Configuration
> Remote Access VPN > Network (Client) Access > Advanced > AnyConnect Essentials pane.
See also the “VPN License and Feature Compatibility” section on page 3-20.
AnyConnect for Cisco
VPN Phone

In conjunction with an AnyConnect Premium license, this license enables access from hardware
IP phones that have built in AnyConnect compatibility.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-16

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-15

License Notes (continued)

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 Essentials License Functionality
– Enable or disable mobile device access on a per group basis and to configure that feature

using ASDM.
– Display information about connected mobile devices via CLI or ASDM without having

the ability to enforce DAP policies or deny or allow remote access to those mobile
devices.
AnyConnect Premium

AnyConnect Premium sessions include the following VPN types:
•

SSL VPN

•

Clientless SSL VPN

•

IPsec remote access VPN using IKEv2

AnyConnect Premium
Shared

A shared license lets the ASA act as a shared license server for multiple client ASAs. The shared
license pool is large, but the maximum number of sessions used by each individual ASA cannot
exceed the maximum number listed for permanent licenses.

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 string encryption.

Failover, Active/Active

You cannot use Active/Active failover and VPN; if you want to use VPN, use Active/Standby
failover.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-17

Chapter 3

Managing Feature Licenses

Supported Feature Licenses Per Model

Table 3-15

License Notes (continued)

License

Notes

Intercompany Media
Engine

When you enable the Intercompany Media Engine (IME) license, you can use TLS proxy sessions
up to the configured TLS proxy limit. If you also have a Unified Communications (UC) license
installed that is higher than the default TLS proxy limit, then the ASA sets the limit to be the UC
license limit plus an additional number of sessions depending on your model. You can manually
configure 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. If you also install the
UC license, then the TLS proxy sessions available for UC are also available for IME sessions. For
example, if the configured limit is 1000 TLS proxy sessions, and you purchase a 750-session UC
license, then the first 250 IME sessions do not affect the sessions available for UC. If you need
more than 250 sessions for IME, then the remaining 750 sessions of the platform limit are used
on a first-come, first-served basis by UC and IME.
•

For a license part number ending in “K8”, TLS proxy sessions are limited to 1000.

•

For a license part number ending in “K9”, the TLS proxy limit depends on your configuration
and the platform model.

Note

K8 and K9 refer to whether the license is restricted for export: K8 is unrestricted, and K9
is restricted.

You might also use SRTP encryption sessions for your connections:
•

For a K8 license, SRTP sessions are limited to 250.

•

For a K9 license, there is no 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.

Interfaces of all types,
Max.

The maximum number of combined interfaces; for example, VLANs, physical, redundant, bridge
group, and EtherChannel interfaces.

IPS Module

For failover pairs, both units need an IPS module license.

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

This license is included in the Base license.
Total VPN (sessions),
combined all types

•

Although the maximum VPN sessions add up to more than the maximum VPN AnyConnect
and Other VPN sessions, the combined sessions should not exceed the VPN session limit. If
you exceed the maximum VPN sessions, you can overload the ASA, so be sure to size your
network appropriately.

•

If you start a clientless SSL VPN session and then start an AnyConnect client session from
the portal, 1 session is used in total. However, if you start the AnyConnect client first (from
a standalone client, for example) and then log into the clientless SSL VPN portal, then
2 sessions are used.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-18

Chapter 3

Managing Feature Licenses
Supported Feature Licenses Per Model

Table 3-15

License Notes (continued)

License

Notes

UC Phone Proxy sessions The following applications use TLS proxy sessions for their connections. Each TLS proxy session
used by these applications (and only these applications) is counted against the UC license limit:
•

Phone Proxy

•

Presence Federation Proxy

•

Encrypted Voice Inspection

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) and IME (which requires a separate
IME 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

VPN Load Balancing

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.

VPN load balancing requires a Strong Encryption (3DES/AES) License.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-19

Chapter 3

Managing Feature Licenses

Information About Feature Licenses

VPN License and Feature Compatibility
Table 3-16 shows how the VPN licenses and features can combine.
For a detailed list of the features supported by the AnyConnect Essentials license and AnyConnect
Premium license, see AnyConnect Secure Mobility Client Features, Licenses, and OSs:
•

Version 3.0:
http://www.cisco.com/en/US/docs/security/vpn_client/anyconnect/anyconnect30/feature/guide/any
connect30features.html

•

Version 2.5:
http://www.cisco.com/en/US/docs/security/vpn_client/anyconnect/anyconnect25/feature/guide/any
connect25features.html

Table 3-16

VPN License and Feature Compatibility

Enable one of the following licenses:1
Supported with:

AnyConnect Essentials

AnyConnect Premium

AnyConnect for Cisco VPN Phone

No

Yes

AnyConnect for Mobile2

Yes

Yes

Advanced Endpoint Assessment

No

Yes

AnyConnect Premium Shared

No

Yes

Client-based SSL VPN

Yes

Yes

Browser-based (clientless) SSL VPN

No

Yes

IPsec VPN

Yes

Yes

VPN Load Balancing

Yes

Yes

Cisco Secure Desktop

No

Yes

1. You can only have one license type active, either the AnyConnect Essentials license or the AnyConnect Premium license. By
default, the ASA includes an AnyConnect Premium license for 2 sessions. If you install the AnyConnect Essentials license,
then it is used by default. See the no anyconnect-essentials command to enable the Premium license instead.
2. Mobile Posture support is different for the AnyConnect Essentials vs. the AnyConnect Premium license. See Table 3-15 on
page 3-16 for details.

Information About Feature Licenses
A license specifies the options that are enabled on a given ASA. It is represented by an activation key
that is a 160-bit (5 32-bit words or 20 bytes) value. This value encodes the serial number (an 11 character
string) and the enabled features.
This section includes the following topics:
•

Preinstalled License, page 3-21

•

Permanent License, page 3-21

•

Time-Based Licenses, page 3-21

•

Shared AnyConnect Premium Licenses, page 3-23

•

Failover Licenses (8.3(1) and Later), page 3-28

•

No Payload Encryption Models, page 3-30

Cisco ASA 5500 Series Configuration Guide using the CLI

3-20

Chapter 3

Managing Feature Licenses
Information About Feature Licenses

•

Licenses FAQ, page 3-30

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. See the “Monitoring Licenses” section on
page 3-38 section to determine which licenses you have installed.

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. See the “How Permanent and Time-Based Licenses
Combine” section on page 3-22 for more information about how the ASA combines the licenses.

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.
This section includes the following topics:
•

Time-Based License Activation Guidelines, page 3-21

•

How the Time-Based License Timer Works, page 3-21

•

How Permanent and Time-Based Licenses Combine, page 3-22

•

Stacking Time-Based Licenses, page 3-23

•

Time-Based License Expiration, page 3-23

Time-Based License Activation Guidelines
•

You can install multiple time-based licenses, including multiple licenses for the same feature.
However, only one time-based license per feature can be active at a time. The inactive license
remains installed, and ready for use. For example, if you install a 1000-session AnyConnect
Premium license, and a 2500-session AnyConnect Premium license, then only one of these licenses
can be active.

•

If you activate an evaluation license that has multiple features in the key, then you cannot also
activate another time-based license for one of the included features. For example, if an evaluation
license includes the Botnet Traffic Filter and a 1000-session AnyConnect Premium license, you
cannot also activate a standalone time-based 2500-session AnyConnect Premium license.

How the Time-Based License Timer Works
•

The timer for the time-based license starts counting down when you activate it on the ASA.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-21

Chapter 3

Managing Feature Licenses

Information About Feature Licenses

Note

•

If you stop using the time-based license before it times out, then the timer halts. The timer only starts
again when you reactivate the time-based license.

•

If the time-based license is active, and you shut down the ASA, then the timer continues to count
down. If you intend to leave the ASA in a shut down state for an extended period of time, then you
should deactivate the time-based license before you shut down.

We suggest you do not change the system clock after you install the time-based license. If you set the
clock to be a later date, then if you reload, the ASA checks the system clock against the original
installation time, and assumes that more time has passed than has actually been used. If you set the clock
back, and the actual running time is greater than the time between the original installation time and the
system clock, then the license immediately expires after a reload.

How Permanent and Time-Based Licenses Combine
When you activate a time-based license, then features from both permanent and time-based licenses
combine to form the running license. How the permanent and time-based licenses combine depends on
the type of license. Table 3-17 lists the combination rules for each feature license.

Note

Even when the permanent license is used, if the time-based license is active, it continues to count down.
Table 3-17

Time-Based License Combination Rules

Time-Based Feature

Combined License Rule

AnyConnect Premium
Sessions

The higher value is used, either time-based or permanent. For example,
if the permanent license is 1000 sessions, and the time-based license is
2500 sessions, then 2500 sessions are enabled. 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.

Unified Communications
Proxy Sessions

The time-based license sessions are added to the permanent sessions, up
to 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.

To view the combined license, see the “Monitoring Licenses” section on page 3-38.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-22

Chapter 3

Managing Feature Licenses
Information About Feature Licenses

Stacking Time-Based Licenses
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 you do not have to worry about the license expiring or about losing time on your
licenses because you installed the new one early.
When you install an identical time-based license as one already installed, then the licenses are combined,
and the duration equals the combined duration.
For example:
1.

You install a 52-week Botnet Traffic Filter license, and use the license for 25 weeks (27 weeks
remain).

2.

You then purchase another 52-week Botnet Traffic Filter license. When you install the second
license, the licenses combine to have a duration of 79 weeks (52 weeks plus 27 weeks).

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. See the “Activating or Deactivating Keys”
section on page 3-33 for more information about activating licenses.
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. See the “Time-Based License
Expiration” section on page 3-23 for more information.

Time-Based License Expiration
When the current license for a feature expires, the ASA automatically activates an installed license of
the same feature if available. If there are no other time-based licenses available for the feature, then the
permanent license is used.
If you have more than one additional time-based license installed for a feature, then the ASA uses the
first license it finds; which license is used is not user-configurable and depends on internal operations.
If you prefer to use a different time-based license than the one the ASA activated, then you must
manually activate the license you prefer. See the “Activating or Deactivating Keys” section on page 3-33.
For example, you have a time-based 2500-session AnyConnect Premium license (active), a time-based
1000-session AnyConnect Premium license (inactive), and a permanent 500-session AnyConnect
Premium license. While the 2500-session license expires, the ASA activates the 1000-session license.
After the 1000-session license expires, the ASA uses the 500-session permanent license.

Shared AnyConnect Premium Licenses
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. This section describes how a shared license works and
includes the following topics:

Cisco ASA 5500 Series Configuration Guide using the CLI

3-23

Chapter 3

Managing Feature Licenses

Information About Feature Licenses

•

Information About the Shared Licensing Server and Participants, page 3-24

•

Communication Issues Between Participant and Server, page 3-25

•

Information About the Shared Licensing Backup Server, page 3-25

•

Failover and Shared Licenses, page 3-25

•

Maximum Number of Participants, page 3-27

Information About the Shared Licensing Server and Participants
The following steps describe how shared licenses operate:
1.

Decide which ASA should be the shared licensing server, and purchase the shared licensing server
license using that device serial number.

2.

Decide which ASAs should be shared licensing participants, including the shared licensing backup
server, and obtain a shared licensing participant license for each device, using each device serial
number.

3.

(Optional) Designate a second ASA as a shared licensing backup server. You can only specify one
backup server.

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.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-24

Chapter 3

Managing Feature Licenses
Information About Feature Licenses

Note

The ASA uses SSL between the server and participant to encrypt all communications.

Communication Issues Between Participant and Server
See the following guidelines for communication issues between the participant and server:
•

If a participant fails to send a refresh after 3 times the refresh interval, then the server releases the
sessions back into the shared license pool.

•

If the participant cannot reach the license server to send the refresh, then the participant can continue
to use the shared license it received from the server for up to 24 hours.

•

If the participant is still not able to communicate with a license server after 24 hours, then the
participant releases the shared license, even if it still needs the sessions. The participant leaves
existing connections established, but cannot accept new connections beyond the license limit.

•

If a participant reconnects with the server before 24 hours expires, but after the server expired the
participant sessions, then the participant needs to send a new request for the sessions; the server
responds with as many sessions as can be reassigned to that participant.

Information About the Shared Licensing Backup Server
The shared licensing backup server must register successfully with the main shared licensing server
before it can take on the backup role. When it registers, the main shared licensing server syncs server
settings as well as the shared license information with the backup, including a list of registered
participants and the current license usage. The main server and backup server sync the data at 10 second
intervals. After the initial sync, the backup server can successfully perform backup duties, even after a
reload.
When the main server goes down, the backup server takes over server operation. The backup server can
operate for up to 30 continuous days, after which the backup server stops issuing sessions to participants,
and existing sessions time out. Be sure to reinstate the main server within that 30-day period.
Critical-level syslog messages are sent at 15 days, and again at 30 days.
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.

Failover and Shared Licenses
This section describes how shared licenses interact with failover and includes the following topics:
•

“Failover and Shared License Servers” section on page 3-26

Cisco ASA 5500 Series Configuration Guide using the CLI

3-25

Chapter 3

Managing Feature Licenses

Information About Feature Licenses

•

“Failover and Shared License Participants” section on page 3-27

Failover and Shared License Servers
This section describes how the main server and backup server interact with failover. Because the shared
licensing server is also performing normal duties as the ASA, including performing functions such as
being a VPN gateway and firewall, then you might need to configure failover for the main and backup
shared licensing servers for increased reliability.

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 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 Figure 3-1).

Cisco ASA 5500 Series Configuration Guide using the CLI

3-26

Chapter 3

Managing Feature Licenses
Information About Feature Licenses

Figure 3-1

Failover and Shared License Servers

Key
Blue=Shared license
server in use

Failover Pair #1

Failover Pair #2

(Active)=Active
failover unit
1. Normal Main (Active)
operation:

Main (Standby)

Failover Pair #1

2. Primary main Main (Failed)
server fails over:

Main (Active)

Failover Pair #1

3. Both main Main (Failed)
servers fail:

Main (Failed)

Failover Pair #1

Main (Failed)

Backup (Standby)

Failover Pair #2

Backup (Active)

Backup (Standby)

Failover Pair #2

Backup (Active)

Backup (Standby)

Failover Pair #2

Backup (Failed)

Backup (Active)
251356

4. Both main servers and Main (Failed)
primary backup fail:

Backup (Active)

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. See the “Information
About the Shared Licensing Backup Server” section on page 3-25 for more information.

Failover and Shared License Participants
For participant pairs, both units register with the shared licensing server using separate participant IDs.
The active unit syncs its participant ID with the standby unit. The standby unit uses this ID to generate
a transfer request when it switches to the active role. This transfer request is used to move the shared
sessions from the previously active unit to the new active unit.

Maximum Number of Participants
The ASA does not limit the number of participants for the shared license; however, a very large shared
network could potentially affect the performance on the licensing server. In this case, you can increase
the delay between participant refreshes, or you can create two shared networks.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-27

Chapter 3

Managing Feature Licenses

Information About Feature Licenses

Failover Licenses (8.3(1) and Later)
With some exceptions, failover units do not require the same license on each unit. For earlier versions,
see the licensing document for your version.
This section includes the following topics:
•

Failover License Requirements and Exceptions, page 3-28

•

How Failover Licenses Combine, page 3-28

•

Loss of Communication Between Failover Units, page 3-29

•

Upgrading Failover Pairs, page 3-30

Failover License Requirements and Exceptions
Failover units do not require the same license on each unit.
Older versions of ASA software required that the licenses match on each unit. Starting with Version
8.3(1), you no longer need to install identical licenses. Typically, you buy a license only for the primary
unit; for Active/Standby failover, the secondary unit inherits the primary license when it becomes active.
If you have licenses on both units, they combine into a single running failover cluster license.
The exceptions to this rule include:

Note

•

Security Plus license for the ASA 5505, 5510, and 5512-X—The Base license does not support
failover, so you cannot enable failover on a standby unit that only has the Base license.

•

IPS module license for the ASA 5500-X—You must purchase an IPS module license for each unit,
just as you would need to purchase a hardware module for each unit for other models.

•

Encryption license—Both units must have the same encryption license.

A valid permanent key is required; in rare instances, your 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.

How Failover Licenses Combine
For failover pairs, the licenses on each unit are combined into a single running failover cluster license.
For Active/Active failover, the license usage of the two units combined cannot exceed the failover cluster
license.
If you buy separate licenses for the primary and secondary unit, then the combined license uses the
following rules:
•

For licenses that have numerical tiers, such as the number of sessions, the values from both the
primary and secondary licenses are combined up to the platform limit. If both licenses in use are
time-based, then the licenses count down simultaneously.
For example:
– You have two ASAs with 10 AnyConnect Premium sessions installed on each; the licenses will

be combined for a total of 20 AnyConnect Premium sessions.
– You have two ASA 5520s with 500 AnyConnect Premium sessions each; because the platform

limit is 750, the combined license allows 750 AnyConnect Premium sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-28

Chapter 3

Managing Feature Licenses
Information About Feature Licenses

Note

In the above example, if the AnyConnect Premium licenses are time-based, you might want
to disable one of the licenses so 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 5540s, one with 20 contexts and the other with 10 contexts; the combined

license allows 30 contexts. For Active/Active failover, one unit can use 18 contexts and the other
unit can use 12 contexts, for example, for a total of 30; the combined usage cannot exceed the
failover cluster license (in this case, 30).
•

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 both licenses. The primary unit counts down its license first, and when
it expires, the secondary unit starts counting down its license. This rule also applies to Active/Active
failover, even though both units are actively operating.
For example, if you have 48 weeks left on the Botnet Traffic Filter license on both units, then the
combined duration is 96 weeks.

To view the combined license, see the “Monitoring Licenses” section on page 3-38.

Loss of Communication Between Failover Units
If the failover units lose communication for more than 30 days, then each unit reverts to the license
installed locally. During the 30-day grace period, the combined running license continues to be used by
both units.
If you restore communication during the 30-day grace period, then for time-based licenses, the time
elapsed is subtracted from the primary license; if the primary license becomes expired, only then does
the secondary license start to count down.
If you do not restore communication during the 30-day period, then for time-based licenses, time is
subtracted from both primary and secondary licenses, if installed. They are treated as two separate
licenses and do not benefit from the failover combined license. The time elapsed includes the 30-day
grace period.
For example:
1.

You have a 52-week Botnet Traffic Filter license installed on both units. The combined running
license allows a total duration of 104 weeks.

2.

The units operate as a failover unit for 10 weeks, leaving 94 weeks on the combined license (42
weeks on the primary, and 52 weeks on the secondary).

3.

If the units lose communication (for example the primary unit fails over to the secondary unit), the
secondary unit continues to use the combined license, and continues to count down from 94 weeks.

4.

The time-based license behavior depends on when communication is restored:

•

Within 30 days—The time elapsed is subtracted from the primary unit license. In this case,
communication is restored after 4 weeks. Therefore, 4 weeks are subtracted from the primary license
leaving 90 weeks combined (38 weeks on the primary, and 52 weeks on the secondary).

•

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 and secondary
licenses, leaving 84 weeks combined (36 weeks on the primary, and 46 weeks on the secondary).

Cisco ASA 5500 Series Configuration Guide using the CLI

3-29

Chapter 3

Managing Feature Licenses

Information About Feature Licenses

Upgrading Failover Pairs
Because failover pairs do not require the same license on both units, you can apply new licenses to each
unit without any downtime. If you apply a permanent license that requires a reload (see Table 3-18 on
page 3-34), then you can fail over to the other unit while you reload. If both units require reloading, then
you can reload them separately so you have no downtime.

No Payload Encryption Models
You can purchase some models with No Payload Encryption. For export to some countries, payload
encryption cannot be enabled on the Cisco ASA 5500 series. The ASA software senses a No Payload
Encryption model, and disables the following features:
•

Unified Communications

•

VPN

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 Filer (which uses SSL).
When you view the license (see the “Monitoring Licenses” section on page 3-38), VPN and Unified
Communications licenses will not be listed.

Licenses FAQ
Q. Can I activate multiple time-based licenses, for example, AnyConnect Premium and Botnet Traffic

Filter?
A. Yes. You can use one time-based license per feature at a time.
Q. Can I “stack” time-based licenses so that when the time limit runs out, it will automatically use the

next license?
A. 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.
Q. Can I install a new permanent license while maintaining an active time-based license?
A. Yes. Activating a permanent license does not affect time-based licenses.
Q. For failover, can I use a shared licensing server as the primary unit, and the shared licensing backup

server as the secondary unit?
A. 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.
Q. Do I need to buy the same licenses for the secondary unit in a failover pair?

Cisco ASA 5500 Series Configuration Guide using the CLI

3-30

Chapter 3

Managing Feature Licenses
Guidelines and Limitations

A. 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.
Q. Can I use a time-based or permanent AnyConnect Premium license in addition to a shared

AnyConnect Premium license?
A. 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.

Guidelines and Limitations
See the following guidelines for activation keys.
Context Mode Guidelines
•

In multiple context mode, apply the activation key in the system execution space.

•

Shared licenses are not supported in multiple context mode.

Firewall Mode Guidelines

All license types are available in both routed and transparent mode.
Failover Guidelines
•

Shared licenses are not supported in Active/Active mode. See the “Failover and Shared Licenses”
section on page 3-25 for more information.

•

Failover units do not require the same license on each unit.
Older versions of ASA software required that the licenses match on each unit. Starting with Version
8.3(1), you no longer need to install identical licenses. Typically, you buy a license only for the
primary unit; for Active/Standby failover, the secondary unit inherits the primary license when it
becomes active. If you have licenses on both units, they combine into a single running failover
cluster license.

Note
•

Failover units do require the same RAM on both units.

For the ASA 5505 and 5510, both units require the Security Plus license; the Base license does not
support failover, so you cannot enable failover on a standby unit that only has the Base license.

Upgrade and Downgrade Guidelines

Your activation key remains compatible if you upgrade to the latest version from any previous version.
However, you might have issues if you want to maintain downgrade capability:

Cisco ASA 5500 Series Configuration Guide using the CLI

3-31

Chapter 3

Managing Feature Licenses

Configuring 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 backward 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 and Limitations
•

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.

•

Once purchased, you cannot return a license for a refund or for an upgraded license.

•

Although you can activate all license types, some features are incompatible with each other; for
example, multiple context mode and VPN. 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, the
AnyConnect Essentials license is used instead of the above licenses, but you can disable the
AnyConnect Essentials license in the configuration to restore use of the other licenses using the no
anyconnect-essentials command.

Configuring Licenses
This section includes the following topics:
•

Obtaining an Activation Key, page 3-33

•

Activating or Deactivating Keys, page 3-33

•

Configuring a Shared License, page 3-35

Cisco ASA 5500 Series Configuration Guide using the CLI

3-32

Chapter 3

Managing Feature Licenses
Configuring Licenses

Obtaining an Activation Key
To obtain an activation key, you need a Product Authorization Key, which you can purchase from your
Cisco account representative. You need to purchase a separate Product Activation Key for each feature
license. For example, if you have the Base License, you can purchase separate keys for Advanced
Endpoint Assessment and for additional AnyConnect Premium sessions.
After obtaining the Product Authorization Keys, register them on Cisco.com by performing the
following steps.

Detailed Steps
Step 1

Obtain the serial number for your ASA by entering the following command.
hostname# show activation-key

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

Step 4

Enter the following information, when prompted:
•

Product Authorization Key (if you have multiple keys, enter one of the keys first. You have to enter
each key as a separate process.)

•

The serial number of your ASA

•

Your e-mail address

An activation key is automatically generated and sent to the email 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 Step 4 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.

Activating or Deactivating Keys
This section describes how to enter a new activation key, and how to activate and deactivate time-based
keys.

Prerequisites
•

If you are already in multiple context mode, enter the activation key in the system execution space.

•

Some permanent licenses require you to reload the ASA after you activate them. Table 3-18 lists the
licenses that require reloading.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-33

Chapter 3

Managing Feature Licenses

Configuring Licenses

Table 3-18

Permanent License Reloading Requirements

Model

License Action Requiring Reload

ASA 5505, ASA 5510

Changing between the Base and Security Plus
license.

All models

Changing the Encryption license.

All models

Downgrading any permanent license (for
example, going from 10 contexts to 2 contexts).

Limitations and Restrictions
Your activation key remains compatible if you upgrade to the latest version from any previous version.
However, you might have issues if you want to maintain downgrade capability:
•

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 backward 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 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-34

Chapter 3

Managing Feature Licenses
Configuring Licenses

Detailed Steps

Step 1

Command

Purpose

activation-key key [activate | deactivate]

Applies an activation key to the ASA. 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.

Example:
hostname# activation-key 0xd11b3d48
0xa80a4c0a 0x48e0fd1c 0xb0443480
0x843fc490

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. See the “Time-Based Licenses” section on
page 3-21 for more information.

Step 2

(Might be required.)
reload

Example:
hostname# reload

Reloads the ASA. Some permanent licenses require you to reload
the ASA after entering the new activation key. See Table 3-18 on
page 3-34 for a list of licenses that need reloading. If you need to
reload, you will see the following message:
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.

Configuring a Shared License
This section describes how to configure the shared licensing server and participants. For more
information about shared licenses, see the “Shared AnyConnect Premium Licenses” section on
page 3-23.
This section includes the following topics:
•

Configuring the Shared Licensing Server, page 3-35

•

Configuring the Shared Licensing Backup Server (Optional), page 3-37

•

Configuring the Shared Licensing Participant, page 3-37

Configuring the Shared Licensing Server
This section describes how to configure the ASA to be a shared licensing server.

Prerequisites
The server must have a shared licensing server key.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-35

Chapter 3

Managing Feature Licenses

Configuring Licenses

Detailed Steps

Step 1

Command

Purpose

license-server secret secret

Sets the shared secret, a string between 4 and 128 ASCII
characters. Any participant with this secret can use the licensing
server.

Example:
hostname(config)# license-server secret
farscape

Step 2

(Optional)
license-server refresh-interval seconds

Sets the refresh interval 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.

Example:
hostname(config)# license-server
refresh-interval 100

Step 3

(Optional)

Sets the port on which the server listens for SSL connections from
participants, between 1 and 65535. The default is TCP port
50554.

license-server port port

Example:
hostname(config)# license-server port
40000

Step 4

(Optional)
license-server backup address backup-id
serial_number [ha-backup-id
ha_serial_number]

Identifies the backup server IP address and serial number. 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:
hostname(config)# license-server backup
10.1.1.2 backup-id JMX0916L0Z4
ha-backup-id JMX1378N0W3

Step 5

license-server enable interface_name

Enables this unit to be the shared licensing server. Specify the
interface on which participants contact the server. You can repeat
this command for as many interfaces as desired.

Example:
hostname(config)# license-server enable
inside

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:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
JMX1378N0W3
hostname(config)#

license-server
license-server
license-server
license-server

license-server enable inside

Cisco ASA 5500 Series Configuration Guide using the CLI

3-36

secret farscape
refresh-interval 100
port 40000
backup 10.1.1.2 backup-id JMX0916L0Z4 ha-backup-id

Chapter 3

Managing Feature Licenses
Configuring Licenses

hostname(config)# license-server enable dmz

What to Do Next
See the “Configuring the Shared Licensing Backup Server (Optional)” section on page 3-37, or the
“Configuring the Shared Licensing Participant” section on page 3-37.

Configuring the Shared Licensing Backup Server (Optional)
This section enables a shared license participant to act as the backup server if the main server goes down.

Prerequisites
The backup server must have a shared licensing participant key.

Detailed Steps

Step 1

Command

Purpose

license-server address address secret
secret [port port]

Identifies the shared licensing server IP address and shared secret.
If you changed the default port in the server configuration, set the
port for the backup server to match.

Example:
hostname(config)# license-server address
10.1.1.1 secret farscape

Step 2

license-server backup enable
interface_name

Enables this unit to be the shared licensing backup server. Specify
the interface on which participants contact the server. You can
repeat this command for as many interfaces as desired.

Example:
hostname(config)# license-server backup
enable inside

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:
hostname(config)# license-server address 10.1.1.1 secret farscape
hostname(config)# license-server backup enable inside
hostname(config)# license-server backup enable dmz

What to Do Next
See the “Configuring the Shared Licensing Participant” section on page 3-37.

Configuring the Shared Licensing Participant
This section configures a shared licensing participant to communicate with the shared licensing server.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-37

Chapter 3

Managing Feature Licenses

Monitoring Licenses

Prerequisites
The participant must have a shared licensing participant key.

Detailed Steps

Step 1

Command

Purpose

license-server address address secret
secret [port port]

Identifies the shared licensing server IP address and shared secret.
If you changed the default port in the server configuration, set the
port for the participant to match.

Example:
hostname(config)# license-server address
10.1.1.1 secret farscape

Step 2

(Optional)
license-server backup address address

If you configured a backup server, enter the backup server
address.

Example:
hostname(config)# license-server backup
address 10.1.1.2

Examples
The following example sets the license server IP address and shared secret, as well as the backup license
server IP address:
hostname(config)# license-server address 10.1.1.1 secret farscape
hostname(config)# license-server backup address 10.1.1.2

Monitoring Licenses
This section includes the following topics:
•

Viewing Your Current License, page 3-38

•

Monitoring the Shared License, page 3-44

Viewing Your Current License
This section describes how to view your current license, and for time-based activation keys, how much
time the license has left.

Guidelines
If you have a No Payload Encryption model, then you view the license, VPN and Unified
Communications licenses will not be listed. See the “No Payload Encryption Models” section on
page 3-30 for more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-38

Chapter 3

Managing Feature Licenses
Monitoring Licenses

Detailed Steps

Command

Purpose

show activation-key [detail]

This command shows the permanent license, active time-based licenses,
and the running license, which is a combination of the permanent license
and active time-based licenses. The detail keyword also shows inactive
time-based licenses.

Example:
hostname# show activation-key detail

For failover units, this command also shows the “Failover cluster” license,
which is the combined keys of the primary and secondary units.

Examples
Example 3-1

Standalone Unit Output for the show activation-key command

The following is sample output from the show activation-key command for a standalone unit that shows
the running license (the combined permanent license and time-based licenses), as well as each active
time-based license:
hostname# show activation-key
Serial Number: JMX1232L11M
Running Permanent Activation Key: 0xce06dc6b 0x8a7b5ab7 0xa1e21dd4 0xd2c4b8b8 0xc4594f9c
Running Timebased Activation Key: 0xa821d549 0x35725fe4 0xc918b97b 0xce0b987b 0x47c7c285
Running Timebased Activation Key: 0xyadayad2 0xyadayad2 0xyadayad2 0xyadayad2 0xyadayad2
Licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
Maximum VLANs
: 150
Inside Hosts
: Unlimited
Failover
: Active/Active
VPN-DES
: Enabled
VPN-3DES-AES
: Enabled
Security Contexts
: 10
GTP/GPRS
: Enabled
AnyConnect Premium Peers
: 2
AnyConnect Essentials
: Disabled
Other VPN Peers
: 750
Total VPN Peers
: 750
Shared License
: Enabled
Shared AnyConnect Premium Peers : 12000
AnyConnect for Mobile
: Disabled
AnyConnect for Cisco VPN Phone
: Disabled
Advanced Endpoint Assessment
: Disabled
UC Phone Proxy Sessions
: 12
Total UC Proxy Sessions
: 12
Botnet Traffic Filter
: Enabled
Intercompany Media Engine
: Disabled

perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
62 days
62 days
646 days
perpetual

This platform has a Base license.
The flash permanent activation key is the SAME as the running permanent key.
Active Timebased Activation Key:
0xa821d549 0x35725fe4 0xc918b97b 0xce0b987b 0x47c7c285
Botnet Traffic Filter
: Enabled
646 days
0xyadayad2 0xyadayad2 0xyadayad2 0xyadayad2 0xyadayad2
Total UC Proxy Sessions
: 10
62 days

Cisco ASA 5500 Series Configuration Guide using the CLI

3-39

Chapter 3

Managing Feature Licenses

Monitoring Licenses

Example 3-2

Standalone Unit Output for show activation-key detail

The following is sample output from the show activation-key detail command for a standalone unit that
shows the running license (the combined permanent license and time-based licenses), as well as the
permanent license and each installed time-based license (active and inactive):
hostname# show activation-key detail
Serial Number: 88810093382
Running Permanent Activation Key: 0xce06dc6b 0x8a7b5ab7 0xa1e21dd4 0xd2c4b8b8 0xc4594f9c
Running Timebased Activation Key: 0xa821d549 0x35725fe4 0xc918b97b 0xce0b987b 0x47c7c285
Licensed features for this platform:
Maximum Physical Interfaces
: 8
VLANs
: 20
Dual ISPs
: Enabled
VLAN Trunk Ports
: 8
Inside Hosts
: Unlimited
Failover
: Active/Standby
VPN-DES
: Enabled
VPN-3DES-AES
: Enabled
AnyConnect Premium Peers
: 2
AnyConnect Essentials
: Disabled
Other VPN Peers
: 25
Total VPN Peers
: 25
AnyConnect for Mobile
: Disabled
AnyConnect for Cisco VPN Phone
: Disabled
Advanced Endpoint Assessment
: Disabled
UC Phone Proxy Sessions
: 2
Total UC Proxy Sessions
: 2
Botnet Traffic Filter
: Enabled
Intercompany Media Engine
: Disabled

perpetual
DMZ Unrestricted
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
39 days
perpetual

This platform has an ASA 5505 Security Plus license.
Running Permanent Activation Key: 0xce06dc6b 0x8a7b5ab7 0xa1e21dd4 0xd2c4b8b8 0xc4594f9c
Licensed features for this platform:
Maximum Physical Interfaces
: 8
VLANs
: 20
Dual ISPs
: Enabled
VLAN Trunk Ports
: 8
Inside Hosts
: Unlimited
Failover
: Active/Standby
VPN-DES
: Enabled
VPN-3DES-AES
: Enabled
AnyConnect Premium Peers
: 2
AnyConnect Essentials
: Disabled
Other VPN Peers
: 25
Total VPN Peers
: 25
AnyConnect for Mobile
: Disabled
AnyConnect for Cisco VPN Phone
: Disabled
Advanced Endpoint Assessment
: Disabled
UC Phone Proxy Sessions
: 2
Total UC Proxy Sessions
: 2
Botnet Traffic Filter
: Enabled
Intercompany Media Engine
: Disabled

perpetual
DMZ Unrestricted
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
39 days
perpetual

The flash permanent activation key is the SAME as the running permanent key.
Active Timebased Activation Key:

Cisco ASA 5500 Series Configuration Guide using the CLI

3-40

Chapter 3

Managing Feature Licenses
Monitoring Licenses

0xa821d549 0x35725fe4 0xc918b97b 0xce0b987b 0x47c7c285
Botnet Traffic Filter
: Enabled
39 days
Inactive Timebased Activation Key:
0xyadayada3 0xyadayada3 0xyadayada3 0xyadayada3 0xyadayada3
AnyConnect Premium Peers
: 25
7 days

Example 3-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).

hostname# show activation-key detail
Serial Number: P3000000171
Running Permanent Activation Key: 0xce06dc6b 0x8a7b5ab7 0xa1e21dd4 0xd2c4b8b8 0xc4594f9c
Running Timebased Activation Key: 0xa821d549 0x35725fe4 0xc918b97b 0xce0b987b 0x47c7c285
Licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
Maximum VLANs
: 150
Inside Hosts
: Unlimited
Failover
: Active/Active
VPN-DES
: Enabled
VPN-3DES-AES
: Enabled
Security Contexts
: 12
GTP/GPRS
: Enabled
AnyConnect Premium Peers
: 2
AnyConnect Essentials
: Disabled
Other VPN Peers
: 750
Total VPN Peers
: 750
Shared License
: Disabled
AnyConnect for Mobile
: Disabled
AnyConnect for Cisco VPN Phone
: Disabled
Advanced Endpoint Assessment
: Disabled
UC Phone Proxy Sessions
: 2
Total UC Proxy Sessions
: 2
Botnet Traffic Filter
: Enabled
Intercompany Media Engine
: Disabled

perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
33 days
perpetual

This platform has an ASA 5520 VPN Plus license.
Failover cluster licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
perpetual
Maximum VLANs
: 150
perpetual
Inside Hosts
: Unlimited
perpetual
Failover
: Active/Active perpetual
VPN-DES
: Enabled
perpetual
VPN-3DES-AES
: Enabled
perpetual
Security Contexts
: 12
perpetual
GTP/GPRS
: Enabled
perpetual
AnyConnect Premium Peers
: 4
perpetual
AnyConnect Essentials
: Disabled
perpetual

Cisco ASA 5500 Series Configuration Guide using the CLI

3-41

Chapter 3

Managing Feature Licenses

Monitoring Licenses

Other VPN Peers
Total VPN Peers
Shared License
AnyConnect for Mobile
AnyConnect for Cisco VPN Phone
Advanced Endpoint Assessment
UC Phone Proxy Sessions
Total UC Proxy Sessions
Botnet Traffic Filter
Intercompany Media Engine

:
:
:
:
:
:
:
:
:
:

750
750
Disabled
Disabled
Disabled
Disabled

4
4
Enabled
Disabled

perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
33 days
perpetual

This platform has an ASA 5520 VPN Plus license.
Running Permanent Activation Key: 0xce06dc6b 0x8a7b5ab7 0xa1e21dd4 0xd2c4b8b8 0xc4594f9c
Licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
Maximum VLANs
: 150
Inside Hosts
: Unlimited
Failover
: Active/Active
VPN-DES
: Enabled
VPN-3DES-AES
: Disabled
Security Contexts
: 2
GTP/GPRS
: Disabled
AnyConnect Premium Peers
: 2
AnyConnect Essentials
: Disabled
Other VPN Peers
: 750
Total VPN Peers
: 750
Shared License
: Disabled
AnyConnect for Mobile
: Disabled
AnyConnect for Cisco VPN Phone
: Disabled
Advanced Endpoint Assessment
: Disabled
UC Phone Proxy Sessions
: 2
Total UC Proxy Sessions
: 2
Botnet Traffic Filter
: Disabled
Intercompany Media Engine
: Disabled

perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual

The flash permanent activation key is the SAME as the running permanent key.
Active Timebased Activation Key:
0xa821d549 0x35725fe4 0xc918b97b 0xce0b987b 0x47c7c285
Botnet Traffic Filter
: Enabled
33 days
Inactive Timebased Activation Key:
0xyadayad3 0xyadayad3 0xyadayad3 0xyadayad3 0xyadayad3
Security Contexts
: 2
7 days
AnyConnect Premium Peers
: 100

7 days

0xyadayad4 0xyadayad4 0xyadayad4 0xyadayad4 0xyadayad4
Total UC Proxy Sessions
: 100
14 days

Example 3-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:
•

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-42

Chapter 3

Managing Feature Licenses
Monitoring Licenses

•

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.

hostname# show activation-key detail
Serial Number: P3000000011
Running Activation Key: 0xyadayad1 0xyadayad1 0xyadayad1 0xyadayad1 0xyadayad1
Licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
Maximum VLANs
: 150
Inside Hosts
: Unlimited
Failover
: Active/Active
VPN-DES
: Enabled
VPN-3DES-AES
: Disabled
Security Contexts
: 2
GTP/GPRS
: Disabled
AnyConnect Premium Peers
: 2
AnyConnect Essentials
: Disabled
Other VPN Peers
: 750
Total VPN Peers
: 750
Shared License
: Disabled
AnyConnect for Mobile
: Disabled
AnyConnect for Cisco VPN Phone
: Disabled
Advanced Endpoint Assessment
: Disabled
UC Phone Proxy Sessions
: 2
Total UC Proxy Sessions
: 2
Botnet Traffic Filter
: Disabled
Intercompany Media Engine
: Disabled

perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual

This platform has an ASA 5520 VPN Plus license.
Failover cluster licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
perpetual
Maximum VLANs
: 150
perpetual
Inside Hosts
: Unlimited
perpetual
Failover
: Active/Active perpetual
VPN-DES
: Enabled
perpetual
VPN-3DES-AES
: Enabled
perpetual
Security Contexts
: 10
perpetual
GTP/GPRS
: Enabled
perpetual
AnyConnect Premium Peers
: 4
perpetual
AnyConnect Essentials
: Disabled
perpetual
Other VPN Peers
: 750
perpetual
Total VPN Peers
: 750
perpetual
Shared License
: Disabled
perpetual
AnyConnect for Mobile
: Disabled
perpetual
AnyConnect for Cisco VPN Phone
: Disabled
perpetual
Advanced Endpoint Assessment
: Disabled
perpetual
UC Phone Proxy Sessions
: 4
perpetual
Total UC Proxy Sessions
: 4
perpetual
Botnet Traffic Filter
: Enabled
33 days
Intercompany Media Engine
: Disabled
perpetual
This platform has an ASA 5520 VPN Plus license.
Running Permanent Activation Key: 0xyadayad1 0xyadayad1 0xyadayad1 0xyadayad1 0xyadayad1
Licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
Maximum VLANs
: 150
Inside Hosts
: Unlimited

perpetual
perpetual
perpetual

Cisco ASA 5500 Series Configuration Guide using the CLI

3-43

Chapter 3

Managing Feature Licenses

Monitoring Licenses

Failover
VPN-DES
VPN-3DES-AES
Security Contexts
GTP/GPRS
AnyConnect Premium Peers
AnyConnect Essentials
Other VPN Peers
Total VPN Peers
Shared License
AnyConnect for Mobile
AnyConnect for Cisco VPN Phone
Advanced Endpoint Assessment
UC Phone Proxy Sessions
Total UC Proxy Sessions
Botnet Traffic Filter
Intercompany Media Engine

:
:
:
:
:

:
:
:
:

Active/Active
Enabled
Disabled
2
Disabled
: 2
: Disabled
: 750
: 750
: Disabled
: Disabled
: Disabled
: Disabled
2
2
Disabled
Disabled

perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual

The flash permanent activation key is the SAME as the running permanent key.

Monitoring the Shared License
To monitor the shared license, enter one of the following commands.
Command

Purpose

show shared license [detail | client
[hostname] | backup]

Shows shared license statistics. Optional keywords ar available only for
the licensing server: the detail keyword shows statistics per participant.
To limit the display to one participant, use the client keyword. The
backup keyword shows information about the backup server.
To clear the shared license statistics, enter the clear shared license
command.

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.

Examples
The following is sample output from the show shared license command on the license participant:
hostname> show shared license
Primary License Server : 10.3.32.20
Version
: 1
Status
: Inactive
Shared license utilization:
SSLVPN:
Total for network :
5000
Available
:
5000
Utilized
:
0
This device:
Platform limit
:
250
Current usage
:
0
High usage
:
0

Cisco ASA 5500 Series Configuration Guide using the CLI

3-44

Chapter 3

Managing Feature Licenses
Monitoring Licenses

Messages Tx/Rx/Error:
Registration
: 0
Get
: 0
Release
: 0
Transfer
: 0

/
/
/
/

0
0
0
0

/
/
/
/

0
0
0
0

The following is sample output from the show shared license detail command on the license server:
hostname> show shared license detail
Backup License Server Info:
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
Shared license utilization:
SSLVPN:
Total for network :
Available
:
Utilized
:
This device:
Platform limit
:
Current usage
:
High usage
:
Messages Tx/Rx/Error:
Registration
: 0 / 0
Get
: 0 / 0
Release
: 0 / 0
Transfer
: 0 / 0

500
500
0
250
0
0
/
/
/
/

0
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
...

Cisco ASA 5500 Series Configuration Guide using the CLI

3-45

Chapter 3

Managing Feature Licenses

Feature History for Licensing

Feature History for Licensing
Table 3-19 lists each feature change and the platform release in which it was implemented.
Table 3-19

Feature History for Licensing

Feature Name

Platform
Releases

Feature Information

Increased Connections and VLANs

7.0(5)

Increased the following limits:
•

ASA5510 Base license connections from 32000 to
5000; VLANs from 0 to 10.

•

ASA5510 Security Plus license connections from
64000 to 130000; VLANs from 10 to 25.

•

ASA5520 connections from 130000 to 280000; VLANs
from 25 to 100.

•

ASA5540 connections from 280000 to 400000; VLANs
from 100 to 200.

SSL VPN Licenses

7.1(1)

SSL VPN licenses were introduced.

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)
ASA 5510

For the Base license on the ASA 5510, the maximum
number of interfaces was increased from 3 plus a
management interface to unlimited interfaces.

Increased VLANs

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.

7.2(2)

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).
Gigabit Ethernet Support for the ASA 5510
Security Plus License

7.2(3)

The ASA 5510 now supports Gigabit Ethernet (1000 Mbps)
for the Ethernet 0/0 and 0/1 ports with the Security Plus
license. In the Base license, they continue to be used as Fast
Ethernet (100 Mbps) ports. Ethernet 0/2, 0/3, and 0/4
remain as Fast Ethernet ports for both licenses.
Note

The interface names 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-46

Chapter 3

Managing Feature Licenses
Feature History for Licensing

Table 3-19

Feature History for Licensing (continued)

Feature Name

Platform
Releases

Advanced Endpoint Assessment License

8.0(2)

Feature Information
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.

Time-based Licenses

8.0(4)/8.1(2)

Support for time-based licenses was introduced.

Increased VLANs for the ASA 5580

8.1(2)

The number of VLANs supported on the ASA 5580 are
increased from 100 to 250.

Unified Communications Proxy Sessions
license

8.0(4)

The UC Proxy sessions license was introduced. Phone
Proxy, Presence Federation Proxy, and Encrypted Voice
Inspection applications use TLS proxy sessions for their
connections. Each TLS proxy session is counted against the
UC license limit. All of these applications are licensed
under the UC Proxy umbrella, and can be mixed and
matched.
This feature is not available in Version 8.1.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-47

Chapter 3

Managing Feature Licenses

Feature History for Licensing

Table 3-19

Feature History for Licensing (continued)

Feature Name

Platform
Releases

AnyConnect Essentials License

8.2(1)

Feature Information
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 no anyconnect-essentials command.
SSL VPN license changed to AnyConnect
Premium SSL VPN Edition license

8.2(1)

The SSL VPN license name was changed to the
AnyConnect 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
Unified Communications Proxy license

8.2(2)

The Mobility Proxy no longer requires the UC Proxy
license.

10 GE I/O license for the ASA 5585-X with
SSP-20

8.2(3)

We introduced the 10 GE I/O license for the ASA 5585-X
with SSP-20 to enable 10-Gigabit Ethernet speeds for the
fiber ports. The SSP-60 supports 10-Gigabit Ethernet
speeds by default.
Note

10 GE I/O license for the ASA 5585-X with
SSP-10

8.2(4)

We introduced the 10 GE I/O license for the ASA 5585-X
with SSP-10 to enable 10-Gigabit Ethernet speeds for the
fiber ports. The SSP-40 supports 10-Gigabit Ethernet
speeds by default.
Note

Cisco ASA 5500 Series Configuration Guide using the CLI

3-48

The ASA 5585-X is not supported in 8.3(x).

The ASA 5585-X is not supported in 8.3(x).

Chapter 3

Managing Feature Licenses
Feature History for Licensing

Table 3-19

Feature History for Licensing (continued)

Feature Name

Platform
Releases

Non-identical failover licenses

8.3(1)

Feature Information
Failover licenses no longer need to be identical on each unit.
The license used for both units is the combined license from
the primary and secondary units.
We modified the following commands: show
activation-key and show version.

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 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)
time

You can now install multiple time-based licenses, and have
one license per feature active at a time.
The following commands were modified: show
activation-key and show version.

Discrete activation and deactivation of
time-based licenses.

8.3(1)

You can now activate or deactivate time-based licenses
using a command.
The following command was modified: activation-key
[activate | deactivate].

AnyConnect Premium SSL VPN Edition license 8.3(1)
changed to AnyConnect Premium SSL VPN
license

The AnyConnect Premium SSL VPN Edition license name
was changed to the AnyConnect Premium SSL VPN
license.

No Payload Encryption image for export

If you install the No Payload Encryption software on the
ASA 5505 through 5550, then you disable Unified
Communications, strong encryption VPN, and strong
encryption management protocols.

8.3(2)

Note

This special image is only supported in 8.3(x); for
No Payload Encryption support in 8.4(1) and later,
you need to purchase a special hardware version of
the ASA.

Increased contexts for the ASA 5550, 5580, and 8.4(1)
5585-X

For the ASA 5550 and ASA 5585-X with SSP-10, the
maximum contexts was increased from 50 to 100. For the
ASA 5580 and 5585-X with SSP-20 and higher, the
maximum was increased from 50 to 250.

Increased VLANs for the ASA 5580 and
5585-X

For the ASA 5580 and 5585-X, the maximum VLANs was
increased from 250 to 1024.

8.4(1)

Cisco ASA 5500 Series Configuration Guide using the CLI

3-49

Chapter 3

Managing Feature Licenses

Feature History for Licensing

Table 3-19

Feature History for Licensing (continued)

Feature Name
Increased connections for the ASA 5580 and
5585-X

Platform
Releases

Feature Information

8.4(1)

We increased the firewall connection limits:
•

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 to AnyConnect Premium license

8.4(1)

The AnyConnect Premium SSL VPN license name was
changed 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 5580

8.4(1)

The AnyConnect VPN session limit was increased from
5,000 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.

IPsec remote access VPN using IKEv2

8.4(1)

IPsec remote access VPN using IKEv2 was added to the
AnyConnect Essentials and AnyConnect Premium licenses.
IKEv2 site-to-site sessions were added to the Other VPN
license (formerly IPsec VPN). The Other VPN license is
included in the Base license.

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 ASA 5555-X

8.6(1)

The IPS SSP software module on the ASA 5512-X, ASA
5515-X, ASA 5525-X, ASA 5545-X, and ASA 5555-X
requires the IPS module license.

Cisco ASA 5500 Series Configuration Guide using the CLI

3-50

PA R T

2

Configuring Firewall and Security Context
Modes

CH A P T E R

4

Configuring the Transparent or Routed Firewall
This chapter describes how to set the firewall mode to routed or transparent, as well as how the firewall
works in each firewall mode.
In multiple context mode, you cannot set the firewall mode separately for each context; you can only set
the firewall mode for the entire ASA.
This chapter includes the following sections:
•

Configuring the Firewall Mode, page 4-1

•

Configuring ARP Inspection for the Transparent Firewall, page 4-9

•

Customizing the MAC Address Table for the Transparent Firewall, page 4-13

•

Firewall Mode Examples, page 4-17

Configuring the Firewall Mode
This section describes routed and transparent firewall mode, and how to set the mode. This section
includes the following topics:
•

Information About the Firewall Mode, page 4-1

•

Licensing Requirements for the Firewall Mode, page 4-6

•

Default Settings, page 4-6

•

Guidelines and Limitations, page 4-6

•

Setting the Firewall Mode, page 4-8

•

Feature History for Firewall Mode, page 4-9

Information About the Firewall Mode
This section describes routed and transparent firewall mode and includes the following topics:
•

Information About Routed Firewall Mode, page 4-2

•

Information About Transparent Firewall Mode, page 4-2

Cisco ASA 5500 Series Configuration Guide using the CLI

4-1

Chapter 4

Configuring the Transparent or Routed Firewall

Configuring the Firewall Mode

Information About Routed Firewall Mode
In routed mode, the ASA is considered to be a router hop in the network. It can use OSPF or RIP (in
single context mode). Routed mode supports many interfaces. Each interface is on a different subnet.
You can share interfaces between contexts.
The ASA acts as a router between connected networks, and each interface requires an IP address on a
different subnet. In single context mode, the routed firewall supports OSPF, EIGRP, and RIP. Multiple
context mode supports static routes only. We recommend using the advanced routing capabilities of the
upstream and downstream routers instead of relying on the ASA for extensive routing needs.

Information About Transparent Firewall Mode
Traditionally, a firewall is a routed hop and acts as a default gateway for hosts that connect to one of its
screened subnets. A transparent firewall, on the other hand, is a Layer 2 firewall that acts like a “bump
in the wire,” or a “stealth firewall,” and is not seen as a router hop to connected devices.
This section describes transparent firewall mode and includes the following topics:
•

Transparent Firewall Network, page 4-2

•

Bridge Groups, page 4-2

•

Management Interface (ASA 5510 and Higher), page 4-3

•

Allowing Layer 3 Traffic, page 4-3

•

Allowed MAC Addresses, page 4-3

•

Passing Traffic Not Allowed in Routed Mode, page 4-3

•

BPDU Handling, page 4-4

•

MAC Address vs. Route Lookups, page 4-4

•

Using the Transparent Firewall in Your Network, page 4-5

Transparent Firewall Network
The ASA connects the same network between its interfaces. Because the firewall is not a routed hop, you
can easily introduce a transparent firewall into an existing network.

Bridge Groups
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; 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.

Note

Each bridge group requires a management IP address. 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 the “Management Interface (ASA
5510 and Higher)” section on page 4-3.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-2

Chapter 4

Configuring the Transparent or Routed Firewall
Configuring the Firewall Mode

The ASA does not support traffic on secondary networks; only traffic on the same network as the
management IP address is supported.

Management Interface (ASA 5510 and Higher)
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 the “Management Interface” section on page 6-2.

Allowing Layer 3 Traffic
•

IPv4 and IPv6 traffic is allowed through the transparent firewall automatically from a higher security
interface to a lower security interface, without an access list.

•

ARPs are allowed through the transparent firewall in both directions without an access list. ARP
traffic can be controlled by ARP inspection.

•

For Layer 3 traffic travelling from a low to a high security interface, an extended access list is
required on the low security interface. See Chapter 15, “Adding an Extended Access List,” or
Chapter 19, “Adding an IPv6 Access List,” for more information.

Allowed MAC Addresses
The following destination MAC addresses are allowed through the transparent firewall. Any
MAC address not on this list is dropped.
•

TRUE broadcast destination MAC address equal to FFFF.FFFF.FFFF

•

IPv4 multicast MAC addresses from 0100.5E00.0000 to 0100.5EFE.FFFF

•

IPv6 multicast MAC addresses from 3333.0000.0000 to 3333.FFFF.FFFF

•

BPDU multicast address equal to 0100.0CCC.CCCD

•

AppleTalk multicast MAC addresses from 0900.0700.0000 to 0900.07FF.FFFF

Passing Traffic Not Allowed in Routed Mode
In routed mode, some types of traffic cannot pass through the ASA even if you allow it in an access list.
The transparent firewall, however, can allow almost any traffic through using either an extended access
list (for IP traffic) or an EtherType access list (for non-IP traffic).
Non-IP traffic (for example AppleTalk, IPX, BPDUs, and MPLS) can be configured to go through using
an EtherType access list.

Note

The transparent mode ASA does not pass CDP packets, or any packets that do not have a valid EtherType
greater than or equal to 0x600. For example, you cannot pass IS-IS packets. An exception is made for
BPDUs, which are supported.

Passing Traffic For Routed-Mode Features
For features that are not directly supported on the transparent firewall, you can allow traffic to pass
through so that upstream and downstream routers can support the functionality. For example, by using
an extended access list, you can allow DHCP traffic (instead of the unsupported DHCP relay feature) or

Cisco ASA 5500 Series Configuration Guide using the CLI

4-3

Chapter 4

Configuring the Transparent or Routed Firewall

Configuring the Firewall Mode

multicast traffic such as that created by IP/TV. You can also establish routing protocol adjacencies
through a transparent firewall; you can allow OSPF, RIP, EIGRP, or BGP traffic through based on an
extended access list. Likewise, protocols like HSRP or VRRP can pass through the ASA.

BPDU Handling
To prevent loops using the Spanning Tree Protocol, BPDUs are passed by default. To block BPDUs, you
need to configure an EtherType access list to deny them. If you are using failover, you might want to
block BPDUs to prevent the switch port from going into a blocking state when the topology changes.
See the “Transparent Firewall Mode Requirements” section on page 61-11 for more information.

MAC Address vs. Route Lookups
When the ASA runs in transparent mode, the outgoing interface of a packet is determined by performing
a MAC address lookup instead of a route lookup.
Route lookups, however, are necessary for the following traffic types:
•

Traffic originating on the ASA—For example, if your syslog server is located on a remote network,
you must use a static route so the ASA can reach that subnet.

•

Traffic that is at least one hop away from the ASA with NAT enabled—The ASA needs to perform
a route lookup; you need to add a static route on the ASA for the real host address.

•

Voice over IP (VoIP) traffic with inspection enabled, and the endpoint is at least one hop away from
the ASA—For example, if you use the transparent firewall between a CCM and an H.323 gateway,
and there is a router between the transparent firewall and the H.323 gateway, then you need to add
a static route on the ASA for the H.323 gateway for successful call completion.

•

VoIP or DNS traffic with inspection enabled, with NAT enabled, and the embedded address is at least
one hop away from the ASA—To successfully translate the IP address inside VoIP and DNS packets,
the ASA needs to perform a route lookup; you need to add a static route on the ASA for the real host
address that is embedded in the packet.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-4

Chapter 4

Configuring the Transparent or Routed Firewall
Configuring the Firewall Mode

Using the Transparent Firewall in Your Network
Figure 4-1 shows a typical transparent firewall network where the outside devices are on the same subnet
as the inside devices. The inside router and hosts appear to be directly connected to the outside router.
Figure 4-1

Transparent Firewall Network

Internet

10.1.1.1

Network A

Management IP
10.1.1.2

10.1.1.3

Network B

92411

192.168.1.2

Cisco ASA 5500 Series Configuration Guide using the CLI

4-5

Chapter 4

Configuring the Transparent or Routed Firewall

Configuring the Firewall Mode

Figure 4-2 shows two networks connected to the ASA, which has two bridge groups.
Figure 4-2

Transparent Firewall Network with Two Bridge Groups

10.1.1.1
Management IP
Bridge Group 1
10.1.1.2

Management IP
Bridge Group 2
10.2.1.2
10.2.1.3

254279

10.1.1.3

10.2.1.1

Licensing Requirements for the Firewall Mode
The following table shows the licensing requirements for this feature.
Model

License Requirement

All models

Base License.

Default Settings
The default mode is routed mode.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
•

For the ASA 5500 series appliances, the firewall mode is set for the entire system and all contexts;
you cannot set the mode individually for each context.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-6

Chapter 4

Configuring the Transparent or Routed Firewall
Configuring the Firewall Mode

•

When you change modes, the ASA clears the running configuration because many commands are
not supported for both modes. This action removes any contexts from running. If you then re-add a
context that has an existing configuration that was created for the wrong mode, the context
configuration might not work correctly. Be sure to recreate your context configurations for the
correct mode before you re-add them, or add new contexts with new paths for the new
configurations.

Transparent Firewall Guidelines

Follow these guidelines when planning your transparent firewall network:
•

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 Cisco
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.

•

Each directly-connected network must be on the same subnet.

•

Do not specify the bridge group management IP address as the default gateway for connected
devices; devices need to specify the router on the other side of the ASA as the default gateway.

•

The default route for the transparent firewall, which is required to provide a return path for
management traffic, is only applied to management traffic from one bridge group network. This is
because the default route specifies an interface in the bridge group as well as the router IP address
on the bridge group network, and you can only define one default route. If you have management
traffic from more than one bridge group network, you need to specify a static route that identifies
the network from which you expect management traffic.

See the “Guidelines and Limitations” section on page 9-5 for more guidelines.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines and Limitations
•

When you change firewall modes, the ASA clears the running configuration because many
commands are not supported for both modes. The startup configuration remains unchanged. If you
reload without saving, then the startup configuration is loaded, and the mode reverts back to the
original setting. See the “Setting the Firewall Mode” section on page 4-8 for information about
backing up your configuration file.

•

If you download a text configuration to the ASA that changes the mode with the
firewall transparent command, be sure to put the command at the top of the configuration; the ASA
changes the mode as soon as it reads the command and then continues reading the configuration you
downloaded. If the command appears later in the configuration, the ASA clears all the preceding
lines in the configuration. See the “Downloading Software or Configuration Files to Flash Memory”
section on page 81-2 for information about downloading text files.

Unsupported Features in Transparent Mode

Table 4-1 lists the features are not supported in transparent mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-7

Chapter 4

Configuring the Transparent or Routed Firewall

Configuring the Firewall Mode

Table 4-1

Unsupported Features in Transparent 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 access lists: 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 access list.

Multicast IP routing

You can allow multicast traffic through the ASA by allowing it in an
extended access list.

QoS

—

VPN termination for through
traffic

The transparent firewall supports site-to-site VPN tunnels for
management connections only. It does not terminate VPN connections
for traffic through the ASA. You can pass VPN traffic through the
ASA using an extended access list, but it does not terminate
non-management connections. SSL VPN is also not supported.

Setting the Firewall Mode
This section describes how to change the firewall mode.

Note

We recommend that you set the firewall mode before you perform any other configuration because
changing the firewall mode clears the running configuration.

Prerequisites
When you change modes, the ASA clears the running configuration (see the “Guidelines and
Limitations” section on page 4-6 for more information).
•

If you already have a populated configuration, be sure to back up your configuration before changing
the mode; you can use this backup for reference when creating your new configuration. See the
“Backing Up Configuration Files or Other Files” section on page 81-8.

•

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.

•

For the ASA 5500 series appiances, set the mode for the whole system in the system execution
space.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-8

Chapter 4

Configuring the Transparent or Routed Firewall
Configuring ARP Inspection for the Transparent Firewall

Detailed Steps

Command

Purpose

firewall transparent

Sets the firewall mode to transparent. To change the mode to routed, enter
the no firewall transparent command.
Note

Example:

You are not prompted to confirm the firewall mode change; the
change occurs immediately.

hostname(config)# firewall transparent

Feature History for Firewall Mode
Table 4-2 lists the release history for each feature change and the platform release in which it was
implemented.
Table 4-2

Feature History for Firewall Mode

Feature Name
Transparent firewall mode

Releases

Feature Information

7.0(1)

A transparent firewall is a Layer 2 firewall that acts like a
“bump in the wire,” or a “stealth firewall,” and is not seen as
a router hop to connected devices.
We introduced the following commands: firewall
transparent, show firewall.

Transparent firewall bridge groups

8.4(1)

Multiple bridge groups are now allowed in transparent
firewall mode. Also, you can now configure up to four
interfaces (per bridge group); formerly, you could only
configure two interfaces in transparent mode.
We introduced the following commands: firewall
transparent, show firewall.

Configuring ARP Inspection for the Transparent Firewall
This section describes ARP inspection and how to enable it and includes the following topics:
•

Information About ARP Inspection, page 4-10

•

Licensing Requirements for ARP Inspection, page 4-10

•

Default Settings, page 4-10

•

Guidelines and Limitations, page 4-10

•

Configuring ARP Inspection, page 4-11

•

Monitoring ARP Inspection, page 4-12

•

Feature History for ARP Inspection, page 4-13

Cisco ASA 5500 Series Configuration Guide using the CLI

4-9

Chapter 4

Configuring the Transparent or Routed Firewall

Configuring ARP Inspection for the Transparent Firewall

Information About ARP Inspection
By default, all ARP packets are allowed through the ASA. You can control the flow of ARP packets by
enabling ARP inspection.
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:
•

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, if present, never floods packets even if this parameter
is set to flood.

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.

Licensing Requirements for ARP Inspection
The following table shows the licensing requirements for this feature.
Model

License Requirement

All models

Base License.

Default Settings
By default, all ARP packets are allowed through the ASA.
If you enable ARP inspection, the default setting is to flood non-matching packets.

Guidelines and Limitations
Context Mode Guidelines
•

Supported in single and multiple context mode.

•

In multiple context mode, configure ARP inspection within each context.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-10

Chapter 4

Configuring the Transparent or Routed Firewall
Configuring ARP Inspection for the Transparent Firewall

Firewall Mode Guidelines

Supported only in transparent firewall mode. Routed mode is not supported.

Configuring ARP Inspection
This section describes how to configure ARP inspection and includes the following topics:
•

Task Flow for Configuring ARP Inspection, page 4-11

•

Adding a Static ARP Entry, page 4-11

•

Enabling ARP Inspection, page 4-12

Task Flow for Configuring ARP Inspection
To configure ARP Inspection, perform the following steps:
Step 1

Add static ARP entries according to the “Adding a Static ARP Entry” section on page 4-11. 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 the “Enabling ARP Inspection” section on page 4-12.

Adding a Static ARP Entry
ARP inspection compares ARP packets with static ARP entries in the ARP table. Although hosts identify
a packet destination by an IP address, the actual delivery of the packet on Ethernet relies on the Ethernet
MAC address. When a router or host wants to deliver a packet on a directly connected network, it sends
an ARP request asking for the MAC address associated with the IP address, and then delivers the packet
to the MAC address according to the ARP response. The host or router keeps an ARP table so it does not
have to send ARP requests for every packet it needs to deliver. The ARP table is dynamically updated
whenever ARP responses are sent 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
times out before it can be updated.

Note

The transparent firewall uses dynamic ARP entries in the ARP table for traffic to and from the ASA,
such as management traffic.

Detailed Steps

Command

Purpose

arp interface_name ip_address mac_address

Adds a static ARP entry.

Example:
hostname(config)# arp outside 10.1.1.1
0009.7cbe.2100

Cisco ASA 5500 Series Configuration Guide using the CLI

4-11

Chapter 4

Configuring the Transparent or Routed Firewall

Configuring ARP Inspection for the Transparent Firewall

Examples
For example, to allow ARP responses from the router at 10.1.1.1 with the MAC address 0009.7cbe.2100
on the outside interface, enter the following command:
hostname(config)# arp outside 10.1.1.1 0009.7cbe.2100

What to Do Next
Enable ARP inspection according to the “Enabling ARP Inspection” section on page 4-12.

Enabling ARP Inspection
This section describes how to enable ARP inspection.

Detailed Steps

Command

Purpose

arp-inspection interface_name enable
[flood | no-flood]

Enables ARP inspection.
The flood keyword forwards non-matching ARP packets out all interfaces,
and no-flood drops non-matching packets.
Note

Example:
hostname(config)# arp-inspection outside
enable no-flood

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.

Examples
For example, to enable ARP inspection on the outside interface, and to drop all non-matching ARP
packets, enter the following command:
hostname(config)# arp-inspection outside enable no-flood

Monitoring ARP Inspection
To monitor ARP inspection, perform the following task:
Command

Purpose

show arp-inspection

Shows the current settings for ARP inspection on all interfaces.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-12

Chapter 4

Configuring the Transparent or Routed Firewall
Customizing the MAC Address Table for the Transparent Firewall

Feature History for ARP Inspection
Table 4-2 lists the release history for each feature change and the platform release in which it was
implemented.
Table 4-3

Feature History for ARP Inspection

Feature Name
ARP inspection

Releases

Feature Information

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.

ARP cache additions for non-connected subnets 8.4(5)

The ASA ARP cache only contains entries from
directly-connected subnets by default. You can now enable
the ARP cache to also include non-directly-connected
subnets. We do not recommend enabling this feature unless
you know the security risks. This feature could facilitate
denial of service (DoS) attack against the ASA; a user on
any interface could send out many ARP replies and overload
the ASA ARP table with false entries.
You may want to use this feature if you use:
•

Secondary subnets.

•

Proxy ARP on adjacent routes for traffic forwarding.

We introduced the following command: arp
permit-nonconnected.
This feature is not available in 8.5(1), 8.6(1), or 9.0(1).

Customizing the MAC Address Table for the Transparent
Firewall
This section describes the MAC address table and includes the following topics:
•

Information About the MAC Address Table, page 4-14

•

Licensing Requirements for the MAC Address Table, page 4-14

•

Default Settings, page 4-14

•

Guidelines and Limitations, page 4-14

•

Configuring the MAC Address Table, page 4-15

•

Monitoring the MAC Address Table, page 4-16

•

Feature History for the MAC Address Table, page 4-17

Cisco ASA 5500 Series Configuration Guide using the CLI

4-13

Chapter 4

Configuring the Transparent or Routed Firewall

Customizing the MAC Address Table for the Transparent Firewall

Information About the MAC Address Table
The ASA learns and builds a MAC address table in a similar way as a normal bridge or switch: when a
device sends a packet through the ASA, the ASA adds the MAC address to its table. The table associates
the MAC address with the source interface so that the ASA knows to send any packets addressed to the
device out the correct interface.
The ASA 5505 includes a built-in switch; the switch MAC address table maintains the MAC
address-to-switch port mapping for traffic within each VLAN. This section only discusses the bridge
MAC address table, which maintains the MAC address-to-VLAN interface mapping for traffic that
passes between VLANs.
Because the ASA is a firewall, if the destination MAC address of a packet is not in the table, the ASA
does not flood the original packet on all interfaces as a normal bridge does. Instead, it generates the
following packets for directly connected devices or for remote devices:
•

Packets for directly connected devices—The ASA generates an ARP request for the destination IP
address, so that the ASA can learn which interface receives the ARP response.

•

Packets for remote devices—The ASA generates a ping to the destination IP address so that the ASA
can learn which interface receives the ping reply.

The original packet is dropped.

Licensing Requirements for the MAC Address Table
The following table shows the licensing requirements for this feature.
Model

License Requirement

All models

Base License.

Default Settings
The default timeout value for dynamic MAC address table entries is 5 minutes.
By default, each interface automatically learns the MAC addresses of entering traffic, and the ASA adds
corresponding entries to the MAC address table.

Guidelines and Limitations
Context Mode Guidelines
•

Supported in single and multiple context mode.

•

In multiple context mode, configure the MAC address table within each context.

Firewall Mode Guidelines

Supported only in transparent firewall mode. Routed mode is not supported.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-14

Chapter 4

Configuring the Transparent or Routed Firewall
Customizing the MAC Address Table for the Transparent Firewall

Additional Guidelines

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 Cisco 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.

Configuring the MAC Address Table
This section describes how you can customize the MAC address table and includes the following
sections:
•

Adding a Static MAC Address, page 4-15

•

Setting the MAC Address Timeout, page 4-15

•

Disabling MAC Address Learning, page 4-16

Adding a Static MAC Address
Normally, MAC addresses are added to the MAC address table dynamically as traffic from a particular
MAC address enters an interface. You can add static MAC addresses to the MAC address table if desired.
One benefit to adding static entries is to guard against MAC spoofing. If a client with the same
MAC address as a static entry attempts to send traffic to an interface that does not match the static entry,
then the ASA drops the traffic and generates a system message. When you add a static ARP entry (see
the “Adding a Static ARP Entry” section on page 4-11), a static MAC address entry is automatically
added to the MAC address table.
To add a static MAC address to the MAC address table, enter the following command:
Command

Purpose

mac-address-table static interface_name
mac_address

Adds a static MAC address entry.
The interface_name is the source interface.

Example:
hostname(config)# mac-address-table static
inside 0009.7cbe.2100

Setting the MAC Address Timeout
The default timeout value for dynamic MAC address table entries is 5 minutes, but you can change the
timeout. To change the timeout, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

4-15

Chapter 4

Configuring the Transparent or Routed Firewall

Customizing the MAC Address Table for the Transparent Firewall

Command

Purpose

mac-address-table aging-time timeout_value

Sets the MAC address entry timeout.
The timeout_value (in minutes) is between 5 and 720 (12 hours). 5 minutes
is the default.

Example:
hostname(config)# mac-address-table
aging-time 10

Disabling MAC Address Learning
By default, each interface automatically learns the MAC addresses of entering traffic, and the ASA adds
corresponding entries to the MAC address table. You can disable MAC address learning if desired,
however, unless you statically add MAC addresses to the table, no traffic can pass through the ASA.
To disable MAC address learning, enter the following command:
Command

Purpose

mac-learn interface_name disable

Disables MAC address learning.

Example:

The no form of this command reenables MAC address learning. The clear
configure mac-learn command reenables MAC address learning on all
interfaces.

hostname(config)# mac-learn inside disable

Monitoring the MAC Address Table
You can view the entire MAC address table (including static and dynamic entries for both interfaces), or
you can view the MAC address table for an interface. To view the MAC address table, enter the following
command:
Command

Purpose

show mac-address-table [interface_name]

Shows the MAC address table.

Examples
The following is sample output from the show mac-address-table command that shows the entire table:
hostname# show mac-address-table
interface
mac address
type
Time Left
----------------------------------------------------------------------outside
0009.7cbe.2100
static
inside
0010.7cbe.6101
static
inside
0009.7cbe.5101
dynamic
10

The following is sample output from the show mac-address-table command that shows the table for the
inside interface:
hostname# show mac-address-table inside
interface
mac address
type
Time Left
----------------------------------------------------------------------inside
0010.7cbe.6101
static
-

Cisco ASA 5500 Series Configuration Guide using the CLI

4-16

Chapter 4

Configuring the Transparent or Routed Firewall
Firewall Mode Examples

inside

0009.7cbe.5101

dynamic

10

Feature History for the MAC Address Table
Table 4-2 lists the release history for each feature change and the platform release in which it was
implemented.
Table 4-4

Feature History for the MAC Address Table

Feature Name
MAC address table

Releases

Feature Information

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.

Firewall Mode Examples
This section includes examples of how traffic moves through the ASA and includes the following topics:
•

How Data Moves Through the ASA in Routed Firewall Mode, page 4-17

•

How Data Moves Through the Transparent Firewall, page 4-23

How Data Moves Through the ASA in Routed Firewall Mode
This section describes how data moves through the ASA in routed firewall mode and includes the
following topics:
•

An Inside User Visits a Web Server, page 4-18

•

An Outside User Visits a Web Server on the DMZ, page 4-19

•

An Inside User Visits a Web Server on the DMZ, page 4-20

•

An Outside User Attempts to Access an Inside Host, page 4-21

•

A DMZ User Attempts to Access an Inside Host, page 4-22

Cisco ASA 5500 Series Configuration Guide using the CLI

4-17

Chapter 4

Configuring the Transparent or Routed Firewall

Firewall Mode Examples

An Inside User Visits a Web Server
Figure 4-3 shows an inside user accessing an outside web server.
Figure 4-3

Inside to Outside

www.example.com

Outside

209.165.201.2
Source Addr Translation
10.1.2.27
209.165.201.10
10.1.2.1

10.1.1.1

DMZ

User
10.1.2.27

Web Server
10.1.1.3

92404

Inside

The following steps describe how data moves through the ASA (see Figure 4-3):
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, the ASA verifies that the packet is
allowed according to the terms of the security policy (access lists, filters, AAA).
For multiple context mode, the ASA first classifies the packet according to either a unique interface
or a unique destination address associated with a context; the destination address is associated by
matching an address translation in a context. In this case, the interface would be unique; the
www.example.com IP address does not have a current address translation in a context.

3.

The ASA translates the local source address (10.1.2.27) to the global address 209.165.201.10, which
is on the outside interface subnet.
The global 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-18

Chapter 4

Configuring the Transparent or Routed Firewall
Firewall Mode Examples

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 translating the global destination address to the local user
address, 10.1.2.27.

6.

The ASA forwards the packet to the inside user.

An Outside User Visits a Web Server on the DMZ
Figure 4-4 shows an outside user accessing the DMZ web server.
Figure 4-4

Outside to DMZ

User

Outside

209.165.201.2

Inside

10.1.1.1

DMZ

Web Server
10.1.1.3

92406

10.1.2.1

Dest Addr Translation
10.1.1.13
209.165.201.3

The following steps describe how data moves through the ASA (see Figure 4-4):
1.

A user on the outside network requests a web page from the DMZ web server using the global
destination address of 209.165.201.3, which is on the outside interface subnet.

2.

The ASA untranslates the destination address to the local address 10.1.1.3.

3.

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 (access lists, filters, AAA).
For multiple context mode, the ASA first classifies the packet according to either a unique interface
or a unique destination address associated with a context; the destination address is associated by
matching an address translation in a context. In this case, the classifier “knows” that the DMZ web
server address belongs to a certain context because of the server address translation.

4.

The ASA then adds a session entry to the fast path and forwards the packet from the DMZ interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-19

Chapter 4

Configuring the Transparent or Routed Firewall

Firewall Mode Examples

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 local source address to 209.165.201.3.

6.

The ASA forwards the packet to the outside user.

An Inside User Visits a Web Server on the DMZ
Figure 4-5 shows an inside user accessing the DMZ web server.
Figure 4-5

Inside to DMZ

Outside

209.165.201.2

10.1.2.1

DMZ

92403

Inside

10.1.1.1

User
10.1.2.27

Web Server
10.1.1.3

The following steps describe how data moves through the ASA (see Figure 4-5):
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 (access lists, filters, AAA).
For multiple context mode, the ASA first classifies the packet according to either a unique interface
or a unique destination address associated with a context; the destination address is associated by
matching an address translation in a context. In this case, the interface is unique; the web server
IP address does not have a current address translation.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-20

Chapter 4

Configuring the Transparent or Routed Firewall
Firewall Mode Examples

5.

The ASA forwards the packet to the inside user.

An Outside User Attempts to Access an Inside Host
Figure 4-6 shows an outside user attempting to access the inside network.
Figure 4-6

Outside to Inside

www.example.com

Outside

209.165.201.2

Inside

User
10.1.2.27

10.1.1.1

DMZ

92407

10.1.2.1

The following steps describe how data moves through the ASA (see Figure 4-6):
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, the ASA verifies if the packet is
allowed according to the security policy (access lists, filters, AAA).

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-21

Chapter 4

Configuring the Transparent or Routed Firewall

Firewall Mode Examples

A DMZ User Attempts to Access an Inside Host
Figure 4-7 shows a user in the DMZ attempting to access the inside network.
Figure 4-7

DMZ to Inside

Outside

209.165.201.2

10.1.2.1

10.1.1.1

DMZ

User
10.1.2.27

Web Server
10.1.1.3

92402

Inside

The following steps describe how data moves through the ASA (see Figure 4-7):
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, the ASA verifies if the packet is
allowed according to the security policy (access lists, filters, AAA).
The packet is denied, and the ASA drops the packet and logs the connection attempt.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-22

Chapter 4

Configuring the Transparent or Routed Firewall
Firewall Mode Examples

How Data Moves Through the Transparent Firewall
Figure 4-8 shows a typical transparent firewall implementation with an inside network that contains a
public web server. The ASA has an access list so that the inside users can access Internet resources.
Another access list lets the outside users access only the web server on the inside network.
Figure 4-8

Typical Transparent Firewall Data Path

www.example.com

Internet

209.165.201.2
Management IP
209.165.201.6

Host
209.165.201.3

92412

209.165.200.230

Web Server
209.165.200.225

This section describes how data moves through the ASA and includes the following topics:
•

An Inside User Visits a Web Server, page 4-24

•

An Inside User Visits a Web Server Using NAT, page 4-25

•

An Outside User Visits a Web Server on the Inside Network, page 4-26

•

An Outside User Attempts to Access an Inside Host, page 4-27

Cisco ASA 5500 Series Configuration Guide using the CLI

4-23

Chapter 4

Configuring the Transparent or Routed Firewall

Firewall Mode Examples

An Inside User Visits a Web Server
Figure 4-9 shows an inside user accessing an outside web server.
Figure 4-9

Inside to Outside

www.example.com

Internet

209.165.201.2

Host
209.165.201.3

92408

Management IP
209.165.201.6

The following steps describe how data moves through the ASA (see Figure 4-9):
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 (access lists, filters, AAA).
For multiple context mode, the ASA first classifies the packet according to a unique interface.

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, the ASA 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-24

Chapter 4

Configuring the Transparent or Routed Firewall
Firewall Mode Examples

An Inside User Visits a Web Server Using NAT
Figure 4-10 shows an inside user accessing an outside web server.
Figure 4-10

Inside to Outside with NAT

www.example.com

Internet
Static route on router
to 209.165.201.0/27
through security appliance

Source Addr Translation
10.1.2.27
209.165.201.10
10.1.2.1
Management IP
10.1.2.2

Host
10.1.2.27

191243

Security
appliance

The following steps describe how data moves through the ASA (see Figure 4-10):
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 (access lists, filters, AAA).
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, the ASA 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.

7.

The ASA performs NAT by translating the mapped address to the real address, 10.1.2.27.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-25

Chapter 4

Configuring the Transparent or Routed Firewall

Firewall Mode Examples

An Outside User Visits a Web Server on the Inside Network
Figure 4-11 shows an outside user accessing the inside web server.
Figure 4-11

Outside to Inside

Host

Internet

209.165.201.2
Management IP
209.165.201.6

209.165.201.1

Web Server
209.165.200.225

92409

209.165.200.230

The following steps describe how data moves through the ASA (see Figure 4-11):
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 (access lists, filters, AAA).
For multiple context mode, the ASA first classifies the packet according to a unique interface.

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, the ASA attempts to discover the MAC
address by sending an ARP request and 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 outside user.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-26

Chapter 4

Configuring the Transparent or Routed Firewall
Firewall Mode Examples

An Outside User Attempts to Access an Inside Host
Figure 4-12 shows an outside user attempting to access a host on the inside network.
Figure 4-12

Outside to Inside

Host

Internet

209.165.201.2

92410

Management IP
209.165.201.6

Host
209.165.201.3

The following steps describe how data moves through the ASA (see Figure 4-12):
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 (access lists, filters, AAA).
For multiple context mode, the ASA first classifies the packet according to a unique interface.

3.

The packet is denied because there is no access list 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

4-27

Chapter 4
Firewall Mode Examples

Cisco ASA 5500 Series Configuration Guide using the CLI

4-28

Configuring the Transparent or Routed Firewall

CH A P T E R

5

Configuring Multiple Context Mode
This chapter describes how to configure multiple security contexts on the ASA and includes the
following sections:
•

Information About Security Contexts, page 5-1

•

Licensing Requirements for Multiple Context Mode, page 5-12

•

Guidelines and Limitations, page 5-13

•

Default Settings, page 5-14

•

Configuring Multiple Contexts, page 5-14

•

Changing Between Contexts and the System Execution Space, page 5-23

•

Managing Security Contexts, page 5-23

•

Monitoring Security Contexts, page 5-27

•

Configuration Examples for Multiple Context Mode, page 5-38

•

Feature History for Multiple Context Mode, page 5-39

Information About Security Contexts
You can partition a single ASA into multiple virtual devices, known as security contexts. Each context
is an independent device, with its own security policy, interfaces, and administrators. Multiple contexts
are similar to having multiple standalone devices. Many features are supported in multiple context mode,
including routing tables, firewall features, IPS, and management. Some features are not supported,
including VPN and dynamic routing protocols.

Note

When the ASA is configured for security contexts (for example, for Active/Active Stateful Failover),
IPsec or SSL VPN cannot be enabled. Therefore, these features are unavailable.
This section provides an overview of security contexts and includes the following topics:
•

Common Uses for Security Contexts, page 5-2

•

Context Configuration Files, page 5-2

•

How the ASA Classifies Packets, page 5-3

•

Cascading Security Contexts, page 5-6

•

Management Access to Security Contexts, page 5-7

Cisco ASA 5500 Series Configuration Guide using the CLI

5-1

Chapter 5

Configuring Multiple Context Mode

Information About Security Contexts

•

Information About Resource Management, page 5-8

•

Information About MAC Addresses, page 5-11

Common Uses for Security Contexts
You might want to use multiple security contexts in the following situations:
•

You are a service provider and want to sell security services to many customers. By enabling
multiple security contexts on the ASA, you can implement a cost-effective, space-saving solution
that keeps all customer traffic separate and secure, and also eases configuration.

•

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 Configuration Files
This section describes how the ASA implements multiple context mode configurations and includes the
following sections:
•

Context Configurations, page 5-2

•

System Configuration, page 5-2

•

Admin Context Configuration, page 5-2

Context Configurations
The ASA includes a configuration for each context that identifies the security policy, interfaces, and
almost all the options you can configure on a standalone device. You can store context configurations on
the internal flash memory or the external flash memory card, 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.

Admin Context Configuration
The admin context is just like any other context, except that when a user logs in to the admin context,
then that user has system administrator rights and can access the system and all other contexts. The
admin context is not restricted in any way, and can be used as a regular context. However, because

Cisco ASA 5500 Series Configuration Guide using the CLI

5-2

Chapter 5

Configuring Multiple Context Mode
Information About Security Contexts

logging into the admin context grants you administrator privileges over all contexts, you might need to
restrict access to the admin context to appropriate users. The admin context must reside on flash memory,
and not remotely.
If your system is already in multiple context mode, or if you convert from single mode, the admin context
is created automatically as a file on the internal flash memory called admin.cfg. This context is named
“admin.” If you do not want to use admin.cfg as the admin context, you can change the admin context.

How the ASA Classifies Packets
Each packet that enters the ASA must be classified, so that the ASA can determine to which context to
send a packet. This section includes the following topics:

Note

•

Valid Classifier Criteria, page 5-3

•

Classification Examples, page 5-4

If the destination MAC address is a multicast or broadcast MAC address, the packet is duplicated and
delivered to each context.

Valid Classifier Criteria
This section describes the criteria used by the classifier and includes the following topics:

Note

•

Unique Interfaces, page 5-3

•

Unique MAC Addresses, page 5-3

•

NAT Configuration, page 5-4

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.

Unique MAC Addresses
If multiple contexts share an interface, then the classifier uses the interface MAC address. The ASA lets
you assign a different MAC address in each context to the same shared interface. By default, shared
interfaces do not have unique MAC addresses; the interface uses the burned-in MAC address in every
context. An upstream router cannot route directly to a context without unique MAC addresses. You can
set the MAC addresses manually when you configure each interface (see the “Configuring the MAC
Address and MTU” section on page 8-9), or you can automatically generate MAC addresses (see the
“Automatically Assigning MAC Addresses to Context Interfaces” section on page 5-22).

Cisco ASA 5500 Series Configuration Guide using the CLI

5-3

Chapter 5

Configuring Multiple Context Mode

Information About Security Contexts

NAT Configuration
If you do not use unique MAC addresses, then the mapped addresses in your NAT configuration are used
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.

Classification Examples
Figure 5-1 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 5-1

Packet Classification with a Shared Interface using MAC Addresses

Internet

Packet Destination:
209.165.201.1 via MAC 000C.F142.4CDC
GE 0/0.1 (Shared Interface)
Classifier

Context A

GE 0/1.1

MAC 000C.F142.4CDC

Context B

GE 0/1.2

GE 0/1.3

Admin
Network

Inside
Customer A

Inside
Customer B

Host
209.165.202.129

Host
209.165.200.225

Host
209.165.201.1

Cisco ASA 5500 Series Configuration Guide using the CLI

5-4

MAC 000C.F142.4CDB

153367

MAC 000C.F142.4CDA
Admin
Context

Configuring Multiple Context Mode
Information About Security Contexts

Note that all new incoming traffic must be classified, even from inside networks. Figure 5-2 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.
Figure 5-2

Incoming Traffic from Inside Networks

Internet

GE 0/0.1
Admin
Context

Context A

Context B

Classifier

GE 0/1.1

GE 0/1.2

GE 0/1.3

Admin
Network

Inside
Customer A

Inside
Customer B

Host
10.1.1.13

Host
10.1.1.13

Host
10.1.1.13

92395

Chapter 5

Cisco ASA 5500 Series Configuration Guide using the CLI

5-5

Chapter 5

Configuring Multiple Context Mode

Information About Security Contexts

For transparent firewalls, you must use unique interfaces. Figure 5-3 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 1/0.3, which is assigned to Context B.
Figure 5-3

Transparent Firewall Contexts

Internet

Classifier
GE 0/0.2
GE 0/0.1

GE 0/0.3

Admin
Context

Context A

Context B

GE 1/0.1

GE 1/0.2

GE 1/0.3

Inside
Customer A

Inside
Customer B

Host
10.1.1.13

Host
10.1.2.13

Host
10.1.3.13

92401

Admin
Network

Cascading Security Contexts
Placing a context directly in front of another context is called cascading contexts; the outside interface
of one context is the same interface as the inside interface of another context. You might want to cascade
contexts if you want to simplify the configuration of some contexts by configuring shared parameters in
the top context.

Note

Cascading contexts requires that you configure 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-6

Chapter 5

Configuring Multiple Context Mode
Information About Security Contexts

Figure 5-4 shows a gateway context with two contexts behind the gateway.
Figure 5-4

Cascading Contexts

Internet
GE 0/0.2
Outside
Gateway
Context
Inside
GE 0/0.1
(Shared Interface)
Outside

Outside

Admin
Context

Context A

Inside

GE 1/1.43
Inside

153366

GE 1/1.8

Management Access to Security Contexts
The ASA provides system administrator access in multiple context mode as well as access for individual
context administrators. The following sections describe logging in as a system administrator or as a
context administrator:
•

System Administrator Access, page 5-7

•

Context Administrator Access, page 5-8

System Administrator Access
You can access the ASA as a system administrator in two ways:
•

Access the ASA console.
From the console, you access the system execution space, which means that any commands you enter
affect only the system configuration or the running of the system (for run-time commands).

•

Access the admin context using Telnet, SSH, or ASDM.
See Chapter 37, “Configuring Management Access,” to enable Telnet, SSH, and SDM access.

As the system administrator, you can access all contexts.
When you change to a context from admin or the system, your username changes to the default
“enable_15” username. If you configured command authorization in that context, you need to either
configure authorization privileges for the “enable_15” user, or you can log in as a different name for
which you provide sufficient privileges in the command authorization configuration for the context. To

Cisco ASA 5500 Series Configuration Guide using the CLI

5-7

Chapter 5

Configuring Multiple Context Mode

Information About Security Contexts

log in with a username, enter the login command. For example, you log in to the admin context with the
username “admin.” The admin context does not have any command authorization configuration, but all
other contexts include command authorization. For convenience, each context configuration includes a
user “admin” with maximum privileges. When you change from the admin context to context A, your
username is altered, 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.

Context Administrator Access
You can access a context using Telnet, SSH, or ASDM. If you log in to a non-admin context, you can
only access the configuration for that context. You can provide individual logins to the context. See
Chapter 37, “Configuring Management Access,” to enable Telnet, SSH, and SDM access and to
configure management authentication.

Information About Resource Management
By default, all security contexts have unlimited access to the resources of the ASA, except where
maximum limits per context are enforced. However, if you find that one or more contexts use too many
resources, and they cause other contexts to be denied connections, for example, then you can configure
resource management to limit the use of resources per context.
The ASA manages resources by assigning contexts to resource classes. Each context uses the resource
limits set by the class.
This section includes the following topics:
•

Resource Limits, page 5-8

•

Default Class, page 5-9

•

Class Members, page 5-10

Resource Limits
When you create a class, 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.
You can set the limit for individual resources, as a percentage (if there is a hard system limit) or as an
absolute value.
You can oversubscribe the ASA by assigning more than 100 percent of a resource across all contexts.
For example, you can set the Bronze class to limit connections 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. (See Figure 5-5.)

Cisco ASA 5500 Series Configuration Guide using the CLI

5-8

Chapter 5

Configuring Multiple Context Mode
Information About Security Contexts

Figure 5-5

Resource Oversubscription

Total Number of System Connections = 999,900
Max. 20%
(199,800)

Maximum connections
allowed.

16%
(159,984)

Connections in use.

12%
(119,988)

Connections denied
because system limit
was reached.

8%
(79,992)

1

2

3

4
5
6
Contexts in Class

7

8

9

104895

4%
(39,996)
10

If you assign an absolute value to a resource across all contexts that exceeds the practical limit of the
ASA, then the performance of the ASA might be impaired.
The ASA lets you assign unlimited access to one or more resources in a class, instead of a percentage or
absolute number. When a resource is unlimited, contexts can use as much of the resource as the system
has available or that is practically available. For example, Context A, B, and C are in the Silver Class,
which limits each class member to 1 percent of the connections, for a total of 3 percent; but the three
contexts are currently only using 2 percent combined. Gold Class has unlimited access to connections.
The contexts in the Gold Class can use more than the 97 percent of “unassigned” connections; they can
also use the 1 percent of connections not currently in use by Context A, B, and C, even if that means that
Context A, B, and C are unable to reach their 3 percent combined limit. (See Figure 5-6.) Setting
unlimited access is similar to oversubscribing the ASA, except that you have less control over how much
you oversubscribe the system.
Figure 5-6

Unlimited Resources

50% 43%
5%

Maximum connections
allowed.

4%

Connections in use.
3%
Connections denied
because system limit
was reached.

2%

A
B
C
Contexts Silver Class

1
2
3
Contexts Gold Class

153211

1%

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-9

Chapter 5

Configuring Multiple Context Mode

Information About Security Contexts

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 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.
By default, the default class provides unlimited access to resources for all contexts, except for the
following limits, which are by default set to the maximum allowed per context:
•

Telnet sessions—5 sessions.

•

SSH sessions—5 sessions.

•

IPsec sessions—5 sessions.

•

MAC addresses—65,535 entries.

Figure 5-7 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.
Figure 5-7

Class
Bronze
(Some
Limits
Set)

Context A

Resource Classes

Default Class

Context D

Class Silver
(Some Limits
Set)
Class Gold
(All Limits
Set)

Context B

104689

Context C

Class Members
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-10

Chapter 5

Configuring Multiple Context Mode
Information About Security Contexts

Information About MAC Addresses
To allow contexts to share interfaces, you should assign unique MAC addresses to each shared context
interface.
The MAC address is used to classify packets within a context. If you share an interface, but do not have
unique MAC addresses for the interface in each context, then other classification methods are attempted
that might not provide full coverage. See the “How the ASA Classifies Packets” section on page 5-3 for
information about classifying packets.
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. See the
“Configuring the MAC Address and MTU” section on page 8-9 to manually set the MAC address.
This section includes the following topics:
•

Default MAC Address, page 5-11

•

Interaction with Manual MAC Addresses, page 5-11

•

Failover MAC Addresses, page 5-12

•

MAC Address Format, page 5-12

Default MAC Address
If you disable MAC address generation, the physical interface uses the burned-in MAC address, and all
subinterfaces of a physical interface use the same burned-in MAC address.
See the following sections for your release for additional information about automatic MAC address
generation. See also the “MAC Address Format” section on page 5-12.
8.6(1) and Later

Automatic MAC address generation is enabled—Uses an autogenerated prefix. The ASA autogenerates
the prefix based on the last two bytes of the interface MAC address. You cannot use the legacy
auto-generation method (without a prefix).

Note

To maintain hitless upgrade for failover pairs, the ASA does not convert an existing auto-generation
configuration upon a reload if failover is enabled. However, we strongly recommend that you manually
change to the prefix method of generation when using failover. After upgrading, to use the prefix method
of MAC address generation, reenable MAC address autogeneration to use a prefix.
Earlier Releases

Automatic MAC address generation is disabled.

Interaction with Manual MAC Addresses
If you manually assign a MAC address and also enable auto-generation, then the manually assigned
MAC address is used. If you later remove the manual MAC address, the auto-generated address is used.
Because auto-generated addresses (when using a prefix) start with A2, you cannot start manual
MAC addresses with A2 if you also want to use auto-generation.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-11

Chapter 5

Configuring Multiple Context Mode

Licensing Requirements for Multiple Context Mode

Failover MAC Addresses
For use with failover, the ASA generates both an active and standby MAC address for each interface. 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. See the “MAC Address Format” section for more
information.

MAC Address Format
The MAC address format without a prefix is a legacy version not supported on newer ASA versions.

MAC Address Format Using a Prefix
The ASA generates the MAC address using the following format:
A2xx.yyzz.zzzz
Where xx.yy is a user-defined prefix or an autogenerated prefix based on the last two bytes of the
interface MAC address, and zz.zzzz is an internal counter generated by the ASA. For the standby MAC
address, the address is identical except that the internal counter is increased by 1.
For an example of how the prefix is used, if you set a prefix of 77, then the ASA converts 77 into the
hexadecimal value 004D (yyxx). When used in the MAC address, the prefix is reversed (xxyy) to match
the ASA native form:
A24D.00zz.zzzz
For a prefix of 1009 (03F1), the MAC address is:
A2F1.03zz.zzzz

MAC Address Format Without a Prefix (Legacy Method; Not Available in 8.6(1) and Later)
Without a prefix, the MAC address is generated using the following format:
•

Active unit MAC address: 12_slot.port_subid.contextid.

•

Standby unit MAC address: 02_slot.port_subid.contextid.

For platforms with no interface slots, the slot is always 0. The port is the interface port. The subid is an
internal ID for the subinterface, which is not viewable. The contextid is an internal ID for the context,
viewable with the show context detail command. For example, the interface GigabitEthernet 0/1.200 in
the context with the ID 1 has the following generated MAC addresses, where the internal ID for
subinterface 200 is 31:
•

Active: 1200.0131.0001

•

Standby: 0200.0131.0001

This MAC address generation method does not allow for persistent MAC addresses across reloads, does
not allow for multiple ASAs on the same network segment (because unique MAC addresses are not
guaranteed), and does not prevent overlapping MAC addresses with manually assigned MAC addresses.
We recommend using a prefix with the MAC address generation to avoid these issues.

Licensing Requirements for Multiple Context Mode

Cisco ASA 5500 Series Configuration Guide using the CLI

5-12

Chapter 5

Configuring Multiple Context Mode
Guidelines and Limitations

Model

License Requirement

ASA 5505

No support.

ASA 5510

Security Plus License: 2 contexts.
Optional license: 5 contexts.

ASA 5520

Base License: 2 contexts.
Optional licenses: 5, 10, or 20 contexts.

ASA 5540

Base License: 2 contexts.
Optional licenses: 5, 10, 20, or 50 contexts.

ASA 5550

Base License: 2 contexts.
Optional licenses: 5, 10, 20, 50, or 100 contexts.

ASA 5580

Base License: 2 contexts.
Optional licenses: 5, 10, 20, 50, 100, or 250 contexts.

ASA 5512-X

No support.

ASA 5515-X

Security Plus License: 2 contexts.
Optional license: 5 contexts.

ASA 5525-X

Base License: 2 contexts.
Optional licenses: 5, 10, or 20 contexts.

ASA 5545-X

Base License: 2 contexts.
Optional licenses: 5, 10, 20, or 50 contexts.

ASA 5555-X

Base License: 2 contexts.
Optional licenses: 5, 10, 20, 50, or 100 contexts.

ASA 5585-X with
SSP-10

Base License: 2 contexts.

ASA 5585-X with
SSP-20, -40, and -60

Base License: 2 contexts.

Optional licenses: 5, 10, 20, 50, or 100 contexts.
Optional licenses: 5, 10, 20, 50, 100, or 250 contexts.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Failover Guidelines

Active/Active mode failover is only supported in multiple context mode.
IPv6 Guidelines

Supports IPv6.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-13

Chapter 5

Configuring Multiple Context Mode

Default Settings

Model Guidelines

Does not support the ASA 5505.
Unsupported Features

Multiple context mode does not support the following features:
•

Dynamic routing protocols
Security contexts support only static routes. You cannot enable OSPF, RIP, or EIGRP in multiple
context mode.

•

VPN

•

Multicast routing

•

Threat Detection

•

Phone Proxy

•

QoS

•

Unified Communications

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.

Default Settings
By default, the ASA is in single context mode.

Configuring Multiple Contexts
This section describes how to configure multiple context mode, and includes the following topics:
•

Task Flow for Configuring Multiple Context Mode, page 5-14

•

Enabling or Disabling Multiple Context Mode, page 5-15

•

Configuring a Class for Resource Management, page 5-16

•

Configuring a Security Context, page 5-18

•

Automatically Assigning MAC Addresses to Context Interfaces, page 5-22

Task Flow for Configuring Multiple Context Mode
To configure multiple context mode, perform the following steps:
Step 1

Enable multiple context mode. See the “Enabling or Disabling Multiple Context Mode” section on
page 5-15.

Step 2

(Optional) Configure classes for resource management. See the “Configuring a Class for Resource
Management” section on page 5-16.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-14

Chapter 5

Configuring Multiple Context Mode
Configuring Multiple Contexts

Step 3

Configure interfaces in the system execution space. See Chapter 6, “Starting Interface Configuration
(ASA 5510 and Higher).”

Step 4

Configure security contexts. See the “Configuring a Security Context” section on page 5-18.

Step 5

(Optional) Automatically assign MAC addresses to context interfaces. See the “Automatically Assigning
MAC Addresses to Context Interfaces” section on page 5-22.

Step 6

Complete interface configuration in the context. See Chapter 8, “Completing Interface Configuration
(Routed Mode),” or Chapter 9, “Completing Interface Configuration (Transparent Mode).”

Enabling or Disabling Multiple Context Mode
Your ASA might already be configured for multiple security contexts depending on how you ordered it
from Cisco. If you are upgrading, however, you might need to convert from single mode to multiple
mode by following the procedures in this section.
This section includes the following topics:
•

Enabling Multiple Context Mode, page 5-15

•

Restoring Single Context Mode, page 5-16

Enabling Multiple Context Mode
When you convert from single mode to multiple mode, the ASA converts the running configuration into
two files: a new startup configuration that comprises the system configuration, and admin.cfg that
comprises the admin context (in the root directory of the internal flash memory). The original running
configuration is saved as old_running.cfg (in the root directory of the internal flash memory). The
original startup configuration is not saved. The ASA automatically adds an entry for the admin context
to the system configuration with the name “admin.”

Prerequisites
•

When you convert from single mode to multiple mode, the ASA converts the running configuration
into two files. The original startup configuration is not saved, so if it differs from the running
configuration, you should back it up before proceeding.

•

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.

Detailed Steps

Command

Purpose

mode multiple

Changes to multiple context mode. You are prompted to reboot the ASA.

Example:
hostname(config)# mode multiple

Cisco ASA 5500 Series Configuration Guide using the CLI

5-15

Chapter 5

Configuring Multiple Context Mode

Configuring Multiple Contexts

Restoring Single Context Mode
To copy the old running configuration to the startup configuration and to change the mode to single
mode, perform the following steps.

Prerequisites
Perform this procedure in the system execution space.

Detailed Steps

Step 1

Command

Purpose

copy flash:old_running.cfg startup-config

Copies the backup version of your original running configuration
to the current startup configuration.

Example:
hostname(config)# copy
flash:old_running.cfg startup-config

Step 2

Sets the mode to single mode. You are prompted to reboot the
ASA.

mode single

Example:
hostname(config)# mode single

Configuring a Class for Resource Management
To configure a class in the system configuration, perform the following steps. You can change the value
of a particular resource limit by reentering the command with a new value.

Prerequisites
Perform this procedure in the system execution space.

Guidelines
Table 5-1 lists the resource types and the limits. See also the show resource types command.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-16

Chapter 5

Configuring Multiple Context Mode
Configuring Multiple Contexts

Table 5-1

Resource Names and Limits

Rate or
Resource Name Concurrent

Minimum and
Maximum Number
per Context
System Limit1

mac-addresses Concurrent

N/A

65,535

conns

N/A

Concurrent connections: TCP or UDP connections between any two
hosts, including connections between one
See the “Supported
host and multiple other hosts.
Feature Licenses Per
Model” section on
page 3-1 for the
connection limit for your
platform.

Concurrent
or Rate

Description
For transparent firewall mode, the number of
MAC addresses allowed in the MAC address
table.

Rate: N/A
inspects

Rate

N/A

N/A

Application inspections.

hosts

Concurrent

N/A

N/A

Hosts that can connect through the ASA.

asdm

Concurrent

1 minimum

200

ASDM management sessions.

5 maximum

ssh

Concurrent

1 minimum

Note

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.

100

SSH sessions.

5 maximum
syslogs

Rate

N/A

N/A

Syslog messages.

telnet

Concurrent

1 minimum

100

Telnet sessions.

N/A

Address translations.

5 maximum
xlates

Concurrent

N/A

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.

Detailed Steps

Step 1

Command

Purpose

class name

Specifies the class name and enters the class configuration mode.
The name is a string up to 20 characters long. To set the limits for
the default class, enter default for the name.

Example:
hostname(config)# threat-detection
scanning-threat shun except ip-address
10.1.1.0 255.255.255.0

Step 2

Do one or more of the following:

Cisco ASA 5500 Series Configuration Guide using the CLI

5-17

Chapter 5

Configuring Multiple Context Mode

Configuring Multiple Contexts

Command

Purpose

limit-resource all 0

Sets all resource limits (shown in Table 5-1) to be unlimited. For
example, you might want to create a class that includes the admin
context that has no limitations. The default class has all resources
set to unlimited by default.

Example:
hostname(config)# limit-resource all 0
limit-resource [rate] resource_name
number[%]

Example:
hostname(config)# limit-resource rate
inspects 10

Sets a particular resource limit. For this particular resource, the
limit overrides the limit set for all. Enter the rate argument to set
the rate per second for certain resources. For resources that do not
have a system limit, you cannot set the percentage (%) between 1
and 100; you can only set an absolute value. See Table 5-1 for
resources for which you can set the rate per second and which do
not have a system limit.

Examples
For example, to set the default class limit for conns to 10 percent instead of unlimited, enter the
following commands:
hostname(config)# class default
hostname(config-class)# limit-resource conns 10%

All other resources remain at unlimited.
To add a class called gold, enter the following commands:
hostname(config)# class
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#

gold
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource

mac-addresses 10000
conns 15%
rate conns 1000
rate inspects 500
hosts 9000
asdm 5
ssh 5
rate syslogs 5000
telnet 5
xlates 36000

Configuring a Security Context
The security context definition in the system configuration identifies the context name, configuration file
URL, and interfaces that a context can use.

Prerequisites
•

Perform this procedure in the system execution space.

•

For ASA 5500 series appliances, configure physical interface parameters, VLAN subinterfaces, and
redundant interfaces according to the Chapter 6, “Starting Interface Configuration
(ASA 5510 and Higher).”

•

If you do not have an admin context (for example, if you clear the configuration) then you must first
specify the admin context name by entering the following command:
hostname(config)# admin-context name

Cisco ASA 5500 Series Configuration Guide using the CLI

5-18

Chapter 5

Configuring Multiple Context Mode
Configuring Multiple Contexts

Although this context name does not exist yet in your configuration, you can subsequently enter the
context name command to match the specified name to continue the admin context configuration.

Detailed Steps

Step 1

Command

Purpose

context name

Adds or modifies a context. 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.

Example:
hostname(config)# context administrator

“System” or “Null” (in upper or lower case letters) are reserved
names, and cannot be used.
Step 2

(Optional)

Adds a description for this context.

description text

Example:
hostname(config)# description
Administrator Context

Cisco ASA 5500 Series Configuration Guide using the CLI

5-19

Chapter 5

Configuring Multiple Context Mode

Configuring Multiple Contexts

Step 3

Command

Purpose

To allocate a physical interface:

Specifies the interfaces you can use in the context. Do not include
a space between the interface type and the port number.

allocate-interface physical_interface
[mapped_name] [visible | invisible]

To allocate one or more subinterfaces:
allocate-interface
physical_interface.subinterface[-physical_
interface.subinterface]
[mapped_name[-mapped_name]] [visible |
invisible]

Example:
hostname(config-ctx)# allocate-interface
gigabitethernet0/1.100 int1
hostname(config-ctx)# allocate-interface
gigabitethernet0/1.200 int2
hostname(config-ctx)# allocate-interface
gigabitethernet0/2.300-gigabitethernet0/2.
305 int3-int8

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. The management interface for
transparent mode does not flood a packet out the interface when
that packet is not in the MAC address table.
You can assign the same interfaces to multiple contexts in routed
mode, if desired.
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 are being used by the
context. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-20

Chapter 5

Configuring Multiple Context Mode
Configuring Multiple Contexts

Step 4

Command

Purpose

config-url url

Identifies the URL from which the system downloads the context
configuration. When you add a context URL, the system
immediately loads the context so that it is running, if the
configuration is available.

Example:

hostname(config-ctx)# config-url
ftp://user1:passw0rd@10.1.1.1/configlets/t Note
est.cfg

Enter the allocate-interface command(s) 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 message:
WARNING: Could not fetch the URL disk:/url
INFO: Creating context with default config

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).
Note

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. See the “Changing the Security Context URL” section on
page 5-25 for more information about changing the URL.
Step 5

(Optional)
member class_name

Assigns the context to a resource class. If you do not specify a
class, the context belongs to the default class. You can only assign
a context to one resource class.

Example:
hostname(config-ctx)# member gold

Step 6

(Optional)
join-failover-group {1 | 2)

Example:
hostname(config-ctx)# join-failover-group
2

Step 7

(Optional)
allocate-ips sensor_name [mapped_name]
[default]

Example:

Assigns a context to a failover group in Active/Active failover. By
default, contexts are in group 1. The admin context must always
be in group 1.
See the “Configuring the Primary Failover Unit” section on
page 63-8 for detailed information about failover groups.
Assigns an IPS virtual sensor to this context if you have the AIP
SSM installed.
See the “Assigning Virtual Sensors to a Security Context (ASA
5510 and Higher)” section on page 58-15 for detailed information
about virtual sensors.

hostname(config-ctx)# allocate-ips sensor1
highsec

Cisco ASA 5500 Series Configuration Guide using the CLI

5-21

Chapter 5

Configuring Multiple Context Mode

Configuring Multiple Contexts

Examples
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:
hostname(config)# admin-context administrator
hostname(config)# context administrator
hostname(config-ctx)# allocate-interface gigabitethernet0/0.1
hostname(config-ctx)# allocate-interface gigabitethernet0/1.1
hostname(config-ctx)# config-url flash:/admin.cfg
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
int3-int8
hostname(config-ctx)#
hostname(config-ctx)#

context test
allocate-interface gigabitethernet0/0.100 int1
allocate-interface gigabitethernet0/0.102 int2
allocate-interface gigabitethernet0/0.110-gigabitethernet0/0.115

hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
int3-int8
hostname(config-ctx)#
hostname(config-ctx)#

context sample
allocate-interface gigabitethernet0/1.200 int1
allocate-interface gigabitethernet0/1.212 int2
allocate-interface gigabitethernet0/1.230-gigabitethernet0/1.235

config-url ftp://user1:passw0rd@10.1.1.1/configlets/test.cfg
member gold

config-url ftp://user1:passw0rd@10.1.1.1/configlets/sample.cfg
member silver

Automatically Assigning MAC Addresses to Context Interfaces
This section describes how to configure auto-generation of MAC addresses.
The MAC address is used to classify packets within a context. See the “Information About MAC
Addresses” section on page 5-11 for more information, especially if you are upgrading from an earlier
ASA version. See also the “Viewing Assigned MAC Addresses” section on page 5-35.

Guidelines
•

When you configure a nameif command for the interface in a context, the new MAC address is
generated immediately. If you enable this feature after you configure context interfaces, then MAC
addresses are 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.
See the “Configuring the MAC Address and MTU” section on page 8-9 to manually set the MAC
address.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-22

Chapter 5

Configuring Multiple Context Mode
Changing Between Contexts and the System Execution Space

Detailed Steps

Command

Purpose

mac-address auto [prefix prefix]

Automatically assign private MAC addresses to each context interface.

Example:
hostname(config)# mac-address auto prefix
19

The prefix is a decimal value between 0 and 65535. This prefix is converted
to a 4-digit hexadecimal number, and used as part of the MAC address. The
prefix ensures that each ASA uses unique MAC addresses, so you can have
multiple ASAs on a network segment, for example. See the “MAC Address
Format” section for more information about how the prefix is used.

Changing Between Contexts and the System Execution Space
If you log in to the system execution space (or the admin context using Telnet or SSH), you can change
between contexts and perform configuration and monitoring tasks within each context. The running
configuration that you edit in a configuration mode, or that is used in the copy or write commands,
depends on your location. When you are in the system execution space, the running configuration
consists only of the system configuration; when you are in a context, the running configuration consists
only of that context. For example, you cannot view all running configurations (system plus all contexts)
by entering the show running-config command. Only the current configuration displays.
To change between the system execution space and a context, or between contexts, see the following
commands:

Command

Purpose

changeto context name

Changes to a context. The prompt changes to the following:
hostname/name#

Changes to the system execution space. The prompt changes to the
following:

changeto system

hostname#

Managing Security Contexts
This section describes how to manage security contexts and includes the following topics:
•

Removing a Security Context, page 5-24

•

Changing the Admin Context, page 5-24

•

Changing the Security Context URL, page 5-25

•

Reloading a Security Context, page 5-26

Cisco ASA 5500 Series Configuration Guide using the CLI

5-23

Chapter 5

Configuring Multiple Context Mode

Managing Security Contexts

Removing a Security Context
You can only remove a context by editing the system configuration. You cannot remove the current
admin context, unless you remove all contexts using the clear context command.

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.

Prerequisites
Perform this procedure in the system execution space.

Detailed Steps

Command

Purpose

no context name

Removes a single context. All context commands are also removed.

clear context

Removes all contexts (including the admin context).

Changing the Admin Context
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 admin context is just like any other context, except that when a user logs in to the admin context,
then that user has system administrator rights and can access the system and all other contexts. The
admin context is not restricted in any way, and can be used as a regular context. However, because
logging into the admin context grants you administrator privileges over all contexts, you might need to
restrict access to the admin context to appropriate users.

Guidelines
You can set any context to be the admin context, as long as the configuration file is stored in the internal
flash memory.

Prerequisites
Perform this procedure in the system execution space.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-24

Chapter 5

Configuring Multiple Context Mode
Managing Security Contexts

Detailed Steps

Command

Purpose

admin-context context_name

Sets the admin context. 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.

Example:
hostname(config)# admin-context
administrator

Note

A few system 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.

Changing the Security Context URL
This section describes how to change the context URL.

Guidelines
•

You cannot change the security context URL without reloading the configuration from the new URL.
The ASA merges the new configuration with the current running configuration.

•

Reentering the same URL also merges the saved configuration with the running configuration.

A merge adds any new commands from the new configuration to the running configuration.
•

If the configurations are the same, no changes 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. If the running
configuration is blank (for example, if the server was unavailable and the configuration was never
downloaded), then the new configuration is used.

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.

Prerequisites
Perform this procedure in the system execution space.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-25

Chapter 5

Configuring Multiple Context Mode

Managing Security Contexts

Detailed Steps

Step 1

Command

Purpose

(Optional, if you do not want to perform a
merge)

Changes to the context and clears its configuration. If you want to
perform a merge, skip to Step 2.

changeto context name
clear configure all

Example:
hostname(config)# changeto context ctx1
hostname/ctx1(config)# clear configure all

Step 2

changeto system

Changes to the system execution space.

Example:
hostname/ctx1(config)# changeto system
hostname(config)#

Step 3

Enters the context configuration mode for the context you want to
change.

context name

Example:
hostname(config)# context ctx1

Step 4

config-url new_url

Enters the new URL. The system immediately loads the context
so that it is running.

Example:
hostname(config)# config-url
ftp://user1:passw0rd@10.1.1.1/configlets/c
tx1.cfg

Reloading a Security Context
You can reload the context in two ways:
•

Clear the running configuration and then import the startup configuration.
This action clears most attributes associated with the context, such as connections and NAT tables.

•

Remove the context from the system configuration.
This action clears additional attributes, such as memory allocation, which might be useful for
troubleshooting. However, to add the context back to the system requires you to respecify the URL
and interfaces.

This section includes the following topics:
•

Reloading by Clearing the Configuration, page 5-26

•

Reloading by Removing and Re-adding the Context, page 5-27

Reloading by Clearing the Configuration
To reload the context by clearing the context configuration, and reloading the configuration from the
URL, perform the following steps.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-26

Chapter 5

Configuring Multiple Context Mode
Monitoring Security Contexts

Detailed Steps

Step 1

Command

Purpose

changeto context name

Changes to the context that you want to reload.

Example:
hostname(comfig)# changeto context ctx1
hostname/ctx1(comfig)#

Step 2

clear configure all

Clears the running configuration. This command clears all
connections.

Example:
hostname/ctx1(config)# clear configure all

Step 3

copy startup-config running-config

Example:

Reloads the configuration. The ASA copies the configuration
from the URL specified in the system configuration. You cannot
change the URL from within a context.

hostname/ctx1(config)# copy startup-config
running-config

Reloading by Removing and Re-adding the Context
To reload the context by removing the context and then re-adding it, perform the steps in the following
sections:
1.

“Removing a Security Context” section on page 5-24

2.

“Configuring a Security Context” section on page 5-18

Monitoring Security Contexts
This section describes how to view and monitor context information and includes the following topics:
•

Viewing Context Information, page 5-27

•

Viewing Context Information, page 5-27

•

Viewing Resource Allocation, page 5-29

•

Viewing Resource Usage, page 5-32

•

Monitoring SYN Attacks in Contexts, page 5-33

•

Viewing Assigned MAC Addresses, page 5-35

Viewing Context Information
From the system execution space, you can view a list of contexts including the name, allocated
interfaces, and configuration file URL.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-27

Chapter 5

Configuring Multiple Context Mode

Monitoring Security Contexts

From the system execution space, view all contexts by entering the following command:

Command

Purpose

show context [name | detail| count]

Shows all contexts.
The detail option shows additional information. See the following sample
outputs below for more information.
If you want to show information for a particular context, specify the name.
The count option shows the total number of contexts.

The following is sample output from the show context command. The following sample output shows
three contexts:
hostname# show context
Context Name
*admin

Interfaces
GigabitEthernet0/1.100
GigabitEthernet0/1.101
contexta
GigabitEthernet0/1.200
GigabitEthernet0/1.201
contextb
GigabitEthernet0/1.300
GigabitEthernet0/1.301
Total active Security Contexts: 3

URL
disk0:/admin.cfg
disk0:/contexta.cfg
disk0:/contextb.cfg

Table 5-2 shows each field description.
Table 5-2

show context Fields

Field

Description

Context Name

Lists all context names. The context name with the asterisk (*) is the admin context.

Interfaces

The interfaces assigned to the context.

URL

The URL from which the ASA loads the context configuration.

The following is sample output from the show context detail command:
hostname# show context detail
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
Context "system", is a system resource
Config URL: startup-config
Real Interfaces:
Mapped Interfaces: Control0/0, GigabitEthernet0/0,
GigabitEthernet0/0.10, GigabitEthernet0/1, GigabitEthernet0/1.10,

Cisco ASA 5500 Series Configuration Guide using the CLI

5-28

Chapter 5

Configuring Multiple Context Mode
Monitoring Security Contexts

GigabitEthernet0/1.20, GigabitEthernet0/2, GigabitEthernet0/2.30,
GigabitEthernet0/3, Management0/0, Management0/0.1
Flags: 0x00000019, ID: 257
Context "null", is a system resource
Config URL: ... null ...
Real Interfaces:
Mapped Interfaces:
Flags: 0x00000009, ID: 258

See the command reference for more information about the detail output.
The following is sample output from the show context count command:
hostname# show context count
Total active contexts: 2

Viewing Resource Allocation
From the system execution space, you can view the allocation for each resource across all classes and
class members.
To view the resource allocation, enter the following command:

Command

Purpose

show resource allocation [detail]

Shows the resource allocation. This command shows the resource
allocation, but does not show the actual resources being used. See the
“Viewing Resource Usage” section on page 5-32 for more information
about actual resource usage.
The detail argument shows additional information. See the following
sample outputs for more information.

The following sample output shows the total allocation of each resource as an absolute value and as a
percentage of the available system resources:
hostname# show resource allocation
Resource
Total
Conns [rate]
35000
Inspects [rate]
35000
Syslogs [rate]
10500
Conns
305000
Hosts
78842
SSH
35
Telnet
35
Xlates
91749
All
unlimited

% of Avail
N/A
N/A
N/A
30.50%
N/A
35.00%
35.00%
N/A

Cisco ASA 5500 Series Configuration Guide using the CLI

5-29

Chapter 5

Configuring Multiple Context Mode

Monitoring Security Contexts

Table 5-3 shows each field description.
Table 5-3

show resource allocation Fields

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.

The following is sample output from the show resource allocation detail command:
hostname# show resource allocation detail
Resource Origin:
A
Value was derived from the resource 'all'
C
Value set in the definition of this class
D
Value set in default class
Resource
Class
Mmbrs Origin
Limit
Conns [rate]
default
all
CA unlimited
gold
1
C
34000
silver
1
CA
17000
bronze
0
CA
8500
All Contexts:
3
Inspects [rate]

Syslogs [rate]

Conns

Hosts

SSH

Telnet

default
gold
silver
bronze
All Contexts:

all
1
1
0
3

CA
DA
CA
CA

default
gold
silver
bronze
All Contexts:

all
1
1
0
3

CA
C
CA
CA

default
gold
silver
bronze
All Contexts:

all
1
1
0
3

CA
C
CA
CA

default
gold
silver
bronze
All Contexts:

all
1
1
0
3

CA
DA
CA
CA

default
gold
silver
bronze
All Contexts:

all
1
1
0
3

C
D
CA
CA

default

all

C

Cisco ASA 5500 Series Configuration Guide using the CLI

5-30

unlimited
unlimited
10000
5000

unlimited
6000
3000
1500

unlimited
200000
100000
50000

unlimited
unlimited
26214
13107

5
5
10
5

5

Total

Total %

34000
17000

N/A
N/A

51000

N/A

10000

N/A

10000

N/A

6000
3000

N/A
N/A

9000

N/A

200000
100000

20.00%
10.00%

300000

30.00%

26214

N/A

26214

N/A

5
10

5.00%
10.00%

20

20.00%

Chapter 5

Configuring Multiple Context Mode
Monitoring Security Contexts

Xlates

mac-addresses

gold
silver
bronze
All Contexts:

1
1
0
3

D
CA
CA

default
gold
silver
bronze
All Contexts:

all
1
1
0
3

CA
DA
CA
CA

default
gold
silver
bronze
All Contexts:

all
1
1
0
3

C
D
CA
CA

5
10
5

unlimited
unlimited
23040
11520

65535
65535
6553
3276

5
10

5.00%
10.00%

20

20.00%

23040

N/A

23040

N/A

65535
6553

100.00%
9.99%

137623

209.99%

Table 5-4 shows each field description.
Table 5-4

show resource allocation detail Fields

Field

Description

Resource

The name of the resource that you can limit.

Class

The name of each class, including the default class.
The All contexts field shows the total values across all classes.

Mmbrs

The number of contexts assigned to each class.

Origin

The origin of the resource limit, as follows:
•

A—You set this limit with the all option, instead of as an individual resource.

•

C—This limit is derived from the member class.

•

D—This limit was not defined in the member class, but was derived from the
default class. For a context assigned to the default class, the value will be “C”
instead of “D.”

The ASA can combine “A” with “C” or “D.”
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-31

Chapter 5

Configuring Multiple Context Mode

Monitoring Security Contexts

Viewing Resource Usage
From the system execution space, you can view the resource usage for each context and display the
system resource usage.
From the system execution space, view the resource usage for each context by entering the following
command:

Command

Purpose

show resource usage [context context_name
| top n | all | summary | system]
[resource {resource_name | all} | detail]
[counter counter_name [count_threshold]]

By default, all context usage is displayed; each context is listed separately.
Enter the top n keyword to show the contexts that are the top n users of the
specified resource. You must specify a single resource type, and not
resource all, with this option.
The summary option shows all context usage combined.
The system option shows all context usage combined, but shows the
system limits for resources instead of the combined context limits.
For the resource resource_name, see Table 5-1 for available resource
names. See also the show resource type command. Specify all (the
default) for all types.
The detail option shows the resource usage of all resources, including
those you cannot manage. For example, you can view the number of TCP
intercepts.
The counter counter_name is one of the following keywords:
•

current—Shows the active concurrent instances or the current rate of
the resource.

•

denied—Shows the number of instances that were denied because they
exceeded the resource limit shown in the Limit column.

•

peak—Shows the peak concurrent instances, or the peak rate of the
resource since the statistics were last cleared, either using the clear
resource usage command or because the device rebooted.

•

all—(Default) Shows all statistics.

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.
Note

To show all resources, set the count_threshold to 0.

The following is sample output from the show resource usage context command, which shows the
resource usage for the admin context:
hostname# show resource usage context admin
Resource
Telnet
Conns
Hosts

Current
1
44
45

Cisco ASA 5500 Series Configuration Guide using the CLI

5-32

Peak
1
55
56

Limit
5
N/A
N/A

Denied
0
0
0

Context
admin
admin
admin

Chapter 5

Configuring Multiple Context Mode
Monitoring Security Contexts

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 6 contexts.
hostname# show resource usage summary
Resource
Current
Peak
Limit
Denied
Syslogs [rate]
1743
2132
N/A
0
Conns
584
763
280000(S)
0
Xlates
8526
8966
N/A
0
Hosts
254
254
N/A
0
Conns [rate]
270
535
N/A
1704
Inspects [rate]
270
535
N/A
0
S = System: Combined context limits exceed the system limit; the

Context
Summary
Summary
Summary
Summary
Summary
Summary
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.
hostname# show resource usage summary
Resource
Current
Peak
Limit
Denied
Context
Telnet
1
1
100[S]
0
Summary
SSH
2
2
100[S]
0
Summary
Conns
56
90
N/A
0
Summary
Hosts
89
102
N/A
0
Summary
S = System: Combined context limits exceed the system limit; 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.
hostname# show resource usage system counter all 0
Resource
Telnet
SSH
ASDM
Syslogs [rate]
Conns
Xlates
Hosts
Conns [rate]
Inspects [rate]

Current
0
0
0
1
0
0
0
1
0

Peak
0
0
0
18
1
0
2
1
0

Limit
100
100
32
N/A
280000
N/A
N/A
N/A
N/A

Denied
0
0
0
0
0
0
0
0
0

Context
System
System
System
System
System
System
System
System
System

Monitoring SYN Attacks in Contexts
The ASA prevents SYN attacks using TCP Intercept. TCP Intercept uses the SYN cookies algorithm to
prevent TCP SYN-flooding attacks. A SYN-flooding attack consists of a series of SYN packets usually
originating from spoofed IP addresses. The constant flood of SYN packets keeps the server SYN queue
full, which prevents it from servicing connection requests. When the embryonic connection threshold of
a connection is crossed, the ASA acts as a proxy for the server and generates a SYN-ACK response to
the client SYN request. When the ASA receives an ACK back from the client, it can then authenticate
the client and allow the connection to the server.
Monitor SYN attacks using the following commands:

Cisco ASA 5500 Series Configuration Guide using the CLI

5-33

Chapter 5

Configuring Multiple Context Mode

Monitoring Security Contexts

Command

Purpose

show perfmon

Monitors the rate of attacks for individual contexts.

show resource usage detail

Monitors the amount of resources being used by TCP intercept for
individual contexts.

show resource usage summary detail

Monitors the resources being used by TCP intercept for the entire system.

The following is sample output from the show perfmon command that shows the rate of TCP intercepts
for a context called admin.
hostname/admin# show perfmon
Context:admin
PERFMON STATS:
Xlates
Connections
TCP Conns
UDP Conns
URL Access
URL Server Req
WebSns Req
TCP Fixup
HTTP Fixup
FTP Fixup
AAA Authen
AAA Author
AAA Account
TCP Intercept

Current
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
322779/s

Average
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/s
0/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 italics shows the TCP
intercept information.)
hostname(config)# show resource usage detail
Resource
Current
Peak
Limit
memory
843732
847288 unlimited
chunk:channels
14
15 unlimited
chunk:fixup
15
15 unlimited
chunk:hole
1
1 unlimited
chunk:ip-users
10
10 unlimited
chunk:list-elem
21
21 unlimited
chunk:list-hdr
3
4 unlimited
chunk:route
2
2 unlimited
chunk:static
1
1 unlimited
tcp-intercepts
328787
803610 unlimited
np-statics
3
3 unlimited
statics
1
1 unlimited
ace-rules
1
1 unlimited
console-access-rul
2
2 unlimited
fixup-rules
14
15 unlimited
memory
959872
960000 unlimited
chunk:channels
15
16 unlimited
chunk:dbgtrace
1
1 unlimited
chunk:fixup
15
15 unlimited
chunk:global
1
1 unlimited
chunk:hole
2
2 unlimited
chunk:ip-users
10
10 unlimited
chunk:udp-ctrl-blk
1
1 unlimited
chunk:list-elem
24
24 unlimited
chunk:list-hdr
5
6 unlimited

Cisco ASA 5500 Series Configuration Guide using the CLI

5-34

Denied
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

Context
admin
admin
admin
admin
admin
admin
admin
admin
admin
admin
admin
admin
admin
admin
admin
c1
c1
c1
c1
c1
c1
c1
c1
c1
c1

Chapter 5

Configuring Multiple Context Mode
Monitoring Security Contexts

chunk:nat
chunk:route
chunk:static
tcp-intercept-rate
globals
np-statics
statics
nats
ace-rules
console-access-rul
fixup-rules
memory
chunk:channels
chunk:dbgtrace
chunk:fixup
chunk:ip-users
chunk:list-elem
chunk:list-hdr
chunk:route
block:16384
block:2048

1
2
1
16056
1
3
1
1
2
2
14
232695716
17
3
15
4
1014
1
1
510
32

1
2
1
16254
1
3
1
1
2
2
15
232020648
20
3
15
4
1014
1
1
885
34

unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited
unlimited

0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

c1
c1
c1
c1
c1
c1
c1
c1
c1
c1
c1
system
system
system
system
system
system
system
system
system
system

The following sample output shows the resources being used by TCP intercept for the entire system.
(Sample text in italics shows the TCP intercept information.)
hostname(config)# show resource usage summary detail
Resource
Current
Peak
Limit
memory
238421312
238434336 unlimited
chunk:channels
46
48 unlimited
chunk:dbgtrace
4
4 unlimited
chunk:fixup
45
45 unlimited
chunk:global
1
1 unlimited
chunk:hole
3
3 unlimited
chunk:ip-users
24
24 unlimited
chunk:udp-ctrl-blk
1
1 unlimited
chunk:list-elem
1059
1059 unlimited
chunk:list-hdr
10
11 unlimited
chunk:nat
1
1 unlimited
chunk:route
5
5 unlimited
chunk:static
2
2 unlimited
block:16384
510
885 unlimited
block:2048
32
35 unlimited
tcp-intercept-rate
341306
811579 unlimited
globals
1
1 unlimited
np-statics
6
6 unlimited
statics
2
2
N/A
nats
1
1
N/A
ace-rules
3
3
N/A
console-access-rul
4
4
N/A
fixup-rules
43
44
N/A

Denied
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

Context
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary
Summary

Viewing Assigned MAC Addresses
You can view auto-generated MAC addresses within the system configuration or within the context. This
section includes the following topics:
•

Viewing MAC Addresses in the System Configuration, page 5-36

•

Viewing MAC Addresses Within a Context, page 5-37

Cisco ASA 5500 Series Configuration Guide using the CLI

5-35

Chapter 5

Configuring Multiple Context Mode

Monitoring Security Contexts

Viewing MAC Addresses in the System Configuration
This section describes how to view MAC addresses in the system configuration.

Guidelines
If you manually assign a MAC address to an interface, but also have auto-generation enabled, the
auto-generated address continues to show in the configuration even though the manual MAC address is
the one that is in use. If you later remove the manual MAC address, the auto-generated one shown will
be used.

Detailed Steps

Command

Purpose

show running-config all context [name]

Shows the assigned MAC addresses from the system execution space.
The all option is required to view the assigned MAC addresses. Although
this command is user-configurable in global configuration mode only, the
mac-address auto command appears as a read-only entry in the
configuration for each context 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:
hostname# show running-config all context admin
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.
hostname# show running-config all context
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

Cisco ASA 5500 Series Configuration Guide using the CLI

5-36

Chapter 5

Configuring Multiple Context Mode
Monitoring Security Contexts

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
!

Viewing MAC Addresses Within a Context
This section describes how to view MAC addresses within a context.

Detailed Steps

Command

Purpose

show interface | include (Interface)|(MAC)

Shows the MAC address in use by each interface within the context.

Examples
For example:
hostname/context# show interface | include (Interface)|(MAC)
Interface GigabitEthernet1/1.1 "g1/1.1", is down, line protocol is down
MAC address a201.0101.0600, MTU 1500
Interface GigabitEthernet1/1.2 "g1/1.2", is down, line protocol is down
MAC address a201.0102.0600, MTU 1500
Interface GigabitEthernet1/1.3 "g1/1.3", is down, line protocol is down
MAC address a201.0103.0600, MTU 1500
...

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-37

Chapter 5

Configuring Multiple Context Mode

Configuration Examples for Multiple Context Mode

Configuration Examples for Multiple Context Mode
The following example:
•

Automatically sets the MAC addresses in contexts.

•

Sets the default class limit for conns to 10 percent instead of unlimited.

•

Creates a gold resource class.

•

Sets the admin context to be “administrator.”

•

Creates a context called “administrator” on the internal flash memory to be part of the default
resource class.

•

Adds two contexts from an FTP server as part of the gold resource class.

hostname(config)# mac-address auto prefix 19
hostname(config)# class default
hostname(config-class)# limit-resource conns 10%
hostname(config)# class
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#
hostname(config-class)#

gold
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource
limit-resource

mac-addresses 10000
conns 15%
rate conns 1000
rate inspects 500
hosts 9000
asdm 5
ssh 5
rate syslogs 5000
telnet 5
xlates 36000

hostname(config)# admin-context administrator
hostname(config)# context administrator
hostname(config-ctx)# allocate-interface gigabitethernet0/0.1
hostname(config-ctx)# allocate-interface gigabitethernet0/1.1
hostname(config-ctx)# config-url flash:/admin.cfg
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
int3-int8
hostname(config-ctx)#
hostname(config-ctx)#

context test
allocate-interface gigabitethernet0/0.100 int1
allocate-interface gigabitethernet0/0.102 int2
allocate-interface gigabitethernet0/0.110-gigabitethernet0/0.115

hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
int3-int8
hostname(config-ctx)#
hostname(config-ctx)#

context sample
allocate-interface gigabitethernet0/1.200 int1
allocate-interface gigabitethernet0/1.212 int2
allocate-interface gigabitethernet0/1.230-gigabitethernet0/1.235

config-url ftp://user1:passw0rd@10.1.1.1/configlets/test.cfg
member gold

config-url ftp://user1:passw0rd@10.1.1.1/configlets/sample.cfg
member gold

Cisco ASA 5500 Series Configuration Guide using the CLI

5-38

Chapter 5

Configuring Multiple Context Mode
Feature History for Multiple Context Mode

Feature History for Multiple Context Mode
Table 5-5 lists each feature change and the platform release in which it was implemented.
Table 5-5

Feature History for Multiple Context Mode

Feature Name

Platform
Releases

Feature Information

Multiple security contexts

7.0(1)

Multiple context mode was introduced.
We introduced the following commands: context, mode,
and class.

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.

Resource management

7.2(1)

Resource management was introduced.
We introduced the following commands: class,
limit-resource, and member.

Virtual sensors for IPS

8.0(2)

The AIP SSM running IPS software Version 6.0 and above
can run multiple virtual sensors, which means you can
configure multiple security policies on the AIP SSM. You
can assign each context or single mode ASA to one or more
virtual sensors, or you can assign multiple security contexts
to the same virtual sensor.
We introduced the following command: allocate-ips.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-39

Chapter 5

Configuring Multiple Context Mode

Feature History for Multiple Context Mode

Table 5-5

Feature History for Multiple Context Mode (continued)

Feature Name

Platform
Releases

Feature Information

Maximum contexts increased for the ASA 5550 8.4(1)
and 5580

The maximum security contexts for the ASA 5550 was
increased from 50 to 100. The maximum for the ASA 5580
was increased from 50 to 250.

Automatic generation of a MAC address prefix 8.6(1)
for the mac-address auto command

In multiple context mode, the ASA now converts the
automatic MAC address generation configuration to use a
default prefix. The ASA auto-generates the prefix based on
the last two bytes of the interface MAC address. This
conversion happens automatically when you reload, or if
you reenable MAC address generation. The prefix method
of generation provides many benefits, including a better
guarantee of unique MAC addresses on a segment. You can
view the auto-generated prefix by entering the show
running-config mac-address command. If you want to
change the prefix, you can reconfigure the feature with a
custom prefix. The legacy method of MAC address
generation is no longer available.
Note

To maintain hitless upgrade for failover pairs, the
ASA does not convert the MAC address method in
an existing configuration upon a reload if failover is
enabled. However, we strongly recommend that you
manually change to the prefix method of generation
when using failover. After upgrading, to use the
prefix method of MAC address generation, reenable
MAC address generation to use the default prefix.

We modified the following command: mac-address auto.

Cisco ASA 5500 Series Configuration Guide using the CLI

5-40

PA R T

3

Configuring Interfaces

CH A P T E R

6

Starting Interface Configuration
(ASA 5510 and Higher)
This chapter includes tasks for starting your interface configuration for the ASA 5510 and higher,
including configuring Ethernet settings, redundant interfaces, and EtherChannels.

Note

For ASA 5505 configuration, see Chapter 7, “Starting Interface Configuration (ASA 5505).”
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.
This chapter includes the following sections:
•

Information About Starting ASA 5510 and Higher Interface Configuration, page 6-1

•

Licensing Requirements for ASA 5510 and Higher Interfaces, page 6-8

•

Guidelines and Limitations, page 6-9

•

Default Settings, page 6-11

•

Starting Interface Configuration (ASA 5510 and Higher), page 6-12

•

Monitoring Interfaces, page 6-33

•

Configuration Examples for ASA 5510 and Higher Interfaces, page 6-33

•

Where to Go Next, page 6-34

•

Feature History for ASA 5510 and Higher Interfaces, page 6-35

Information About Starting ASA 5510 and Higher Interface
Configuration
This section includes the following topics:
•

Auto-MDI/MDIX Feature, page 6-2

•

Interfaces in Transparent Mode, page 6-2

•

Management Interface, page 6-2

•

Redundant Interfaces, page 6-4

•

EtherChannels, page 6-5

Cisco ASA 5500 Series Configuration Guide using the CLI

6-1

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Information About Starting ASA 5510 and Higher Interface Configuration

Auto-MDI/MDIX Feature
For RJ-45 interfaces on the ASA 5500 series, 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.

Interfaces in Transparent Mode
Interfaces in transparent mode belong to a “bridge group,” one bridge group for each network. You can
have up to eight bridge groups of four interfaces each per context or in single mode. For more
information about bridge groups, see the “Bridge Groups in Transparent Mode” section on page 9-1.

Management Interface
•

Management Interface Overview, page 6-2

•

Management Slot/Port Interface, page 6-2

•

Using Any Interface for Management-Only Traffic, page 6-3

•

Management Interface for Transparent Mode, page 6-3

•

No Support for Redundant Management Interfaces, page 6-4

•

Management 0/0 Interface on the ASA 5512-X through ASA 5555-X, page 6-4

Management Interface Overview
You can manage the ASA by connecting to:
•

Any through-traffic interface

•

A dedicated Management Slot/Port interface (if available for your model)

You may need to configure management access to the interface according to Chapter 37, “Configuring
Management Access.”

Management Slot/Port Interface
Table 6-1 shows the Management interfaces per model.Table 6-1

Management Interfaces Per Model

Model

Configurable for
Through Traffic1

Management 0/02

Management 0/1

Management 1/0

Management 1/1

ASA 5505

N/A

No

No

No

No

ASA 5510

Yes

Yes

No

No

No

Cisco ASA 5500 Series Configuration Guide using the CLI

6-2

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Information About Starting ASA 5510 and Higher Interface Configuration

Table 6-1

Management Interfaces Per Model

Model

Configurable for
Through Traffic1

Management 0/02

Management 0/1

Management 1/0

Management 1/1

ASA 5520

Yes

Yes

No

No

No

ASA 5540

Yes

Yes

No

No

No

ASA 5550

Yes

Yes

No

No

No

ASA 5580

Yes

Yes

Yes

No

No

ASA 5512-X

No

Yes

No

No

No

ASA 5515-X

No

Yes

No

No

No

ASA 5525-X

No

Yes

No

No

No

ASA 5545-X

No

Yes

No

No

No

ASA 5555-X

No

Yes

No

No

ASA 5585-X

Yes

Yes

Yes

Yes

No
3

Yes3

1. By default, the Management 0/0 interface is configured for management-only traffic (the management-only command). For supported models in routed
mode, you can remove the limitation and pass through traffic. If your model includes additional Management interfaces, you can use them for through
traffic as well. The Management interfaces might not be optimized for through-traffic, however.
2. The Management 0/0 interface is configured for ASDM access as part of the default factory configuration. See the “Factory Default Configurations”
section on page 2-10 for more information.
3. If you installed an SSP in slot 1, then Management 1/0 and 1/1 provide management access to the SSP in slot 1 only.

Note

If you installed an IPS module, then the IPS module management interface(s) provides management
access for the IPS module only. For the ASA 5512-X through ASA 5555-X, the IPS SSP software
module uses the same physical Management 0/0 interface as the ASA.

Using Any Interface for Management-Only Traffic
You can use any interface as a dedicated management-only interface by configuring it for management
traffic, including an EtherChannel interface (see the management-only command).

Management Interface for Transparent Mode
In transparent firewall mode, in addition to the maximum allowed through-traffic interfaces, you can also
use the Management interface (either the physical interface, a subinterface (if supported for your model),
or an EtherChannel interface comprised of Management interfaces (if you have multiple Management
interfaces)) as a separate management interface. You cannot use any other interface types as management
interfaces.
If your model does not include a Management interface, you must manage the transparent firewall from
a data interface.
In multiple context mode, you cannot share any interfaces, including the Management interface, across
contexts. To provide management per context, you can create subinterfaces of the Management interface
and allocate a Management subinterface to each context. Note that the ASA 5512-X through ASA
5555-X do not allow subinterfaces on the Management interface, so for per-context management, you
must connect to a data interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-3

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Information About Starting ASA 5510 and Higher Interface Configuration

For 8.4(1) and later, the management interface is not part of a normal bridge group. Note that for
operational purposes, it is part of a non-configurable bridge group.

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 Cisco 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.

No Support for Redundant Management Interfaces
Redundant interfaces do not support Management slot/port interfaces as members. You also cannot set
a redundant interface comprised of non-Management interfaces as management-only.

Management 0/0 Interface on the ASA 5512-X through ASA 5555-X
The Management 0/0 interface on the ASA 5512-X through ASA 5555-X has the following
characteristics:
•

No through traffic support

•

No subinterface support

•

No priority queue support

•

No multicast MAC support

•

The IPS SSP software module shares the Management 0/0 interface. Separate MAC addresses and
IP addresses are supported for the ASA and IPS module. You must perform configuration of the IPS
IP address within the IPS operating system. However, physical characteristics (such as enabling the
interface) are configured on the ASA.

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 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.

Redundant Interface MAC Address
The redundant interface uses the MAC address of the first physical interface that you add. If you change
the order of the member interfaces in the configuration, then the MAC address changes to match the
MAC address of the interface that is now listed first. Alternatively, you can assign a MAC address to the
redundant interface, which is used regardless of the member interface MAC addresses (see the
“Configuring the MAC Address and MTU” section on page 8-9 or the “Configuring Multiple Contexts”
section on page 5-14). When the active interface fails over to the standby, the same MAC address is
maintained so that traffic is not disrupted.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-4

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Information About Starting ASA 5510 and Higher Interface Configuration

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.
This section includes the following topics:
•

Channel Group Interfaces, page 6-5

•

Connecting to an EtherChannel on Another Device, page 6-5

•

Link Aggregation Control Protocol, page 6-6

•

Load Balancing, page 6-7

•

EtherChannel MAC Address, page 6-7

Channel Group Interfaces
Each channel group can have eight active interfaces. Note that 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 EtherChannel aggregates the traffic across all the available active interfaces in the channel. The port
is selected using a proprietary hash algorithm, based on source or destination MAC addresses, IP
addresses, TCP and UDP port numbers and vlan numbers.

Connecting to an EtherChannel on Another Device
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.
When the switch is part of a Virtual Switching System (VSS), then you can connect ASA interfaces
within the same EtherChannel to separate switches in the VSS. The switch interfaces are members of the
same EtherChannel port-channel interface, because the separate switches act like a single switch (see
Figure 6-1).

Cisco ASA 5500 Series Configuration Guide using the CLI

6-5

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Information About Starting ASA 5510 and Higher Interface Configuration

Figure 6-1

Connecting to a VSS

VSS
Switch 2

Switch 1

gig3/5

gig6/5

gig0/0

gig0/1

port-channel 2

port-channel 1

ASA

If you use the ASA in an Active/Standby failover deployment, then you need to create separate
EtherChannels on the switches in the VSS, one for each ASA (see Figure 6-1). 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 ASAs (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.
Figure 6-2

Active/Standby Failover and VSS

VSS
Switch 1

port-channel 2 gig3/2

port-channel 1 gig0/0

gig3/3

Switch 2

gig6/2

gig0/1

Primary ASA

gig0/0

gig6/3 port-channel 3

gig0/1

port-channel 1

Secondary ASA

Link Aggregation Control Protocol
The Link Aggregation Control Protocol (LACP) aggregates interfaces by exchanging the Link
Aggregation Control Protocol Data Units (LACPDUs) between two network devices.
You can configure each physical interface in an EtherChannel to be:
•

Active—Sends and receives LACP updates. An active EtherChannel can establish connectivity with
either an active or a passive EtherChannel. You should use the active mode unless you need to
minimize the amount of LACP traffic.

•

Passive—Receives LACP updates. A passive EtherChannel can only establish connectivity with an
active EtherChannel.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-6

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Information About Starting ASA 5510 and Higher Interface Configuration

•

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; see the “Customizing the EtherChannel” section
on page 6-29). The hash result is a 3-bit value (0 to 7).
The eight hash result values are distributed in a round robin fashion between the channel group
interfaces, starting with the interface with the lowest ID (slot/port). For example, all packets with a hash
result of 0 go to GigabitEthernet 0/0, packets with a hash result of 1 go to GigabitEthernet 0/1, packets
with a hash result of 2 go to GigabitEthernet 0/2, and so on.
Because there are eight hash result values regardless of how many active interfaces are in the
EtherChannel, packets might not be distributed evenly depending on the number of active interfaces.
Table 6-2 shows the load balancing amounts per interface for each number of active interfaces. The
active interfaces in bold have even distribution.
Table 6-2

Load Distribution per Interface

# of Active
Interfaces

% Distribution Per Interface
1

2

3

4

5

6

7

8

1

100%

—

—

—

—

—

—

—

2

50%

50%

—

—

—

—

—

—

3

37.5%

37.5%

25%

—

—

—

—

—

4

25%

25%

25%

25%

—

—

—

—

5

25%

25%

25%

12.5%

12.5%

—

—

—

6

25%

25%

12.5%

12.5%

12.5%

12.5%

—

—

7

25%

12.5%

12.5%

12.5%

12.5%

12.5%

12.5%

—

8

12.5%

12.5%

12.5%

12.5%

12.5%

12.5%

12.5%

12.5%

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.

EtherChannel MAC Address
All interfaces that are part of the channel group share the same MAC address. This feature makes the
EtherChannel transparent to network applications and users, because they only see the one logical
connection; they have no knowledge of the individual links.
The port-channel interface uses the lowest 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

Cisco ASA 5500 Series Configuration Guide using the CLI

6-7

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Licensing Requirements for ASA 5510 and Higher Interfaces

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.

Licensing Requirements for ASA 5510 and Higher Interfaces
Model

License Requirement

ASA 5510

VLANs:
Base License: 50
Security Plus License: 100
Interface Speed:
Base License—All interfaces Fast Ethernet.
Security Plus License—Ethernet 0/0 and 0/1: Gigabit Ethernet; all others Fast Ethernet.
Interfaces of all types1:
Base License: 52
Security Plus License: 120

ASA 5520

VLANs:
Base License: 150.
Interfaces of all types1:
Base License: 640

ASA 5540

VLANs:
Base License: 200
Interfaces of all types1:
Base License: 840

ASA 5550

VLANs:
Base License: 400
Interfaces of all types1:
Base License: 1640

ASA 5580

VLANs:
Base License: 1024
Interfaces of all types1:
Base License: 4176

ASA 5512-X

VLANs:
Base License: 50
Interfaces of all types1:
Base License: 328

Cisco ASA 5500 Series Configuration Guide using the CLI

6-8

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Guidelines and Limitations

Model

License Requirement

ASA 5515-X

VLANs:
Base License: 100
Interfaces of all types1:
Base License: 528

ASA 5525-X

VLANs:
Base License: 200
Interfaces of all types1:
Base License: 928

ASA 5545-X

VLANs:
Base License: 300
Interfaces of all types1:
Base License: 1328

ASA 5555-X

VLANs:
Base License: 500
Interfaces of all types1:
Base License: 2128

ASA 5585-X

VLANs:
Base License: 1024
Interface Speed for SSP-10 and SSP-20:
Base License—1-Gigabit Ethernet for fiber interfaces
10 GE I/O License—10-Gigabit Ethernet for fiber interfaces
(SSP-40 and SSP-60 support 10-Gigabit Ethernet by default.)
Interfaces of all types1:
Base License: 4176

1. The maximum number of combined interfaces; for example, VLANs, physical, redundant, bridge group, and EtherChannel interfaces.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

In multiple context mode, configure the physical interfaces in the system execution space according to
the “Starting Interface Configuration (ASA 5510 and Higher)” section on page 6-12. Then, configure the
logical interface parameters in the context execution space according to Chapter 8, “Completing
Interface Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

Cisco ASA 5500 Series Configuration Guide using the CLI

6-9

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Guidelines and Limitations

Firewall Mode Guidelines
•

For transparent mode, you can configure up to eight bridge groups per context or for a single mode
device.

•

Each bridge group can include up to four interfaces.

•

For multiple context, transparent mode, each context must use different interfaces; you cannot share
an interface across contexts.

Failover Guidelines
•

When you use a redundant or EtherChannel interface as a failover link, it must be pre-configured on
both units in the failover pair; you cannot configure it on the primary unit and expect it to replicate
to the secondary unit because the failover link itself is required for replication.

•

If you use a redundant or EtherChannel interface for the state link, no special configuration is
required; the configuration can replicate from the primary unit as normal.

•

You can monitor redundant or EtherChannel interfaces for failover using the monitor-interface
command; be sure to reference the logical redundant interface name. When an active member
interface fails over to a standby interface, this activity does not cause the redundant or EtherChannel
interface to appear to be failed when being monitored for device-level failover. Only when all
physical interfaces fail does the redundant or EtherChannel interface appear to be failed (for an
EtherChannel interface, the number of member interfaces allowed to fail is configurable).

•

If you use an EtherChannel interface for a failover or state link, then 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. To alter the configuration, you need to either shut down the EtherChannel while you make
changes, or temporarily disable failover; either action prevents failover from occurring for the
duration.

•

Although you can configure failover and failover state links on a port channel link, this port channel
cannot be shared with other firewall traffic.

Redundant Interface Guidelines
•

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.

•

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 also cannot
set a redundant interface comprised of non-Management interfaces as management-only.

•

For failover guidelines, see the “Failover Guidelines” section on page 6-10.

EtherChannel Guidelines
•

You can configure up to 48 EtherChannels.

•

Each channel group can have eight active interfaces. Note that 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-10

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Default Settings

•

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 5500 EtherChannel must also support 802.3ad
EtherChannels; for example, you can connect to the Catalyst 6500 switch.

•

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.

•

You cannot use interfaces on the 4GE SSM, including the integrated 4GE SSM in slot 1 on the ASA
5550, as part of an EtherChannel.

•

For failover guidelines, see the “Failover Guidelines” section on page 6-10.

Default Settings
This section lists default settings for interfaces if you do not have a factory default configuration. For
information about the factory default configurations, see the “Factory Default Configurations” section
on page 2-10.
Default State of Interfaces

The default state of an interface depends on the type and the context mode.
In multiple context mode, all allocated interfaces are enabled by default, no matter what the state of the
interface is in the system execution space. However, for traffic to pass through the interface, the interface
also has to be enabled in the system execution space. If you shut down an interface in the system
execution space, then that interface is down in all contexts that share it.
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.

•

Subinterfaces—Enabled. However, for traffic to pass through the subinterface, the physical interface
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.

Default Speed and Duplex
•

By default, the speed and duplex for copper (RJ-45) interfaces are set to auto-negotiate.

•

The fiber interface for the ASA 5550 (slot 1) and the 4GE SSM has a fixed speed and does not
support duplex, but you can set the interface to negotiate link parameters (the default) or not to
negotiate.

•

For fiber interfaces for the ASA 5580 and 5585-X, the speed is set for automatic link negotiation.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-11

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

Default Connector Type

The ASA 5550 (slot 1) and the 4GE SSM for the ASA 5510 and higher ASA include two connector
types: copper RJ-45 and fiber SFP. RJ-45 is the default. You can configure the ASA to use the fiber SFP
connectors.
Default MAC Addresses

By default, the physical interface uses the burned-in MAC address, and all subinterfaces of a physical
interface use the same burned-in MAC address.

Starting Interface Configuration (ASA 5510 and Higher)
This section includes the following topics:
•

Task Flow for Starting Interface Configuration, page 6-12

•

Converting In-Use Interfaces to a Redundant or EtherChannel Interface, page 6-13

•

Enabling the Physical Interface and Configuring Ethernet Parameters, page 6-22

•

Configuring a Redundant Interface, page 6-25

•

Configuring an EtherChannel, page 6-27

•

Configuring VLAN Subinterfaces and 802.1Q Trunking, page 6-30

•

Enabling Jumbo Frame Support (Supported Models), page 6-32

Task Flow for Starting Interface Configuration
Note

If you have an existing configuration, and want to convert interfaces that are in use to a redundant or
EtherChannel interface, perform your configuration offline to minimize disruption. See the “Converting
In-Use Interfaces to a Redundant or EtherChannel Interface” section on page 6-13.
To start configuring interfaces, perform the following steps:

Step 1

(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.

Step 2

Enable the physical interface, and optionally change Ethernet parameters. See the “Enabling the Physical
Interface and Configuring Ethernet Parameters” section on page 6-22.
Physical interfaces are disabled by default.

Step 3

(Optional) Configure redundant interface pairs. See the “Configuring a Redundant Interface” section on
page 6-25.
A logical redundant interface pairs an active and a standby physical interface. When the active interface
fails, the standby interface becomes active and starts passing traffic.

Step 4

(Optional) Configure an EtherChannel. See the “Configuring an EtherChannel” section on page 6-27.
An EtherChannel groups multiple Ethernet interfaces into a single logical interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-12

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

You cannot use interfaces on the 4GE SSM, including the integrated 4GE SSM in slot 1 on the
ASA 5550, as part of an EtherChannel.

Note

Step 5

(Optional) Configure VLAN subinterfaces. See the “Configuring VLAN Subinterfaces and 802.1Q
Trunking” section on page 6-30.

Step 6

(Optional) Enable jumbo frame support on the ASA 5580 and 5585-X according to the “Enabling Jumbo
Frame Support (Supported Models)” section on page 6-32.

Step 7

(Multiple context mode only) To complete the configuration of interfaces in the system execution space,
perform the following tasks that are documented in Chapter 5, “Configuring Multiple Context Mode”:
•

To assign interfaces to contexts, see the “Configuring a Security Context” section on page 5-18.

•

(Optional) To automatically assign unique MAC addresses to context interfaces, see the
“Automatically Assigning MAC Addresses to Context Interfaces” section on page 5-22.

The MAC address is used to classify packets within a context. If you share an interface, but do not have
unique MAC addresses for the interface in each context, then the destination IP address is used to
classify packets. Alternatively, you can manually assign MAC addresses within the context according to
the “Configuring the MAC Address and MTU” section on page 8-9.
Step 8

Complete the interface configuration according to Chapter 8, “Completing Interface Configuration
(Routed Mode),” or Chapter 9, “Completing Interface Configuration (Transparent Mode).”

Converting In-Use Interfaces to a Redundant or EtherChannel Interface
If you have an existing configuration and want to take advantage of the redundant or EtherChannel
interface feature for interfaces that are currently in use, you will have some amount of downtime when
you convert to the logical interfaces.
This section provides an overview of how to convert your existing interfaces to a redundant or
EtherChannel interface with minimal downtime. See the “Configuring a Redundant Interface” section
on page 6-25 and the “Configuring an EtherChannel” section on page 6-27 fore more information.
•

Detailed Steps (Single Mode), page 6-13

•

Detailed Steps (Multiple Mode), page 6-18

Detailed Steps (Single Mode)
We recommend that you update your configuration offline as a text file, and reimport the whole
configuration for the following reasons:
•

Because you cannot add a named interface as a member of a redundant or EtherChannel interface,
you must remove the name from the interface. When you remove the name from the interface, any
command that referred to that name is deleted. Because commands that refer to interface names are
widespread throughout the configuration and affect multiple features, removing a name from an
in-use interface at the CLI or in ASDM would cause significant damage to your configuration, not
to mention significant downtime while you reconfigure all your features around a new interface
name.

•

Changing your configuration offline lets you use the same interface names for your new logical
interfaces, so you do not need to touch the feature configurations that refer to interface names. You
only need to change the interface configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-13

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

•

Clearing the running configuration and immediately applying a new configuration will minimize the
downtime of your interfaces. You will not be waiting to configure the interfaces in real time.

Step 1

Connect to the ASA; if you are using failover, connect to the active ASA.

Step 2

If you are using failover, disable failover by entering the no failover command.

Step 3

Copy the running configuration by entering the more system:running-config command and copying the
display output to a text editor.
Be sure to save an extra copy of the old configuration in case you make an error when you edit it.

Step 4

For each in-use interface that you want to add to a redundant or EtherChannel interface, cut and paste
all commands under the interface command to the end of the interface configuration section for use in
creating your new logical interfaces. The only exceptions are the following commands, which should
stay with the physical interface configuration:
•

media-type

•

speed

•

duplex

•

flowcontrol

Note

You can only add physical interfaces to an EtherChannel or redundant interface; you cannot have
VLANs configured for the physical interfaces.
Be sure to match the above values for all interfaces in a given EtherChannel or redundant
interface. Note that the duplex setting for an EtherChannel interface must be Full or Auto.

For example, you have the following interface configuration. The bolded commands are the ones we
want to use with three new EtherChannel interfaces, and that you should cut and paste to the end of the
interface section.
interface GigabitEthernet0/0
nameif outside
security-level 0
ip address 10.86.194.225 255.255.255.0
no shutdown
!
interface GigabitEthernet0/1
nameif inside
security-level 100
ip address 192.168.1.3 255.255.255.0
no shutdown
!
interface GigabitEthernet0/2
shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/3
shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/4
shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

6-14

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

no nameif
no security-level
no ip address
!
interface GigabitEthernet0/5
shutdown
no nameif
no security-level
no ip address
!
interface Management0/0
nameif mgmt
security-level 100
ip address 10.1.1.5 255.255.255.0
no shutdown
!
interface Management0/1
shutdown
no nameif
no security-level
no ip address

Step 5

Above each pasted command section, create your new logical interfaces by entering one of the following
commands:
•

interface redundant number [1-8]

•

interface port-channel channel_id [1-48]

For example:
...
interface port-channel 1
nameif outside
security-level 0
ip address 10.86.194.225 255.255.255.0
no shutdown
!
interface port-channel 2
nameif inside
security-level 100
ip address 192.168.1.3 255.255.255.0
no shutdown
!
interface port-channel 3
nameif mgmt
security-level 100
ip address 10.1.1.5 255.255.255.0
no shutdown

Step 6

Assign the physical interfaces to the new logical interfaces:
•

Redundant interface—Enter the following commands under the new interface redundant
command:
member-interface physical_interface1
member-interface physical_interface2

Where the physical interfaces are any two interfaces of the same type (either formerly in use or
unused). You cannot assign a Management interface to a redundant interface.
For example, to take advantage of existing cabling, you would continue to use the formerly in-use
interfaces in their old roles as part of the inside and outside redundant interfaces:

Cisco ASA 5500 Series Configuration Guide using the CLI

6-15

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

interface redundant 1
nameif outside
security-level 0
ip address 10.86.194.225 255.255.255.0
member-interface GigabitEthernet0/0
member-interface GigabitEthernet0/2
interface redundant 2
nameif inside
security-level 100
ip address 192.168.1.3 255.255.255.0
member-interface GigabitEthernet0/1
member-interface GigabitEthernet0/3

•

EtherChannel interface—Enter the following command under each interface you want to add to the
EtherChannel (either formerly in use or unused). You can assign up to 16 interfaces per
EtherChannel, although only eight can be active; the others are in a standby state in case of failure.
channel-group channel_id mode active

For example, to take advantage of existing cabling, you would continue to use the formerly in-use
interfaces in their old roles as part of the inside and outside EtherChannel interfaces:
interface GigabitEthernet0/0
channel-group 1 mode active
no shutdown
!
interface GigabitEthernet0/1
channel-group 2 mode active
no shutdown
!
interface GigabitEthernet0/2
channel-group 1 mode active
shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/3
channel-group 1 mode active
shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/4
channel-group 2 mode active
shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/5
channel-group 2 mode active
shutdown
no nameif
no security-level
no ip address
!
interface Management0/0
channel-group 3 mode active
no shutdown
!
interface Management0/1

Cisco ASA 5500 Series Configuration Guide using the CLI

6-16

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

channel-group 3 mode active
shutdown
no nameif
no security-level
no ip address
...

Step 7

Enable each formerly unused interface that is now part of a logical interface by adding no in front of the
shutdown command.
For example, your final EtherChannel configuration is:
interface GigabitEthernet0/0
channel-group 1 mode active
no shutdown
!
interface GigabitEthernet0/1
channel-group 2 mode active
no shutdown
!
interface GigabitEthernet0/2
channel-group 1 mode active
no shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/3
channel-group 1 mode active
no shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/4
channel-group 2 mode active
no shutdown
no nameif
no security-level
no ip address
!
interface GigabitEthernet0/5
channel-group 2 mode active
no shutdown
no nameif
no security-level
no ip address
!
interface Management0/0
channel-group 3 mode active
no shutdown
!
interface Management0/1
channel-group 3 mode active
no shutdown
no nameif
no security-level
no ip address
!
interface port-channel 1
nameif outside
security-level 0
ip address 10.86.194.225 255.255.255.0

Cisco ASA 5500 Series Configuration Guide using the CLI

6-17

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

!
interface port-channel 2
nameif inside
security-level 100
ip address 192.168.1.3 255.255.255.0
!
interface port-channel 3
nameif mgmt
security-level 100
ip address 10.1.1.5 255.255.255.0

Note

Step 8

Other optional EtherChannel parameters can be configured after you import the new
configuration. See the “Configuring an EtherChannel” section on page 6-27.

At the ASA CLI prompt, perform the following steps depending on your connection (console or remote).
•

Console connection:
a. Copy the entire new configuration to the clipboard, including the altered interface section.
b. Clear the running configuration by entering:
hostname(config)# clear configure all

Traffic through the ASA stops at this point.
c. Paste in the new configuration at the prompt.

Traffic through the ASA resumes.
•

Remote connection:
a. Save the new configuration to a TFTP or FTP server, so you can copy it to the startup

configuration on the ASA. For example, you can run a TFTP or FTP server on your PC.
b. Clear the startup configuration by entering:
hostname(config)# write erase

c. Copy the new configuration to the startup configuration by entering:
hostname(config)# copy url startup-config

See the “Downloading a File to a Specific Location” section on page 81-3
d. Reload the ASA using the reload command. Do not save the running configuration.
Step 9

Reenable failover by entering the failover command.

Detailed Steps (Multiple Mode)
We recommend that you update your system and context configurations offline as text files, and reimport
them for the following reasons:
•

Because you cannot add an allocated interface as a member of a redundant or EtherChannel
interface, you must deallocate the interface from any contexts. When you deallocate the interface,
any context command that referred to that interface is deleted. Because commands that refer to
interfaces are widespread throughout the configuration and affect multiple features, removing an
allocation from an in-use interface at the CLI or in ASDM would cause significant damage to your
configuration, not to mention significant downtime while you reconfigure all your features around
a new interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-18

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

•

Changing your configuration offline lets you use the same interface names for your new logical
interfaces, so you do not need to touch the feature configurations that refer to interface names. You
only need to change the interface configuration.

•

Clearing the running system configuration and immediately applying a new configuration will
minimize the downtime of your interfaces. You will not be waiting to configure the interfaces in real
time.

Step 1

Connect to the ASA, and change to the system; if you are using failover, connect to the active ASA.

Step 2

If you are using failover, disable failover by entering the no failover command.

Step 3

In the system, copy the running configuration by entering the more system:running-config command
and copying the display output to a text editor.
Be sure to save an extra copy of the old configuration in case you make an error when you edit it.
For example, you have the following interface configuration and allocation in the system configuration,
with shared interfaces between two contexts.
System
interface GigabitEthernet0/0
no shutdown
interface GigabitEthernet0/1
no shutdown
interface GigabitEthernet0/2
shutdown
interface GigabitEthernet0/3
shutdown
interface GigabitEthernet0/4
shutdown
interface GigabitEthernet0/5
shutdown
interface Management0/0
no shutdown
interface Management1/0
shutdown
!
context customerA
allocate-interface gigabitethernet0/0 int1
allocate-interface gigabitethernet0/1 int2
allocate-interface management0/0 mgmt
context customerB
allocate-interface gigabitethernet0/0
allocate-interface gigabitethernet0/1
allocate-interface management0/0

Step 4

Get copies of all context configurations that will use the new EtherChannel or redundant interface. See
the “Backing Up a Context Configuration or Other File in Flash Memory” section on page 81-8.
For example, you download the following context configurations (interface configuration shown):
CustomerA Context
interface int1
nameif outside
security-level 0
ip address 10.86.194.225 255.255.255.0
!
interface int2
nameif inside
security-level 100

Cisco ASA 5500 Series Configuration Guide using the CLI

6-19

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

ip address 192.168.1.3 255.255.255.0
no shutdown
!
interface mgmt
nameif mgmt
security-level 100
ip address 10.1.1.5 255.255.255.0
management-only

CustomerB Context
interface GigabitEthernet0/0
nameif outside
security-level 0
ip address 10.20.15.5 255.255.255.0
!
interface GigabitEthernet0/1
nameif inside
security-level 100
ip address 192.168.6.78 255.255.255.0
!
interface Management0/0
nameif mgmt
security-level 100
ip address 10.8.1.8 255.255.255.0
management-only

Step 5

In the system configuration, create the new logical interfaces according to the “Configuring a Redundant
Interface” section on page 6-25 or the “Configuring an EtherChannel” section on page 6-27. Be sure to
enter the no shutdown command on any additional physical interfaces you want to use as part of the
logical interface.

Note

You can only add physical interfaces to an EtherChannel or redundant interface; you cannot have
VLANs configured for the physical interfaces.
Be sure to match physical interface parameters such as speed and duplex for all interfaces in a
given EtherChannel or redundant interface. Note that the duplex setting for an EtherChannel
interface must be Full or Auto.

For example, the new configuration is:
System
interface GigabitEthernet0/0
channel-group 1 mode active
no shutdown
!
interface GigabitEthernet0/1
channel-group 2 mode active
no shutdown
!
interface GigabitEthernet0/2
channel-group 1 mode active
no shutdown
!
interface GigabitEthernet0/3
channel-group 1 mode active
no shutdown
!

Cisco ASA 5500 Series Configuration Guide using the CLI

6-20

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

interface GigabitEthernet0/4
channel-group 2 mode active
no shutdown
!
interface GigabitEthernet0/5
channel-group 2 mode active
no shutdown
!
interface Management0/0
channel-group 3 mode active
no shutdown
!
interface Management0/1
channel-group 3 mode active
no shutdown
!
interface port-channel 1
interface port-channel 2
interface port-channel 3

Step 6

Change the interface allocation per context to use the new EtherChannel or redundant interfaces. See the
“Configuring a Security Context” section on page 5-18.
For example, to take advantage of existing cabling, you would continue to use the formerly in-use
interfaces in their old roles as part of the inside and outside redundant interfaces:
context customerA
allocate-interface
allocate-interface
allocate-interface
context customerB
allocate-interface
allocate-interface
allocate-interface

Note

Step 7

port-channel1 int1
port-channel2 int2
port-channel3 mgmt
port-channel1
port-channel2
port-channel3

You might want to take this opportunity to assign mapped names to interfaces if you have not
done so already. For example, the configuration for customerA does not need to be altered at all;
it just needs to be reapplied on the ASA. The customerB configuration, however, needs to have
all of the interface IDs changed; if you assign mapped names for customerB, you still have to
change the interface IDs in the context configuration, but mapped names might help future
interface changes.

For contexts that do not use mapped names, change the context configuration to use the new
EtherChannel or redundant interface ID. (Contexts that use mapped interface names do not require any
alteration.)
For example:
CustomerB Context
interface port-channel1
nameif outside
security-level 0
ip address 10.20.15.5 255.255.255.0
!
interface port-channel2
nameif inside
security-level 100
ip address 192.168.6.78 255.255.255.0
!

Cisco ASA 5500 Series Configuration Guide using the CLI

6-21

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

interface port-channel3
nameif mgmt
security-level 100
ip address 10.8.1.8 255.255.255.0
management-only

Step 8

Copy the new context configuration files over the old ones. For example, if your contexts are on an FTP
server, copy over the existing files (making backups as desired) using FTP. If your contexts are in flash
memory, you can use the copy command and run a TFTP or FTP server on your PC, or use secure copy.
See the “Downloading a File to a Specific Location” section on page 81-3. This change only affects the
startup configuration; the running configuration is still using the old context configuration.

Step 9

At the ASA system CLI prompt, perform the following steps depending on your connection (console or
remote).
•

Console connection:
a. Copy the entire new system configuration to the clipboard, including the altered interface

section.
b. Clear the running configuration (both system and contexts) by entering:
hostname(config)# clear configure all

Traffic through the ASA stops at this point.
c. Paste in the new system configuration at the prompt.

All of the new context configurations now reload. When they are finished reloading, traffic
through the ASA resumes.
•

Remote connection:
a. Save the new system configuration to a TFTP or FTP server, so you can copy it to the startup

configuration on the ASA. For example, you can run a TFTP or FTP server on your PC.
b. Clear the startup configuration by entering:
hostname(config)# write erase

c. Copy the new system configuration to the startup configuration by entering:
hostname(config)# copy url startup-config

See the “Downloading a File to a Specific Location” section on page 81-3
d. Reload the ASA using the reload command. Do not save the running configuration.
Step 10

Reenable failover by entering the failover command.

Enabling the Physical Interface and Configuring Ethernet Parameters
This section describes how to:
•

Enable the physical interface

•

Set a specific speed and duplex (if available)

•

Enable pause frames for flow control

Cisco ASA 5500 Series Configuration Guide using the CLI

6-22

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

Prerequisites
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.

Detailed Steps

Step 1

Command

Purpose

interface physical_interface

Specifies the interface you want to configure.

Example:

where the physical_interface ID includes the type, slot, and port
number as type[slot/]port.

hostname(config)# interface
gigabitethernet 0/0

The physical interface types include the following:
•

ethernet

•

gigabitethernet

•

tengigabitethernet

•

management

Enter the type followed by slot/port, for example,
gigabitethernet0/1 or ethernet 0/1. A space is optional between
the type and the slot/port.
Step 2

(Optional)
media-type sfp

Sets the media type to SFP, if available for your model. To restore
the default RJ-45, enter the media-type rj45 command.

Example:
hostname(config-if)# media-type sfp

Step 3

(Optional)

Sets the speed.

speed {auto | 10 | 100 | 1000 |
nonegotiate}

For copper interfaces, the default setting is auto.

Example:
hostname(config-if)# speed 100

Step 4

(Optional)
duplex {auto | full | half}

For SFP interfaces, the default setting is no speed nonegotiate,
which sets the speed to the maximum speed and enables link
negotiation for flow-control parameters and remote fault
information. The nonegotiate keyword is the only keyword
available for SFP interfaces. The speed nonegotiate command
disables link negotiation.
Sets the duplex for copper interfaces. The auto setting is the
default.
Note

Example:

The duplex setting for an EtherChannel interface must be
Full or Auto.

hostname(config-if)# duplex full

Cisco ASA 5500 Series Configuration Guide using the CLI

6-23

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

Step 5

Command

Purpose

(Optional)

Enables pause (XOFF) frames for flow control on 1-Gigabit and
10-Gigabit Ethernet interfaces.

flowcontrol send on [low_water high_water
pause_time] [noconfirm]

Example:
hostname(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.
Proceed with flow-control changes?

To change the parameters without being prompted, use the
noconfirm keyword.
Note
Step 6

no shutdown

Example:
hostname(config-if)# no shutdown

Only flow control frames defined in 802.3x are supported.
Priority-based flow control is not supported.

Enables the interface. 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.

What to Do Next
Optional Tasks:
•

Configure redundant interface pairs. See the “Configuring a Redundant Interface” section on
page 6-25.

•

Configure an EtherChannel. See the “Configuring an EtherChannel” section on page 6-27.

•

Configure VLAN subinterfaces. See the “Configuring VLAN Subinterfaces and 802.1Q Trunking”
section on page 6-30.

Required Tasks:
•

For multiple context mode, assign interfaces to contexts and automatically assign unique MAC
addresses to context interfaces. See the “Configuring Multiple Contexts” section on page 5-14.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-24

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

•

For single context mode, complete the interface configuration. See Chapter 8, “Completing
Interface Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

Configuring a Redundant Interface
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 redundant interface to increase the ASA reliability. This feature is separate from device-level
failover, but you can configure redundant interfaces as well as failover if desired.
This section describes how to configure redundant interfaces and includes the following topics:
•

Configuring a Redundant Interface, page 6-25

•

Changing the Active Interface, page 6-27

Configuring a Redundant Interface
This section describes how to create a redundant interface. By default, redundant interfaces are enabled.

Guidelines and Limitations
•

You can configure up to 8 redundant interface pairs.

•

Redundant interface delay values are configurable, but by default the ASA inherits the default delay
values based on the physical type of its member interfaces.

•

See also the “Redundant Interface Guidelines” section on page 6-10.

•

Both member interfaces must be of the same physical type. For example, both must be Ethernet.

•

You cannot add a physical interface to the redundant interface if you configured a name for it. You
must first remove the name using the no nameif command.

•

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.

Prerequisites

Caution

If you are using a physical interface already in your configuration, removing the name will clear any
configuration that refers to the interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-25

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

Detailed Steps

Step 1

Command

Purpose

interface redundant number

Adds the logical redundant interface, where the number argument
is an integer between 1 and 8.

Example:

Note

hostname(config)# interface redundant 1

Step 2

You need to add at least one member interface to the
redundant interface before you can configure logical
parameters for it such as a name.

member-interface physical_interface

Adds the first member interface to the redundant interface.

Example:

See the “Enabling the Physical Interface and Configuring
Ethernet Parameters” section for a description of the physical
interface ID.

hostname(config-if)# member-interface
management 0/0

Redundant interfaces do not support Management slot/port
interfaces as members.
After you add the interface, any configuration for it (such as an IP
address) is removed.

Step 3

member-interface physical_interface

Adds the second member interface to the redundant interface.

Example:

Make sure the second interface is the same physical type as the
first interface.

hostname(config-if)# member-interface
management 1/0

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:
hostname(config)# interface redundant 1
hostname(config-if)# member-interface gigabitethernet
hostname(config-if)# member-interface gigabitethernet
hostname(config-if)# interface redundant 2
hostname(config-if)# member-interface gigabitethernet
hostname(config-if)# member-interface gigabitethernet

0/0
0/1
0/2
0/3

What to Do Next
Optional Task:
•

Configure VLAN subinterfaces. See the “Configuring VLAN Subinterfaces and 802.1Q Trunking”
section on page 6-30.

Required Tasks:
•

For multiple context mode, assign interfaces to contexts and automatically assign unique MAC
addresses to context interfaces. See the “Configuring Multiple Contexts” section on page 5-14.

•

For single context mode, complete the interface configuration. See the Chapter 8, “Completing
Interface Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

Cisco ASA 5500 Series Configuration Guide using the CLI

6-26

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

Changing the Active Interface
By default, the active interface is the first interface listed in the configuration, if it is available. To view
which interface is active, enter the following command:
hostname# show interface redundantnumber detail | grep Member

For example:
hostname# show interface redundant1 detail | grep Member
Members GigabitEthernet0/3(Active), GigabitEthernet0/2

To change the active interface, enter the following command:
hostname# redundant-interface redundantnumber active-member physical_interface

where the redundantnumber argument is the redundant interface ID, such as redundant1.
The physical_interface is the member interface ID that you want to be active.

Configuring an EtherChannel
This section describes how to create an EtherChannel port-channel interface, assign interfaces to the
EtherChannel, and customize the EtherChannel.
This section includes the following topics:
•

Adding Interfaces to the EtherChannel, page 6-27

•

Customizing the EtherChannel, page 6-29

Adding Interfaces to the EtherChannel
This section describes how to create an EtherChannel port-channel interface and assign interfaces to the
EtherChannel. By default, port-channel interfaces are enabled.

Guidelines and Limitations
•

You can configure up to 48 EtherChannels.

•

Each channel group can have eight active interfaces. Note that 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.

•

You cannot use interfaces on the 4GE SSM, including the integrated 4GE SSM in slot 1 on the ASA
5550, as part of an EtherChannel.

•

See also the “EtherChannel Guidelines” section on page 6-10.

•

All interfaces in the channel group must be the same type, speed, and duplex. Half duplex is not
supported.

•

You cannot add a physical interface to the channel group if you configured a name for it. You must
first remove the name using the no nameif command.

•

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.

Prerequisites

Cisco ASA 5500 Series Configuration Guide using the CLI

6-27

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

Caution

If you are using a physical interface already in your configuration, removing the name will clear any
configuration that refers to the interface.

Detailed Steps

Step 1

Command

Purpose

interface physical_interface

Specifies the interface you want to add to the channel group,
where 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:
hostname(config)# interface
gigabitethernet 0/0

Step 2

channel-group channel_id mode {active |
passive | on}

Example:
hostname(config-if)# channel-group 1 mode
active

In transparent mode, if you create a channel group with multiple
Management interfaces, then you can use this EtherChannel as the
management-only interface.
Assigns this physical interface to an EtherChannel with the
channel_id 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. For information about active,
passive, and on modes, see the “Link Aggregation Control
Protocol” section on page 6-6.
Step 3

(Optional)
lacp port-priority number

Example:
hostname(config-if)# lacp port-priority
12345

Sets the priority for a physical interface in the channel group
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 in the
“Customizing the EtherChannel” section on page 6-29.

Step 4

Repeat steps 1 through 5 for each interface you
want to add to the channel group.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-28

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.

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

What to Do Next
Optional Tasks:
•

Customize the EtherChannel interface. See the “Customizing the EtherChannel” section on
page 6-29.

•

Configure VLAN subinterfaces. See the “Configuring VLAN Subinterfaces and 802.1Q Trunking”
section on page 6-30.

Required Tasks:
•

For multiple context mode, assign interfaces to contexts and automatically assign unique MAC
addresses to context interfaces. See the “Configuring Multiple Contexts” section on page 5-14.

•

For single context mode, complete the interface configuration. See the Chapter 8, “Completing
Interface Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

Customizing the EtherChannel
This section describes how to set the maximum number of interfaces in the EtherChannel, the minimum
number of operating interfaces for the EtherChannel to be active, the load balancing algorithm, and other
optional parameters.

Detailed Steps

Command
Step 1

interface port-channel channel_id

Step 2

lacp max-bundle number

Purpose

Specifies the port-channel interface. 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
Example:
the port-channel interface.
hostname(config)# interface port-channel 1
Note
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.
Specifies the maximum number of active interfaces allowed in the
channel group, between 1 and 8. The default is 8.

Example:
hostname(config-if)# lacp max-bundle 6

Step 3

port-channel min-bundle number

Example:
hostname(config-if)# port-channel
min-bundle 2

Specifies the minimum number of active interfaces required for
the port-channel interface to become active, between 1 and 8. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-29

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

Step 4

Command

Purpose

port-channel load-balance {dst-ip |
dst-ip-port | dst-mac | dst-port |
src-dst-ip | src-dst-ip-port | src-dst-mac
| src-dst-port | src-ip | src-ip-port |
src-mac | src-port | vlan-dst-ip |
vlan-dst-ip-port | vlan-only |
vlan-src-dst-ip | vlan-src-dst-ip-port |
vlan-src-ip | vlan-src-ip-port}

Configures the load-balancing algorithm. 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
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. For more information about load balancing, see
the “Load Balancing” section on page 6-7.

Example:
hostname(config-if)# port-channel
load-balance src-dst-mac

Step 5

lacp system-priority number

Example:
hostname(config)# lacp system-priority
12345

Step 6

Sets the LACP system priority, from 1 to 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 in the “Adding Interfaces to
the EtherChannel” section on page 6-27.

This method provides a shortcut to set these parameters because
these parameters must match for all interfaces in the channel
You can set the Ethernet properties for the
group. See the “Enabling the Physical Interface and Configuring
port-channel interface to override the properties
Ethernet Parameters” section on page 6-22 for Ethernet
set on the individual interfaces.
commands.
(Optional)

What to Do Next
Optional Task:
•

Configure VLAN subinterfaces. See the “Configuring VLAN Subinterfaces and 802.1Q Trunking”
section on page 6-30.

Required Tasks:
•

For multiple context mode, assign interfaces to contexts and automatically assign unique MAC
addresses to context interfaces. See the “Configuring Multiple Contexts” section on page 5-14.

•

For single context mode, complete the interface configuration. See the Chapter 8, “Completing
Interface Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

Configuring VLAN Subinterfaces and 802.1Q Trunking
Subinterfaces let you divide a physical, redundant, or EtherChannel interface into multiple logical
interfaces that are tagged with different VLAN IDs. An interface with one or more VLAN subinterfaces
is automatically configured as an 802.1Q trunk. Because VLANs allow you to keep traffic separate on a
given physical interface, you can increase the number of interfaces available to your network without
adding additional physical interfaces or ASAs. This feature is particularly useful in multiple context
mode so that you can assign unique interfaces to each context.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-30

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Starting Interface Configuration (ASA 5510 and Higher)

Guidelines and Limitations
•

Maximum subinterfaces—To determine how many VLAN subinterfaces are allowed for your
platform, see the “Licensing Requirements for ASA 5510 and Higher Interfaces” section on
page 6-8.

•

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.
Because the physical or redundant interface must be enabled for the subinterface to pass traffic,
ensure that the physical or redundant interface does not pass traffic by leaving out the nameif
command. If you want to let the physical or redundant interface pass untagged packets, you can
configure the nameif command as usual. See Chapter 8, “Completing Interface Configuration
(Routed Mode),” or Chapter 9, “Completing Interface Configuration (Transparent Mode),” for more
information about completing the interface configuration.

•

(ASA 5512-X through ASA 5555-X) You cannot configure subinterfaces on the Management 0/0
interface.

Prerequisites
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.

Detailed Steps

Step 1

Command

Purpose

interface {physical_interface | redundant
number | port-channel number}.subinterface

Specifies the new subinterface. See the “Enabling the Physical
Interface and Configuring Ethernet Parameters” section for a
description of the physical interface ID.

Example:

The redundant number argument is the redundant interface ID,
such as redundant 1.

hostname(config)# interface
gigabitethernet 0/1.100

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.
Step 2

vlan vlan_id

Example:
hostname(config-subif)# vlan 101

Specifies the VLAN for the subinterface. 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.
You can only assign a single VLAN to a subinterface, and 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-31

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Starting Interface Configuration (ASA 5510 and Higher)

What to Do Next
(Optional) For the ASA 5580 and 5585-X, enable jumbo frame support according to the “Enabling
Jumbo Frame Support (Supported Models)” section on page 6-32.

Enabling Jumbo Frame Support (Supported Models)
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 access lists.
Supported models include:
•

ASA 5512-X

•

ASA 5515-X

•

ASA 5525-X

•

ASA 5545-X

•

ASA 5555-X

•

ASA 5580

•

ASA 5585-X

•

In multiple context mode, set this option in the system execution space.

•

Changes in this setting require you to reload the ASA.

•

Be sure to set the MTU for each interface that needs to transmit jumbo frames to a higher value than
the default 1500; for example, set the value to 9000 using the mtu command. See the “Configuring
the MAC Address and MTU” section on page 8-9. In multiple context mode, set the MTU within
each context.

Prerequisites

Detailed Steps

Command

Purpose

jumbo-frame reservation

Enables jumbo frame support for the ASA 5580 and 5585-X. To disable
jumbo frames, use the no form of this command.

Example:
hostname(config)# jumbo-frame reservation

Examples
The following example enables jumbo frame reservation, saves the configuration, and reloads the ASA:
hostname(config)# jumbo-frame reservation
WARNING: this command will take effect after the running-config is saved
and the system has been rebooted. Command accepted.
hostname(config)# write memory
Building configuration...

Cisco ASA 5500 Series Configuration Guide using the CLI

6-32

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Monitoring Interfaces

Cryptochecksum: 718e3706 4edb11ea 69af58d0 0a6b7cb5
70291 bytes copied in 3.710 secs (23430 bytes/sec)
[OK]
hostname(config)# reload
Proceed with reload? [confirm] Y

Monitoring Interfaces
To monitor interfaces, enter one of the following commands:
Command

Purpose

show interface

Displays interface statistics.

show interface ip brief

Displays interface IP addresses and status.

show lacp {[channel_group_number] {counters
| internal | neighbor} | sys-id}

For EtherChannel, displays LACP information such as traffic statistics,
system identifier and neighbor details.

show port-channel [channel_group_number]
[brief | detail | port | protocol |
summary]

For EtherChannel, displays EtherChannel information in a detailed and
one-line summary form. This command also displays the port and
port-channel information.

show port-channel channel_group_number
load-balance [hash-result {ip | ipv6 |
l4port | mac | mixed | vlan-only}
parameters]

For EtherChannel, displays port-channel load-balance information along
with the hash result and member interface selected for a given set of
parameters.

Configuration Examples for ASA 5510 and Higher Interfaces
This section includes the following topics:
•

Physical Interface Parameters Example, page 6-33

•

Subinterface Parameters Example, page 6-33

•

Multiple Context Mode Example, page 6-34

•

EtherChannel Example, page 6-34

Physical Interface Parameters Example
The following example configures parameters for the physical interface in single mode:
interface gigabitethernet 0/1
speed 1000
duplex full
no shutdown

Subinterface Parameters Example
The following example configures parameters for a subinterface in single mode:

Cisco ASA 5500 Series Configuration Guide using the CLI

6-33

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Where to Go Next

interface gigabitethernet 0/1.1
vlan 101
no shutdown

Multiple Context Mode Example
The following example configures interface parameters in multiple context mode for the system
configuration, and allocates the gigabitethernet 0/1.1 subinterface to contextA:
interface gigabitethernet 0/1
speed 1000
duplex full
no shutdown
interface gigabitethernet 0/1.1
vlan 101
context contextA
allocate-interface gigabitethernet 0/1.1

EtherChannel Example
The following example configures three interfaces as part of an EtherChannel. It also sets the system
priority to be a higher priority, and GigabitEthernet 0/2 to be a higher priority than the other interfaces
in case more than eight interfaces are assigned to the EtherChannel.
lacp system-priority 1234
interface GigabitEthernet0/0
channel-group 1 mode active
interface GigabitEthernet0/1
channel-group 1 mode active
interface GigabitEthernet0/2
lacp port-priority 1234
channel-group 1 mode passive
interface Port-channel1
lacp max-bundle 4
port-channel min-bundle 2
port-channel load-balance dst-ip

Where to Go Next
•

For multiple context mode:
a. Assign interfaces to contexts and automatically assign unique MAC addresses to context

interfaces. See Chapter 5, “Configuring Multiple Context Mode.”
b. Complete the interface configuration according to Chapter 8, “Completing Interface

Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”
•

For single context mode, complete the interface configuration according to Chapter 8, “Completing
Interface Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

Cisco ASA 5500 Series Configuration Guide using the CLI

6-34

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)
Feature History for ASA 5510 and Higher Interfaces

Feature History for ASA 5510 and Higher Interfaces
Table 6-3 lists the release history for this feature.
Table 6-3

Feature History for Interfaces

Feature Name

Releases

Feature Information

Increased VLANs

7.0(5)

Increased the following limits:
•

ASA5510 Base license VLANs from 0 to 10.

•

ASA5510 Security Plus license VLANs from 10 to 25.

•

ASA5520 VLANs from 25 to 100.

•

ASA5540 VLANs from 100 to 200.

Increased interfaces for the Base license on the 7.2(2)
ASA 5510

For the Base license on the ASA 5510, the maximum
number of interfaces was increased from 3 plus a
management interface to unlimited interfaces.

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).

Gigabit Ethernet Support for the ASA 5510
Security Plus License

7.2(3)

The ASA 5510 ASA now supports GE (Gigabit Ethernet)
for port 0 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 access lists.
This feature is also supported on the ASA 5585-X.
We introduced the following command: jumbo-frame
reservation.

Increased VLANs for the ASA 5580

8.1(2)

The number of VLANs supported on the ASA 5580 are
increased from 100 to 250.

Cisco ASA 5500 Series Configuration Guide using the CLI

6-35

Chapter 6

Starting Interface Configuration (ASA 5510 and Higher)

Feature History for ASA 5510 and Higher Interfaces

Table 6-3

Feature History for Interfaces (continued)

Feature Name

Releases

Feature Information

Support for Pause Frames for Flow Control on
the ASA 5580 10-Gigabit Ethernet Interfaces

8.2(2)

You can now enable pause (XOFF) frames for flow control.
This feature is also supported on the ASA 5585-X.
We introduced the following command: flowcontrol.

Support for Pause Frames for Flow Control on
1-Gigabit Ethernet Interfaces

8.2(5)/8.4(2)

You can now enable pause (XOFF) frames for flow control
for 1-Gigabit interfaces on all models.
We modified the following command: flowcontrol.

EtherChannel support

8.4(1)

You can configure up to 48 802.3ad EtherChannels of eight
active interfaces each.
We introduced the following commands: channel-group,
lacp port-priority, interface port-channel, lacp
max-bundle, port-channel min-bundle, port-channel
load-balance, lacp system-priority, clear lacp counters,
show lacp, show port-channel.
Note

Cisco ASA 5500 Series Configuration Guide using the CLI

6-36

EtherChannel is not supported on the ASA 5505.

CH A P T E R

7

Starting Interface Configuration (ASA 5505)
This chapter includes tasks for starting your interface configuration for the ASA 5505, including creating
VLAN interfaces and assigning them to switch ports.
For ASA 5510 and higher configuration, see the “Feature History for ASA 5505 Interfaces” section on
page 7-13.
This chapter includes the following sections:
•

Information About ASA 5505 Interfaces, page 7-1

•

Licensing Requirements for ASA 5505 Interfaces, page 7-4

•

Guidelines and Limitations, page 7-5

•

Default Settings, page 7-5

•

Starting ASA 5505 Interface Configuration, page 7-6

•

Monitoring Interfaces, page 7-11

•

Configuration Examples for ASA 5505 Interfaces, page 7-11

•

Where to Go Next, page 7-13

•

Feature History for ASA 5505 Interfaces, page 7-13

Information About ASA 5505 Interfaces
This section describes the ports and interfaces of the ASA 5505 and includes the following topics:
•

Understanding ASA 5505 Ports and Interfaces, page 7-2

•

Maximum Active VLAN Interfaces for Your License, page 7-2

•

VLAN MAC Addresses, page 7-4

•

Power over Ethernet, page 7-4

•

Monitoring Traffic Using SPAN, page 7-4

•

Auto-MDI/MDIX Feature, page 7-4

Cisco ASA 5500 Series Configuration Guide using the CLI

7-1

Chapter 7

Starting Interface Configuration (ASA 5505)

Information About ASA 5505 Interfaces

Understanding ASA 5505 Ports and Interfaces
The ASA 5505 supports a built-in switch. There are two kinds of ports and interfaces that you need to
configure:
•

Physical switch ports—The ASA has 8 Fast Ethernet switch ports that forward traffic at Layer 2,
using the switching function in hardware. Two of these ports are PoE ports. See the “Power over
Ethernet” section on page 7-4 for more information. You can connect these interfaces directly to
user equipment such as PCs, IP phones, or a DSL modem. Or you can connect to another switch.

•

Logical VLAN interfaces—In routed mode, these interfaces forward traffic between VLAN
networks at Layer 3, using the configured security policy to apply firewall and VPN services. In
transparent mode, these interfaces forward traffic between the VLANs on the same network at Layer
2, using the configured security policy to apply firewall services. See the “Maximum Active VLAN
Interfaces for Your License” section for more information about the maximum VLAN interfaces.
VLAN interfaces let you divide your equipment into separate VLANs, for example, home, business,
and Internet VLANs.

To segregate the switch ports into separate VLANs, you assign each switch port to a VLAN interface.
Switch ports on the same VLAN can communicate with each other using hardware switching. But when
a switch port on VLAN 1 wants to communicate with a switch port on VLAN 2, then the ASA applies
the security policy to the traffic and routes or bridges between the two VLANs.

Maximum Active VLAN Interfaces for Your License
In routed mode, you can configure the following VLANs depending on your license:
•

Base license—3 active VLANs. The third VLAN can only be configured to initiate traffic to one
other VLAN. See Figure 7-1 for more information.

•

Security Plus license—20 active VLANs.

In transparent firewall mode, you can configure the following VLANs depending on your license:

Note

•

Base license—2 active VLANs in 1 bridge group.

•

Security Plus license—3 active VLANs: 2 active VLANs in 1 bridge group, and 1 active VLAN for
the failover link.

An active VLAN is a VLAN with a nameif command configured.

Cisco ASA 5500 Series Configuration Guide using the CLI

7-2

Starting Interface Configuration (ASA 5505)
Information About ASA 5505 Interfaces

With the Base license in routed mode, the third VLAN can only be configured to initiate traffic to one
other VLAN. See Figure 7-1 for an example network where the Home VLAN can communicate with the
Internet, but cannot initiate contact with Business.
Figure 7-1

ASA 5505 with Base License

Internet

ASA 5505
with Base License

Home

153364

Business

With the Security Plus license, you can configure 20 VLAN interfaces in routed mode, including a
VLAN interface for failover and a VLAN interface as a backup link to your ISP. You can configure the
backup interface to not pass through traffic unless the route through the primary interface fails. You can
configure trunk ports to accommodate multiple VLANs per port.

Note

The ASA 5505 supports Active/Standby failover, but not Stateful Failover.
See Figure 7-2 for an example network.
Figure 7-2

ASA 5505 with Security Plus License

Backup ISP

Primary ISP

ASA 5505
with Security Plus
License

Failover
ASA 5505

DMZ

Failover Link

Inside

153365

Chapter 7

Cisco ASA 5500 Series Configuration Guide using the CLI

7-3

Chapter 7

Starting Interface Configuration (ASA 5505)

Licensing Requirements for ASA 5505 Interfaces

VLAN MAC Addresses
•

Routed firewall mode—All VLAN interfaces share a MAC address. Ensure that any connected
switches can support this scenario. If the connected switches require unique MAC addresses, you
can manually assign MAC addresses. See the “Configuring the MAC Address and MTU” section on
page 8-9.

•

Transparent firewall mode—Each VLAN has a unique MAC address. You can override the generated
MAC addresses if desired by manually assigning MAC addresses. See the “Configuring the MAC
Address and MTU” section on page 9-12.

Power over Ethernet
Ethernet 0/6 and Ethernet 0/7 support PoE for devices such as IP phones or wireless access points. If you
install a non-PoE device or do not connect to these switch ports, the ASA does not supply power to the
switch ports.
If you shut down the switch port using the shutdown command, you disable power to the device. Power
is restored when you enable the port using the no shutdown command. See the “Configuring and
Enabling Switch Ports as Access Ports” section on page 7-7 for more information about shutting down
a switch port.
To view the status of PoE switch ports, including the type of device connected (Cisco or IEEE 802.3af),
use the show power inline command.

Monitoring Traffic Using SPAN
If you want to monitor traffic that enters or exits one or more switch ports, you can enable SPAN, also
known as switch port monitoring. The port for which you enable SPAN (called the destination port)
receives a copy of every packet transmitted or received on a specified source port. The SPAN feature lets
you attach a sniffer to the destination port so you can monitor all traffic; without SPAN, you would have
to attach a sniffer to every port you want to monitor. You can only enable SPAN for one destination port.
See the switchport monitor command in the command reference for more information.

Auto-MDI/MDIX Feature
All ASA 5505 interfaces include 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. You cannot disable Auto-MDI/MDIX.

Licensing Requirements for ASA 5505 Interfaces

Cisco ASA 5500 Series Configuration Guide using the CLI

7-4

Chapter 7

Starting Interface Configuration (ASA 5505)
Guidelines and Limitations

Model

License Requirement

ASA 5505

VLANs:
Base License: 3 (2 regular zones and 1 restricted zone that can only communicate with 1 other
zone)
Security Plus License: 20
VLAN Trunks:
Base License: None.
Security Plus License: 8.
Interfaces of all types1:
Base License: 52.
Security Plus License: 120.

1. The maximum number of combined interfaces; for example, VLANs, physical, redundant, and bridge group interfaces.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

The ASA 5505 does not support multiple context mode.
Firewall Mode Guidelines
•

In transparent mode, you can configure up to eight bridge groups. Note that you must use at least
one bridge group; data interfaces must belong to a bridge group.

•

Each bridge group can include up to four VLAN interfaces, up to the license limit.

Default Settings
This section lists default settings for interfaces if you do not have a factory default configuration. For
information about the factory default configurations, see the “Factory Default Configurations” section
on page 2-10.
Default State of Interfaces

Interfaces have the following default states:
•

Switch ports—Disabled.

•

VLANs—Enabled. However, for traffic to pass through the VLAN, the switch port must also be
enabled.

Default Speed and Duplex

By default, the speed and duplex are set to auto-negotiate.

Cisco ASA 5500 Series Configuration Guide using the CLI

7-5

Chapter 7

Starting Interface Configuration (ASA 5505)

Starting ASA 5505 Interface Configuration

Starting ASA 5505 Interface Configuration
This section includes the following topics:
•

Task Flow for Starting Interface Configuration, page 7-6

•

Configuring VLAN Interfaces, page 7-6

•

Configuring and Enabling Switch Ports as Access Ports, page 7-7

•

Configuring and Enabling Switch Ports as Trunk Ports, page 7-9

Task Flow for Starting Interface Configuration
To configure interfaces in single mode, perform the following steps:
Step 1

Configure VLAN interfaces. See the “Configuring VLAN Interfaces” section on page 7-6.

Step 2

Configure and enable switch ports as access ports. See the “Configuring and Enabling Switch Ports as
Access Ports” section on page 7-7.

Step 3

(Optional for Security Plus licenses) Configure and enable switch ports as trunk ports. See the
“Configuring and Enabling Switch Ports as Trunk Ports” section on page 7-9.

Step 4

Complete the interface configuration according to Chapter 8, “Completing Interface Configuration
(Routed Mode),” or Chapter 9, “Completing Interface Configuration (Transparent Mode).”

Configuring VLAN Interfaces
This section describes how to configure VLAN interfaces. For more information about ASA 5505
interfaces, see the “Information About ASA 5505 Interfaces” section on page 7-1.

Guidelines
We suggest that you finalize your interface configuration before you enable Easy VPN.

Cisco ASA 5500 Series Configuration Guide using the CLI

7-6

Chapter 7

Starting Interface Configuration (ASA 5505)
Starting ASA 5505 Interface Configuration

Detailed Steps

Step 1

Command

Purpose

interface vlan number

Adds a VLAN interface, where the number is between 1 and 4090.

Example:
hostname(config)# interface vlan 100

Step 2

(Optional for the Base license)
no forward interface vlan number

To remove this VLAN interface and all associated configuration,
enter the no interface vlan command. Because this interface also
includes the interface name configuration, and the name is used in
other commands, those commands are also removed.
Allows this interface to be the third VLAN by limiting it from
initiating contact to one other VLAN.
The number specifies the VLAN ID to which this VLAN interface
cannot initiate traffic.

Example:
hostname(config-if)# no forward interface
vlan 101

With the Base license, you can only configure a third VLAN if
you use this command to limit it.
For example, you have one VLAN assigned to the outside for
Internet access, one VLAN assigned to an inside business
network, and a third VLAN assigned to your home network. The
home network does not need to access the business network, so
you can use the no forward interface command on the home
VLAN; the business network can access the home network, but
the home network cannot access the business network.
If you already have two VLAN interfaces configured with a
nameif command, be sure to enter the no forward interface
command before the nameif command on the third interface; the
ASA does not allow three fully functioning VLAN interfaces with
the Base license on the ASA 5505.
Note

If you upgrade to the Security Plus license, you can
remove this command and achieve full functionality for
this interface. If you leave this command in place, this
interface continues to be limited even after upgrading.

What to Do Next
Configure the switch ports. See the “Configuring and Enabling Switch Ports as Access Ports” section on
page 7-7 and the “Configuring and Enabling Switch Ports as Trunk Ports” section on page 7-9.

Configuring and Enabling Switch Ports as Access Ports
By default (with no configuration), all switch ports are shut down, and assigned to VLAN 1. To assign
a switch port to a single VLAN, configure it as an access port. To create a trunk port to carry multiple
VLANs, see the “Configuring and Enabling Switch Ports as Trunk Ports” section on page 7-9. If you
have a factory default configuration, see the “ASA 5505 Default Configuration” section on page 2-11 to
check if you want to change the default interface settings according to this procedure.
For more information about ASA 5505 interfaces, see the “Information About ASA 5505 Interfaces”
section on page 7-1.

Cisco ASA 5500 Series Configuration Guide using the CLI

7-7

Chapter 7

Starting Interface Configuration (ASA 5505)

Starting ASA 5505 Interface Configuration

Caution

The ASA 5505 does not support Spanning Tree Protocol for loop detection in the network. Therefore
you must ensure that any connection with the ASA does not end up in a network loop.

Detailed Steps

Step 1

Command

Purpose

interface ethernet0/port

Specifies the switch port you want to configure, where port is 0
through 7.

Example:
hostname(config)# interface ethernet0/1

Step 2

switchport access vlan number

Example:
hostname(config-if)# switchport access
vlan 100

Assigns this switch port to a VLAN, where number is the VLAN
ID, between 1 and 4090. See the “Configuring VLAN Interfaces”
section on page 7-6 to configure the VLAN interface that you
want to assign to this switch port. To view configured VLANs,
enter the show interface command.
Note

Step 3

(Optional)
switchport protected

Example:
hostname(config-if)# switchport protected

Step 4

(Optional)
speed {auto | 10 | 100}

Example:

You might assign multiple switch ports to the primary or
backup VLANs if the Internet access device includes
Layer 2 redundancy.

Prevents the switch port from communicating with other
protected switch ports on the same VLAN.
You might want to prevent switch ports from communicating with
each other if the devices on those switch ports are primarily
accessed from other VLANs, you do not need to allow
intra-VLAN access, and you want to isolate the devices from each
other in case of infection or other security breach. For example, if
you have a DMZ that hosts three web servers, you can isolate the
web servers from each other if you apply the switchport
protected command to each switch port. The inside and outside
networks can both communicate with all three web servers, and
vice versa, but the web servers cannot communicate with each
other.
Sets the speed. The auto setting is the default. If you set the speed
to anything other than auto on PoE ports Ethernet 0/6 or 0/7, then
Cisco IP phones and Cisco wireless access points that do not
support IEEE 802.3af will not be detected and supplied with
power.

hostname(config-if)# speed 100

Step 5

(Optional)
duplex {auto | full | half}

Example:

Sets the duplex. The auto setting is the default. If you set the
duplex to anything other than auto on PoE ports Ethernet 0/6 or
0/7, then Cisco IP phones and Cisco wireless access points that do
not support IEEE 802.3af will not be detected and supplied with
power.

hostname(config-if)# duplex full

Step 6

no shutdown

Example:
hostname(config-if)# no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

7-8

Enables the switch port. To disable the switch port, enter the
shutdown command.

Chapter 7

Starting Interface Configuration (ASA 5505)
Starting ASA 5505 Interface Configuration

What to Do Next
•

If you want to configure a switch port as a trunk port, see the “Configuring and Enabling Switch
Ports as Trunk Ports” section on page 7-9.

•

To complete the interface configuration, see Chapter 8, “Completing Interface Configuration
(Routed Mode),” or Chapter 9, “Completing Interface Configuration (Transparent Mode).”

Configuring and Enabling Switch Ports as Trunk Ports
This procedure describes how to create a trunk port that can carry multiple VLANs using 802.1Q
tagging. Trunk mode is available only with the Security Plus license.
To create an access port, where an interface is assigned to only one VLAN, see the “Configuring and
Enabling Switch Ports as Access Ports” section on page 7-7.

Guidelines
This switch port cannot pass traffic until you assign at least one VLAN to it, native or non-native.

Detailed Steps

Step 1

Command

Purpose

interface ethernet0/port

Specifies the switch port you want to configure, where port is 0
through 7.

Example:
hostname(config)# interface ethernet0/1

Step 2

To assign VLANs to this trunk, do one or more of the following:
switchport trunk allowed vlan vlan_range

Example:
hostname(config)# switchport trunk allowed
vlan 100-200

Identifies one or more VLANs that you can assign to the trunk
port, where the vlan_range (with VLANs between 1 and 4090)
can be identified in one of the following ways:
•

A single number (n)

•

A range (n-x)

•

Separate numbers and ranges by commas, for example:
5,7-10,13,45-100
You can enter spaces instead of commas, but the command is
saved to the configuration with commas.

You can include the native VLAN in this command, but it is not
required; the native VLAN is passed whether it is included in this
command or not.

Cisco ASA 5500 Series Configuration Guide using the CLI

7-9

Chapter 7

Starting Interface Configuration (ASA 5505)

Starting ASA 5505 Interface Configuration

Command

Purpose

switchport trunk native vlan vlan_id

Assigns a native VLAN to the trunk, where the vlan_id is a single
VLAN ID between 1 and 4090.

Example:

Packets on the native VLAN are not modified when sent over the
trunk. For example, if a port has VLANs 2, 3 and 4 assigned to it,
and VLAN 2 is the native VLAN, then packets on VLAN 2 that
egress the port are not modified with an 802.1Q header. Frames
which ingress (enter) this port and have no 802.1Q header are put
into VLAN 2.

hostname(config-if)# switchport trunk
native vlan 100

Each port can only have one native VLAN, but every port can have
either the same or a different native VLAN.
Step 3

switchport mode trunk

Makes this switch port a trunk port. To restore this port to access
mode, enter the switchport mode access command.

Example:
hostname(config-if)# switchport mode trunk

Step 4

(Optional)
switchport protected

Example:
hostname(config-if)# switchport protected

Step 5

(Optional)
speed {auto | 10 | 100}

Example:

Prevents the switch port from communicating with other
protected switch ports on the same VLAN.
You might want to prevent switch ports from communicating with
each other if the devices on those switch ports are primarily
accessed from other VLANs, you do not need to allow
intra-VLAN access, and you want to isolate the devices from each
other in case of infection or other security breach. For example, if
you have a DMZ that hosts three web servers, you can isolate the
web servers from each other if you apply the switchport
protected command to each switch port. The inside and outside
networks can both communicate with all three web servers, and
vice versa, but the web servers cannot communicate with each
other.
Sets the speed. The auto setting is the default. If you set the speed
to anything other than auto on PoE ports Ethernet 0/6 or 0/7, then
Cisco IP phones and Cisco wireless access points that do not
support IEEE 802.3af will not be detected and supplied with
power.

hostname(config-if)# speed 100

Step 6

(Optional)
duplex {auto | full | half}

Example:

Sets the duplex. The auto setting is the default. If you set the
duplex to anything other than auto on PoE ports Ethernet 0/6 or
0/7, then Cisco IP phones and Cisco wireless access points that do
not support IEEE 802.3af will not be detected and supplied with
power.

hostname(config-if)# duplex full

Step 7

no shutdown

Example:
hostname(config-if)# no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

7-10

Enables the switch port. To disable the switch port, enter the
shutdown command.

Chapter 7

Starting Interface Configuration (ASA 5505)
Monitoring Interfaces

Monitoring Interfaces
To monitor interfaces, enter one of the following commands:
Command

Purpose

show interface

Displays interface statistics.

show interface ip brief

Displays interface IP addresses and status.

Configuration Examples for ASA 5505 Interfaces
This section includes the following topics:
•

Access Port Example, page 7-11

•

Trunk Port Example, page 7-12

Access Port Example
The following example configures five VLAN interfaces, including the failover interface which is
configured using the failover lan command:
hostname(config)# interface vlan 100
hostname(config-if)# nameif outside
hostname(config-if)# security-level 0
hostname(config-if)# ip address 10.1.1.1 255.255.255.0
hostname(config-if)# no shutdown
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 200
nameif inside
security-level 100
ip address 10.2.1.1 255.255.255.0
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 300
nameif dmz
security-level 50
ip address 10.3.1.1 255.255.255.0
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 400
nameif backup-isp
security-level 50
ip address 10.1.2.1 255.255.255.0
no shutdown

hostname(config-if)# failover lan faillink vlan500
hostname(config)# failover interface ip faillink 10.4.1.1 255.255.255.0 standby 10.4.1.2
255.255.255.0
hostname(config)# interface ethernet 0/0
hostname(config-if)# switchport access vlan 100
hostname(config-if)# no shutdown
hostname(config-if)# interface ethernet 0/1
hostname(config-if)# switchport access vlan 200

Cisco ASA 5500 Series Configuration Guide using the CLI

7-11

Chapter 7

Starting Interface Configuration (ASA 5505)

Configuration Examples for ASA 5505 Interfaces

hostname(config-if)# no shutdown
hostname(config-if)# interface ethernet 0/2
hostname(config-if)# switchport access vlan 300
hostname(config-if)# no shutdown
hostname(config-if)# interface ethernet 0/3
hostname(config-if)# switchport access vlan 400
hostname(config-if)# no shutdown
hostname(config-if)# interface ethernet 0/4
hostname(config-if)# switchport access vlan 500
hostname(config-if)# no shutdown

Trunk Port Example
The following example configures seven VLAN interfaces, including the failover interface which is
configured using the failover lan command. VLANs 200, 201, and 202 are trunked on Ethernet 0/1.
hostname(config)# interface vlan 100
hostname(config-if)# nameif outside
hostname(config-if)# security-level 0
hostname(config-if)# ip address 10.1.1.1 255.255.255.0
hostname(config-if)# no shutdown
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 200
nameif inside
security-level 100
ip address 10.2.1.1 255.255.255.0
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 201
nameif dept1
security-level 90
ip address 10.2.2.1 255.255.255.0
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 202
nameif dept2
security-level 90
ip address 10.2.3.1 255.255.255.0
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 300
nameif dmz
security-level 50
ip address 10.3.1.1 255.255.255.0
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 400
nameif backup-isp
security-level 50
ip address 10.1.2.1 255.255.255.0
no shutdown

hostname(config-if)# failover lan faillink vlan500
hostname(config)# failover interface ip faillink 10.4.1.1 255.255.255.0 standby 10.4.1.2
255.255.255.0
hostname(config)# interface ethernet 0/0
hostname(config-if)# switchport access vlan 100

Cisco ASA 5500 Series Configuration Guide using the CLI

7-12

Chapter 7

Starting Interface Configuration (ASA 5505)
Where to Go Next

hostname(config-if)# no shutdown
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface ethernet 0/1
switchport mode trunk
switchport trunk allowed vlan 200-202
switchport trunk native vlan 5
no shutdown

hostname(config-if)# interface ethernet 0/2
hostname(config-if)# switchport access vlan 300
hostname(config-if)# no shutdown
hostname(config-if)# interface ethernet 0/3
hostname(config-if)# switchport access vlan 400
hostname(config-if)# no shutdown
hostname(config-if)# interface ethernet 0/4
hostname(config-if)# switchport access vlan 500
hostname(config-if)# no shutdown

Where to Go Next
Complete the interface configuration according to Chapter 8, “Completing Interface Configuration
(Routed Mode),” or Chapter 9, “Completing Interface Configuration (Transparent Mode).”

Feature History for ASA 5505 Interfaces
Table 7-1 lists the release history for this feature.
Table 7-1

Feature History for Interfaces

Feature Name

Releases

Feature Information

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.

Native VLAN support for the ASA 5505

7.2(4)/8.0(4)

You can now include the native VLAN in an ASA 5505
trunk port.
We introduced the following command: switchport trunk
native vlan.

Cisco ASA 5500 Series Configuration Guide using the CLI

7-13

Chapter 7
Feature History for ASA 5505 Interfaces

Cisco ASA 5500 Series Configuration Guide using the CLI

7-14

Starting Interface Configuration (ASA 5505)

CH A P T E R

8

Completing Interface Configuration
(Routed Mode)
This chapter includes tasks to complete the interface configuration for all models in routed firewall
mode. This chapter includes the following sections:

Note

•

Information About Completing Interface Configuration in Routed Mode, page 8-1

•

Licensing Requirements for Completing Interface Configuration in Routed Mode, page 8-2

•

Guidelines and Limitations, page 8-5

•

Default Settings, page 8-5

•

Completing Interface Configuration in Routed Mode, page 8-5

•

Monitoring Interfaces, page 8-16

•

Configuration Examples for Interfaces in Routed Mode, page 8-16

•

Feature History for Interfaces in Routed Mode, page 8-17

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.

Information About Completing Interface Configuration in Routed
Mode
This section includes the following topics:
•

Security Levels, page 8-1

•

Dual IP Stack (IPv4 and IPv6), page 8-2

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. See the “Allowing Same Security Level Communication”
section on page 8-15 for more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-1

Chapter 8

Completing Interface Configuration (Routed Mode)

Licensing Requirements for Completing Interface Configuration in Routed Mode

The level controls the following behavior:
•

Network access—By default, there is an implicit permit from a higher security interface to a lower
security interface (outbound). Hosts on the higher security interface can access any host on a lower
security interface. You can limit access by applying an access list to the interface.
If you enable communication for same security interfaces (see the “Allowing Same Security Level
Communication” section on page 8-15), there is an implicit permit for interfaces to access other
interfaces on the same security level or lower.

•

Inspection engines—Some application inspection engines are dependent on the security level. For
same security interfaces, inspection engines apply to traffic in either direction.
– NetBIOS inspection engine—Applied only for outbound connections.
– SQL*Net inspection engine—If a control connection for the SQL*Net (formerly OraServ) port

exists between a pair of hosts, then only an inbound data connection is permitted through the
ASA.
•

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.

Dual IP Stack (IPv4 and IPv6)
The ASA supports the configuration of both IPv6 and IPv4 on an interface. You do not need to enter any
special commands to do so; simply enter the IPv4 configuration commands and IPv6 configuration
commands as you normally would. Make sure you configure a default route for both IPv4 and IPv6.

Licensing Requirements for Completing Interface Configuration
in Routed Mode

Cisco ASA 5500 Series Configuration Guide using the CLI

8-2

Chapter 8

Completing Interface Configuration (Routed Mode)
Licensing Requirements for Completing Interface Configuration in Routed Mode

Model

License Requirement

ASA 5505

VLANs:
Base License: 3 (2 regular zones and 1 restricted zone that can only communicate with 1 other
zone)
Security Plus License: 20
VLAN Trunks:
Base License: None.
Security Plus License: 8.
Interfaces of all types1:
Base License: 52.
Security Plus License: 120.

1. The maximum number of combined interfaces; for example, VLANs, physical, redundant, and bridge group interfaces.

Model

License Requirement

ASA 5510

VLANs:
Base License: 50
Security Plus License: 100
Interface Speed:
Base License—All interfaces Fast Ethernet.
Security Plus License—Ethernet 0/0 and 0/1: Gigabit Ethernet; all others Fast Ethernet.
Interfaces of all types1:
Base License: 52
Security Plus License: 120

ASA 5520

VLANs:
Base License: 150.
Interfaces of all types1:
Base License: 640

ASA 5540

VLANs:
Base License: 200
Interfaces of all types1:
Base License: 840

ASA 5550

VLANs:
Base License: 400
Interfaces of all types1:
Base License: 1640

Cisco ASA 5500 Series Configuration Guide using the CLI

8-3

Chapter 8

Completing Interface Configuration (Routed Mode)

Licensing Requirements for Completing Interface Configuration in Routed Mode

Model

License Requirement

ASA 5580

VLANs:
Base License: 1024
Interfaces of all types1:
Base License: 4176

ASA 5512-X

VLANs:
Base License: 50
Interfaces of all types1:
Base License: 328

ASA 5515-X

VLANs:
Base License: 100
Interfaces of all types1:
Base License: 528

ASA 5525-X

VLANs:
Base License: 200
Interfaces of all types1:
Base License: 928

ASA 5545-X

VLANs:
Base License: 300
Interfaces of all types1:
Base License: 1328

ASA 5555-X

VLANs:
Base License: 500
Interfaces of all types1:
Base License: 2128

ASA 5585-X

VLANs:
Base License: 1024
Interface Speed for SSP-10 and SSP-20:
Base License—1-Gigabit Ethernet for fiber interfaces
10 GE I/O License—10-Gigabit Ethernet for fiber interfaces
(SSP-40 and SSP-60 support 10-Gigabit Ethernet by default.)
Interfaces of all types1:
Base License: 4176

1. The maximum number of combined interfaces; for example, VLANs, physical, redundant, bridge group, and EtherChannel interfaces.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-4

Chapter 8

Completing Interface Configuration (Routed Mode)
Guidelines and Limitations

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
•

For the ASA 5510 and higher in multiple context mode, configure the physical interfaces in the
system execution space according to Chapter 6, “Starting Interface Configuration
(ASA 5510 and Higher).” Then, configure the logical interface parameters in the context execution
space according to this chapter.
The ASA 5505 does not support multiple context mode.

•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

•

PPPoE is not supported in multiple context mode.

Firewall Mode Guidelines

Supported in routed firewall mode. For transparent mode, see Chapter 9, “Completing Interface
Configuration (Transparent Mode).”
Failover Guidelines

Do not finish configuring failover interfaces with the procedures in this chapter. See the “Configuring
Active/Standby Failover” section on page 62-7 or the “Configuring Active/Active Failover” section on
page 63-8 to configure the failover and state links. In multiple context mode, failover interfaces are
configured in the system configuration.
IPv6 Guidelines

Supports IPv6.

Default Settings
This section lists default settings for interfaces if you do not have a factory default configuration. For
information about the factory default configurations, see the “Factory Default Configurations” section
on page 2-10.
Default Security Level

The default security level is 0. If you name an interface “inside” and you do not set the security level
explicitly, then the ASA sets the security level to 100.

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.

Completing Interface Configuration in Routed Mode
This section includes the following topics:

Cisco ASA 5500 Series Configuration Guide using the CLI

8-5

Chapter 8

Completing Interface Configuration (Routed Mode)

Completing Interface Configuration in Routed Mode

•

Task Flow for Completing Interface Configuration, page 8-6

•

Configuring General Interface Parameters, page 8-6

•

Configuring the MAC Address and MTU, page 8-9

•

Configuring IPv6 Addressing, page 8-11

•

Allowing Same Security Level Communication, page 8-15

Task Flow for Completing Interface Configuration
Step 1

Set up your interfaces depending on your model:
•

ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”

•

ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”

Step 2

(Multiple context mode) Allocate interfaces to the context according to the “Configuring Multiple
Contexts” section on page 5-14.

Step 3

(Multiple context mode) Enter the changeto context name command to change to the context you want
to configure. Configure general interface parameters, including the interface name, security level, and
IPv4 address. See the “Configuring General Interface Parameters” section on page 8-6.

Step 4

(Optional) Configure the MAC address and the MTU. See the “Configuring the MAC Address and
MTU” section on page 8-9.

Step 5

(Optional) Configure IPv6 addressing. See the “Configuring IPv6 Addressing” section on page 8-11.

Step 6

(Optional) Allow same security level communication, either by allowing communication between two
interfaces or by allowing traffic to enter and exit the same interface. See the “Allowing Same Security
Level Communication” section on page 8-15.

Configuring General Interface Parameters
This procedure describes how to set the name, security level, IPv4 address and other options.
For the ASA 5510 and higher, you must configure interface parameters for the following interface types:
•

Physical interfaces

•

VLAN subinterfaces

•

Redundant interfaces

•

EtherChannel interfaces

For the ASA 5505, you must configure interface parameters for the following interface types:
•

VLAN interfaces

Guidelines and Limitations
•

For the ASA 5550, for maximum throughput, be sure to balance your traffic over the two interface
slots; for example, assign the inside interface to slot 1 and the outside interface to slot 0.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-6

Chapter 8

Completing Interface Configuration (Routed Mode)
Completing Interface Configuration in Routed Mode

•

If you are using failover, do not use this procedure to name interfaces that you are reserving for
failover and Stateful Failover communications. See the “Configuring Active/Standby Failover”
section on page 62-7 or the “Configuring Active/Active Failover” section on page 63-8 to configure
the failover and state links.

•

PPPoE is not supported in multiple context mode.

•

Set up your interfaces depending on your model:

Restrictions

Prerequisites

– ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”
– ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”
•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

•

In multiple context mode, complete this procedure in the context execution space. To change from
the system to a context configuration, enter the changeto context name command.

Detailed Steps

Step 1

Command

Purpose

For the ASA 5510 and higher:

If you are not already in interface configuration mode, enters
interface configuration mode.

interface {{redundant number |
port-channel number |
physical_interface}[.subinterface] |
mapped_name}

For the ASA 5505:
hostname(config)# interface vlan number

Example:
hostname(config)# interface
gigabithethernet 0/0

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.
See the “Enabling the Physical Interface and Configuring
Ethernet Parameters” section for a description of the physical
interface ID.
Append the subinterface ID to the physical or redundant interface
ID separated by a period (.).
In multiple context mode, enter the mapped_name if one was
assigned using the allocate-interface command.

Step 2

nameif name

Example:
hostname(config-if)# nameif inside

Step 3

Names the interface.
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.

Do one of the following:

Cisco ASA 5500 Series Configuration Guide using the CLI

8-7

Chapter 8

Completing Interface Configuration (Routed Mode)

Completing Interface Configuration in Routed Mode

Command

Purpose

ip address ip_address [mask] [standby
ip_address]

Sets the IP address manually.
Note

Example:
hostname(config-if)# ip address 10.1.1.1
255.255.255.0 standby 10.1.1.2

For use with failover, you must set the IP address and
standby address manually; DHCP and PPPoE are 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. See the
“Configuring Active/Standby Failover” section on page 62-7 or
the “Configuring Active/Active Failover” section on page 63-8
for more information.

ip address dhcp [setroute]

Obtains an IP address from a DHCP server.

Example:

The setroute keyword lets the ASA use the default route supplied
by the DHCP server.

hostname(config-if)# ip address dhcp

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.

To obtain an IP address from a PPPoE server, see PPPoE is not supported in multiple context mode.
Chapter 72, “Configuring the PPPoE Client.”
Step 4

security-level number

Example:

Sets the security level, where number is an integer between 0
(lowest) and 100 (highest). See the “Security Levels” section on
page 8-1.

hostname(config-if)# security-level 50

Step 5

(Optional)
management-only

Example:
hostname(config-if)# management-only

Sets an interface to management-only mode so that it does not
pass through traffic.
By default, Management interfaces are configured as
management-only. To disable this setting, enter the no
management-only command.
(ASA 5512-X through ASA 5555-X) You cannot disable
management-only on the Management 0/0 interface.
The management-only command is not supported for a
redundant interface.

Example
The following example configures parameters for VLAN 101:
hostname(config)# interface vlan 101
hostname(config-if)# nameif inside
hostname(config-if)# security-level 100
hostname(config-if)# ip address 10.1.1.1 255.255.255.0

The following example configures parameters in multiple context mode for the context configuration.
The interface ID is a mapped name.
hostname/contextA(config)# interface int1

Cisco ASA 5500 Series Configuration Guide using the CLI

8-8

Chapter 8

Completing Interface Configuration (Routed Mode)
Completing Interface Configuration in Routed Mode

hostname/contextA(config-if)# nameif outside
hostname/contextA(config-if)# security-level 100
hostname/contextA(config-if)# ip address 10.1.2.1 255.255.255.0

What to Do Next
•

(Optional) Configure the MAC address and the MTU. See the “Configuring the MAC Address and
MTU” section on page 8-9.

•

(Optional) Configure IPv6 addressing. See the “Configuring IPv6 Addressing” section on
page 8-11.

Configuring the MAC Address and MTU
This section describes how to configure MAC addresses for interfaces and how to set the MTU.

Information About MAC Addresses
By default, the physical interface uses the burned-in MAC address, and all subinterfaces of a physical
interface use the same burned-in MAC address.
A redundant interface uses the MAC address of the first physical interface that you add. If you change
the order of the member interfaces in the configuration, then the MAC address changes to match the
MAC address of the interface that is now listed first. If you assign a MAC address to the redundant
interface using this command, then it is used regardless of the member interface MAC addresses.
For an EtherChannel, all interfaces that are part of the channel group share the same MAC address. This
feature makes the EtherChannel transparent to network applications and users, because they only see the
one logical connection; they have no knowledge of the individual links. The port-channel interface uses
the lowest 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. See the “How the ASA Classifies Packets” section on page 5-3 for more information. You
can assign each MAC address manually, or you can automatically generate MAC addresses for shared
interfaces in contexts. See the “Automatically Assigning MAC Addresses to Context Interfaces” section
on page 5-22 to automatically generate MAC addresses. If you automatically generate MAC addresses,
you can use this procedure to override the generated address.
For single context mode, or for interfaces that are not shared in multiple context mode, you might want
to assign unique MAC addresses to subinterfaces. For example, your service provider might perform
access control based on the MAC address.

Information About the MTU
The MTU is the maximum datagram size that is sent on a connection. Data that is larger than the MTU
value is fragmented before being sent.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-9

Chapter 8

Completing Interface Configuration (Routed Mode)

Completing Interface Configuration in Routed Mode

The ASA supports IP path MTU discovery (as defined in RFC 1191), which allows a host to dynamically
discover and cope with the differences in the maximum allowable MTU size of the various links along
the path. Sometimes, the ASA cannot forward a datagram because the packet is larger than the MTU that
you set for the interface, but the “don't fragment” (DF) bit is set. The network software sends a message
to the sending host, alerting it to the problem. The host has to fragment packets for the destination so
that they fit the smallest packet size of all the links along the path.
The default MTU is 1500 bytes in a block for Ethernet interfaces. This value is sufficient for most
applications, but you can pick a lower number if network conditions require it.
To enable jumbo frames, see the “Enabling Jumbo Frame Support (Supported Models)” section on
page 6-32. 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. Jumbo frames require extra memory to process,
and assigning more memory for jumbo frames might limit the maximum use of other features, such as
access lists. To use jumbo frames, set the value higher, for example, to 9000 bytes.

Prerequisites
•

Set up your interfaces depending on your model:
– ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”
– ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”

•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

•

In multiple context mode, complete this procedure in the context execution space. To change from
the system to a context configuration, enter the changeto context name command.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-10

Chapter 8

Completing Interface Configuration (Routed Mode)
Completing Interface Configuration in Routed Mode

Detailed Steps

Step 1

Command

Purpose

For the ASA 5510 and higher:

If you are not already in interface configuration mode, enters
interface configuration mode.

interface {{redundant number |
port-channel number |
physical_interface}[.subinterface] |
mapped_name}

For the ASA 5505:
hostname(config)# interface vlan number

Example:
hostname(config)# interface vlan 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.
See the “Enabling the Physical Interface and Configuring
Ethernet Parameters” section for a description of the physical
interface ID.
Append the subinterface ID to the physical or redundant interface
ID separated by a period (.).
In multiple context mode, enter the mapped_name if one was
assigned using the allocate-interface command.

Step 2

mac-address mac_address
[standby mac_address]

Example:
hostname(config-if)# mac-address
000C.F142.4CDE

Assigns a private MAC address to this interface. 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.

Step 3

mtu interface_name bytes

Sets the MTU between 300 and 65,535 bytes. The default is 1500
bytes.

Example:

Note

hostname(config)# mtu inside 9200

When you set the MTU for a redundant or port-channel
interface, the ASA applies the setting to all member
interfaces.

For models that support jumbo frames, if you enter a value for any
interface that is greater than 1500, then you need to enable jumbo
frame support. See the “Enabling Jumbo Frame Support
(Supported Models)” section on page 6-32.

What to Do Next
(Optional) Configure IPv6 addressing. See the “Configuring IPv6 Addressing” section on page 8-11.

Configuring IPv6 Addressing
This section describes how to configure IPv6 addressing. For more information about IPv6, see the
“Information About IPv6 Support” section on page 21-9 and the “IPv6 Addresses” section on page B-5.
This section includes the following topics:

Cisco ASA 5500 Series Configuration Guide using the CLI

8-11

Chapter 8

Completing Interface Configuration (Routed Mode)

Completing Interface Configuration in Routed Mode

•

Information About IPv6, page 8-12

•

Configuring a Global IPv6 Address and Other Options, page 8-13

Information About IPv6
This section includes information about how to configure IPv6, and includes the following topics:
•

IPv6 Addressing, page 8-12

•

Duplicate Address Detection, page 8-12

•

Modified EUI-64 Interface IDs, page 8-13

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.

•

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.

At a minimum, you need to configure a link-local addresses 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.

Duplicate Address Detection
During the stateless autoconfiguration process, duplicate address detection (DAD) verifies the
uniqueness of new unicast IPv6 addresses before the addresses are assigned to interfaces (the new
addresses remain in a tentative state while duplicate address detection is performed). Duplicate address
detection is performed first on the new link-local address. When the link-local address is verified as
unique, then duplicate address detection is performed all the other IPv6 unicast addresses on the
interface.
Duplicate address detection is suspended on interfaces that are administratively down. While an
interface is administratively down, the unicast IPv6 addresses assigned to the interface are set to a
pending state. An interface returning to an administratively up state restarts duplicate address detection
for all of the unicast IPv6 addresses on the interface.
When a duplicate address is identified, the state of the address is set to DUPLICATE, the address is not
used, and the following error message is generated:
%ASA-4-325002: Duplicate address ipv6_address/MAC_address on interface

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. However,
all configuration commands associated with the duplicate address remain as configured while the state
of the address is set to DUPLICATE.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-12

Chapter 8

Completing Interface Configuration (Routed Mode)
Completing Interface Configuration in Routed Mode

If the link-local address for an interface changes, duplicate address detection is performed on the new
link-local address and all of the other IPv6 address associated with the interface are regenerated
(duplicate address detection is performed only on the new link-local address).
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.

Modified EUI-64 Interface IDs
RFC 3513: Internet Protocol Version 6 (IPv6) Addressing Architecture requires that the interface
identifier portion of all unicast IPv6 addresses, except those that start with binary value 000, be 64 bits
long and be constructed in Modified EUI-64 format. The ASA can enforce this requirement for hosts
attached to the local link.
When this feature is enabled on an interface, the source addresses of IPv6 packets received on that
interface are verified against the source MAC addresses to ensure that the interface identifiers use the
Modified EUI-64 format. If the IPv6 packets do not use the Modified EUI-64 format for the interface
identifier, the packets are dropped and the following system log message is generated:
%ASA-3-325003: EUI-64 source address check failed.

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 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.

Configuring a Global IPv6 Address and Other Options
To configure a global IPv6 address and other options, perform the following steps.

Note

Configuring the global address automatically configures the link-local address, so you do not need to
configure it separately.

Restrictions
The ASA does not support IPv6 anycast addresses.

Prerequisites
•

Set up your interfaces depending on your model:
– ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”
– ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”

•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

•

In multiple context mode, complete this procedure in the context execution space. To change from
the system to a context configuration, enter the changeto context name command.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-13

Chapter 8

Completing Interface Configuration (Routed Mode)

Completing Interface Configuration in Routed Mode

Detailed Steps

Step 1

Command

Purpose

For the ASA 5510 and higher:

If you are not already in interface configuration mode, enters
interface configuration mode.

interface {{redundant number |
port-channel number |
physical_interface}[.subinterface] |
mapped_name}

For the ASA 5505:
hostname(config)# interface vlan number

Example:
hostname(config)# interface
gigabithethernet 0/0

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.
See the “Enabling the Physical Interface and Configuring
Ethernet Parameters” section for a description of the physical
interface ID.
Append the subinterface ID to the physical or redundant interface
ID separated by a period (.).
In multiple context mode, enter the mapped_name if one was
assigned using the allocate-interface command.

Step 2

Do one of the following:
ipv6 address autoconfig

Example:
hostname(config-if)# ipv6 address
autoconfig

Enables stateless autoconfiguration on the interface. Enabling
stateless autoconfiguration on the interface configures IPv6
addresses based on prefixes received in Router Advertisement
messages. A link-local address, based on the Modified EUI-64
interface ID, is automatically generated for the interface when
stateless autoconfiguration is enabled.
Note

Although RFC 4862 specifies that hosts configured for
stateless autoconfiguration do not send Router
Advertisement messages, the ASA does send Router
Advertisement messages in this case. See the ipv6 nd
suppress-ra command to suppress messages.

ipv6 address ipv6-address/prefix-length
[standby ipv6-address]

Assigns a global address to the interface. When you assign a
global address, the link-local address is automatically created for
the interface.

Example:

standby specifies the interface address used by the secondary unit
or failover group in a failover pair.

hostname(config-if)# ipv6 address
2001:0DB8::BA98:0:3210/48

See the “IPv6 Addresses” section on page B-5 for more
information about IPv6 addressing.
ipv6 address ipv6-prefix/prefix-length
eui-64

Example:
hostname(config-if)# ipv6 address
2001:0DB8::BA98::/48 eui-64

Assigns 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. When you
assign a global address, the link-local address is automatically
created for the interface.
You do not need to specify the standby address; the interface ID
will be generated automatically.
See the “IPv6 Addresses” section on page B-5 for more
information about IPv6 addressing.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-14

Chapter 8

Completing Interface Configuration (Routed Mode)
Completing Interface Configuration in Routed Mode

Step 3

Command

Purpose

(Optional)

Suppresses Router Advertisement messages on an interface. By
default, Router Advertisement messages are automatically sent in
response to router solicitation messages. You may want to disable
these messages on any interface for which you do not want the
ASA to supply the IPv6 prefix (for example, the outside
interface).

ipv6 nd suppress-ra

Example:
hostname(config-if)# ipv6 nd suppress-ra

Step 4

(Optional)
ipv6 nd dad attempts value

Example:
hostname(config-if)# ipv6 nd dad attempts
3

Step 5

(Optional)
ipv6 nd ns-interval value

Example:
hostname(config-if)# ipv6 nd ns-interval
2000

Changes the number of duplicate address detection attempts. The
value argument can be any value from 0 to 600. Setting the value
argument to 0 disables duplicate address detection on the
interface.
By default, the number of times an interface performs duplicate
address detection is 1. See the “Duplicate Address Detection”
section on page 8-12 for more information.
Changes the neighbor solicitation message interval. When you
configure an interface to send out more than one duplicate address
detection attempt with the ipv6 nd dad attempts command, this
command configures the interval at which the neighbor
solicitation messages are sent out. By default, they are sent out
once every 1000 milliseconds. The value argument can be from
1000 to 3600000 milliseconds.
Note

Step 6

(Optional)
ipv6 enforce-eui64 if_name

Example:
hostname(config)# ipv6 enforce-eui64
inside

Changing this value changes it for all neighbor
solicitation messages sent out on the interface, not just
those used for duplicate address detection.

Enforces the use of Modified EUI-64 format interface identifiers
in IPv6 addresses on a local link.
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.
See the “Modified EUI-64 Interface IDs” section on page 8-13 for
more information.

Allowing Same Security Level Communication
By default, interfaces on the same security level cannot communicate with each other, and packets
cannot enter and exit the same interface. This section describes how to enable inter-interface
communication when interfaces are on the same security level, and how to enable intra-interface
communication.

Information About 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 access lists.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-15

Chapter 8

Completing Interface Configuration (Routed Mode)

Monitoring Interfaces

If you enable same security interface communication, you can still configure interfaces at different
security levels as usual.

Information About Intra-Interface Communication
Intra-interface communication might be useful for VPN traffic that enters an interface, but is then routed
out the same interface. The VPN traffic might be unencrypted in this case, or it might be reencrypted for
another VPN connection. For example, if you have a hub and spoke VPN network, where the ASA is the
hub, and remote VPN networks are spokes, for one spoke to communicate with another spoke, traffic
must go into the ASA and then out again to the other spoke.

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.

Detailed Steps

Command

Purpose

same-security-traffic permit
inter-interface

Enables interfaces on the same security level so that they can communicate
with each other.

same-security-traffic permit
intra-interface

Enables communication between hosts connected to the same interface.

Monitoring Interfaces
To monitor interfaces, enter one of the following commands:
Command

Purpose

show interface

Displays interface statistics.

show interface ip brief

Displays interface IP addresses and status.

Configuration Examples for Interfaces in Routed Mode
This section includes the following topics:
•

ASA 5505 Example, page 8-16

ASA 5505 Example
The following example configures three VLAN interfaces for the Base license. The third home interface
cannot forward traffic to the business interface.
hostname(config)# interface vlan 100

Cisco ASA 5500 Series Configuration Guide using the CLI

8-16

Chapter 8

Completing Interface Configuration (Routed Mode)
Feature History for Interfaces in Routed Mode

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

nameif outside
security-level 0
ip address dhcp
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 200
nameif business
security-level 100
ip address 10.1.1.1 255.255.255.0
no shutdown

hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 300
no forward interface vlan 200
nameif home
security-level 50
ip address 10.2.1.1 255.255.255.0
no shutdown

Feature History for Interfaces in Routed Mode
Table 8-1 lists the release history for this feature.
Table 8-1

Feature History for Interfaces

Feature Name

Releases

Feature Information

Increased VLANs

7.0(5)

Increased the following limits:

Increased VLANs

7.2(2)

•

ASA5510 Base license VLANs from 0 to 10.

•

ASA5510 Security Plus license VLANs from 10 to 25.

•

ASA5520 VLANs from 25 to 100.

•

ASA5540 VLANs from 100 to 200.

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).

Cisco ASA 5500 Series Configuration Guide using the CLI

8-17

Chapter 8

Completing Interface Configuration (Routed Mode)

Feature History for Interfaces in Routed Mode

Table 8-1

Feature History for Interfaces (continued)

Feature Name

Releases

Feature Information

Gigabit Ethernet Support for the ASA 5510
Security Plus License

7.2(3)

The ASA 5510 now supports GE (Gigabit Ethernet) for port
0 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.

Native VLAN support for the ASA 5505

7.2(4)/8.0(4)

You can now include the native VLAN in an ASA 5505
trunk port.
We introduced the following command: switchport trunk
native vlan.

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 access lists.
We introduced the following command: jumbo-frame
reservation.

Increased VLANs for the ASA 5580

8.1(2)

The number of VLANs supported on the ASA 5580 are
increased from 100 to 250.

IPv6 support for transparent mode

8.2(1)

IPv6 support was introduced for transparent firewall mode.

Support for Pause Frames for Flow Control on
the ASA 5580 10 Gigabit Ethernet Interfaces

8.2(2)

You can now enable pause (XOFF) frames for flow control.

Cisco ASA 5500 Series Configuration Guide using the CLI

8-18

We introduced the following command: flowcontrol.

CH A P T E R

9

Completing Interface Configuration
(Transparent Mode)
This chapter includes tasks to complete the interface configuration for all models in transparent firewall
mode.
This chapter includes the following sections:

Note

•

Information About Completing Interface Configuration in Transparent Mode, page 9-1

•

Licensing Requirements for Completing Interface Configuration in Transparent Mode, page 9-2

•

Guidelines and Limitations, page 9-5

•

Default Settings, page 9-6

•

Completing Interface Configuration in Transparent Mode, page 9-6

•

Monitoring Interfaces, page 9-19

•

Configuration Examples for Interfaces in Transparent Mode, page 9-19

•

Feature History for Interfaces in Transparent Mode, page 9-20

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.

Information About Completing Interface Configuration in
Transparent Mode
This section includes the following topics:
•

Bridge Groups in Transparent Mode, page 9-1

•

Security Levels, page 9-2

Bridge Groups in Transparent Mode
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; 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

Cisco ASA 5500 Series Configuration Guide using the CLI

9-1

Chapter 9

Completing Interface Configuration (Transparent Mode)

Licensing Requirements for Completing Interface Configuration in Transparent Mode

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. At least one bridge group is required per context or in single mode.
Each bridge group requires a management IP address. For another method of management, see the
“Management Interface” section.

Note

The ASA does not support traffic on secondary networks; only traffic on the same network as the
management IP address is supported.

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. See the “Allowing Same Security Level Communication”
section on page 9-18 for more information.
The level controls the following behavior:
•

Network access—By default, there is an implicit permit from a higher security interface to a lower
security interface (outbound). Hosts on the higher security interface can access any host on a lower
security interface. You can limit access by applying an access list to the interface.
If you enable communication for same security interfaces (see the “Allowing Same Security Level
Communication” section on page 9-18), there is an implicit permit for interfaces to access other
interfaces on the same security level or lower.

•

Inspection engines—Some application inspection engines are dependent on the security level. For
same security interfaces, inspection engines apply to traffic in either direction.
– NetBIOS inspection engine—Applied only for outbound connections.
– SQL*Net inspection engine—If a control connection for the SQL*Net (formerly OraServ) port

exists between a pair of hosts, then only an inbound data connection is permitted through the
ASA.
•

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.

Licensing Requirements for Completing Interface Configuration
in Transparent Mode

Cisco ASA 5500 Series Configuration Guide using the CLI

9-2

Chapter 9

Completing Interface Configuration (Transparent Mode)
Licensing Requirements for Completing Interface Configuration in Transparent Mode

Model

License Requirement

ASA 5505

VLANs:
Base License: 3 (2 regular zones and 1 restricted zone that can only communicate with 1 other
zone)
Security Plus License: 20
VLAN Trunks:
Base License: None.
Security Plus License: 8.
Interfaces of all types1:
Base License: 52.
Security Plus License: 120.

1. The maximum number of combined interfaces; for example, VLANs, physical, redundant, and bridge group interfaces.

Model

License Requirement

ASA 5510

VLANs:
Base License: 50
Security Plus License: 100
Interface Speed:
Base License—All interfaces Fast Ethernet.
Security Plus License—Ethernet 0/0 and 0/1: Gigabit Ethernet; all others Fast Ethernet.
Interfaces of all types1:
Base License: 52
Security Plus License: 120

ASA 5520

VLANs:
Base License: 150.
Interfaces of all types1:
Base License: 640

ASA 5540

VLANs:
Base License: 200
Interfaces of all types1:
Base License: 840

ASA 5550

VLANs:
Base License: 400
Interfaces of all types1:
Base License: 1640

Cisco ASA 5500 Series Configuration Guide using the CLI

9-3

Chapter 9

Completing Interface Configuration (Transparent Mode)

Licensing Requirements for Completing Interface Configuration in Transparent Mode

Model

License Requirement

ASA 5580

VLANs:
Base License: 1024
Interfaces of all types1:
Base License: 4176

ASA 5512-X

VLANs:
Base License: 50
Interfaces of all types1:
Base License: 328

ASA 5515-X

VLANs:
Base License: 100
Interfaces of all types1:
Base License: 528

ASA 5525-X

VLANs:
Base License: 200
Interfaces of all types1:
Base License: 928

ASA 5545-X

VLANs:
Base License: 300
Interfaces of all types1:
Base License: 1328

ASA 5555-X

VLANs:
Base License: 500
Interfaces of all types1:
Base License: 2128

ASA 5585-X

VLANs:
Base License: 1024
Interface Speed for SSP-10 and SSP-20:
Base License—1-Gigabit Ethernet for fiber interfaces
10 GE I/O License—10-Gigabit Ethernet for fiber interfaces
(SSP-40 and SSP-60 support 10-Gigabit Ethernet by default.)
Interfaces of all types1:
Base License: 4176

1. The maximum number of combined interfaces; for example, VLANs, physical, redundant, bridge group, and EtherChannel interfaces.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-4

Chapter 9

Completing Interface Configuration (Transparent Mode)
Guidelines and Limitations

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
•

For the ASA 5510 and higher in multiple context mode, configure the physical interfaces in the
system execution space according to Chapter 6, “Starting Interface Configuration
(ASA 5510 and Higher).” Then, configure the logical interface parameters in the context execution
space according to this chapter.
The ASA 5505 does not support multiple context mode.

•

You can only configure context interfaces that you already assigned to the context in the system
configuration using the allocate-interface command.

Firewall Mode Guidelines
•

You can configure up to 8 bridge groups in single mode or per context in multiple mode. Note that
you must use at least 1 bridge group; data interfaces must belong to a 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.

•

Each bridge group can include up to 4 interfaces.

•

For IPv4, a management IP address is required for each bridge group for both management traffic
and for traffic to pass through the ASA.
Unlike routed mode, which requires an IP address for each interface, a transparent firewall has an
IP address assigned to the entire bridge group. The ASA uses this IP address as the source address
for packets originating on the ASA, such as system messages or AAA communications. In addition
to the bridge group management address, you can optionally configure a management interface for
some models; see the “Management Interface” section on page 6-2 for more information.
The management IP address must be on the same subnet as the connected network. You cannot set
the subnet to a host subnet (255.255.255.255). The ASA does not support traffic on secondary
networks; only traffic on the same network as the management IP address is supported. See the
“Configuring Bridge Groups” section on page 9-7 for more information about management IP
subnets.

•

For IPv6, at a minimum you need to configure link-local addresses for each interface for through
traffic. For full functionality, including the ability to manage the ASA, you need to configure a
global IPv6 address for each bridge group.

•

For multiple context mode, each context must use different interfaces; you cannot share an interface
across contexts.

•

For multiple context mode, each context typically uses a different subnet. You can use overlapping
subnets, but your network topology requires router and NAT configuration to make it possible from
a routing standpoint.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-5

Chapter 9

Completing Interface Configuration (Transparent Mode)

Default Settings

Failover Guidelines

Do not finish configuring failover interfaces with the procedures in this chapter. See the “Configuring
Active/Standby Failover” section on page 62-7 or the “Configuring Active/Active Failover” section on
page 63-8 to configure the failover and state links. In multiple context mode, failover interfaces are
configured in the system configuration.
IPv6 Guidelines
•

Supports IPv6.

•

No support for IPv6 anycast addresses in transparent mode.

Default Settings
This section lists default settings for interfaces if you do not have a factory default configuration. For
information about the factory default configurations, see the “Factory Default Configurations” section
on page 2-10.
Default Security Level

The default security level is 0. If you name an interface “inside” and you do not set the security level
explicitly, then the ASA sets the security level to 100.

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.

Completing Interface Configuration in Transparent Mode
This section includes the following topics:
•

Task Flow for Completing Interface Configuration, page 9-6

•

Configuring Bridge Groups, page 9-7

•

Configuring General Interface Parameters, page 9-8

•

Configuring a Management Interface (ASA 5510 and Higher), page 9-11

•

Configuring the MAC Address and MTU, page 9-12

•

Configuring IPv6 Addressing, page 9-15

•

Allowing Same Security Level Communication, page 9-18

Task Flow for Completing Interface Configuration
Step 1

Set up your interfaces depending on your model:
•

ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”

•

ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”

Cisco ASA 5500 Series Configuration Guide using the CLI

9-6

Chapter 9

Completing Interface Configuration (Transparent Mode)
Completing Interface Configuration in Transparent Mode

Step 2

(Multiple context mode) Allocate interfaces to the context according to the “Configuring Multiple
Contexts” section on page 5-14.

Step 3

(Multiple context mode) Enter the changeto context name command to change to the context you want
to configure.Configure one or more bridge groups, including the IPv4 address. See the “Configuring
Bridge Groups” section on page 9-7.

Step 4

Configure general interface parameters, including the interface name and security level. See the
“Configuring General Interface Parameters” section on page 9-8.

Step 5

(Optional; not supported for the ASA 5505) Configure a management interface. See the “Configuring a
Management Interface (ASA 5510 and Higher)” section on page 9-11.

Step 6

(Optional) Configure the MAC address and the MTU. See the “Configuring the MAC Address and
MTU” section on page 9-12.

Step 7

(Optional) Configure IPv6 addressing. See the “Configuring IPv6 Addressing” section on page 9-15.

Step 8

(Optional) Allow same security level communication, either by allowing communication between two
interfaces or by allowing traffic to enter and exit the same interface. See the “Allowing Same Security
Level Communication” section on page 9-18.

Configuring Bridge Groups
Each bridge group requires a management IP address. 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 IPv4 traffic, the management IP address is required to pass any traffic.
For IPv6 traffic, you must, at a minimum, configure the link-local addresses to pass traffic, but a global
management address is recommended for full functionality, including remote management and other
management operations.

Guidelines and Limitations
You can configure up to 8 bridge groups in single mode or per context in multiple mode. Note that you
must use at least one bridge group; data interfaces must belong to a bridge group.

Note

For a separate management interface (for supported models), a non-configurable bridge group (ID 101)
is automatically added to your configuration. This bridge group is not included in the bridge group limit.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-7

Chapter 9

Completing Interface Configuration (Transparent Mode)

Completing Interface Configuration in Transparent Mode

Detailed Steps

Step 1

Command

Purpose

interface bvi bridge_group_number

Creates a bridge group, where bridge_group_number is an integer
between 1 and 100.

Example:
hostname(config)# interface bvi 1

Step 2

ip address ip_address [mask]
[standby ip_address]

Example:
hostname(config-if)# ip address 10.1.3.1
255.255.255.0 standby 10.1.3.2

Specifies the management IP address for the bridge group.
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 ASA does not support traffic on secondary networks; only
traffic on the same network as the management IP address is
supported.
The standby keyword and address is used for failover.

Examples
The following example sets the management address and standby address of bridge group 1:
hostname(config)# interface bvi 1
hostname(config-if)# ip address 10.1.3.1 255.255.255.0 standby 10.1.3.2

What to Do Next
Configure general interface parameters. See the “Configuring General Interface Parameters” section on
page 9-8.

Configuring General Interface Parameters
This procedure describes how to set the name, security level, and bridge group for each transparent
interface.
To configure a separate management interface, see the “Configuring a Management Interface (ASA 5510
and Higher)” section on page 9-11.
For the ASA 5510 and higher, you must configure interface parameters for the following interface types:
•

Physical interfaces

•

VLAN subinterfaces

•

Redundant interfaces

•

EtherChannel interfaces

Cisco ASA 5500 Series Configuration Guide using the CLI

9-8

Chapter 9

Completing Interface Configuration (Transparent Mode)
Completing Interface Configuration in Transparent Mode

For the ASA 5505, you must configure interface parameters for the following interface types:
•

VLAN interfaces

Guidelines and Limitations
•

You can configure up to four interfaces per bridge group.

•

For the ASA 5550, for maximum throughput, be sure to balance your traffic over the two interface
slots; for example, assign the inside interface to slot 1 and the outside interface to slot 0.

•

For information about security levels, see the “Security Levels” section on page 9-2.

•

If you are using failover, do not use this procedure to name interfaces that you are reserving for
failover and Stateful Failover communications. See the “Configuring Active/Standby Failover”
section on page 62-7 or the “Configuring Active/Active Failover” section on page 63-8 to configure
the failover and state links.

•

Set up your interfaces depending on your model:

Prerequisites

– ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”
– ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”
•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

•

In multiple context mode, complete this procedure in the context execution space. To change from
the system to a context configuration, enter the changeto context name command.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-9

Chapter 9

Completing Interface Configuration (Transparent Mode)

Completing Interface Configuration in Transparent Mode

Detailed Steps

Step 1

Command

Purpose

For the ASA 5510 and higher:

If you are not already in interface configuration mode, enters
interface configuration mode.

interface {{redundant number |
port-channel number |
physical_interface}[.subinterface] |
mapped_name}

For the ASA 5505:
hostname(config)# interface vlan number

Example:
hostname(config)# interface vlan 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.
See the “Enabling the Physical Interface and Configuring
Ethernet Parameters” section for a description of the physical
interface ID. Do not use this procedure for Management
interfaces; see the “Configuring a Management Interface (ASA
5510 and Higher)” section on page 9-11 to configure the
Management interface.
Append the subinterface ID to the physical or redundant interface
ID separated by a period (.).
In multiple context mode, enter the mapped_name if one was
assigned using the allocate-interface command.

Step 2

hostname(config-if)# bridge-group 1

Assigns the interface to a bridge group, 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.

nameif name

Names the interface.

bridge-group number

Example:
Step 3

Example:
hostname(config-if)# nameif inside

Step 4

security-level number

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.
Sets the security level, where number is an integer between 0
(lowest) and 100 (highest).

Example:
hostname(config-if)# security-level 50

What to Do Next
•

(Optional) Configure a management interface. See the “Configuring a Management Interface (ASA
5510 and Higher)” section on page 9-11.

•

(Optional) Configure the MAC address and the MTU. See the “Configuring the MAC Address and
MTU” section on page 9-12.

•

(Optional) Configure IPv6 addressing. See the “Configuring IPv6 Addressing” section on
page 9-15.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-10

Chapter 9

Completing Interface Configuration (Transparent Mode)
Completing Interface Configuration in Transparent Mode

Configuring a Management Interface (ASA 5510 and Higher)
You can configure one management interface separate from the bridge group interfaces in single mode
or per context. For more information, see the “Management Interface” section on page 6-2.

Restrictions
•

See the “Management Interface” section on page 6-2.

•

Do not assign this interface to a bridge group; a non-configurable bridge group (ID 101) is
automatically added to your configuration. This bridge group is not included in the bridge group
limit.

•

If your model does not include a Management interface, you must manage the transparent firewall
from a data interface; skip this procedure. (For example, on the ASA 5505.)

•

In multiple context mode, you cannot share any interfaces, including the Management interface,
across contexts. To provide management per context, you can create subinterfaces of the
Management interface and allocate a Management subinterface to each context. Note that the ASA
5512-X through ASA 5555-X do not allow subinterfaces on the Management interface, so for
per-context management, you must connect to a data interface.

•

Complete the procedures in Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”

•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

•

In multiple context mode, complete this procedure in the context execution space. To change from
the system to a context configuration, enter the changeto context name command.

Prerequisites

Detailed Steps

Step 1

Command

Purpose

interface {{port-channel number |
management slot/port}[.subinterface] |
mapped_name}

If you are not already in interface configuration mode, enters
interface configuration mode for the management interface.

Example:
hostname(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 also cannot 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.

Step 2

nameif name

Example:
hostname(config-if)# nameif management

Names the interface.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-11

Chapter 9

Completing Interface Configuration (Transparent Mode)

Completing Interface Configuration in Transparent Mode

Command
Step 3

Purpose

Do one of the following:
ip address ip_address [mask] [standby
ip_address]

Sets the IP address manually.
Note

For use with failover, you must set the IP address and
standby address manually; DHCP is not supported.

Example:
hostname(config-if)# ip address 10.1.1.1
255.255.255.0 standby 10.1.1.2

The ip_address and mask arguments set the interface IP address
and subnet mask.
The standby ip_address argument is used for failover. See the
“Configuring Active/Standby Failover” section on page 62-7 or
the “Configuring Active/Active Failover” section on page 63-8
for more information.

ip address dhcp [setroute]

Obtains an IP address from a DHCP server.

Example:

The setroute keyword lets the ASA use the default route supplied
by the DHCP server.

hostname(config-if)# ip address dhcp

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.

Step 4

security-level number

Sets the security level, where number is an integer between 0
(lowest) and 100 (highest).

Example:
hostname(config-if)# security-level 50

What to Do Next
•

(Optional) Configure the MAC address and the MTU. See the “Configuring the MAC Address and
MTU” section on page 9-12.

•

(Optional) Configure IPv6 addressing. See the “Configuring IPv6 Addressing” section on
page 9-15.

Configuring the MAC Address and MTU
This section describes how to configure MAC addresses for interfaces and how to set the MTU.

Information About MAC Addresses
By default, the physical interface uses the burned-in MAC address, and all subinterfaces of a physical
interface use the same burned-in MAC address.
A redundant interface uses the MAC address of the first physical interface that you add. If you change
the order of the member interfaces in the configuration, then the MAC address changes to match the
MAC address of the interface that is now listed first. If you assign a MAC address to the redundant
interface using this command, then it is used regardless of the member interface MAC addresses.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-12

Chapter 9

Completing Interface Configuration (Transparent Mode)
Completing Interface Configuration in Transparent Mode

For an EtherChannel, all interfaces that are part of the channel group share the same MAC address. This
feature makes the EtherChannel transparent to network applications and users, because they only see the
one logical connection; they have no knowledge of the individual links. The port-channel interface uses
the lowest 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. See the “How the ASA Classifies Packets” section on page 5-3 for more information. You
can assign each MAC address manually, or you can automatically generate MAC addresses for shared
interfaces in contexts. See the “Automatically Assigning MAC Addresses to Context Interfaces” section
on page 5-22 to automatically generate MAC addresses. If you automatically generate MAC addresses,
you can use this procedure to override the generated address.
For single context mode, or for interfaces that are not shared in multiple context mode, you might want
to assign unique MAC addresses to subinterfaces. For example, your service provider might perform
access control based on the MAC address.

Information About the MTU
The MTU is the maximum datagram size that is sent on a connection. Data that is larger than the MTU
value is fragmented before being sent.
The ASA supports IP path MTU discovery (as defined in RFC 1191), which allows a host to dynamically
discover and cope with the differences in the maximum allowable MTU size of the various links along
the path. Sometimes, the ASA cannot forward a datagram because the packet is larger than the MTU that
you set for the interface, but the “don't fragment” (DF) bit is set. The network software sends a message
to the sending host, alerting it to the problem. The host has to fragment packets for the destination so
that they fit the smallest packet size of all the links along the path.
The default MTU is 1500 bytes in a block for Ethernet interfaces. This value is sufficient for most
applications, but you can pick a lower number if network conditions require it.
To enable jumbo frames, see the “Enabling Jumbo Frame Support (Supported Models)” section on
page 6-32. 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. Jumbo frames require extra memory to process,
and assigning more memory for jumbo frames might limit the maximum use of other features, such as
access lists. To use jumbo frames, set the value higher, for example, to 9000 bytes.

Prerequisites
•

Set up your interfaces depending on your model:
– ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”
– ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”

•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-13

Chapter 9

Completing Interface Configuration (Transparent Mode)

Completing Interface Configuration in Transparent Mode

•

In multiple context mode, complete this procedure in the context execution space. To change from
the system to a context configuration, enter the changeto context name command.

Detailed Steps

Step 1

Command

Purpose

For the ASA 5510 and higher:

If you are not already in interface configuration mode, enters
interface configuration mode.

interface {{redundant number |
port-channel number |
physical_interface}[.subinterface] |
mapped_name}

For the ASA 5505:
hostname(config)# interface vlan number

Example:
hostname(config)# interface vlan 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.
See the “Enabling the Physical Interface and Configuring
Ethernet Parameters” section for a description of the physical
interface ID.
Append the subinterface ID to the physical or redundant interface
ID separated by a period (.).
In multiple context mode, enter the mapped_name if one was
assigned using the allocate-interface command.

Step 2

mac-address mac_address
[standby mac_address]

Example:
hostname(config-if)# mac-address
000C.F142.4CDE

Assigns a private MAC address to this interface. 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.

Step 3

mtu interface_name bytes

Sets the MTU between 300 and 65,535 bytes. The default is 1500
bytes.

Example:

Note

hostname(config)# mtu inside 9200

When you set the MTU for a redundant or port-channel
interface, the ASA applies the setting to all member
interfaces.

For models that support jumbo frames, if you enter a value for any
interface that is greater than 1500, then you need to enable jumbo
frame support. See the “Enabling Jumbo Frame Support
(Supported Models)” section on page 6-32.

What to Do Next
(Optional) Configure IPv6 addressing. See the “Configuring IPv6 Addressing” section on page 9-15.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-14

Chapter 9

Completing Interface Configuration (Transparent Mode)
Completing Interface Configuration in Transparent Mode

Configuring IPv6 Addressing
This section describes how to configure IPv6 addressing. For more information about IPv6, see the
“Information About IPv6 Support” section on page 21-9 and the “IPv6 Addresses” section on page B-5.
This section includes the following topics:
•

Information About IPv6, page 9-15

•

Configuring a Global IPv6 Address and Other Options, page 9-17

Information About IPv6
This section includes information about how to configure IPv6, and includes the following topics:
•

IPv6 Addressing, page 9-15

•

Duplicate Address Detection, page 9-15

•

Modified EUI-64 Interface IDs, page 9-16

•

Unsupported Commands, page 9-16

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. 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. 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 addresses is automatically configured on each 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.

Duplicate Address Detection
During the stateless autoconfiguration process, duplicate address detection (DAD) verifies the
uniqueness of new unicast IPv6 addresses before the addresses are assigned to interfaces (the new
addresses remain in a tentative state while duplicate address detection is performed). Duplicate address
detection is performed first on the new link-local address. When the link local address is verified as
unique, then duplicate address detection is performed all the other IPv6 unicast addresses on the
interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-15

Chapter 9

Completing Interface Configuration (Transparent Mode)

Completing Interface Configuration in Transparent Mode

Duplicate address detection is suspended on interfaces that are administratively down. While an
interface is administratively down, the unicast IPv6 addresses assigned to the interface are set to a
pending state. An interface returning to an administratively up state restarts duplicate address detection
for all of the unicast IPv6 addresses on the interface.
When a duplicate address is identified, the state of the address is set to DUPLICATE, the address is not
used, and the following error message is generated:
%ASA-4-325002: Duplicate address ipv6_address/MAC_address on interface

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. However,
all configuration commands associated with the duplicate address remain as configured while the state
of the address is set to DUPLICATE.
If the link-local address for an interface changes, duplicate address detection is performed on the new
link-local address and all of the other IPv6 address associated with the interface are regenerated
(duplicate address detection is performed only on the new link-local address).
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.

Modified EUI-64 Interface IDs
RFC 3513: Internet Protocol Version 6 (IPv6) Addressing Architecture requires that the interface
identifier portion of all unicast IPv6 addresses, except those that start with binary value 000, be 64 bits
long and be constructed in Modified EUI-64 format. The ASA can enforce this requirement for hosts
attached to the local link.
When this feature is enabled on an interface, the source addresses of IPv6 packets received on that
interface are verified against the source MAC addresses to ensure that the interface identifiers use the
Modified EUI-64 format. If the IPv6 packets do not use the Modified EUI-64 format for the interface
identifier, the packets are dropped and the following system log message is generated:
%ASA-3-325003: EUI-64 source address check failed.

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 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.

Unsupported Commands
The following IPv6 commands are not supported in transparent firewall mode, because they require
router capabilities:
•

ipv6 address autoconfig

•

ipv6 nd prefix

•

ipv6 nd ra-interval

•

ipv6 nd ra-lifetime

•

ipv6 nd suppress-ra

The ipv6 local pool VPN command is not supported, because transparent mode does not support VPN.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-16

Chapter 9

Completing Interface Configuration (Transparent Mode)
Completing Interface Configuration in Transparent Mode

Configuring a Global IPv6 Address and Other Options
To configure a global IPv6 address and other options for a bridge group or management interface,
perform the following steps.

Note

Configuring the global address automatically configures the link-local address, so you do not need to
configure it separately.

Restrictions
The ASA does not support IPv6 anycast addresses.

Prerequisites
•

Set up your interfaces depending on your model:
– ASA 5510 and higher—Chapter 6, “Starting Interface Configuration (ASA 5510 and Higher).”
– ASA 5505—Chapter 7, “Starting Interface Configuration (ASA 5505).”

•

In multiple context mode, you can only configure context interfaces that you already assigned to the
context in the system configuration according to the “Configuring Multiple Contexts” section on
page 5-14.

•

In multiple context mode, complete this procedure in the context execution space. To change from
the system to a context configuration, enter the changeto context name command.

Detailed Steps

Step 1

Command

Purpose

For the bridge group:

If you are not already in interface configuration mode, enters
interface configuration mode.

interface bvi bridge_group_id

For the management interface:
interface management_interface_id

Example:
hostname(config)# interface bvi 1

Step 2

ipv6 address ipv6-address/prefix-length
[standby ipv6-address]

Assigns a global address to the interface. When you assign a
global address, the link-local address is automatically created for
the interface (for a bridge group, for each member interface).

Example:

standby specifies the interface address used by the secondary unit
or failover group in a failover pair.

hostname(config-if)# ipv6 address
2001:0DB8::BA98:0:3210/48

Note

The eui-64 keyword to use the Modified EUI-64 interface
ID for the interface ID is not supported in transparent
mode.

See the “IPv6 Addresses” section on page B-5 for more
information about IPv6 addressing.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-17

Chapter 9

Completing Interface Configuration (Transparent Mode)

Completing Interface Configuration in Transparent Mode

Step 3

Command

Purpose

(Optional)

Suppresses Router Advertisement messages on an interface. By
default, Router Advertisement messages are automatically sent in
response to router solicitation messages. You may want to disable
these messages on any interface for which you do not want the
ASA to supply the IPv6 prefix (for example, the outside
interface).

ipv6 nd suppress-ra

Example:
hostname(config-if)# ipv6 nd suppress-ra

Step 4

(Optional)
ipv6 nd dad attempts value

Example:
hostname(config-if)# ipv6 nd dad attempts
3

Step 5

(Optional)
ipv6 nd ns-interval value

Example:
hostname(config-if)# ipv6 nd ns-interval
2000

Changes the number of duplicate address detection attempts. The
value argument can be any value from 0 to 600. Setting the value
argument to 0 disables duplicate address detection on the
interface.
By default, the number of times an interface performs duplicate
address detection is 1. See the “Duplicate Address Detection”
section on page 9-15 for more information.
Changes the neighbor solicitation message interval. When you
configure an interface to send out more than one duplicate address
detection attempt with the ipv6 nd dad attempts command, this
command configures the interval at which the neighbor
solicitation messages are sent out. By default, they are sent out
once every 1000 milliseconds. The value argument can be from
1000 to 3600000 milliseconds.
Note

Step 6

(Optional)
ipv6 enforce-eui64 if_name

Example:
hostname(config)# ipv6 enforce-eui64
inside

Changing this value changes it for all neighbor
solicitation messages sent out on the interface, not just
those used for duplicate address detection.

Enforces the use of Modified EUI-64 format interface identifiers
in IPv6 addresses on a local link.
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.
See the “Modified EUI-64 Interface IDs” section on page 9-16 for
more information.

Allowing Same Security Level Communication
By default, interfaces on the same security level cannot communicate with each other, and packets
cannot enter and exit the same interface. This section describes how to enable inter-interface
communication when interfaces are on the same security level.

Information About Inter-Interface Communication
Allowing interfaces on the same security level to communicate with each other is useful if you want
traffic to flow freely between all same security interfaces without access lists.
If you enable same security interface communication, you can still configure interfaces at different
security levels as usual.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-18

Chapter 9

Completing Interface Configuration (Transparent Mode)
Monitoring Interfaces

Detailed Steps

Command

Purpose

same-security-traffic permit
inter-interface

Enables interfaces on the same security level so that they can communicate
with each other.

Monitoring Interfaces
To monitor interfaces, enter one of the following commands:
Command

Purpose

show interface

Displays interface statistics.

show interface ip brief

Displays interface IP addresses and status.

show bridge-group

Shows bridge group information.

Configuration Examples for Interfaces in Transparent Mode
The following example includes two bridge groups of three interfaces each, plus a management-only
interface:
interface gigabitethernet 0/0
nameif inside1
security-level 100
bridge-group 1
no shutdown
interface gigabitethernet 0/1
nameif outside1
security-level 0
bridge-group 1
no shutdown
interface gigabitethernet 0/2
nameif dmz1
security-level 50
bridge-group 1
no shutdown
interface bvi 1
ip address 10.1.3.1 255.255.255.0 standby 10.1.3.2
interface gigabitethernet 1/0
nameif inside2
security-level 100
bridge-group 2
no shutdown
interface gigabitethernet 1/1
nameif outside2
security-level 0
bridge-group 2
no shutdown
interface gigabitethernet 1/2
nameif dmz2
security-level 50
bridge-group 2

Cisco ASA 5500 Series Configuration Guide using the CLI

9-19

Chapter 9

Completing Interface Configuration (Transparent Mode)

Feature History for Interfaces in Transparent Mode

no shutdown
interface bvi 2
ip address 10.3.5.8 255.255.255.0 standby 10.3.5.9
interface management 0/0
nameif mgmt
security-level 100
ip address 10.2.1.1 255.255.255.0 standby 10.2.1.2
no shutdown

Feature History for Interfaces in Transparent Mode
Table 9-1 lists each feature change and the platform release in which it was implemented.
Table 9-1

Feature History for Interfaces in Transparent Mode

Feature Name

Platform
Releases

Feature Information

Increased VLANs

7.0(5)

Increased the following limits:

Increased VLANs

7.2(2)

•

ASA5510 Base license VLANs from 0 to 10.

•

ASA5510 Security Plus license VLANs from 10 to 25.

•

ASA5520 VLANs from 25 to 100.

•

ASA5540 VLANs from 100 to 200.

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).

Gigabit Ethernet Support for the ASA 5510
Security Plus License

7.2(3)

Cisco ASA 5500 Series Configuration Guide using the CLI

9-20

The ASA 5510 now supports GE (Gigabit Ethernet) for port
0 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.

Chapter 9

Completing Interface Configuration (Transparent Mode)
Feature History for Interfaces in Transparent Mode

Table 9-1

Feature History for Interfaces in Transparent Mode (continued)

Feature Name

Platform
Releases

Native VLAN support for the ASA 5505

7.2(4)/8.0(4)

Feature Information
You can now include the native VLAN in an ASA 5505
trunk port.
We introduced the following command: switchport trunk
native vlan.

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 access lists.
We introduced the following command: jumbo-frame
reservation.

Increased VLANs for the ASA 5580

8.1(2)

The number of VLANs supported on the ASA 5580 are
increased from 100 to 250.

IPv6 support for transparent mode

8.2(1)

IPv6 support was introduced for transparent firewall mode.

Support for Pause Frames for Flow Control on
the ASA 5580 10-Gigabit Ethernet Interfaces

8.2(2)

You can now enable pause (XOFF) frames for flow control.

Bridge groups for transparent mode

8.4(1)

We introduced the following command: flowcontrol.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

9-21

Chapter 9
Feature History for Interfaces in Transparent Mode

Cisco ASA 5500 Series Configuration Guide using the CLI

9-22

Completing Interface Configuration (Transparent Mode)

PA R T

4

Configuring Basic Settings

CH A P T E R

10

Configuring Basic Settings
This chapter describes how to configure basic settings on your ASA that are typically required for a
functioning configuration. This chapter includes the following sections:
•

Configuring the Hostname, Domain Name, and Passwords, page 10-1

•

Setting the Date and Time, page 10-3

•

Configuring the Master Passphrase, page 10-6

•

Configuring the DNS Server, page 10-11

Configuring the Hostname, Domain Name, and Passwords
This section describes how to change the device name and passwords, and includes the following topics:
•

Changing the Login Password, page 10-1

•

Changing the Enable Password, page 10-2

•

Setting the Hostname, page 10-2

•

Setting the Domain Name, page 10-3

Changing the Login Password
To change the login password, enter the following command:
Command

Purpose

{passwd | password} password

Changes the login password. The login password is used for Telnet and
SSH connections. The default login password is “cisco.”
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. Use the no password
command to restore the password to the default setting.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-1

Chapter 10

Configuring Basic Settings

Configuring the Hostname, Domain Name, and Passwords

Changing the Enable Password
To change the enable password, enter the following command:
Command

Purpose

enable password password

Changes the enable password, which lets you enter privileged EXEC mode.
By default, the enable password is blank.

Example:

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.

hostname(config)# passwd Pa$$w0rd

This command changes the password for the highest privilege level. If you
configure local command authorization, you can set enable passwords for
each privilege level from 0 to 15.
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.

Setting the Hostname
To set the hostname, enter the following command:
Command

Purpose

hostname name

Specifies the hostname for the ASA or for a context.

Example:

This name can be up to 63 characters. A hostname must start and end with
a letter or digit, and have as interior characters only letters, digits, or a
hyphen.

hostname(config)# hostname farscape
farscape(config)#

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. The default hostname
depends on your platform.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-2

Chapter 10

Configuring Basic Settings
Setting the Date and Time

Setting the Domain Name
To set the domain name, enter the following command:
Command

Purpose

domain-name name

Specifies the domain name for the ASA.

Example:
hostname(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.”
The default domain name is default.domain.invalid.
For multiple context mode, you can set the domain name for each context,
as well as within the system execution space.

Setting the Date and Time
This section includes the following topics:
•

Setting the Time Zone and Daylight Saving Time Date Range, page 10-3

•

Setting the Date and Time Using an NTP Server, page 10-4

•

Setting the Date and Time Manually, page 10-6

Setting the Time Zone and Daylight Saving Time Date Range
To change the time zone and daylight saving time date range, perform the following steps:

Step 1

Command

Purpose

clock timezone zone
[-]hours [minutes]

Sets 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.

Example:

Where zone specifies the time zone as a string, for example, PST for Pacific Standard
Time.

hostname(config)# clock
timezone PST -8

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

To change the date range for daylight saving time from the default, enter one of the following commands. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-3

Chapter 10

Configuring Basic Settings

Setting the Date and Time

Command

Purpose

clock summer-time zone
date {day month | month
day} year hh:mm {day
month | month day} year
hh:mm [offset]

Sets 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.
The zone value specifies the time zone as a string, for example, PDT for Pacific
Daylight Time.

Example:

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.

hostname(config)# clock
summer-time PDT 1 April
2010 2:00 60

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.

clock summer-time zone
recurring [week weekday
month hh:mm week weekday
month hh:mm] [offset]

Specifies 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.

Example:

The zone value specifies the time zone as a string, for example, PDT for Pacific
Daylight Time.

hostname(config)# clock
summer-time PDT
recurring first Monday
April 2:00 60

This command enables you to set a recurring date range that you do not need to change
yearly.

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.

Setting the Date and Time Using an NTP Server
To obtain the date and time from an NTP server, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

ntp authenticate

Enables authentication with an NTP server.

Example:
hostname(config)# ntp
authenticate

Cisco ASA 5500 Series Configuration Guide using the CLI

10-4

Chapter 10

Configuring Basic Settings
Setting the Date and Time

Step 2

ntp trusted-key key_id

Specifies an authentication key ID to be a trusted key, which is required for
authentication with an NTP server.

Example:

The key_id argument is a value between 1 and 4294967295. You can enter
multiple trusted keys for use with multiple servers.

hostname(config)# ntp
trusted-key 1

Step 3

ntp authentication-key key_id
md5 key

Sets a key to authenticate with an NTP server.
The key_id argument is the ID you set in Step 2 using the ntp trusted-key
command, and the key argument is a string up to 32 characters long.

Example:
hostname(config)# ntp
authentication-key 1 md5
aNiceKey

Step 4

ntp server ip_address [key
key_id] [source interface_name]
[prefer]

Identifies an NTP server.

Example:

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.

hostname(config)# ntp server
10.1.1.1 key 1 prefer

The key_id argument is the ID you set in Step 2 using the ntp trusted-key
command.

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.
Note

In multiple context mode, set the time in the system configuration
only.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-5

Chapter 10

Configuring Basic Settings

Configuring the Master Passphrase

Setting the Date and Time Manually
To set the date and time manually, perform the following steps:

Detailed Steps

Command

Purpose

clock set hh:mm:ss {month day | day month}
year

Sets the date time manually.
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.

Example:
hostname# clock set 20:54:00 april 1 2004

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.

Configuring the Master Passphrase
This section describes how to configure the master passphrase and includes the following topics:
•

Information About the Master Passphrase, page 10-6

•

Licensing Requirements for the Master Passphrase, page 10-7

•

Guidelines and Limitations, page 10-7

•

Adding or Changing the Master Passphrase, page 10-7

•

Disabling the Master Passphrase, page 10-9

•

Recovering the Master Passphrase, page 10-10

•

Feature History for the Master Passphrase, page 10-11

Information About the Master Passphrase
The master passphrase feature allows you to securely store plain text passwords in encrypted format. The
master passphrase provides a key that is used to universally encrypt or mask all passwords, without
changing any functionality. Features that implement the master passphrase include the following:
•

OSPF

Cisco ASA 5500 Series Configuration Guide using the CLI

10-6

Chapter 10

Configuring Basic Settings
Configuring the Master Passphrase

•

EIGRP

•

VPN load balancing

•

VPN (remote access and site-to-site)

•

Failover

•

AAA servers

•

Logging

•

Shared licenses

Licensing Requirements for the Master Passphrase
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.

Adding or Changing the Master Passphrase
This section describes how to add or change the master passphrase.

Prerequisites
•

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.

•

This procedure will only be accepted in a secure session, for example by console, SSH, or ASDM
via HTTPS.

To add or change the master passphrase, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

10-7

Chapter 10

Configuring Basic Settings

Configuring the Master Passphrase

Detailed Steps

Step 1

Command

Purpose

key config-key password-encryption
[new_passphrase [old_passphrase]]

Sets the passphrase used for generating the encryption key. The
passphrase must be between 8 and 128 characters long. All
characters except a back space and double quotes are accepted
for the passphrase.

Example:
hostname(config)# key config-key
password-encryption
Old key: bumblebee
New key: haverford
Confirm key: haverford

If you do not enter the new passphrase in the command, you are
prompted for it.
When you want to change the passphrase, you also have to
enter the old passphrase.
See the “Examples” section on page 10-9 for examples of the
interactive prompts.
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 can use the no form of this command when
downgrading to a software version that does not support
password encryption.
Step 2

password encryption aes

Example:
hostname(config)# password encryption aes

Enables password encryption. As soon as password encryption
is turned on 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.
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

write memory

Example:
hostname(config)# write memory

Saves the runtime value of the master passphrase and the
resulting configuration. If you do not enter this command,
passwords in startup configuration may still be visible if they
were not saved with encryption before.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-8

Chapter 10

Configuring Basic Settings
Configuring the Master Passphrase

Examples
In the following configuration example, no previous key is present:
hostname (config)# key config-key password-encryption 12345678

In the following configuration example, a key already exists:
Hostname (config)# key config-key password-encryption 23456789
Old key: 12345678
hostname (config)#

In the following configuration example, you want to key in interactively, but a key already exists. The
Old key, New key, and Confirm key prompts will appear on your screen if you enter the key config-key
password-encryption command and press Enter to access interactive mode.
hostname (config)# key config-key password-encryption
Old key: 12345678
New key: 23456789
Confirm key: 23456789

In the following example, you want to key in interactively, but no key is present. The New key and
Confirm key prompts will appear on your screen if you are in interactive mode.
hostname (config)# key config-key password-encryption
New key: 12345678
Confirm key: 12345678

Disabling the Master Passphrase
Disabling the master passphrase reverts encrypted passwords into plain text passwords. Removing the
passphrase might be useful if you downgrade to a previous software version that does not support
encrypted passwords.

Prerequisites
•

You must know the current master passphrase to disable it. If you do not know the passphrase, see
the “Recovering the Master Passphrase” section on page 10-10.

•

This procedure will only be accepted in a secure session, that is, by Telnet, SSH, or ASDM via
HTTPS.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-9

Chapter 10

Configuring Basic Settings

Configuring the Master Passphrase

Detailed Steps

Step 1

Command

Purpose

no key config-key password-encryption
[old_passphrase]]

Removes the master passphrase.
If you do not enter the passphrase in the command, you are
prompted for it.

Example:
hostname(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.
Old key: bumblebee

Step 2

write memory

Example:
hostname(config)# write memory

Saves the run time value of the master passphrase and the
resulting configuration. 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 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.

Recovering the Master Passphrase
You cannot recover the master passphrase.
If the master passphrase is lost or unknown, you can remove it using the write erase command followed
by the reload command. These commands remove the master key and the configuration that includes the
encrypted passwords.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-10

Chapter 10

Configuring Basic Settings
Configuring the DNS Server

Feature History for the Master Passphrase
Table 10-1 lists each feature change and the platform release in which it was implemented.
Table 10-1

Feature History for the Master Passphrase

Feature Name

Platform
Releases

Feature Information

Master Passphrase

8.3(1)

This feature was introduced.
We introduced the following commands: key config-key
password-encryption, password encryption aes, clear
configure password encryption aes, show running-config
password encryption aes, show password encryption.

Password Encryption Visibility

8.4(1)

We modified the show password encryption command.

Configuring the DNS Server
Some ASA features require use of a DNS server to access external servers by domain name; for example,
the Botnet Traffic Filter feature requires a DNS server to access the dynamic database server and to
resolve entries in the static database. Other features, such as the ping or traceroute command, let you
enter a name that you want to ping or traceroute, and the ASA can resolve the name by communicating
with a DNS server. Many SSL VPN and certificate commands also support names.

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.
For information about dynamic DNS, see the “Configuring DDNS” section on page 12-2.

Prerequisites
Make sure that you configure the appropriate routing for any interface on which you enable DNS domain
lookup so you can reach the DNS server. See the “Information About Routing” section on page 21-1 for
more information about routing.

Detailed Steps

Step 1

Command

Purpose

dns domain-lookup interface_name

Enables the ASA to send DNS requests to a DNS server to perform a
name lookup for supported commands.

Example:
hostname(config)# dns domain-lookup
inside

Cisco ASA 5500 Series Configuration Guide using the CLI

10-11

Chapter 10

Configuring Basic Settings

Monitoring DNS Cache

Step 2

dns server-group DefaultDNS

Specifies the DNS server group that the ASA uses for outgoing
requests.

Example:

Other DNS server groups can be configured for VPN tunnel groups.
See the tunnel-group command in the command reference for more
information.

hostname(config)# dns server-group
DefaultDNS

Step 3

name-server ip_address [ip_address2]
[...] [ip_address6]

Example:

Specifies one or more DNS servers. You can 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.

hostname(config-dns-server-group)#
name-server 10.1.1.5 192.168.1.67
209.165.201.6

Monitoring DNS Cache
The ASA provides a local cache of DNS information from external DNS queries that are sent for certain
clientless SSL VPN and certificate commands. Each DNS translation request is first looked for in the
local cache. If the local cache has the information, the resulting IP address is returned. If the local cache
can not resolve the request, a DNS query is sent to the various DNS servers that have been configured.
If an external DNS server resolves the request, the resulting IP address is stored in the local cache with
its corresponding hostname.

DNS Cache Monitoring Commands
To monitor the DNS cache, enter the following command:
Command

Purpose

show dns-hosts

Show the DNS cache, which includes dynamically learned
entries from a DNS server as well as manually entered name
and IP addresses using the name command.

Feature History for DNS Cache
Table 2 lists each feature change and the platform release in which it was implemented.
Table 2

Feature History for DNS Cache

Feature Name

Platform
Releases

DNS Cache

7.0(1)

Feature Information
DNS cache stores responses that allow a DNS server to
respond more quickly to queries.
We introduced the following command: show dns host.

Cisco ASA 5500 Series Configuration Guide using the CLI

10-12

C H A P T E R

11

Configuring DHCP
This chapter describes how to configure the DHCP server and includes the following sections:
•

Information About DHCP, page 11-1

•

Licensing Requirements for DHCP, page 11-1

•

Guidelines and Limitations, page 11-2

•

Configuring a DHCP Server, page 11-2

•

Configuring DHCP Relay Services, page 11-7

•

DHCP Monitoring Commands, page 11-8

•

Feature History for DHCP, page 11-8

Information About DHCP
DHCP provides network configuration parameters, such as IP addresses, to DHCP clients. The ASA can
provide a DHCP server or DHCP relay services to DHCP clients attached to ASA interfaces. The DHCP
server provides network configuration parameters directly to DHCP clients. DHCP relay passes DHCP
requests received on one interface to an external DHCP server located behind a different interface.

Licensing Requirements for DHCP
Table 11-1 shows the licensing requirements for DHCP.
Table 11-1

Licensing Requirements

Model

License Requirement

All models

Base License.
For the ASA 5505, the maximum number of DHCP client addresses varies depending on the license:
•

If the limit is 10 hosts, the maximum available DHCP pool is 32 addresses.

•

If the limit is 50 hosts, the maximum available DHCP pool is 128 addresses.

•

If the number of hosts is unlimited, the maximum available DHCP pool is 256 addresses.

Cisco ASA 5500 Series Configuration Guide using the CLI

11-1

Chapter 11

Configuring DHCP

Guidelines and Limitations

Note

By default, the ASA 5505 ships with a 10-user license.

Guidelines and Limitations
Use the following guidelines to configure the DHCP server:
•

You can configure a DHCP server on each interface of the ASA. Each interface can have its own
pool of addresses to draw from. 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 services 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.

•

The ASA does not support QIP DHCP servers for use with DHCP proxy.

•

The relay agent cannot be enabled if the DHCP server is also enabled.

•

When it receives a DHCP request, the ASA sends a discovery message to the DHCP server. This
message includes the IP address (within a subnetwork) configured with the dhcp-network-scope
command in the group policy. If the server has an address pool that falls within that subnetwork, the
server sends the offer message with the pool information to the IP address—not to the source IP
address of the discovery message.

•

For example, if the server has a pool in the range of 209.165.200.225 to 209.165.200.254, mask
255.255.255.0, and the IP address specified by the dhcp-network-scope command is
209.165.200.1, the server sends that pool in the offer message to the ASA.

Failover Guidelines

Supports Active/Active and Active/Standby failover.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
Context Mode Guidelines

Supported in single mode and multiple context mode.

Configuring a DHCP Server
This section describes how to configure a DHCP server provided by the ASA and includes the following
topics:
•

Enabling the DHCP Server, page 11-3

•

Configuring DHCP Options, page 11-4

•

Using Cisco IP Phones with a DHCP Server, page 11-6

•

DHCP Monitoring Commands, page 11-8

Cisco ASA 5500 Series Configuration Guide using the CLI

11-2

Chapter 11

Configuring DHCP
Configuring a DHCP Server

Enabling the DHCP Server
The ASA can act as a DHCP server. DHCP is a protocol that provides network settings to hosts, including
the host IP address, the default gateway, and a DNS server.

Note

The ASA DHCP server does not support BOOTP requests. In multiple context mode, you cannot enable
the DHCP server or DHCP relay on an interface that is used by more than one context.
To enable the DHCP server on a ASA interface, perform the following steps:

Step 1

Command

Purpose

dhcpd address ip_address-ip_address
interface_name

Create a DHCP address pool. The ASA assigns a client one of the
addresses from this pool to use for a given length of time. These
addresses are the local, untranslated addresses for the directly
connected network.

Example:

Step 2

hostname(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.

dhcpd dns dns1 [dns2]

(Optional) Specifies the IP address(es) of the DNS server(s).

Example:
hostname(config)# dhcpd dns 209.165.201.2
209.165.202.129

Step 3

dhcpd wins wins1 [wins2]

(Optional) Specifies the IP address(es) of the WINS server(s).
You can specify up to two WINS servers.

Example:
hostname(config)# dhcpd wins 209.165.201.5

Step 4

hostname(config)# dhcpd lease 3000

(Optional) Change the lease length to be granted to the client.
This lease equals the amount of time (in seconds) the client can
use its allocated IP address before the lease expires. Enter a value
between 0 to 1,048,575. The default value is 3600 seconds.

dhcpd domain domain_name

(Optional) Configures the domain name.

dhcpd lease lease_length

Example:
Step 5

Example:
hostname(config)# dhcpd domain example.com

Step 6

dhcpd ping_timeout milliseconds

Example:
hostname(config)# dhcpd ping timeout 20

(Optional) Configures the DHCP ping timeout value. To avoid
address conflicts, the ASA sends two ICMP ping packets to an
address before assigning that address to a DHCP client. This
command specifies the timeout value for those packets.

Cisco ASA 5500 Series Configuration Guide using the CLI

11-3

Chapter 11

Configuring DHCP

Configuring a DHCP Server

Step 7

Command

Purpose

dhcpd option 3 ip gateway_ip

Defines 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 IP address of the management
interface. As a result, the DHCP ACK does not include this
option. The management interface does not route traffic.

Example:
hostname(config)# dhcpd option 3 ip
10.10.1.1

Step 8

Enables the DHCP daemon within the ASA to listen for DHCP
client requests on the enabled interface.

dhcpd enable interface_name

Example:
hostname(config)# dhcpd enable outside

Configuring DHCP Options
You can configure the ASA to send information for the DHCP options listed in RFC 2132. The DHCP
options include the following three categories:
•

Options that Return an IP Address, page 11-4

•

Options that Return a Text String, page 11-4

•

Options that Return a Hexadecimal Value, page 11-5

The ASA supports all three categories. To configure a DHCP option, choose one of the following
commands:

Options that Return an IP Address
Command

Purpose

dhcpd option code ip addr_1 [addr_2]

Configures a DHCP option that returns one or two IP addresses.

Example:
hostname(config)# dhcpd option 2 ip
10.10.1.1 10.10.1.2

Options that Return a Text String
Command

Purpose

dhcpd option code ascii text

Configures a DHCP option that returns a text string.

Example:
hostname(config)# dhcpd option 2 ascii
examplestring

Cisco ASA 5500 Series Configuration Guide using the CLI

11-4

Chapter 11

Configuring DHCP
Configuring a DHCP Server

Options that Return a Hexadecimal Value
Command

Purpose

dhcpd option code hex value

Configures a DHCP option that returns a hexadecimal value.

Example:
hostname(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 the option codes and their
associated types and expected values, see RFC 2132.
Table 11-2 shows the DHCP options that are not supported by the dhcpd option command.
Table 11-2

Unsupported DHCP Options

Option Code

Description

0

DHCPOPT_PAD

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

DHCP options 3, 66, and 150 are used to configure Cisco IP Phones. For more information about
configuring these options, see the “Using Cisco IP Phones with a DHCP Server” section on page 11-6.

Cisco ASA 5500 Series Configuration Guide using the CLI

11-5

Chapter 11

Configuring DHCP

Configuring a DHCP Server

Using Cisco IP Phones with a DHCP Server
Enterprises with small branch offices that implement a Cisco IP Telephony Voice over IP solution
typically implement Cisco CallManager at a central office to control Cisco IP Phones at small branch
offices. This implementation allows centralized call processing, reduces the equipment required, and
eliminates the administration of additional Cisco CallManager and other servers at branch offices.
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.

Note

•

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.

Cisco IP Phones might also include DHCP option 3 in their requests, which 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 configure the ASA to send information for most options listed in RFC 2132. The following
examples show the syntax for any option number, as well as the syntax for options 3, 66, and 150:

Command

Purpose

dhcpd option number value

Provides information for DHCP requests that include an option number as
specified in RFC-2132.

Example:
hostname(config)# dhcpd option 2

Command

Purpose

dhcpd option 66 ascii server_name

Provides the IP address or name of a TFTP server for option 66.

Example:
hostname(config)# dhcpd option 66 ascii
exampleserver

Command

Purpose

dhcpd option 150 ip server_ip1
[server_ip2]

Provides the IP address or names of one or two TFTP servers for option
150. The server_ip1 is the IP address or name of the primary TFTP server
while server_ip2 is the IP address or name of the secondary TFTP server.
A maximum of two TFTP servers can be identified using option 150.

Example:
hostname(config)# dhcpd option 150 ip
10.10.1.1

Cisco ASA 5500 Series Configuration Guide using the CLI

11-6

Chapter 11

Configuring DHCP
Configuring DHCP Relay Services

Command

Purpose

dhcpd option 3 ip router_ip1

Sets the default route.

Example:
hostname(config)# dhcpd option 3 ip
10.10.1.1

Configuring DHCP Relay Services
A DHCP relay agent allows the ASA to forward DHCP requests from clients to a router connected to a
different interface.
The following restrictions apply to the use of the DHCP relay agent:

Note

•

The relay agent cannot be enabled if the DHCP server feature is also enabled.

•

DHCP clients must be directly connected to the ASA and cannot send requests through another relay
agent or a router.

•

For multiple context mode, you cannot enable DHCP relay on an interface that is used by more than
one context.

•

DHCP Relay services are not available in transparent firewall mode. An ASA in transparent firewall
mode only allows ARP traffic through; all other traffic requires an access list. To allow DHCP
requests and replies through the ASA in transparent mode, you need to configure two access lists,
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.

•

When DHCP relay is enabled and more than one DHCP relay server is defined, the ASA forwards
client requests to each defined DHCP relay server. Replies from the servers are also forwarded to
the client until the client DHCP relay binding is removed. The binding is removed when the ASA
receives any of the following DHCP messages: ACK, NACK, or decline.

You cannot enable DHCP Relay on an interface running DHCP Proxy. You must Remove VPN DHCP
configuration first or you will see an error message. This error happens if both DHCP relay and DHCP
proxy are enabled. Ensure that either DHCP relay or DHCP proxy are enabled, but not both.
To enable DHCP relay, perform the following steps:

Step 1

Command

Purpose

dhcprelay server ip_address if_name

Set the IP address of a DHCP server on a different interface from
the DHCP client.

Example:

You can use this command up to ten times to identify up to ten
servers.

hostname(config)# dhcprelay server
201.168.200.4 outside

Step 2

dhcprelay enable interface

Enables DHCP relay on the interface connected to the clients.

Example:
hostname(config)# dhcprelay enable inside

Cisco ASA 5500 Series Configuration Guide using the CLI

11-7

Chapter 11

Configuring DHCP

DHCP Monitoring Commands

Step 3

Command

Purpose

dhcprelay timeout seconds

(Optional) Set the number of seconds allowed for relay address
negotiation.

Example:
hostname(config)# dhcprelay timeout 25

Step 4

dhcprelay setroute interface_name

(Optional) Change the first default router address in the packet
sent from the DHCP server to the address of the ASA interface.

Example:

This action allows the client to set its default route to point to the
ASA even if the DHCP server specifies a different router.

hostname(config)# dhcprelay setroute
inside

If there is no default router option in the packet, the ASA adds one
containing the interface address.

DHCP Monitoring Commands
To monitor DHCP, enter one of the following commands:
Command

Purpose

show running-config dhcpd

Shows the current DHCP configuration.

show running-config dhcprelay

Shows the current DHCP relay services status.

Feature History for DHCP
Table 11-3 lists each feature change and the platform release in which it was implemented.
Table 11-3

Feature History for DHCP

Feature Name

Releases

Description

DHCP

7.0(1)

The ASA can provide a DHCP server or DHCP relay services to DHCP clients
attached to ASA interfaces.
We introduced the following commands: dhcp client update dns, dhcpd address,
dhcpd domain, dhcpd enable, dhcpd lease, dhcpd option, dhcpd ping timeout,
dhcpd update dns, dhcpd wins, dhcp-network-scope, dhcprelay enable,
dhcprelay server, dhcprelay setroute, dhcprelay trusted, dhcp-server. show
running-config dhcpd, and show running-config dhcprelay.

Cisco ASA 5500 Series Configuration Guide using the CLI

11-8

C H A P T E R

12

Configuring Dynamic DNS
This chapter describes how to configure DDNS update methods and includes the following topics:
•

Information About DDNS, page 12-1

•

Licensing Requirements for DDNS, page 12-2

•

Guidelines and Limitations, page 12-2

•

Configuring DDNS, page 12-2

•

Configuration Examples for DDNS, page 12-3

•

DDNS Monitoring Commands, page 12-6

•

Feature History for DDNS, page 12-6

Information 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 pre-defined 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. To
configure the DNS server for other uses, see the “Configuring the DNS Server” section on page 10-11.
To configure DHCP, see the “Configuring a DHCP Server” section on page 11-2.
EDNS allows DNS requesters to advertise the size of their UDP packets and facilitates the transfer of
packets larger than 512 octets. When a DNS server receives a request over UDP, it identifies the size of
the UDP packet from the OPT resource record (RR) and scales its response to contain as many resource
records as are allowed in the maximum UDP packet size specified by the requester. The size of the DNS
packets can be up to 4096 bytes for BIND or 1280 bytes for the Windows 2003 DNS Server. Several
additional message-length maximum commands are available:
•

The existing global limit: message-length maximum 512

•

A client or server specific limit: message-length maximum client 4096

•

The dynamic value specified in the OPT RR field: message-length maximum client auto

If the three commands are present at the same time, the ASA enforces the minimum of the three specified
values.

Cisco ASA 5500 Series Configuration Guide using the CLI

12-1

Chapter 12

Configuring Dynamic DNS

Licensing Requirements for DDNS

Licensing Requirements for DDNS
The following table shows the licensing requirements for DDNS:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
Failover Guidelines

Supports Active/Active and Active/Standby failover.
Firewall Mode Guidelines

Supported in routed firewall mode.
Context Mode Guidelines

Supported in single and multiple context modes.
Supported in transparent mode for the DNS Client pane.
IPv6 Guidelines

Supports IPv6.

Configuring DDNS
This section describes examples for configuring the ASA to support Dynamic DNS. DDNS update
integrates DNS with DHCP. The two protocols are complementary—DHCP centralizes and automates
IP address allocation, while dynamic DNS update automatically records the association between
assigned addresses and hostnames. When you use DHCP and dynamic DNS update, this configures a
host automatically for network access whenever it attaches to the IP network. You can locate and reach
the host using its permanent, unique DNS hostname. Mobile hosts, for example, can move freely without
user or administrator intervention.
DDNS provides address and domain name mapping so that hosts can find each other, even though their
DHCP-assigned IP addresses change frequently. The DDNS name and address mapping is held on the
DHCP server in two resource records: the A RR includes the name-to I- 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 in this release.
The two most common DDNS update configurations are the following:
•

The DHCP client updates the A RR, while the DHCP server updates the PTR RR.

•

The DHCP server updates both the A RR and PTR RR.

Cisco ASA 5500 Series Configuration Guide using the CLI

12-2

Chapter 12

Configuring Dynamic DNS
Configuration Examples for DDNS

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. To
update the PTR RR, the DHCP server must know the FQDN of the client. The client provides an FQDN
to the server using a DHCP option called Client FQDN.

Configuration Examples for DDNS
The following examples present five common scenarios:
•

Example 1: Client Updates Both A and PTR RRs for Static IP Addresses, page 12-3

•

Example 2: Client Updates Both A and PTR RRs; DHCP Server Honors Client Update Request;
FQDN Provided Through Configuration, page 12-3

•

Example 3: Client Includes FQDN Option Instructing Server Not to Update Either RR; Server
Overrides Client and Updates Both RRs., page 12-4

•

Example 4: Client Asks Server To Perform Both Updates; Server Configured to Update PTR RR
Only; Honors Client Request and Updates Both A and PTR RR, page 12-5

•

Example 5: Client Updates A RR; Server Updates PTR RR, page 12-5

Example 1: Client Updates Both A and PTR RRs for Static IP Addresses
The following example shows how to configure the client to request that it update both A and PTR
resource records for static IP addresses.
To configure this scenario, perform the following steps:
Step 1

To define a DDNS update method called ddns-2 that requests that the client update both the A RR and
PTR RR, enter the following commands:
hostname(config)# ddns update method ddns-2
hostname(DDNS-update-method)# ddns both

Step 2

To associate the method ddns-2 with the eth1 interface, enter the following commands:
hostname(DDNS-update-method)# interface eth1
hostname(config-if)# ddns update ddns-2
hostname(config-if)# ddns update hostname asa.example.com

Step 3

To configure a static IP address for eth1, enter the following command:
hostname(config-if)# ip address 10.0.0.40 255.255.255.0

Example 2: Client Updates Both A and PTR RRs; DHCP Server Honors Client
Update Request; FQDN Provided Through Configuration
The following example shows how to configure the DHCP client to request that it update both the A and
PTR RRs, and the DHCP server to honor these requests.
To configure this scenario, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

12-3

Chapter 12

Configuring Dynamic DNS

Configuration Examples for DDNS

Step 1

To configure the DHCP client to request that the DHCP server perform no updates, enter the following
command:
hostname(config)# dhcp-client update dns server none

Step 2

To create a DDNS update method named ddns-2 on the DHCP client that requests that the client perform
both A and PTR updates, enter the following commands:
hostname(config)# ddns update method ddns-2
hostname(DDNS-update-method)# ddns both

Step 3

To associate the method named ddns-2 with the ASA interface named Ethernet0, and enable DHCP on
the interface, enter the following commands:
hostname(DDNS-update-method)# interface Ethernet0
hostname(if-config)# ddns update ddns-2
hostname(if-config)# ddns update hostname asa.example.com
hostname(if-config)# ip address dhcp

Step 4

To configure the DHCP server, enter the following command:
hostname(if-config)# dhcpd update dns

Example 3: Client Includes FQDN Option Instructing Server Not to Update Either
RR; Server Overrides Client and Updates Both RRs.
The following example shows how to configure the DHCP client to include the FQDN option that
instruct the DHCP server not to honor either the A or PTR updates. The example also shows how to
configure the server to override the client request. As a result, the client does not perform any updates.
To configure this scenario, perform the following steps:
Step 1

To configure the update method named ddns-2 to request that it make both A and PTR RR updates, enter
the following commands:
hostname(config)# ddns update method ddns-2
hostname(DDNS-update-method)# ddns both

Step 2

To assign the DDNS update method named ddns-2 on interface Ethernet0 and provide the client
hostname (asa), enter the following commands:
hostname(DDNS-update-method)# interface Ethernet0
hostname(if-config)# ddns update ddns-2
hostname(if-config)# ddns update hostname asa.example.com

Step 3

To enable the DHCP client feature on the interface, enter the following commands:
hostname(if-config)# dhcp client update dns server none
hostname(if-config)# ip address dhcp

Step 4

To configure the DHCP server to override the client update requests, enter the following command:
hostname(if-config)# dhcpd update dns both override

Cisco ASA 5500 Series Configuration Guide using the CLI

12-4

Chapter 12

Configuring Dynamic DNS
Configuration Examples for DDNS

Example 4: Client Asks Server To Perform Both Updates; Server Configured to
Update PTR RR Only; Honors Client Request and Updates Both A and PTR RR
The following example shows how to configure the server to perform only PTR RR updates by default.
However, the server honors the client request that it perform both A and PTR updates. The server also
forms the FQDN by appending the domain name (example.com) to the hostname that the client (asa) has
provided.
To configure this scenario, perform the following steps:
Step 1

To configure the DHCP client on interface Ethernet0, enter the following commands:
hostname(config)# interface Ethernet0
hostname(config-if)# dhcp client update dns both
hostname(config-if)# ddns update hostname asa

Step 2

To configure the DHCP server, enter the following commands:
hostname(config-if)# dhcpd update dns
hostname(config-if)# dhcpd domain example.com

Example 5: Client Updates A RR; Server Updates PTR RR
The following example shows how to configure the client to update the A resource record and how to
configure the server to update the PTR records. Also, the client uses the domain name from the DHCP
server to form the FQDN.
To configure this scenario, perform the following steps:
Step 1

To define the DDNS update method named ddns-2, enter the following commands:
hostname(config)# ddns update method ddns-2
hostname(DDNS-update-method)# ddns

Step 2

To configure the DHCP client for interface Ethernet0 and assign the update method to the interface, enter
the following commands:
hostname(DDNS-update-method)# interface Ethernet0
hostname(config-if)# dhcp client update dns
hostname(config-if)# ddns update ddns-2
hostname(config-if)# ddns update hostname asa

Step 3

To configure the DHCP server, enter the following commands:
hostname(config-if)# dhcpd update dns
hostname(config-if)# dhcpd domain example.com

Cisco ASA 5500 Series Configuration Guide using the CLI

12-5

Chapter 12

Configuring Dynamic DNS

DDNS Monitoring Commands

DDNS Monitoring Commands
To monitor DDNS, enter one of the following commands:
Command

Purpose

show running-config ddns

Shows the current DDNS configuration.

show running-config dns server-group

Shows the current DNS server group status.

Feature History for DDNS
Table 12-1 lists each feature change and the platform release in which it was implemented.
Table 12-1

Feature History for DDNS

Feature Name

Releases

Feature Information

DDNS

7.0(1)

This feature was introduced.
The following commands were introduced: ddns, ddns update, dhcp client update
dns, dhcpd update dns, show running-config ddns, and show running-config dns
server-group.

Cisco ASA 5500 Series Configuration Guide using the CLI

12-6

PA R T

5

Configuring Objects and Access Lists

C H A P T E R

13

Configuring Objects
Objects are reusable components for use in your configuration. They can be defined and used in ASA
configurations in the place of inline IP addresses. Objects make it easy to maintain your configurations
because you can modify an object in one place and have it be reflected in all other places that are
referencing it. Without objects you would have to modify the parameters for every feature when
required, instead of just once. For example, if a network object defines an IP address and subnet mask,
and you want to change the address, you only need to change it in the object definition, not in every
feature that refers to that IP address.
This chapter describes how to configure objects, and it includes the following sections:
•

Configuring Objects and Groups, page 13-1

•

Configuring Regular Expressions, page 13-12

•

Scheduling Extended Access List Activation, page 13-16

Configuring Objects and Groups
This section includes the following topics:
•

Information About Objects and Groups, page 13-1

•

Licensing Requirements for Objects and Groups, page 13-2

•

Guidelines and Limitations for Objects and Groups, page 13-3

•

Configuring Objects, page 13-3

•

Configuring Object Groups, page 13-6

•

Monitoring Objects and Groups, page 13-11

•

Feature History for Objects and Groups, page 13-12

Information About Objects and Groups
The ASA supports objects and object groups. You can attach or detach objects from one or more object
groups when needed, ensuring that the objects are not duplicated but can be re-used wherever needed.
This section includes the following topics:
•

Information About Objects, page 13-2

Cisco ASA 5500 Series Configuration Guide using the CLI

13-1

Chapter 13

Configuring Objects

Configuring Objects and Groups

•

Information About Object Groups, page 13-2

Information About Objects
Objects are created in and used by the ASA in the place of an inline IP address in any given
configuration. You can define an object with a particular IP address and netmask pair or a protocol (and,
optionally, a port) and use this object in several configurations. The advantage is that whenever you want
to modify the configurations created to this IP address or protocol, you do not need to modify all rules
in the running configuration. You can modify the object, and then the change automatically applies to
all rules that use the specified object. You can configure two types of objects: network objects and
service objects. These objects can be used in Network Address Translation (NAT), access lists, and
object groups.

Information About Object Groups
By grouping like objects together, you can use the object group in an ACE instead of having to enter an
ACE for each object separately. You can create the following types of object groups:
•

Protocol

•

Network

•

Service

•

ICMP type

For example, consider the following three object groups:
•

MyServices—Includes the TCP and UDP port numbers of the service requests that are allowed
access to the internal network.

•

TrustedHosts—Includes the host and network addresses allowed access to the greatest range of
services and servers.

•

PublicServers—Includes the host addresses of servers to which the greatest access is provided.

After creating these groups, you could use a single ACE to allow trusted hosts to make specific service
requests to a group of public servers.
You can also nest object groups in other object groups.

Licensing Requirements for Objects and Groups
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-2

Chapter 13

Configuring Objects
Configuring Objects and Groups

Guidelines and Limitations for Objects and Groups
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
IPv6 Guidelines

Supports IPv6, with limitations. (See the “Additional Guidelines and Limitations” section on page 13-3.)
Additional Guidelines and Limitations

The following guidelines and limitations apply to object groups:
•

Objects and object groups share the same name space.

•

Object groups must have unique names. While you might want to create a network object group
named “Engineering” and a service object group named “Engineering,” you need to add an identifier
(or “tag”) to the end of at least one object group name to make it unique. For example, you can use
the names “Engineering_admins” and “Engineering_hosts” to make the object group names unique
and to aid in identification.

•

You cannot remove an object group or make an object group empty if it is used in a command.

•

The ASA does not support IPv6 nested object groups, so you cannot group an object with IPv6
entities under another IPv6 object group.

Configuring Objects
This section includes the following topics:
•

Configuring a Network Object, page 13-3

•

Configuring a Service Object, page 13-4

Configuring a Network Object
A network object contains a single IP address/mask pair. Network objects can be of three types: host,
subnet, or range.
You can also configure auto NAT as part of the object definition; see Chapter 30, “Configuring Network
Object NAT,” for more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-3

Chapter 13

Configuring Objects

Configuring Objects and Groups

Detailed Steps

Step 1

Command

Purpose

object network obj_name

Creates a new network object. The obj_name is a text string up to
64 characters in length and can be any combination of letters,
digits, and the following characters:

Example:
hostname(config)# object-network OBJECT1

•

underscore “_”

•

dash “-”

•

period “.”

The prompt changes to network object configuration mode.
Step 2

{host ip_addr | subnet net_addr net_mask |
range ip_addr_1 ip_addr_2}

Assigns the IP address to the named object. You can configure a
host address, a subnet, or a range of addresses.

Example:
hostname(config-network-object)# host
10.2.2.2

Step 3

description text

Adds a description to the object.

Example:
hostname(config-network-object)#
description Engineering Network

Examples
To create a network object, enter the following commands:
hostname (config)# object network OBJECT1
hostname (config-network-object)# host 10.2.2.2

Configuring a Service Object
A service object contains a protocol and optional source and/or destination port.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-4

Chapter 13

Configuring Objects
Configuring Objects and Groups

Detailed Steps

Step 1

Command

Purpose

object service obj_name

Creates a new service object. The obj_name is a text string up to
64 characters in length and can be any combination of letters,
digits, and the following characters:

Example:
hostname(config)# object-service
SERVOBJECT1

•

underscore “_”

•

dash “-”

•

period “.”

The prompt changes to service object configuration mode.
Step 2

service {protocol | icmp icmp-type | icmp6
icmp6-type | {tcp | udp} [source operator
port] [destination operator port]}

Creates a service object for the source mapped address.
The protocol argument specifies an IP protocol name or number.
The icmp, tcp, or udp keywords specify that this service object is
for either the ICMP, TCP, or UDP protocol.

Example:
hostname(config-service-object)# service
tcp source eq www destination eq ssh

The icmp-type argument names the ICMP type.
The icmp6 keyword specifies that the service type is for ICMP
version 6 connections.
The icmp6-type argument names the ICMP version 6 type.
The source keyword specifies the source port.
The destination keyword specifies the destination port.
The operator port argument specifies a single port/code value that
supports configuring the port for the protocol. You can specify
“eq,” “neq,” “lt,” “gt,” and “range” when configuring a port for
TCP or UDP. The “range” operator lists the beginning port and
ending port.

Example
To create a service object, enter the following commands:
hostname (config)# object service SERVOBJECT1
hostname (config-service-object)# service tcp source eq www destination eq ssh

Cisco ASA 5500 Series Configuration Guide using the CLI

13-5

Chapter 13

Configuring Objects

Configuring Objects and Groups

Configuring Object Groups
This section includes the following topics:
•

Adding a Protocol Object Group, page 13-6

•

Adding a Network Object Group, page 13-7

•

Adding a Service Object Group, page 13-8

•

Adding an ICMP Type Object Group, page 13-9

•

Nesting Object Groups, page 13-10

•

Removing Object Groups, page 13-11

Adding a Protocol Object Group
To add or change a protocol object group, perform the steps in this section. After you add the group, you
can add more objects as required by following this procedure again for the same group name and
specifying additional objects. You do not need to reenter existing objects; the commands you already set
remain in place unless you remove them with the no form of the command.

Detailed Steps

Step 1

Command

Purpose

object-group protocol obj_grp_id

Adds a protocol group. The obj_grp_id is a text string up to 64
characters in length and can be any combination of letters, digits,
and the following characters:

Example:
hostname(config)# object-group protocol
tcp_udp_icmp

•

underscore “_”

•

dash “-”

•

period “.”

The prompt changes to protocol configuration mode.
Step 2

description text

(Optional) Adds a description. The description can be up to 200
characters.

Example:
hostname(config-protocol)# description New
Group

Step 3

Defines the protocols in the group. Enter the command for each
protocol. The protocol is the numeric identifier of the specified IP
protocol (1 to 254) or a keyword identifier (for example, icmp,
Example:
tcp, or udp). To include all IP protocols, use the keyword ip. For
hostname(config-protocol)# protocol-object
a list of protocols that you can specify, see the “Protocols and
tcp
Applications” section on page B-11.
protocol-object protocol

Example
To create a protocol group for TCP, UDP, and ICMP, enter the following commands:
hostname (config)# object-group protocol tcp_udp_icmp
hostname (config-protocol)# protocol-object tcp
hostname (config-protocol)# protocol-object udp

Cisco ASA 5500 Series Configuration Guide using the CLI

13-6

Chapter 13

Configuring Objects
Configuring Objects and Groups

hostname (config-protocol)# protocol-object icmp

Adding a Network Object Group
A network object group supports IPv4 and IPv6 addresses.
To add or change a network object group, perform the steps in this section. After you add the group, you
can add more objects as required by following this procedure again for the same group name and
specifying additional objects. You do not need to reenter existing objects; the commands you already set
remain in place unless you remove them with the no form of the command.

Detailed Steps

Step 1

Command

Purpose

object-group network grp_id

Adds a network group.

Example:

The grp_id is a text string up to 64 characters in
length and can be any combination of letters, digits,
and the following characters:

hostname(config)# object-group network
admins

•

underscore “_”

•

dash “-”

•

period “.”

The prompt changes to protocol configuration mode.
Step 2

(Optional) Adds a description. The description can
be up to 200 characters.

description text

Example:
hostname(config-network)# Administrator
Addresses

Step 3

The object keyword adds an additional object to the
network object group.

network-object {object name | host
ip_address | ip_address mask}

Defines the networks in the group. Enter the
command for each network or address.

Example:
hostname(config-network)# network-object
host 10.2.2.4

Example
To create a network group that includes the IP addresses of three administrators, enter the following
commands:
hostname
hostname
hostname
hostname
hostname

(config)# object-group network admins
(config-protocol)# description Administrator Addresses
(config-protocol)# network-object host 10.2.2.4
(config-protocol)# network-object host 10.2.2.78
(config-protocol)# network-object host 10.2.2.34

Cisco ASA 5500 Series Configuration Guide using the CLI

13-7

Chapter 13

Configuring Objects

Configuring Objects and Groups

Adding a Service Object Group
To add or change a service object group, perform the steps in this section. After you add the group, you
can add more objects as required by following this procedure again for the same group name and
specifying additional objects. You do not need to reenter existing objects; the commands you already set
remain in place unless you remove them with the no form of the command.

Detailed Steps

Step 1

Command

Purpose

object-group service grp_id {tcp | udp |
tcp-udp}

Adds a service group.
The object keyword adds an additional object to the
service object group.

Example:
hostname(config)# object-group service
services1 tcp-udp

The grp_id is a text string up to 64 characters in
length and can be any combination of letters, digits,
and the following characters:
•

underscore “_”

•

dash “-”

•

period “.”

Specify the protocol for the services (ports) you
want to add with either the tcp, udp, or tcp-udp
keywords. Enter the tcp-udp keyword if your
service uses both TCP and UDP with the same port
number, for example, DNS (port53).
The prompt changes to service configuration mode.
Step 2

description text

(Optional) Adds a description. The description can
be up to 200 characters.

Example:
hostname(config-service)# description DNS
Group

Step 3

port-object {eq port | range begin_port
end_port}

Example:

Defines the ports in the group. Enter the command
for each port or range of ports. For a list of permitted
keywords and well-known port assignments, see the
“Protocols and Applications” section on page B-11.

hostname(config-service)# port-object eq
domain

Example
To create service groups that include DNS (TCP/UDP), LDAP (TCP), and RADIUS (UDP), enter the
following commands:
hostname (config)# object-group service services1 tcp-udp
hostname (config-service)# description DNS Group
hostname (config-service)# port-object eq domain
hostname (config)# object-group service services2 udp
hostname (config-service)# description RADIUS Group
hostname (config-service)# port-object eq radius

Cisco ASA 5500 Series Configuration Guide using the CLI

13-8

Chapter 13

Configuring Objects
Configuring Objects and Groups

hostname (config-service)# port-object eq radius-acct
hostname (config)# object-group service services3 tcp
hostname (config-service)# description LDAP Group
hostname (config-service)# port-object eq ldap

Adding an ICMP Type Object Group
To add or change an ICMP type object group, perform the steps in this section. After you add the group,
you can add more objects as required by following this procedure again for the same group name and
specifying additional objects. You do not need to reenter existing objects; the commands you already set
remain in place unless you remove them with the no form of the command.

Detailed Steps

Step 1

Command

Purpose

object-group icmp-type grp_id

Adds an ICMP type object group. The grp_id is a text string up to
64 characters in length and can be any combination of letters,
digits, and the following characters:

Example:
hostname(config)# object-group icmp-type
ping

•

underscore “_”

•

dash “-”

•

period “.”

The prompt changes to ICMP type configuration mode.
Step 2

(Optional) Adds a description. The description can be up to 200
characters.

description text

Example:
hostname(config-icmp-type)# description
Ping Group

Step 3

icmp-object icmp-type

Example:

Defines the ICMP types in the group. Enter the command for each
type. For a list of ICMP types, see the“ICMP Types” section on
page B-15.

hostname(config-icmp-type)# icmp-object
echo-reply

Example
Create an ICMP type group that includes echo-reply and echo (for controlling ping) by entering the
following commands:
hostname
hostname
hostname
hostname

(config)# object-group icmp-type ping
(config-service)# description Ping Group
(config-service)# icmp-object echo
(config-service)# icmp-object echo-reply

Cisco ASA 5500 Series Configuration Guide using the CLI

13-9

Chapter 13

Configuring Objects

Configuring Objects and Groups

Nesting Object Groups
You can nest object groups hierarchically so that one object group can contain other object groups of the
same type and you can mix and match nested group objects and regular objects within an object group.
The ASA does not support IPv6 nested object groups, however, so you cannot group an object with IPv6
entities under another IPv6 object-group.
To nest an object group within another object group of the same type, first create the group that you want
to nest (see the “Configuring Object Groups” section on page 13-6), and then perform the steps in this
section.

Detailed Steps

Step 1

Command

Purpose

object-group group {{protocol | network |
icmp-type} grp_id |service grp_id {tcp |
udp | tcp-udp}}

Adds or edits the specified object group type under which you
want to nest another object group.
The service_grp_id is a text string up to 64 characters in length
and can be any combination of letters, digits, and the following
characters:

Example:
hostname(config)# object-group network
Engineering_group

Step 2

group-object group_id

Example:
hostname(config-network)# group-object
Engineering_groups

•

underscore “_”

•

dash “-”

•

period “.”

Adds the specified group under the object group you specified in
Step 1. The nested group must be of the same type. You can mix
and match nested group objects and regular objects within an
object group.

Examples
Create network object groups for privileged users from various departments by entering the following
commands:
hostname
hostname
hostname
hostname

(config)# object-group network eng
(config-network)# network-object host 10.1.1.5
(config-network)# network-object host 10.1.1.9
(config-network)# network-object host 10.1.1.89

hostname (config)# object-group network hr
hostname (config-network)# network-object host 10.1.2.8
hostname (config-network)# network-object host 10.1.2.12
hostname (config)# object-group network finance
hostname (config-network)# network-object host 10.1.4.89
hostname (config-network)# network-object host 10.1.4.100

You then nest all three groups together as follows:
hostname
hostname
hostname
hostname

(config)# object-group network
(config-network)# group-object
(config-network)# group-object
(config-network)# group-object

Cisco ASA 5500 Series Configuration Guide using the CLI

13-10

admin
eng
hr
finance

Chapter 13

Configuring Objects
Configuring Objects and Groups

You only need to specify the admin object group in your ACE as follows:
hostname (config)# access-list ACL_IN extended permit ip object-group admin host
209.165.201.29

Removing Object Groups
You can remove a specific object group or remove all object groups of a specified type; however, you
cannot remove an object group or make an object group empty if it is used in an access list.

Detailed Step

Step 1

Do one of the following:
no object-group grp_id

Example:

Removes the specified object group. The grp_id is a text string up
to 64 characters in length and can be any combination of letters,
digits, and the following characters:

hostname(config)# no object-group
Engineering_host

clear object-group [protocol | network |
services | icmp-type]

•

underscore “_”

•

dash “-”

•

period “.”

Removes all object groups of the specified type.

Note

Example:

If you do not enter a type, all object groups are removed.

hostname(config)# clear-object group
network

Monitoring Objects and Groups
To monitor objects and groups, enter the following commands:
Command

Purpose

show access-list

Displays the access list entries that are expanded
out into individual entries without their object
groupings.

show running-config object-group

Displays all current object groups.

show running-config object-group grp_id

Displays the current object groups by their group
ID.

show running-config object-group grp_type

Displays the current object groups by their group
type.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-11

Chapter 13

Configuring Objects

Configuring Regular Expressions

Feature History for Objects and Groups
Table 1 lists each feature change and the platform release in which it was implemented.
Table 1

Feature History for Object Groups

Feature Name

Releases

Feature Information

Object groups

7.0(1)

Object groups simplify access list creation and
maintenance.
We introduced or modified the following commands:
object-group protocol, object-group network,
object-group service, object-group icmp_type.

Objects

8.3(1)

Object support was introduced.
We introduced or modified the following commands:
object-network, object-service, object-group network,
object-group service, network object, access-list
extended, access-list webtype, access-list remark.

Configuring Regular Expressions
A regular expression matches text strings either literally as an exact string, or by using metacharacters
so that you can match multiple variants of a text string. You can use a regular expression to match the
content of certain application traffic; for example, you can match a URL string inside an HTTP packet.
This section describes how to create a regular expression and includes the following topics:
•

Creating a Regular Expression, page 13-12

•

Creating a Regular Expression Class Map, page 13-15

Creating a Regular Expression
A regular expression matches text strings either literally as an exact string, or by using metacharacters
so you can match multiple variants of a text string. You can use a regular expression to match the content
of certain application traffic; for example, you can match a URL string inside an HTTP packet.

Guidelines
Use Ctrl+V to escape all of the special characters in the CLI, such as question mark (?) or a tab. For
example, type d[Ctrl+V]?g to enter d?g in the configuration.
See the regex command in the command reference for performance impact information when matching
a regular expression to packets.

Note

As an optimization, the ASA searches on the deobfuscated URL. Deobfuscation compresses multiple
forward slashes (/) into a single slash. For strings that commonly use double slashes, like “http://”, be
sure to search for “http:/” instead.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-12

Chapter 13

Configuring Objects
Configuring Regular Expressions

Table 13-2 lists the metacharacters that have special meanings.
Table 13-2

regex Metacharacters

Character Description

Notes

.

Dot

Matches any single character. For example, d.g matches
dog, dag, dtg, and any word that contains those
characters, such as doggonnit.

(exp)

Subexpression

A subexpression segregates characters from surrounding
characters, so that you can use other metacharacters on
the subexpression. For example, d(o|a)g matches dog
and dag, but do|ag matches do and ag. A subexpression
can also be used with repeat quantifiers to differentiate
the characters meant for repetition. For example,
ab(xy){3}z matches abxyxyxyz.

|

Alternation

Matches either expression it separates. For example,
dog|cat matches dog or cat.

?

Question mark

A quantifier that indicates that there are 0 or 1 of the
previous expression. For example, lo?se matches lse or
lose.
Note

You must enter Ctrl+V and then the question
mark or else the help function is invoked.

*

Asterisk

A quantifier that indicates that there are 0, 1 or any
number of the previous expression. For example, lo*se
matches lse, lose, loose, and so on.

+

Plus

A quantifier that indicates that there is at least 1 of the
previous expression. For example, lo+se matches lose
and loose, but not lse.

{x} or {x,} Minimum repeat quantifier

Repeat at least x times. For example, ab(xy){2,}z
matches abxyxyz, abxyxyxyz, and so on.

[abc]

Character class

Matches any character in the brackets. For example,
[abc] matches a, b, or c.

[^abc]

Negated character class

Matches a single character that is not contained within
the brackets. For example, [^abc] matches any character
other than a, b, or c. [^A-Z] matches any single
character that is not an uppercase letter.

[a-c]

Character range class

Matches any character in the range. [a-z] matches any
lowercase letter. You can mix characters and ranges:
[abcq-z] matches a, b, c, q, r, s, t, u, v, w, x, y, z, and so
does [a-cq-z].
The dash (-) character is literal only if it is the last or the
first character within the brackets: [abc-] or [-abc].

“”

Quotation marks

Preserves trailing or leading spaces in the string. For
example, “ test” preserves the leading space when it
looks for a match.

^

Caret

Specifies the beginning of a line.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-13

Chapter 13

Configuring Objects

Configuring Regular Expressions

Table 13-2

regex Metacharacters (continued)

Character Description

Notes

\

Escape character

When used with a metacharacter, matches a literal
character. For example, \[ matches the left square
bracket.

char

Character

When character is not a metacharacter, matches the
literal character.

\r

Carriage return

Matches a carriage return 0x0d.

\n

Newline

Matches a new line 0x0a.

\t

Tab

Matches a tab 0x09.

\f

Formfeed

Matches a form feed 0x0c.

\xNN

Escaped hexadecimal number

Matches an ASCII character using hexadecimal (exactly
two digits).

\NNN

Escaped octal number

Matches an ASCII character as octal (exactly three
digits). For example, the character 040 represents a
space.

Detailed Steps
Step 1

To test a regular expression to make sure it matches what you think it will match, enter the following
command:
hostname(config)# test regex input_text regular_expression

Where the input_text argument is a string you want to match using the regular expression, up to 201
characters in length.
The regular_expression argument can be up to 100 characters in length.
Use Ctrl+V to escape all of the special characters in the CLI. For example, to enter a tab in the input
text in the test regex command, you must enter test regex “test[Ctrl+V Tab]” “test\t”.
If the regular expression matches the input text, you see the following message:
INFO: Regular expression match succeeded.

If the regular expression does not match the input text, you see the following message:
INFO: Regular expression match failed.

Step 2

To add a regular expression after you tested it, enter the following command:
hostname(config)# regex name regular_expression

Where the name argument can be up to 40 characters in length.
The regular_expression argument can be up to 100 characters in length.

Examples
The following example creates two regular expressions for use in an inspection policy map:
hostname(config)# regex url_example example\.com

Cisco ASA 5500 Series Configuration Guide using the CLI

13-14

Chapter 13

Configuring Objects
Configuring Regular Expressions

hostname(config)# regex url_example2 example2\.com

Creating a Regular Expression Class Map
A regular expression class map identifies one or more regular expressions. You can use a regular
expression class map to match the content of certain traffic; for example, you can match URL strings
inside HTTP packets.

Detailed Steps
Step 1

Create one or more regular expressions according to the “Configuring Regular Expressions” section.

Step 2

Create a class map by entering the following command:
hostname(config)# class-map type regex match-any class_map_name
hostname(config-cmap)#

Where class_map_name is a string up to 40 characters in length. The name “class-default” is reserved.
All types of class maps use the same name space, so you cannot reuse a name already used by another
type of class map.
The match-any keyword specifies that the traffic matches the class map if it matches at least one of the
regular expressions.
The CLI enters class-map configuration mode.
Step 3

(Optional) Add a description to the class map by entering the following command:
hostname(config-cmap)# description string

Step 4

Identify the regular expressions you want to include by entering the following command for each regular
expression:
hostname(config-cmap)# match regex regex_name

Examples
The following example creates two regular expressions, and adds them to a regular expression class map.
Traffic matches the class map if it includes the string “example.com” or “example2.com.”
hostname(config)# regex url_example example\.com
hostname(config)# regex url_example2 example2\.com
hostname(config)# class-map type regex match-any URLs
hostname(config-cmap)# match regex url_example
hostname(config-cmap)# match regex url_example2

Cisco ASA 5500 Series Configuration Guide using the CLI

13-15

Chapter 13

Configuring Objects

Scheduling Extended Access List Activation

Scheduling Extended Access List Activation
This section includes the following topics:
•

Information About Scheduling Access List Activation, page 13-16

•

Licensing Requirements for Scheduling Access List Activation, page 13-16

•

Guidelines and Limitations for Scheduling Access List Activation, page 13-16

•

Configuring and Applying Time Ranges, page 13-17

•

Configuration Examples for Scheduling Access List Activation, page 13-18

•

Feature History for Scheduling Access List Activation, page 13-18

Information About Scheduling Access List Activation
You can schedule each ACE in an access list to be activated at specific times of the day and week by
applying a time range to the ACE.

Licensing Requirements for Scheduling Access List Activation
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations for Scheduling Access List Activation
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
IPv6 Guidelines

Supports IPv6.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-16

Chapter 13

Configuring Objects
Scheduling Extended Access List Activation

Additional Guidelines and Limitations

The following guidelines and limitations apply to using object groups with access lists:
•

Users could experience a delay of approximately 80 to 100 seconds after the specified end time for
the ACL to become inactive. For example, if the specified end time is 3:50, because the end time is
inclusive, the command is picked up anywhere between 3:51:00 and 3:51:59. After the command is
picked up, the ASA finishes any currently running task and then services the command to deactivate
the ACL.

•

Multiple periodic entries are allowed per time-range command. If a time-range command has both
absolute and periodic values specified, then the periodic commands are evaluated only after the
absolute start time is reached, and they are not further evaluated after the absolute end time is
reached.

Configuring and Applying Time Ranges
You can add a time range to implement a time-based access list. To identify the time range, perform the
steps in this section.

Detailed Steps

Step 1

Command

Purpose

time-range name

Identifies the time-range name.

Example:
hostname(config)# time range Sales

Step 2

Do one of the following:
periodic days-of-the-week time to
[days-of-the-week] time

Specifies a recurring time range.
You can specify the following values for days-of-the-week:

Example:
hostname(config-time-range)# periodic
monday 7:59 to friday 17:01

•

monday, tuesday, wednesday, thursday, friday, saturday,
or sunday.

•

daily

•

weekdays

•

weekend

The time is in the format hh:mm. For example, 8:00 is 8:00 a.m.
and 20:00 is 8:00 p.m.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-17

Chapter 13

Configuring Objects

Scheduling Extended Access List Activation

Step 3

Command

Purpose

absolute start time date [end time date]

Specifies an absolute time range.

Example:

The time is in the format hh:mm. For example, 8:00 is 8:00 a.m.
and 20:00 is 8:00 p.m.

hostname(config-time-range)# absolute
start 7:59 2 january 2009

The date is in the format day month year; for example, 1 january
2006.

access-list access_list_name [extended]
{deny | permit}...[time-range name]

Applies the time range to an ACE.

Note

Example:
hostname(config)# access list Marketing
extended deny tcp host 209.165.200.225
host 209.165 201.1 time-range
Pacific_Coast

If you also enable logging for the ACE, use the log
keyword before the time-range keyword. If you disable
the ACE using the inactive keyword, use the inactive
keyword as the last keyword.

See Chapter 15, “Adding an Extended Access List,” for complete
access-list command syntax.

Example
The following example binds an access list named “Sales” to a time range named “New_York_Minute”:
hostname(config)# access-list Sales line 1 extended deny tcp host 209.165.200.225 host
209.165.201.1 time-range New_York_Minute

Configuration Examples for Scheduling Access List Activation
The following is an example of an absolute time range beginning at 8:00 a.m. on January 1, 2006.
Because no end time and date are specified, the time range is in effect indefinitely.
hostname(config)# time-range for2006
hostname(config-time-range)# absolute start 8:00 1 january 2006

The following is an example of a weekly periodic time range from 8:00 a.m. to 6:00 p.m on weekdays:
hostname(config)# time-range workinghours
hostname(config-time-range)# periodic weekdays 8:00 to 18:00

Feature History for Scheduling Access List Activation
Table 13-3 lists each feature change and the platform release in which it was implemented.
Table 13-3

Feature History for Scheduling Access List Activation

Feature Name

Releases

Feature Information

Scheduling access list activation

7.0

You can schedule each ACE in an access list to be activated
at specific times of the day and week.
We introduced or mofied the following commands:
object-group protocol, object-group network,
object-group service, object-group icmp_type.

Cisco ASA 5500 Series Configuration Guide using the CLI

13-18

Chapter 13

Configuring Objects
Scheduling Extended Access List Activation

Cisco ASA 5500 Series Configuration Guide using the CLI

13-19

Chapter 13
Scheduling Extended Access List Activation

Cisco ASA 5500 Series Configuration Guide using the CLI

13-20

Configuring Objects

CH A P T E R

14

Information About Access Lists
Cisco ASAs provide basic traffic filtering capabilities with access lists, which control access in your
network by preventing certain traffic from entering or exiting. This chapter describes access lists and
shows how to add them to your network configuration.
Access lists are made up of one or more access control entries (ACEs). An ACE is a single entry in an
access list that specifies a permit or deny rule (to forward or drop the packet) and is applied to a protocol,
to a source and destination IP address or network, and, optionally, to the source and destination ports.
Access lists can be configured for all routed and network protocols (IP, AppleTalk, and so on) to filter
the packets of those protocols as the packets pass through a router.
Access lists are used in a variety of features. If your feature uses Modular Policy Framework, you can
use an access list to identify traffic within a traffic class map. For more information on Modular Policy
Framework, see Chapter 32, “Configuring a Service Policy Using the Modular Policy Framework.”
This chapter includes the following sections:
•

Access List Types, page 14-1

•

Access Control Entry Order, page 14-2

•

Access Control Implicit Deny, page 14-3

•

IP Addresses Used for Access Lists When You Use NAT, page 14-3

•

Where to Go Next, page 14-3

Access List Types
The ASA uses five types of access control lists:
•

Standard access lists—Identify the destination IP addresses of OSPF routes and can be used in a
route map for OSPF redistribution. Standard access lists cannot be applied to interfaces to control
traffic. For more information, see Chapter 17, “Adding a Standard Access List.”

•

Extended access lists—Use one or more access control entries (ACE) in which you can specify the
line number to insert the ACE, the source and destination addresses, and, depending upon the ACE
type, the protocol, the ports (for TCP or UDP), or the IPCMP type (for ICMP). For more
information, see Chapter 15, “Adding an Extended Access List.”

•

EtherType access lists—Use one or more ACEs that specify an EtherType. For more information,
see Chapter 16, “Adding an EtherType Access List.”

•

Webtype access lists—Used in a configuration that supports filtering for clientless SSL VPN. For
more information, see Chapter 18, “Adding a Webtype Access List.”

Cisco ASA 5500 Series Configuration Guide using the CLI

14-1

Chapter 14

Information About Access Lists

Access Control Entry Order

•

IPv6 access lists—Determine which IPv6 traffic to block and which traffic to forward at router
interfaces. For more information, see Chapter 19, “Adding an IPv6 Access List.”

Table 14-1 lists the types of access lists and some common uses for them.
Table 14-1

Access List Types and Common Uses

Access List Use

Access List Type

Description

Control network access for IP traffic
(routed and transparent mode)

Extended

The ASA does not allow any traffic from a lower security
interface to a higher security interface unless it is
explicitly permitted by an extended access list.
Note

Identify traffic for AAA rules

Extended

To access the ASA interface for management
access, you do not also need an access list
allowing the host IP address. You only need to
configure management access according to
Chapter 37, “Configuring Management Access.”

AAA rules use access lists to identify traffic.

Control network access for IP traffic for a Extended,
given user
downloaded from a
AAA server per user

You can configure the RADIUS server to download a
dynamic access list to be applied to the user, or the server
can send the name of an access list that you already
configured on the ASA.

Identify addresses for NAT (policy NAT
and NAT exemption)

Extended

Policy NAT lets you identify local traffic for address
translation by specifying the source and destination
addresses in an extended access list.

Establish VPN access

Extended

You can use an extended access list in VPN commands.

Identify traffic in a traffic class map for
Modular Policy Framework

Extended

Access lists can be used to identify traffic in a class map,
which is used for features that support Modular Policy
Framework. Features that support Modular Policy
Framework include TCP and general connection settings,
and inspection.

For transparent firewall mode, control
network access for non-IP traffic

EtherType

You can configure an access list that controls traffic based
on its EtherType.

Identify OSPF route redistribution

Standard

Standard access lists include only the destination address.
You can use a standard access list to control the
redistribution of OSPF routes.

Filtering for WebVPN

Webtype

You can configure a Webtype access list to filter URLs.

Control network access for IPV6
networks

IPv6

You can add and apply access lists to control traffic in
IPv6 networks.

EtherType

Access Control Entry Order
An access list is made up of one or more access control entries (ACEs). Each ACE that you enter for a
given access list name is appended to the end of the access list. Depending on the access list type, you
can specify the source and destination addresses, the protocol, the ports (for TCP or UDP), the ICMP
type (for ICMP), or the EtherType.

Cisco ASA 5500 Series Configuration Guide using the CLI

14-2

Chapter 14

Information About Access Lists
Access Control Implicit Deny

The order of ACEs is important. When the ASA decides whether to forward or to drop a packet, the ASA
tests the packet against each ACE in the order in which the entries are listed. After a match is found, no
more ACEs are checked. For example, if you create an ACE at the beginning of an access list that
explicitly permits all traffic, no further statements are checked, and the packet is forwarded.

Access Control Implicit Deny
All access lists have an implicit deny statement at the end, so unless you explicitly permit traffic to pass,
it will be denied. For example, if you want to allow all users to access a network through the ASA except
for one or more particular addresses, then you need to deny those particular addresses and then permit
all others.
For EtherType access lists, the implicit deny at the end of the access list does not affect IP traffic or
ARPs; for example, if you allow EtherType 8037, the implicit deny at the end of the access list does not
now block any IP traffic that you previously allowed with an extended access list (or implicitly allowed
from a high security interface to a low security interface). However, if you explicitly deny all traffic with
an EtherType ACE, then IP and ARP traffic is denied.

IP Addresses Used for Access Lists When You Use NAT
For the following features, you should always use the real IP address in the access list when you use
NAT, even if the address as seen on an interface is the mapped address:
•

access-group command

•

Modular Policy Framework match access-list command

•

Botnet Traffic Filter dynamic-filter enable classify-list command

•

AAA aaa ... match commands

•

WCCP wccp redirect-list group-list command

The following features use access lists, but these access lists use the mapped values as seen on an
interface:
•

IPsec access lists

•

capture command access lists

•

Per-user access lists

•

Routing protocols

•

All other features...

Where to Go Next
For information about implementing access lists, see the following chapters in this guide:
•

Chapter 15, “Adding an Extended Access List”

•

Chapter 16, “Adding an EtherType Access List”

Cisco ASA 5500 Series Configuration Guide using the CLI

14-3

Chapter 14
Where to Go Next

•

Chapter 17, “Adding a Standard Access List”

•

Chapter 18, “Adding a Webtype Access List”

•

Chapter 19, “Adding an IPv6 Access List”

•

Chapter 34, “Configuring Access Rules”

Cisco ASA 5500 Series Configuration Guide using the CLI

14-4

Information About Access Lists

CH A P T E R

15

Adding an Extended Access List
This chapter describes how to configure extended access lists (also known as access control lists), and
it includes the following sections:
•

Information About Extended Access Lists, page 15-1

•

Licensing Requirements for Extended Access Lists, page 15-1

•

Guidelines and Limitations, page 15-1

•

Default Settings, page 15-2

•

Configuring Extended Access Lists, page 15-2

•

Monitoring Extended Access Lists, page 15-5

•

Configuration Examples for Extended Access Lists, page 15-5

•

Where to Go Next, page 15-7

•

Feature History for Extended Access Lists, page 15-7

Information About Extended Access Lists
Access lists are used to control network access or to specify traffic for many features to act upon. An
extended access list is made up of one or more access control entries (ACE) in which you can specify
the line number to insert the ACE, the source and destination addresses, and, depending upon the ACE
type, the protocol, the ports (for TCP or UDP), or the ICMP type. You can identify all of these parameters
within the access-list command, or you can use objects for each parameter.

Licensing Requirements for Extended Access Lists
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations

This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

15-1

Chapter 15

Adding an Extended Access List

Default Settings

Firewall Mode Guidelines

Supported only in routed and transparent firewall modes.
IPv6 Guidelines

IPv6 is supported.
Additional Guidelines and Limitations

The following guidelines and limitations apply to creating an extended access list:
•

Enter the access list name in uppercase letters so that the name is easy to see in the configuration.
You might want to name the access list for the interface (for example, INSIDE), or you can name it
for the purpose for which it is created (for example, NO_NAT or VPN).

•

Typically, you identify the ip keyword for the protocol, but other protocols are accepted. For a list
of protocol names, see the “Protocols and Applications” section on page B-11.

•

You can specify the source and destination ports only for the TCP or UDP protocols. For a list of
permitted keywords and well-known port assignments, see the “TCP and UDP Ports” section on
page B-11. DNS, Discard, Echo, Ident, NTP, RPC, SUNRPC, and Talk each require one definition
for TCP and one for UDP. TACACS+ requires one definition for port 49 on TCP.

•

When you specify a network mask, the method is different from the Cisco IOS software access-list
command. The ASA uses a network mask (for example, 255.255.255.0 for a Class C mask). The
Cisco IOS mask uses wildcard bits (for example, 0.0.0.255).

Default Settings
Table 15-1 lists the default settings for extended access list parameters.
Table 15-1

Default Extended Access List Parameters

Parameters

Default

ACE logging

ACE logging generates system log message
106023 for denied packets. A deny ACE must be
present to log denied packets.

log

When the log keyword is specified, the default
level for system log message 106100 is 6
(informational), and the default interval is 300
seconds.

Configuring Extended Access Lists
This section shows how to add and delete an access control entry and access list, and it includes the
following topics:
•

Adding an Extended Access List, page 15-3

•

Adding Remarks to Access Lists, page 15-5

Cisco ASA 5500 Series Configuration Guide using the CLI

15-2

Chapter 15

Adding an Extended Access List
Configuring Extended Access Lists

Adding an Extended Access List
An access list is made up of one or more access control entries (ACEs) with the same access list ID. To
create an access list you start by creating an ACE and applying a list name. An access list with one entry
is still considered a list, although you can add multiple entries to the list.

Prerequisites
(Optional) Create an object or onject group according to the “Configuring Objects and Groups” section
on page 13-1.

Guidelines
To delete an ACE, enter the no access-list command with the entire command syntax string as it appears
in the configuration. To remove the entire access list, use the clear configure access-list command.

Cisco ASA 5500 Series Configuration Guide using the CLI

15-3

Chapter 15

Adding an Extended Access List

Configuring Extended Access Lists

Detailed Steps

Command

Purpose

(For IP traffic, no ports)

Adds an extended ACE.

access-list access_list_name [line
line_number] extended {deny | permit}
{protocol | object-group prot_grp_id}
{source_address mask | object nw_obj_id |
object-group nw_grp_id}
{dest_address mask | object nw_obj_id |
object-group nw_grp_id}
[log [[level] [interval secs] | disable |
default]]
[inactive | time-range time_range_name]

The line line_number option specifies the line number at which insert the
ACE. If you do not specify a line number, the ACE is added to the end of
the access list. The line number is not saved in the configuration; it only
specifies where to insert the ACE.

(For TCP or UDP traffic, with ports)
access-list access_list_name [line
line_number] extended {deny | permit}
{tcp | udp | object-group prot_grp_id}
{source_address mask | object nw_obj_id |
object-group nw_grp_id}
[operator port | object-group svc_grp_id]
{dest_address mask | object nw_obj_id |
object-group nw_grp_id}
[operator port | object-group svc_grp_id]
[log [[level] [interval secs] | disable |
default]]
[inactive | time-range time_range_name]

(For ICMP traffic)
access-list access_list_name [line
line_number] extended {deny | permit} icmp
{source_address mask | object nw_obj_id |
object-group nw_grp_id}
{dest_address mask | object nw_obj_id |
object-group nw_grp_id}
[icmp_type | object-group icmp_grp_id]
[log [[level] [interval secs] | disable |
default]] [inactive | time-range
time_range_name]

The deny keyword denies a packet if the conditions are matched. The
permit keyword permits a packet if the conditions are matched.
Instead of entering the protocol, IP address, or port directly in the
command, you can use network objects, or protocol, network, port, or
ICMP object groups using the object and object-group keyword. See
“Configuring Objects and Groups” section on page 13-1 for more
information about creating objects.
The protocol argument specifies the IP protocol name or number. For
example UDP is 17, TCP is 6, and EGP is 47.
The source_address specifies the IP address of the network or host from
which the packet is being sent. Enter the host keyword before the IP
address to specify a single address. In this case, do not enter a mask. Enter
the any keyword instead of the address and mask to specify any address.
For the TCP and UDP protocols only, the operator port option matches the
port numbers used by the source or destination. The permitted operators are
as follows:
•

lt—less than.

•

gt—greater than.

•

dq—equal to.

•

neq—not equal to.

•

range—an inclusive range of values. When you use this operator,
specify two port numbers, for example: range 100 200.

Example:

The dest_address argument specifies the IP address of the network or host
to which the packet is being sent. Enter the host keyword before the IP
address to specify a single address. In this case, do not enter a mask. Enter
the any keyword instead of the address and mask to specify any address.

hostname(config)# access-list ACL_IN
extended permit ip any any

The icmp_type argument specifies the ICMP type if the protocol is ICMP.
The time-range keyword specifies when an access list is activated. See the
“Scheduling Extended Access List Activation” section on page 13-16 for
more information.
The inactive keyword disables an ACE. To reenable it, enter the entire
ACE without the inactive keyword. This feature enables you to keep a
record of an inactive ACE in your configuration to make reenabling easier.
For the log keyword, see Chapter 20, “Configuring Logging for Access
Lists.”

Cisco ASA 5500 Series Configuration Guide using the CLI

15-4

Chapter 15

Adding an Extended Access List
Monitoring Extended Access Lists

Adding Remarks to Access Lists
You can include remarks about entries in any access list, including extended, EtherType, IPv6, standard,
and Webtype access lists. The remarks make the access list easier to understand.
To add a remark after the last access-list command you entered, enter the following command:
Command

Purpose

access-list access_list_name remark text

Adds a remark after the last access-list command you entered.
The text can be up to 100 characters in length. You can enter leading spaces
at the beginning of the text. Trailing spaces are ignored.

Example:
hostname(config)# access-list OUT remark this is the inside admin address

If you enter the remark before any access-list command, then the remark
is the first line in the access list.
If you delete an access list using the no access-list access_list_name
command, then all the remarks are also removed.

Example

You can add remarks before each ACE, and the remark appears in the access list in this location. Entering
a dash (-) at the beginning of the remark helps set it apart from the ACEs.
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list
access-list
access-list
access-list

OUT
OUT
OUT
OUT

remark extended
remark extended

this is the inside admin address
permit ip host 209.168.200.3 any
this is the hr admin address
permit ip host 209.168.200.4 any

Monitoring Extended Access Lists
To monitor extended access lists, enter one of the following commands:
Command

Purpose

show access list

Displays the access list entries by number.

show running-config access-list

Displays the current running access-list
configuration.

Configuration Examples for Extended Access Lists
This section includes the following topics:
•

Configuration Examples for Extended Access Lists (No Objects), page 15-6

•

Configuration Examples for Extended Access Lists (Using Objects), page 15-6

Cisco ASA 5500 Series Configuration Guide using the CLI

15-5

Chapter 15

Adding an Extended Access List

Configuration Examples for Extended Access Lists

Configuration Examples for Extended Access Lists (No Objects)
The following access list allows all hosts (on the interface to which you apply the access list) to go
through the ASAe:
hostname(config)# access-list ACL_IN extended permit ip any any

The following sample access list prevents hosts on 192.168.1.0/24 from accessing the 209.165.201.0/27
network. All other addresses are permitted.
hostname(config)# access-list ACL_IN extended deny tcp 192.168.1.0 255.255.255.0
209.165.201.0 255.255.255.224
hostname(config)# access-list ACL_IN extended permit ip any any

If you want to restrict access to selected hosts only, then enter a limited permit ACE. By default, all other
traffic is denied unless explicitly permitted.
hostname(config)# access-list ACL_IN extended permit ip 192.168.1.0 255.255.255.0
209.165.201.0 255.255.255.224

The following access list restricts all hosts (on the interface to which you apply the access list) from
accessing a website at address 209.165.201.29. All other traffic is allowed.
hostname(config)# access-list ACL_IN extended deny tcp any host 209.165.201.29 eq www
hostname(config)# access-list ACL_IN extended permit ip any any

The following access list that uses object groups restricts several hosts on the inside network from
accessing several web servers. All other traffic is allowed.
hostname(config-network)# access-list ACL_IN extended deny tcp object-group denied
object-group web eq www
hostname(config)# access-list ACL_IN extended permit ip any any
hostname(config)# access-group ACL_IN in interface inside

The following example temporarily disables an access list that permits traffic from one group of network
objects (A) to another group of network objects (B):
hostname(config)# access-list 104 permit ip host object-group A object-group B inactive

To implement a time-based access list, use the time-range command to define specific times of the day
and week. Then use the access-list extended command to bind the time range to an access list. The
following example binds an access list named “Sales” to a time range named “New_York_Minute.”
hostname(config)# access-list Sales line 1 extended deny tcp host 209.165.200.225 host
209.165.201.1 time-range New_York_Minute

Configuration Examples for Extended Access Lists (Using Objects)
The following normal access list that does not use object groups restricts several hosts on the inside
network from accessing several web servers. All other traffic is allowed.
hostname(config)#
eq www
hostname(config)#
eq www
hostname(config)#
eq www
hostname(config)#
eq www

access-list ACL_IN extended deny tcp host 10.1.1.4 host 209.165.201.29
access-list ACL_IN extended deny tcp host 10.1.1.78 host 209.165.201.29
access-list ACL_IN extended deny tcp host 10.1.1.89 host 209.165.201.29
access-list ACL_IN extended deny tcp host 10.1.1.4 host 209.165.201.16

Cisco ASA 5500 Series Configuration Guide using the CLI

15-6

Chapter 15

Adding an Extended Access List
Where to Go Next

hostname(config)#
eq www
hostname(config)#
eq www
hostname(config)#
eq www
hostname(config)#
eq www
hostname(config)#
eq www
hostname(config)#
hostname(config)#

access-list ACL_IN extended deny tcp host 10.1.1.78 host 209.165.201.16
access-list ACL_IN extended deny tcp host 10.1.1.89 host 209.165.201.16
access-list ACL_IN extended deny tcp host 10.1.1.4 host 209.165.201.78
access-list ACL_IN extended deny tcp host 10.1.1.78 host 209.165.201.78
access-list ACL_IN extended deny tcp host 10.1.1.89 host 209.165.201.78
access-list ACL_IN extended permit ip any any
access-group ACL_IN in interface inside

If you make two network object groups, one for the inside hosts, and one for the web servers, then the
configuration can be simplified and can be easily modified to add more hosts:
hostname(config)# object-group network denied
hostname(config-network)# network-object host 10.1.1.4
hostname(config-network)# network-object host 10.1.1.78
hostname(config-network)# network-object host 10.1.1.89
hostname(config-network)#
hostname(config-network)#
hostname(config-network)#
hostname(config-network)#

object-group network web
network-object host 209.165.201.29
network-object host 209.165.201.16
network-object host 209.165.201.78

hostname(config-network)# access-list ACL_IN extended deny tcp port object-group denied
object-group web eq www
hostname(config)# access-list ACL_IN extended permit ip any any
hostname(config)# access-group ACL_IN in interface inside

Where to Go Next
Apply the access list to an interface. See the “Configuring Access Rules” section on page 34-7 for more
information.

Feature History for Extended Access Lists
Table 15-2 lists each feature change and the platform release in which it was implemented.
Table 15-2

Feature History for Extended Access Lists

Feature Name

Releases

Feature Information

Extended access lists

7.0(1)

Access lists are used to control network access or to specify
traffic for many features to act upon. An extended access
control list is made up of one or more access control entries
(ACE) in which you can specify the line number to insert
the ACE, the source and destination addresses, and,
depending upon the ACE type, the protocol, the ports (for
TCP or UDP), or the IPCMP type (for ICMP).
We introduced the following command: access-list
extended.

Cisco ASA 5500 Series Configuration Guide using the CLI

15-7

Chapter 15
Feature History for Extended Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

15-8

Adding an Extended Access List

CH A P T E R

16

Adding an EtherType Access List
This chapter describes how to configure EtherType access lists and includes the following sections:
•

Information About EtherType Access Lists, page 16-1

•

Licensing Requirements for EtherType Access Lists, page 16-1

•

Guidelines and Limitations, page 16-2

•

Default Settings, page 16-2

•

Configuring EtherType Access Lists, page 16-2

•

Monitoring EtherType Access Lists, page 16-4

•

What to Do Next, page 16-4

•

Configuration Examples for EtherType Access Lists, page 16-5

•

Feature History for EtherType Access Lists, page 16-5

Information About EtherType Access Lists
An EtherType access list is made up of one or more Access Control Entries (ACEs) that specify an
EtherType. An EtherType rule controls any EtherType identified by a 16-bit hexadecimal number, as well
as other traffic types. See the “Supported EtherTypes and Other Traffic” section on page 34-6 for more
information.
For information about creating an access rule with the EtherType access list, see Chapter 34,
“Configuring Access Rules.”

Licensing Requirements for EtherType Access Lists
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

16-1

Chapter 16

Adding an EtherType Access List

Guidelines and Limitations

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Available in single and multiple context modes.
Firewall Mode Guidelines

Supported in transparent firewall mode only.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines and Limitations

The following guidelines and limitations apply to EtherType access lists:
•

For EtherType access lists, the implicit deny at the end of the access list does not affect IP traffic or
ARPs; for example, if you allow EtherType 8037, the implicit deny at the end of the access list does
not now block any IP traffic that you previously allowed with an extended access list (or implicitly
allowed from a high security interface to a low security interface). However, if you explicitly deny
all traffic with an EtherType ACE, then IP and ARP traffic is denied.

•

802.3-formatted frames are not handled by the access list because they use a length field as opposed
to a type field.

•

See the “Supported EtherTypes and Other Traffic” section on page 34-6 for more information about
supported traffic.

Default Settings
Access list logging generates system log message 106023 for denied packets. Deny packets must be
present to log denied packets.
When you configure logging for the access list, the default severity level for system log message 106100
is 6 (informational).

Configuring EtherType Access Lists
This section includes the following topics:
•

Task Flow for Configuring EtherType Access Lists, page 16-2

•

Adding EtherType Access Lists, page 16-3

•

Adding Remarks to Access Lists, page 16-4

Task Flow for Configuring EtherType Access Lists
Use the following guidelines to create and implement an access list:

Cisco ASA 5500 Series Configuration Guide using the CLI

16-2

Chapter 16

Adding an EtherType Access List
Configuring EtherType Access Lists

Step 1

Create an access list by adding an ACE and applying an access list name, as shown in the “Adding
EtherType Access Lists” section on page 16-3.

Step 2

Apply the access list to an interface. (See the “Configuring Access Rules” section on page 34-7 for more
information.)

Adding EtherType Access Lists
To configure an access list that controls traffic based upon its EtherType, perform the following steps:

Detailed Steps

Command

Purpose

access-list access_list_name ethertype
{deny | permit} {ipx | bpdu | mpls-unicast
| mpls-multicast | is-is | any |
hex_number}

Adds an EtherType ACE.

Example:
hostname(config)# hostname(config)#
access-list ETHER ethertype permit ipx

The access_list_name argument lists the name or number of an access list.
When you specify an access list name, the ACE is added to the end of the
access list. Enter the access_list_name in upper case letters so that the
name is easy to see in the configuration. You might want to name the access
list for the interface (for example, INSIDE) or for the purpose (for
example, MPLS or PIX).
The permit keyword permits access if the conditions are matched.
The deny keyword denies access if the conditions are matched. If an
EtherType access list is configured to deny all, all ethernet frames are
discarded. Only physical protocol traffic, such as auto-negotiation, is still
allowed.
The ipx keyword specifies access to IPX.
The bpdu keyword specifies access to bridge protocol data units, which are
allowed by default.
The mpls-unicast keyword specifies access to MPLS unicast.
The mpls-multicast keyword specifies access to MPLS multicast.
The is-is keyword specifies access to IS-IS traffic (Version 8.4(5) only).
The any keyword specifies access for any traffic.
The hex_number argument indicates any EtherType that can be identified
by a 16-bit hexadecimal number greater than or equal to 0x600. (See RFC
1700, “Assigned Numbers,” at http://www.ietf.org/rfc/rfc1700.txt for a list
of EtherTypes.)

Note

To remove an EtherType ACE, enter the no access-list command
with the entire command syntax string as it appears in the
configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

16-3

Chapter 16

Adding an EtherType Access List

What to Do Next

Example
The following sample access list allows common EtherTypes originating on the inside interface:
hostname(config)# access-list ETHER ethertype permit ipx
hostname(config)# access-list ETHER ethertype permit mpls-unicast
hostname(config)# access-group ETHER in interface inside

Adding Remarks to Access Lists
You can include remarks about entries in any access list, including extended, EtherType, IPv6, standard,
and Webtype access lists. The remarks make an access list easier to understand.
To add a remark after the last access-list command you entered, enter the following command:
Command

Purpose

access-list access_list_name remark text

Adds a remark after the last access-list command you entered.

Example:

The text can be up to 100 characters in length. You can enter leading spaces
at the beginning of the text. Trailing spaces are ignored.

hostname(config)# access-list OUT remark this is the inside admin address

If you enter the remark before any access-list command, then the remark
is the first line in the access list.
If you delete an access list using the no access-list access_list_name
command, then all remarks are also removed.

Example
You can add remarks before each ACE, and the remarks appear in the access list in these locations.
Entering a dash (-) at the beginning of a remark helps to set it apart from the ACE.
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list
access-list
access-list
access-list

OUT
OUT
OUT
OUT

remark extended
remark extended

this is the inside admin address
permit ip host 209.168.200.3 any
this is the hr admin address
permit ip host 209.168.200.4 any

What to Do Next
Apply the access list to an interface. (See the “Configuring Access Rules” section on page 34-7 for more
information.)

Monitoring EtherType Access Lists
To monitor EtherType access lists, enter one of the following commands:
Command

Purpose

show access-list

Displays the access list entries by number.

show running-config access-list

Displays the current running access-list
configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

16-4

Chapter 16

Adding an EtherType Access List
Configuration Examples for EtherType Access Lists

Configuration Examples for EtherType Access Lists
The following example shows how to configure EtherType access lists:
The following access list allows some EtherTypes through the ASA, but it denies IPX:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list ETHER ethertype deny ipx
access-list ETHER ethertype permit 0x1234
access-list ETHER ethertype permit mpls-unicast
access-group ETHER in interface inside
access-group ETHER in interface outside

The following access list denies traffic with EtherType 0x1256, but it allows all others on both interfaces:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list nonIP ethertype deny 1256
access-list nonIP ethertype permit any
access-group ETHER in interface inside
access-group ETHER in interface outside

Feature History for EtherType Access Lists
Table 16-1 lists each feature change and the platform release in which it was implemented.
Table 16-1

Feature History for EtherType Access Lists

Feature Name

Releases

Feature Information

EtherType access lists

7.0(1)

EtherType access lists control traffic based upon its
EtherType.
We introduced the feature and the following command:
access-list ethertype.

Cisco ASA 5500 Series Configuration Guide using the CLI

16-5

Chapter 16
Feature History for EtherType Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

16-6

Adding an EtherType Access List

CH A P T E R

17

Adding a Standard Access List
This chapter describes how to configure a standard access list and includes the following sections:
•

Information About Standard Access Lists, page 17-1

•

Licensing Requirements for Standard Access Lists, page 17-1

•

Guidelines and Limitations, page 17-1

•

Default Settings, page 17-2

•

Adding Standard Access Lists, page 17-3

•

What to Do Next, page 17-4

•

Monitoring Access Lists, page 17-4

•

Configuration Examples for Standard Access Lists, page 17-4

•

Feature History for Standard Access Lists, page 17-5

Information About Standard Access Lists
Standard access lists identify the destination IP addresses of OSPF routes and can be used in a route map
for OSPF redistribution. Standard access lists cannot be applied to interfaces to control traffic.

Licensing Requirements for Standard Access Lists
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature:
•

Context Mode Guidelines, page 17-2

•

Firewall Mode Guidelines, page 17-2

Cisco ASA 5500 Series Configuration Guide using the CLI

17-1

Chapter 17

Adding a Standard Access List

Default Settings

•

IPv6 Guidelines, page 17-2

•

Additional Guidelines and Limitations, page 17-2

Context Mode Guidelines

Supported in single context mode only.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines and Limitations

The following guidelines and limitations apply for standard Access Lists:
•

Standard ACLs identify the destination IP addresses (not source addresses) of OSPF routes and can
be used in a route map for OSPF redistribution. Standard ACLs cannot be applied to interfaces to
control traffic.

•

To add additional ACEs at the end of the access list, enter another access-list command, specifying
the same access list name.

•

When used with the access-group command, the deny keyword does not allow a packet to traverse
the ASA. By default, the ASA denies all packets on the originating interface unless you specifically
permit access.

•

When specifying a source, local, or destination address, use the following guidelines:
– Use a 32-bit quantity in four-part, dotted-decimal format.
– Use the keyword any as an abbreviation for an address and mask of 0.0.0.0.0.0.0.0.
– Use the host ip_address option as an abbreviation for a mask of 255.255.255.255.

•

You can disable an ACE by specifying the keyword inactive in the access-list command.

Default Settings
Table 17-1 lists the default settings for standard Access List parameters.
Table 17-1

Default Standard Access List Parameters

Parameters

Default

deny

The ASA denies all packets on the originating
interface unless you specifically permit access.
Access list logging generates system log message
106023 for denied packets. Deny packets must be
present to log denied packets.

Cisco ASA 5500 Series Configuration Guide using the CLI

17-2

Chapter 17

Adding a Standard Access List
Adding Standard Access Lists

Adding Standard Access Lists
This section includes the following topics:
•

Task Flow for Configuring Extended Access Lists, page 17-3

•

Adding a Standard Access List, page 17-3Adding Remarks to Access Lists, page 17-4

Task Flow for Configuring Extended Access Lists
Use the following guidelines to create and implement an access list:
•

Create an access list by adding an ACE and applying an access list name. See in the “Adding
Standard Access Lists” section on page 17-3.

•

Apply the access list to an interface. See the “Configuring Access Rules” section on page 34-7 for
more information.

Adding a Standard Access List
To add an access list to identify the destination IP addresses of OSPF routes, which can be used in a route
map for OSPF redistribution, enter the following command:
Command

Purpose

hostname(config)# access-list
access_list_name standard {deny | permit}
{any | ip_address mask}

Adds a standard access list entry. To add another ACE to the end of the
access list, enter another access-list command, specifying the same access
list name.

Example:

The access_list_name argument specifies the name of number of an access
list.

hostname(config)# access-list OSPF
standard permit 192.168.1.0 255.255.255.0

The any keyword specifies access to anyone.
The deny keyword denies access if the conditions are matched.
The host ip_address syntax specifies access to a host IP address.
The ip_address ip_mask argument specifies access to a specific IP address
and subnet mask.
The line line-num option specifies the line number at which to insert an
ACE.
The permit keyword permits access if the conditions are matched.
To remove an ACE, enter the no access-list command with the entire
command syntax string as it appears in the configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

17-3

Chapter 17

Adding a Standard Access List

What to Do Next

Adding Remarks to Access Lists
You can include remarks about entries in any access list, including extended, EtherType, IPv6, standard,
and Webtype access lists. The remarks make the access list easier to understand.
To add a remark after the last access-list command you entered, enter the following command:
Command

Purpose

access-list access_list_name remark text

Adds a remark after the last access-list command you entered.

Example:

The text can be up to 100 characters in length. You can enter leading spaces
at the beginning of the text. Trailing spaces are ignored.

hostname(config)# access-list OUT remark this is the inside admin address

If you enter the remark before any access-list command, then the remark
is the first line in the access list.
If you delete an access list using the no access-list access_list_name
command, then all the remarks are also removed.

Example
You can add a remark before each ACE, and the remarks appear in the access lists in these location.
Entering a dash (-) at the beginning of a remark helps to set it apart from an ACE.
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list
access-list
access-list
access-list

OUT
OUT
OUT
OUT

remark extended
remark extended

this is the inside admin address
permit ip host 209.168.200.3 any
this is the hr admin address
permit ip host 209.168.200.4 any

What to Do Next
Apply the access list to an interface. See the “Configuring Access Rules” section on page 34-7 for more
information.

Monitoring Access Lists
To monitor access lists, perform one of the following tasks:
Command

Purpose

show access-list

Displays the access list entries by number.

show running-config access-list

Displays the current running access-list
configuration.

Configuration Examples for Standard Access Lists
The following example shows how to deny IP traffic through the ASA:
hostname(config)# access-list 77 standard deny

Cisco ASA 5500 Series Configuration Guide using the CLI

17-4

Chapter 17

Adding a Standard Access List
Feature History for Standard Access Lists

The following example shows how to permit IP traffic through the ASA if conditions are matched:
hostname(config)# access-list 77 standard permit

The following example shows how to specify a destination address:
hostname(config)# access-list 77 standard permit host 10.1.10.123

Feature History for Standard Access Lists
Table 17-2 lists each feature change and the platform release in which it was implemented.
Table 17-2

Feature History for Standard Access Lists

Feature Name

Releases

Feature Information

Standard access lists

7.0(1)

Standard access listsidentify the destination IP addresses of
OSPF routes, which can be used in a route map for OSPF
redistribution.
We introduced the feature and the following command:
access-list standard.

Cisco ASA 5500 Series Configuration Guide using the CLI

17-5

Chapter 17
Feature History for Standard Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

17-6

Adding a Standard Access List

CH A P T E R

18

Adding a Webtype Access List
Webtype access lists are added to a configuration that supports filtering for clientless SSL VPN. This
chapter describes how to add an access list to the configuration that supports filtering for WebVPN.
This chapter includes the following sections:
•

Licensing Requirements for Webtype Access Lists, page 18-1

•

Guidelines and Limitations, page 18-1

•

Default Settings, page 18-2

•

Using Webtype Access Lists, page 18-2

•

What to Do Next, page 18-5

•

Monitoring Webtype Access Lists, page 18-5

•

Configuration Examples for Webtype Access Lists, page 18-5

•

Feature History for Webtype Access Lists, page 18-7

Licensing Requirements for Webtype Access Lists
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature:
•

Context Mode Guidelines, page 18-1

•

Firewall Mode Guidelines, page 18-2

•

Additional Guidelines and Limitations, page 18-2

Context Mode Guidelines

Supported in single and multiple context mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

18-1

Chapter 18

Adding a Webtype Access List

Default Settings

Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines and Limitations

The following guidelines and limitations apply to Webtype access lists:
•

The access-list webtype command is used to configure clientless SSL VPN filtering. The URL
specified may be full or partial (no file specified), may include wildcards for the server, or may
specify a port. See the “Adding Webtype Access Lists with a URL String” section on page 18-3 for
information about using wildcard characters in the URL string.

•

Valid protocol identifiers are http, https, cifs, imap4, pop3, and smtp. The RL may also contain the
keyword any to refer to any URL. An asterisk may be used to refer to a subcomponent of a DNS
name.

Default Settings
Table 18-1 lists the default settings for Webtype access lists parameters.
Table 18-1

Default Webtype Access List Parameters

Parameters

Default

deny

The ASA denies all packets on the originating
interface unless you specifically permit access.

log

Access list logging generates system log message
106023 for denied packets. Deny packets must be
present to log denied packets.

Using Webtype Access Lists
This section includes the following topics:
•

Task Flow for Configuring Webtype Access Lists, page 18-2

•

Adding Webtype Access Lists with a URL String, page 18-3

•

Adding Webtype Access Lists with an IP Address, page 18-4

•

Adding Remarks to Access Lists, page 18-5

Task Flow for Configuring Webtype Access Lists
Use the following guidelines to create and implement an access list:
•

Create an access list by adding an ACE and applying an access list name. See the “Using Webtype
Access Lists” section on page 18-2.

•

Apply the access list to an interface. See the “Configuring Access Rules” section on page 34-7 for
more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

18-2

Chapter 18

Adding a Webtype Access List
Using Webtype Access Lists

Adding Webtype Access Lists with a URL String
To add an access list to the configuration that supports filtering for clientless SSL VPN, enter the following command:

Command

Purpose

access-list access_list_name webtype {deny
| permit} url [url_string | any]
[log[[disable | default] | level] interval
secs][time_range name]]

Adds an access list to the configuration that supports filtering for
WebVPN.

Example:

The any keyword specifies all URLs.

hostname(config)# access-list acl_company
webtype deny url http://*.cisco.example

The deny keyword denies access if the conditions are matched.

The access_list_name argument specifies the name or number of an access
list.

The interval option specifies the time interval at which to generate system
log message 106100; valid values are from 1 to 600 seconds.
The log [[disable | default] | level] option specifies that system log
message 106100 is generated for the ACE. When the log optional keyword
is specified, the default level for system log message 106100 is 6
(informational). See the log command for more information.
The permit keyword permits access if the conditions are matched.
The time_range name option specifies a keyword for attaching the
time-range option to this access list element.
The url keyword specifies that a URL be used for filtering.
The url_string option specifies the URL to be filtered.
You can use the following wildcard characters to define more than one
wildcard in the Webtype access list entry:
•

Enter an asterisk “*” to match no characters or any number of
characters.

•

Enter a question mark “?” to match any one character exactly.

•

Enter square brackets “[]” to create a range operator that matches any
one character in a range.

Note

To match any http URL, you must enter http://*/* instead of the
former method of entering http://*.

To remove an access list, use the no form of this command with the
complete syntax string as it appears in the configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

18-3

Chapter 18

Adding a Webtype Access List

Using Webtype Access Lists

Adding Webtype Access Lists with an IP Address
To add an access list to the configuration that supports filtering for clientless SSL VPN, enter the following command:

Command

Purpose

access-list access_list_name webtype {deny
| permit} tcp [host ip_address |
ip_address subnet_mask | any] [oper
port[port]] [log[[disable | default] |
level] interval secs][time_range name]]

Adds an access list to the configuration that supports filtering for
WebVPN.
The access_list_name argument specifies the name or number of an access
list.
The any keyword specifies all IP addresses.

Example:
hostname(config)# access-list acl_company
webtype permit tcp any

The deny keyword denies access if the conditions are matched.
The host ip_address option specifies a host IP address.
The interval option specifies the time interval at which to generate system
log message 106100; valid values are from 1 to 600 seconds.
The ip_address ip_mask option specifies a specific IP address and subnet
mask.
The log [[disable | default]| level] option specifies that system log message
106100 is generated for the ACE. When the log optional keyword is
specified, the default level for system log message 106100 is 6
(informational). See the log command for more information.
The permit keyword permits access if the conditions are matched.
The port option specifies the decimal number or name of a TCP or UDP
port.
The time_range name option specifies a keyword for attaching the
time-range option to this access list element.
To remove an access list, use the no form of this command with the
complete syntax string as it appears in the configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

18-4

Chapter 18

Adding a Webtype Access List
What to Do Next

Adding Remarks to Access Lists
You can include remarks about entries in any access list, including extended, EtherType, IPv6, standard,
and Webtype access lists. The remarks make the access list easier to understand.
To add a remark after the last access-list command you entered, enter the following command:
Command

Purpose

access-list access_list_name remark text

Adds a remark after the last access-list command you entered.

Example:

The text can be up to 100 characters in length. You can enter leading spaces
at the beginning of the text. Trailing spaces are ignored.

hostname(config)# access-list OUT remark this is the inside admin address

If you enter the remark before any access-list command, then the remark
is the first line in the access list.
If you delete an access list using the no access-list access_list_name
command, then all the remarks are also removed.

Example
You can add a remark before each ACE, and the remarks appear in the access list in these locations.
Entering a dash (-) at the beginning of a remark helps set it apart from an ACE.
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list
access-list
access-list
access-list

OUT
OUT
OUT
OUT

remark extended
remark extended

this is the inside admin address
permit ip host 209.168.200.3 any
this is the hr admin address
permit ip host 209.168.200.4 any

What to Do Next
Apply the access list to an interface. See the “Configuring Access Rules” section on page 34-7 for more
information.

Monitoring Webtype Access Lists
To monitor webtype access lists, enter the following command:
Command

Purpose

show running-config access list

Displays the access-list configuration running on
the ASA.

Configuration Examples for Webtype Access Lists
The following example shows how to deny access to a specific company URL:
hostname(config)# access-list acl_company webtype deny url http://*.example.com

Cisco ASA 5500 Series Configuration Guide using the CLI

18-5

Chapter 18

Adding a Webtype Access List

Configuration Examples for Webtype Access Lists

The following example shows how to deny access to a specific file:
hostname(config)# access-list acl_file webtype deny url
https://www.example.com/dir/file.html

The following example shows how to deny HTTP access to any URL through port 8080:
hostname(config)# access-list acl_company webtype deny url http://my-server:8080/*

The following examples show how to use wildcards in Webtype access lists.
•

The following example matches URLs such as http://www.example.com/ and
http://www.example.net/:
access-list test webtype permit url http://www.**ample/

•

The following example matches URLs such as http://www.cisco.com and ftp://wwz.example.com:
access-list test webtype permit url *://ww?.c*co*/

•

The following example matches URLs such as http://www.cisco.com:80 and
https://www.cisco.com:81:
access-list test webtype permit url *://ww?.c*co*:8[01]/

The range operator “[]” in the preceding example specifies that either character 0 or 1 can occur.
•

The following example matches URLs such as http://www.example.com and
http://www.example.net:
access-list test webtype permit url http://www.[a-z]ample?*/

The range operator “[]” in the preceding example specifies that any character in the range from a to
z can occur.
•

The following example matches URLs such as http://www.cisco.com/anything/crazy/url/ddtscgiz:
access-list test webtype permit url htt*://*/*cgi?*

Note

To match any http URL, you must enter http://*/* instead of the former method of entering http://*.
The following example shows how to enforce a webtype access list to disable access to specific CIFS
shares.
In this scenario we have a root folder named “shares” that contains two sub-folders named
“Marketing_Reports” and “Sales_Reports.” We want to specifically deny access to the
“shares/Marketing_Reports” folder.
access-list CIFS_Avoid webtype deny url cifs://172.16.10.40/shares/Marketing_Reports.

However, due to the implicit “deny all,” the above access list makes all of the sub-folders inaccessible
(“shares/Sales_Reports” and “shares/Marketing_Reports”), including the root folder (“shares”).
To fix the problem, add a new access list to allow access to the root folder and the remaining sub-folders:
access-list CIFS_Allow webtype permit url cifs://172.16.10.40/shares*

Cisco ASA 5500 Series Configuration Guide using the CLI

18-6

Chapter 18

Adding a Webtype Access List
Feature History for Webtype Access Lists

Feature History for Webtype Access Lists
Table 18-2 lists each feature change and the platform release in which it was implemented.
Table 18-2

Feature History for Webtype Access Lists

Feature Name

Releases

Feature Information

Webtype access lists

7.0(1)

Webtype access lists are access lists that are added to a
configuration that supports filtering for clientless SSL
VPN.
We introduced the feature and the following command:
access-list webtype.

Cisco ASA 5500 Series Configuration Guide using the CLI

18-7

Chapter 18
Feature History for Webtype Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

18-8

Adding a Webtype Access List

Chapter 18

Adding a Webtype Access List
Feature History for Webtype Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

18-9

Chapter 18
Feature History for Webtype Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

18-10

Adding a Webtype Access List

CH A P T E R

19

Adding an IPv6 Access List
This chapter describes how to configure IPv6 access lists to control and filter traffic through the ASA.
This chapter includes the following sections:
•

Information About IPv6 Access Lists, page 19-1

•

Licensing Requirements for IPv6 Access Lists, page 19-1

•

Prerequisites for Adding IPv6 Access Lists, page 19-2

•

Guidelines and Limitations, page 19-2

•

Default Settings, page 19-3

•

Configuring IPv6 Access Lists, page 19-4

•

Monitoring IPv6 Access Lists, page 19-7

•

Configuration Examples for IPv6 Access Lists, page 19-7

•

Where to Go Next, page 19-7

•

Feature History for IPv6 Access Lists, page 19-7

Information About IPv6 Access Lists
The typical access list functionality in IPv6 is similar to access lists in IPv4. Access lists determine
which traffic to block and which traffic to forward at router interfaces. Access lists allow filtering based
upon source and destination addresses, inbound and outbound to specific interfaces. Each access list has
an implicit deny statement at the end. You define IPv6 access lists and set their deny and permit
conditions using the ipv6 access-list command with the deny and permit keywords in global
configuration mode.

Licensing Requirements for IPv6 Access Lists
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

19-1

Chapter 19

Adding an IPv6 Access List

Prerequisites for Adding IPv6 Access Lists

Prerequisites for Adding IPv6 Access Lists
You should be familiar with IPv6 addressing and basic configuration. See the ipv6 commands in the
Cisco Security Appliance Command Reference for more information about configuring IPv6.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context modes.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines and Limitations

The following guidelines and limitations apply to IPv6 access lists:
•

The ipv6 access-list command allows you to specify whether an IPv6 address is permitted or denied
access to a port or protocol. Each command is called an ACE. One or more ACEs with the same
access list name are referred to as an access list. Apply an access list to an interface using the
access-group command.

•

The ASA denies all packets from an outside interface to an inside interface unless you specifically
permit access using an access list. All packets are allowed by default from an inside interface to an
outside interface unless you specifically deny access.

•

The ipv6 access-list command is similar to the access-list command, except that it is IPv6-specific.
For additional information about access lists, refer to the access-list extended command.

•

The ipv6 access-list icmp command is used to filter ICMPv6 messages that pass through the
ASA.To configure the ICMPv6 traffic that is allowed to originate and terminate at a specific
interface, use the ipv6 icmp command.

•

See the object-group command for information on how to configure object groups.

•

Possible operands for the operator option of the ipv6 access-list command include lt for less than,
gt for greater than, eq for equal to, neq for not equal to, and range for an inclusive range. Use the
ipv6 access-list command without an operator and port to indicate all ports by default.

•

ICMP message types are filtered by the access rule. Omitting the icmp_type argument indicates all
ICMP types. If you specify ICMP types, the value can be a valid ICMP type number (from 0 to 255)
or one of the following ICMP type literals:
– destination-unreachable
– packet-too-big
– time-exceeded
– parameter-problem
– echo-request

Cisco ASA 5500 Series Configuration Guide using the CLI

19-2

Chapter 19

Adding an IPv6 Access List
Default Settings

– echo-reply
– membership-query
– membership-report
– membership-reduction
– router-renumbering
– router-solicitation
– router-advertisement
– neighbor-solicitation
– neighbor-advertisement
– neighbor-redirect
•

If the protocol argument is specified, valid values are icmp, ip, tcp, udp, or an integer in the range
of 1 to 254, representing an IP protocol number.

Default Settings
Table 19-1 lists the default settings for IPv6 access list parameters.
Table 19-1

Default IPv6 Access List Parameters

Parameters

Default

default

The default option specifies that a syslog message
106100 is generated for the ACE.

interval secs

Specifies the time interval at which to generate a
106100 syslog message; valid values are from 1 to
600 seconds. The default interval is 300 seconds.
This value is also used as the timeout value for
deleting an inactive flow.

level

The level option specifies the syslog level for
message 106100; valid values are from 0 to 7. The
default level is 6 (informational).

log

The log option specifies logging action for the
ACE. If you do not specify the log keyword or you
specify the log default keyword, then message
106023 is generated when a packet is denied by the
ACE. If you specify the log keyword alone or with
a level or interval, then message 106100 is
generated when a packet is denied by the ACE.
Packets that are denied by the implicit deny at the
end of an access list are not logged. You must
implicitly deny packets with an ACE to enable
logging.

Cisco ASA 5500 Series Configuration Guide using the CLI

19-3

Chapter 19

Adding an IPv6 Access List

Configuring IPv6 Access Lists

Configuring IPv6 Access Lists
This section includes the following topics:
•

Task Flow for Configuring IPv6 Access Lists, page 19-4

•

Adding IPv6 Access Lists, page 19-5

•

Adding Remarks to Access Lists, page 19-6

Task Flow for Configuring IPv6 Access Lists
Use the following guidelines to create and implement an access list:
•

Create an access list by adding an ACE and applying an access list name, as shown in the “Adding
IPv6 Access Lists” section on page 19-5.

•

Apply the access list to an interface. (See the “Configuring Access Rules” section on page 34-7 for
more information.)

Cisco ASA 5500 Series Configuration Guide using the CLI

19-4

Chapter 19

Adding an IPv6 Access List
Configuring IPv6 Access Lists

Adding IPv6 Access Lists
You can add a regular IPv6 access list or add an IPv6 access list with TCP.
To add a regular IPv6 access list, enter the following command:
Command

Purpose

ipv6 access-list id [line line-num] {deny
| permit} {protocol | object-group
protocol_obj_grp_id}
{source-ipv6-prefix/prefix-length | any |
host source-ipv6-address | object-group
network_obj_grp_id} [operator {port [port]
| object-group service_obj_grp_id}]
{destination-ipv6-prefix/prefix-length |
any | host destination-ipv6-address |
object-group network_obj_grp_id}
[{operator port [port] | object-group
service_obj_grp_id}] [log [[level]
[interval secs] | disable | default]]

Configures an IPv6 access list.
The any keyword is an abbreviation for the IPv6 prefix ::/0, indicating any
IPv6 address.
The deny keyword denies access if the conditions are matched.
The destination-ipv6-address argument identifies the IPv6 address of the
host receiving the traffic.
The destination-ipv6-prefix argument identifies the IPv6 network address
where the traffic is destined.
The disable option disables syslog messaging.
The host keyword indicates that the address refers to a specific host.

Example:
hostname(config)# ipv6 access-list acl_grp
permit tcp any host
3001:1::203:A0FF:FED6:162D

The id keyword specifies the number of an access list.
The line line-num option specifies the line number for inserting the access
rule into the list. By default, the ACE is added to the end of the access list.
The network_obj_grp_id argument specifies existing network object group
identification.
The object-group option specifies an object group.
The operator option compares the source IP address or destination IP
address ports. For a list of permitted operands, see the “Guidelines and
Limitations” section on page 19-2.
The permit keyword permits access if the conditions are matched.
The port option specifies the port that you permit or deny access. You can
specify the port either by a number in the range of 0 to 65535 or by a literal
name if the protocol is tcp or udp. For a list of permitted TCP or UDP
literal names, see the “Guidelines and Limitations” section on page 19-2.
The prefix-length argument indicates how many of the high-order,
contiguous bits of the address comprise the IPv6 prefix.
The protocol argument specifies the name or number of an IP protocol.
The protocol_obj_grp_id indicates the existing protocol object group ID.
The service_obj_grp_id option specifies the object group.
The source-ipv6-address specifies the address of the host sending traffic.
The source-ipv6-prefix specifies the IPv6 address of traffic origin.

Cisco ASA 5500 Series Configuration Guide using the CLI

19-5

Chapter 19

Adding an IPv6 Access List

Configuring IPv6 Access Lists

To configure an IPv6 access list with ICMP, enter the following command:
Command

Purpose

ipv6 access-list id [line line-num] {deny
| permit} icmp6
{source-ipv6-prefix/prefix-length | any |
host source-ipv6-address | object-group
network_obj_grp_id}
{destination-ipv6-prefix/prefix-length |
any | host destination-ipv6-address |
object-group network_obj_grp_id}
[icmp_type | object-group
icmp_type_obj_grp_id] [log [[level]
[interval secs] | disable | default]]

Configures an IPv6 access list with ICMP.

Example:

For details about additional ipv6 access-list command parameters, see the
preceding procedure for adding a regular IPv6 access list, or see the
ipv6 access-list command in the Cisco Security Appliance Command
Reference.

hostname(config)# ipv6 access list acl_grp
permit tcp any host
3001:1::203:AOFF:FED6:162D

The icmp6 keyword specifies that the access rule applies to ICMPv6 traffic
passing through the ASA.
The icmp_type argument specifies the ICMP message type being filtered by
the access rule. The value can be a valid ICMP type number from 0 to 255.
(For a list of the permitted ICMP type literals, see the “Guidelines and
Limitations” section on page 19-2.)
The icmp_type_obj_grp_id option specifies the object group ICMP type
ID.

Adding Remarks to Access Lists
You can include remarks about entries in any access list, including extended, EtherType, IPv6, standard,
and Webtype access lists. The remarks make the access list easier to understand.
To add a remark after the last access-list command you entered, enter the following command:
Command

Purpose

access-list access_list_name remark text

Adds a remark after the last access-list command you entered.

Example:

The text can be up to 100 characters in length. You can enter leading spaces
at the beginning of the text. Trailing spaces are ignored.

hostname(config)# access-list OUT remark this is the inside admin address

If you enter the remark before any access-list command, then the remark
is the first line in the access list.
If you delete an access list using the no access-list access_list_name
command, then all the remarks are also removed.

Example

You can add remarks before each ACE, and the remarks appear in the access list in these locations.
Entering a dash (-) at the beginning of a remark helps set it apart from an ACE.
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list
access-list
access-list
access-list

OUT
OUT
OUT
OUT

Cisco ASA 5500 Series Configuration Guide using the CLI

19-6

remark extended
remark extended

this is the inside admin address
permit ip host 209.168.200.3 any
this is the hr admin address
permit ip host 209.168.200.4 any

Chapter 19

Adding an IPv6 Access List
Monitoring IPv6 Access Lists

Monitoring IPv6 Access Lists
To monitor IPv6 access lists, perform one of the following tasks:
Command

Purpose

show ipv6 access-list

Displays all IPv6 access list information.

Configuration Examples for IPv6 Access Lists
The following example shows how to configure IPv6 access lists:
The following example allows any host using TCP to access the 3001:1::203:A0FF:FED6:162D server:
hostname(config)# ipv6 access-list acl_grp permit tcp any host 3001:1::203:A0FF:FED6:162D

The following example uses eq and a port to deny access to just FTP:
hostname(config)# ipv6 access-list acl_out deny tcp any host 3001:1::203:A0FF:FED6:162D eq
ftp
hostname(config)# access-group acl_out in interface inside

The following example uses lt to permit access to all ports less than port 2025, which permits access to
the well-known ports (1 to 1024):
hostname(config)# ipv6 access-list acl_dmz1 permit tcp any host 3001:1::203:A0FF:FED6:162D
lt 1025
hostname(config)# access-group acl_dmz1 in interface dmz1

Where to Go Next
Apply the access list to an interface. (See the “Configuring Access Rules” section on page 34-7 for more
information.)

Feature History for IPv6 Access Lists
Table 19-2 lists each feature change and the platform release in which it was implemented.
Table 19-2

Feature History for IPv6 Access Lists

Feature Name

Releases

Feature Information

IPv6 access lists

7.0(1)

We introduced the following command: ipv6 access-list.

Cisco ASA 5500 Series Configuration Guide using the CLI

19-7

Chapter 19
Feature History for IPv6 Access Lists

Cisco ASA 5500 Series Configuration Guide using the CLI

19-8

Adding an IPv6 Access List

CH A P T E R

20

Configuring Logging for Access Lists
This chapter describes how to configure access list logging for extended access lists and Webytpe access
lists, and it describes how to manage deny flows.
This chapter includes the following sections:
•

Configuring Logging for Access Lists, page 20-1

•

Managing Deny Flows, page 20-5

Configuring Logging for Access Lists
This section includes the following topics:
•

Information About Logging Access List Activity, page 20-1

•

Licensing Requirements for Access List Logging, page 20-2

•

Guidelines and Limitations, page 20-2

•

Default Settings, page 20-3

•

Configuring Access List Logging, page 20-3

•

Monitoring Access Lists, page 20-4

•

Configuration Examples for Access List Logging, page 20-4

•

Feature History for Access List Logging, page 20-5

Information About Logging Access List Activity
By default, when traffic is denied by an extended ACE or a Webtype ACE, the ASA generates syslog
message 106023 for each denied packet in the following form:
%ASA|PIX-4-106023: Deny protocol src [interface_name:source_address/source_port] dst
interface_name:dest_address/dest_port [type {string}, code {code}] by access_group acl_id

If the ASA is attacked, the number of syslog messages for denied packets can be very large. We
recommend that you instead enable logging using syslog message 106100, which provides statistics for
each ACE and enables you to limit the number of syslog messages produced. Alternatively, you can
disable all logging.

Cisco ASA 5500 Series Configuration Guide using the CLI

20-1

Chapter 20

Configuring Logging for Access Lists

Configuring Logging for Access Lists

Note

Only ACEs in the access list generate logging messages; the implicit deny at the end of the access list
does not generate a message. If you want all denied traffic to generate messages, add the implicit ACE
manually to the end of the access list, as shown in the following example:
hostname(config)# access-list TEST deny ip any any log

The log options at the end of the extended access-list command enable you to set the following behavior:
•

Enable message 106100 instead of message 106023

•

Disable all logging

•

Return to the default logging using message 106023

Syslog message 106100 uses the following form:
%ASA|PIX-n-106100: access-list acl_id {permitted | denied} protocol
interface_name/source_address(source_port) -> interface_name/dest_address(dest_port)
hit-cnt number ({first hit | number-second interval})

When you enable logging for message 106100, if a packet matches an ACE, the ASA creates a flow entry
to track the number of packets received within a specific interval. The ASA generates a syslog message
at the first hit and at the end of each interval, identifying the total number of hits during the interval and
the timestamp for the last hit. At the end of each interval, the ASA resets the hit count to 0. If no packets
match the ACE during an interval, the ASA deletes the flow entry.
A flow is defined by the source and destination IP addresses, protocols, and ports. Because the source
port might differ for a new connection between the same two hosts, you might not see the same flow
increment because a new flow was created for the connection. See the “Managing Deny Flows” section
on page 20-5 to limit the number of logging flows.
Permitted packets that belong to established connections do not need to be checked against access lists;
only the initial packet is logged and included in the hit count. For connectionless protocols, such as
ICMP, all packets are logged, even if they are permitted, and all denied packets are logged.
See the syslog message guide guide for detailed information about this syslog message.

Licensing Requirements for Access List Logging
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

20-2

Chapter 20

Configuring Logging for Access Lists
Configuring Logging for Access Lists

Firewall Mode Guidelines

Supported only in routed and transparent firewall modes.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines and Limitations

ACE logging generates syslog message 106023 for denied packets. A deny ACE must be present to log
denied packets.

Default Settings
Table 20-1 lists the default settings for extended access list parameters.
Table 20-1

Default Extended Access List Parameters

Parameters

Default

log

When the log keyword is specified, the default
level for syslog message 106100 is 6
(informational), and the default interval is 300
seconds.

Configuring Access List Logging
This sections describes how to configure access list logging.

Note

For complete access list command syntax, see the “Configuring Extended Access Lists” section on
page 15-2 and the “Using Webtype Access Lists” section on page 18-2.

Cisco ASA 5500 Series Configuration Guide using the CLI

20-3

Chapter 20

Configuring Logging for Access Lists

Configuring Logging for Access Lists

To configure logging for an ACE, enter the following command:
Command

Purpose

access-list access_list_name [extended]
{deny | permit}...[log [[level] [interval
secs] | disable | default]]

Configures logging for an ACE.
The access-list access_list_name syntax specifies the access list for which
you want to configure logging.

Example:

The extended option adds an ACE.

hostname(config)# access-list outside-acl
permit ip host 10.0.0.0 any log 7 interval
600

The deny keyword denies a packet if the conditions are matched. Some
features do not allow deny ACEs, such as NAT. (See the command
documentation for each feature that uses an access list for more
information.)
The permit keyword permits a packet if the conditions are matched.
If you enter the log option without any arguments, you enable syslog
message 106100 at the default level (6) and for the default interval (300
seconds). See the following options:
•

level—A severity level between 0 and 7. The default is 6.

•

interval secs—The time interval in seconds between syslog messages,
from 1 to 600. The default is 300. This value is also used as the timeout
value for deleting an inactive flow.

•

disable—Disables all access list logging.

•

default—Enables logging to message 106023. This setting is the same
as having no log option.

(See the access-list command in the Cisco Security Appliance Command
Reference for more information about command options.)

Monitoring Access Lists
To monitor access lists, enter one of the following commands:
Command

Purpose

show access list

Displays the access list entries by number.

show running-config access-list

Displays the current running access list
configuration.

Configuration Examples for Access List Logging
This section includes sample configurations for logging access lists.
You might configure the following access list:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list outside-acl permit ip host 10.10.0.0 any log 7 interval 600
access-list outside-acl permit ip host 10.255.255.255 any
access-list outside-acl deny ip any any log 2
access-group outside-acl in interface outside

Cisco ASA 5500 Series Configuration Guide using the CLI

20-4

Chapter 20

Configuring Logging for Access Lists
Managing Deny Flows

When the first ACE of outside-acl permits a packet, the ASA generates the following syslog message:
%ASA|PIX-7-106100: access-list outside-acl permitted tcp outside/10.0.0.0(12345) ->
inside/192.168.1.1(1357) hit-cnt 1 (first hit)

Although 20 additional packets for this connection arrive on the outside interface, the traffic does not
have to be checked against the access list, and the hit count does not increase.
If one or more connections by the same host are initiated within the specified 10-minute interval (and
the source and destination ports remain the same), then the hit count is incremented by 1, and the
following syslog message displays at the end of the 10-minute interval:
%ASA|PIX-7-106100: access-list outside-acl permitted tcp outside/10.0.0.0(12345)->
inside/192.168.1.1(1357) hit-cnt 2 (600-second interval)

When the third ACE denies a packet, the ASA generates the following syslog message:
%ASA|PIX-2-106100: access-list outside-acl denied ip outside/10.255.255.255(12345) ->
inside/192.168.1.1(1357) hit-cnt 1 (first hit)

If 20 additional attempts occur within a 5-minute interval (the default), the following syslog message
appears at the end of 5 minutes:
%ASA|PIX-2-106100: access-list outside-acl denied ip outside/10.255.255.255(12345) ->
inside/192.168.1.1(1357) hit-cnt 21 (300-second interval)

Feature History for Access List Logging
Table 20-2 lists each feature change and the platform release in which it was implemented.
Table 20-2

Feature History for Access List Logging

Feature Name

Releases

Feature Information

Access list logging

7.0(1)

You can enable logging using syslog message 106100,
which provides statistics for each ACE and lets you limit the
number of syslog messages produced.
We introduced the following command: access-list.

ACL Timestamp

8.3(1)

The ASA reports the timestamp for the last access rule hit.

Managing Deny Flows
This section includes the following topics:
•

Information About Managing Deny Flows, page 20-6

•

Licensing Requirements for Managing Deny Flows, page 20-6

•

Guidelines and Limitations, page 20-6

•

Managing Deny Flows, page 20-7

•

Monitoring Deny Flows, page 20-7

•

Feature History for Managing Deny Flows, page 20-8

Cisco ASA 5500 Series Configuration Guide using the CLI

20-5

Chapter 20

Configuring Logging for Access Lists

Managing Deny Flows

Information About Managing Deny Flows
When you enable logging for message 106100, if a packet matches an ACE, the ASA creates a flow entry
to track the number of packets received within a specific interval. The ASA has a maximum of 32 K
logging flows for ACEs. A large number of flows can exist concurrently at any point of time. To prevent
unlimited consumption of memory and CPU resources, the ASA places a limit on the number of
concurrent deny flows; the limit is placed on deny flows only (not on permit flows) because they can
indicate an attack. When the limit is reached, the ASA does not create a new deny flow for logging until
the existing flows expire.
For example, if someone initiates a DoS attack, the ASA can create a large number of deny flows in a
short period of time. Restricting the number of deny flows prevents unlimited consumption of memory
and CPU resources.
When you reach the maximum number of deny flows, the ASA issues syslog message 106100:
%ASA|PIX-1-106101: The number of ACL log deny-flows has reached limit (number).

The access-list alert-interval command sets the time interval for generating syslog message 106001.
Syslog message 106001 alerts you that the ASA has reached a deny flow maximum. When the deny flow
maximum is reached, another syslog message 106001 is generated if at least six seconds have passed
since the last 106001 message was generated.

Licensing Requirements for Managing Deny Flows
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported only in routed and transparent firewall modes.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines and Limitations

The ASA places a limit on the number of concurrent deny flows only—not permit flows.

Cisco ASA 5500 Series Configuration Guide using the CLI

20-6

Chapter 20

Configuring Logging for Access Lists
Managing Deny Flows

Default Settings
Table 20-1 lists the default settings for managing deny flows.
Table 20-3

Default Parameters for Managing Deny Flows

Parameters

Default

numbers

The numbers argument specifies the maximum
number of deny flows. The default is 4096.

secs

The secs argument specifies the time, in seconds,
between syslog messages. The default is 300.

Managing Deny Flows
To configure the maximum number of deny flows and to set the interval between deny flow alert
messages (106100), enter the following command:
Command

Purpose

access-list deny-flow-max number

Sets the maximum number of deny flows.

Example:

The numbers argument specifies the maximum number, which can be
between 1 and 4096. The default is 4096.

hostname(config)# access-list
deny-flow-max 3000

To set the amount of time between syslog messages (number 106101), which identifies that the
maximum number of deny flows was reached, enter the following command:
Command

Purpose

access-list alert-interval secs

Sets the time, in seconds, between syslog messages.

Example:

The secs argument specifies the time interval between each deny flow
maximum message. Valid values are from 1 to 3600 seconds. The default
is 300 seconds.

hostname(config)# access-list
alert-interval 200

Monitoring Deny Flows
To monitor access lists, enter one of the following commands:
Command

Purpose

show access-list

Displays access list entries by number.

show running-config access-list

Displays the current running access list
configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

20-7

Chapter 20

Configuring Logging for Access Lists

Managing Deny Flows

Feature History for Managing Deny Flows
Table 20-2 lists each feature change and the platform release in which it was implemented.
Table 20-4

Feature History for Managing Deny Flows

Feature Name

Releases

Feature Information

Managing Deny Flows

7.0(1)

You can configure the maximum number of deny flows and
set the interval between deny flow alert messages.
We introduced the following commands: access-list
deny-flow and access-list alert-interval.

Cisco ASA 5500 Series Configuration Guide using the CLI

20-8

PA R T

6

Configuring IP Routing

C H A P T E R

21

Routing Overview
This chapter describes underlying concepts of how routing behaves within the ASA, and the routing
protocols that are supported.
This chapter includes the following sections:
•

Information About Routing, page 21-1

•

How Routing Behaves Within the ASA, page 21-4

•

Supported Internet Protocols for Routing, page 21-5

•

Information About the Routing Table, page 21-6

•

Information About IPv6 Support, page 21-9

•

Disabling Proxy ARPs, page 21-11

Information About Routing
Routing is the act of moving information across an internetwork from a source to a destination. Along
the way, at least one intermediate node typically is encountered. Routing involves two basic activities:
determining optimal routing paths and transporting information groups (typically called packets)
through an internetwork. In the context of the routing process, the latter of these is referred to as packet
switching. Although packet switching is relatively straightforward, path determination can be very
complex.
This section includes the following topics:
•

Switching, page 21-2

•

Path Determination, page 21-2

•

Supported Route Types, page 21-2

Cisco ASA 5500 Series Configuration Guide using the CLI

21-1

Chapter 21

Routing Overview

Information About Routing

Switching
Switching algorithms is relatively simple; it is the same for most routing protocols. In most cases, a host
determines that it must send a packet to another host. Having acquired a router address by some means,
the source host sends a packet addressed specifically to a router physical (Media Access Control
[MAC]-layer) address, this time with the protocol (network layer) address of the destination host.
As it examines the packet destination protocol address, the router determines that it either knows or does
not know how to forward the packet to the next hop. If the router does not know how to forward the
packet, it typically drops the packet. If the router knows how to forward the packet, however, it changes
the destination physical address to that of the next hop and transmits the packet.
The next hop may be the ultimate destination host. If not, the next hop is usually another router, which
executes the same switching decision process. As the packet moves through the internetwork, its
physical address changes, but its protocol address remains constant.

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.
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. For more
information, see the “Configuring Active/Active Failover” section on page 63-8.

Supported Route Types
There are several route types that a router can use. The ASA uses the following route types:
•

Static Versus Dynamic, page 21-3

•

Single-Path Versus Multipath, page 21-3

•

Flat Versus Hierarchical, page 21-3

Cisco ASA 5500 Series Configuration Guide using the CLI

21-2

Chapter 21

Routing Overview
Information About Routing

•

Link-State Versus Distance Vector, page 21-4

Static Versus Dynamic
Static routing algorithms are hardly algorithms at all, but are table mappings established by the network
administrator before the beginning of routing. These mappings do not change unless the network
administrator alters them. Algorithms that use static routes are simple to design and work well in
environments where network traffic is relatively predictable and where network design is relatively
simple.
Because static routing systems cannot react to network changes, they generally are considered unsuitable
for large, constantly changing networks. Most of the dominant routing algorithms are dynamic routing
algorithms, which adjust to changing network circumstances by analyzing incoming routing update
messages. If the message indicates that a network change has occurred, the routing software recalculates
routes and sends out new routing update messages. These messages permeate the network, stimulating
routers to rerun their algorithms and change their routing tables accordingly.
Dynamic routing algorithms can be supplemented with static routes where appropriate. A router of last
resort (a router to which all unroutable packets are sent), for example, can be designated to act as a
repository for all unroutable packets, ensuring that all messages are at least handled in some way.

Note

There is no dynamic routing support in multi-context mode. As a result, there is no route tracking.

Single-Path Versus Multipath
Some sophisticated routing protocols support multiple paths to the same destination. Unlike single-path
algorithms, these multipath algorithms permit traffic multiplexing over multiple lines. The advantages
of multipath algorithms are substantially better throughput and reliability, which is generally called load
sharing.

Flat Versus Hierarchical
Some routing algorithms operate in a flat space, while others use routing hierarchies. In a flat routing
system, the routers are peers of all others. In a hierarchical routing system, some routers form what
amounts to a routing backbone. Packets from nonbackbone routers travel to the backbone routers, where
they are sent 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 nonbackbone 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

21-3

Chapter 21

Routing Overview

How Routing Behaves Within the ASA

Link-State Versus Distance Vector
Link-state algorithms (also known as shortest path first algorithms) flood routing information to all
nodes in the internetwork. Each router, however, sends only the portion of the routing table that describes
the state of its own links. In link-state algorithms, each router builds a picture of the entire network in
its routing tables. Distance vector algorithms (also known as Bellman-Ford algorithms) call for each
router to send all or some portion of its routing table, but only to its neighbors. In essence, link-state
algorithms send small updates everywhere, while distance vector algorithms send larger updates only to
neighboring routers. Distance vector algorithms know only about their neighbors. Typically, this type of
algorithm is used in conjunction with OSPF routing protocols.

How Routing Behaves Within the ASA
The ASA uses both routing table and XLATE tables for routing decisions. To handle destination IP
translated traffic, that is, untranslated traffic, the ASA searches for existing XLATE, or static translation
to select the egress interface.
This section includes the following topics:
•

Egress Interface Selection Process, page 21-4

•

Next Hop Selection Process, page 21-4

Egress Interface Selection Process
The selection process follows these steps:
1.

If a destination IP translating XLATE already exists, the egress interface for the packet is determined
from the XLATE table, but not from the routing table.

2.

If a destination IP translating XLATE does not exist, but a matching static translation exists, then
the egress interface is determined from the static route and an XLATE is created, and the routing
table is not used.

3.

If a destination IP translating XLATE does not exist and no matching static translation exists, the
packet is not destination IP translated. The ASA processes this packet by looking up the route to
select the egress interface, then source IP translation is performed (if necessary).
For regular dynamic outbound NAT, initial outgoing packets are routed using the route table and
then creating the XLATE. Incoming return packets are forwarded using existing XLATE only. For
static NAT, destination translated incoming packets are always forwarded using existing XLATE or
static translation rules.

Next Hop Selection Process
After selecting the egress interface using any method described previously, an additional route lookup
is performed to find out suitable next hop(s) that belong to a previously selected egress interface. If there
are no routes in the routing table that explicitly belong to a selected interface, the packet is dropped with

Cisco ASA 5500 Series Configuration Guide using the CLI

21-4

Chapter 21

Routing Overview
Supported Internet Protocols for Routing

a level 6 syslog message 110001 generated (no route to host), even if there is another route for a given
destination network that belongs to a different egress interface. If the route that belongs to a selected
egress interface is found, the packet is forwarded to the corresponding next hop.
Load sharing on the ASA is possible only for multiple next hops available using a single egress interface.
Load sharing cannot share multiple egress interfaces.
If dynamic routing is in use on the ASA and the route table changes after XLATE creation (for example,
route flap), then destination translated traffic is still forwarded using the old XLATE, not via the route
table, until XLATE times out. It may be either forwarded to the wrong interface or dropped with a level
6 syslog message 110001 generated (no route to host), if the old route was removed from the old
interface and attached to another one by the routing process.
The same problem may happen when there are no route flaps on the ASA itself, but some routing process
is flapping around it, sending source-translated packets that belong to the same flow through the ASA
using different interfaces. Destination-translated return packets may be forwarded back using the wrong
egress interface.
This issue has a high probability in some security traffic configurations, where virtually any traffic may
be either source-translated or destination-translated, depending on the direction of the initial packet in
the flow. When this issue occurs after a route flap, it can be resolved manually by using the clear xlate
command, or automatically resolved by an XLATE timeout. The XLATE timeout may be decreased if
necessary. To ensure that this issue rarely occurs, make sure that there are no route flaps on the ASA and
around it. That is, ensure that destination-translated packets that belong to the same flow are always
forwarded the same way through the ASA.

Supported Internet Protocols for Routing
The ASA supports several Internet protocols for routing. Each protocol is briefly described in this
section.
•

Enhanced Interior Gateway Routing Protocol (EIGRP)
EIGRP provides compatibility and seamless interoperation with IGRP routers. An
automatic-redistribution mechanism allows IGRP routes to be imported into Enhanced IGRP, and
vice versa, so it is possible to add Enhanced IGRP gradually into an existing IGRP network.
For more information about configuring EIGRP, see the “Configuring EIGRP” section on page 27-3.

•

Open Shortest Path First (OSPF)
Open Shortest Path First (OSPF) is a routing protocol developed for Internet Protocol (IP) networks
by the interior gateway protocol (IGP) working group of the Internet Engineering Task Force
(IETF). OSPF uses a link-state algorithm to build and calculate the shortest path to all known
destinations. Each router in an OSPF area includes an identical link-state database, which is a list
of each of the router usable interfaces and reachable neighbors.
For more information about configuring OSPF, see the “Configuring OSPF” section on page 24-3.

•

Routing Information Protocol
The Routing Information Protocol (RIP) is a distance-vector protocol that uses hop count as its
metric. RIP is widely used for routing traffic in the global Internet and is an interior gateway
protocol (IGP), which means that it performs routing within a single autonomous system.
For more information about configuring RIP, see the “Configuring RIP” section on page 25-4.

Cisco ASA 5500 Series Configuration Guide using the CLI

21-5

Chapter 21

Routing Overview

Information About the Routing Table

Information About the Routing Table
This section includes the following topics:
•

Displaying the Routing Table, page 21-6

•

How the Routing Table Is Populated, page 21-6

•

How Forwarding Decisions Are Made, page 21-8

•

Dynamic Routing and Failover, page 21-9

Displaying the Routing Table
To view the entries in the routing table, enter the following command:
hostname# show route
Codes: C - connected, S - static, I - IGRP, R - RIP, M - mobile, B - BGP
D - EIGRP, EX - EIGRP external, O - OSPF, IA - OSPF inter area
N1 - OSPF NSSA external type 1, N2 - OSPF NSSA external type 2
E1 - OSPF external type 1, E2 - OSPF external type 2, E - EGP
i - IS-IS, L1 - IS-IS level-1, L2 - IS-IS level-2, ia - IS-IS inter area
* - candidate default, U - per-user static route, o - ODR
P - periodic downloaded static route
Gateway of last resort is 10.86.194.1 to network 0.0.0.0
S
C
S*

10.1.1.0 255.255.255.0 [3/0] via 10.86.194.1, outside
10.86.194.0 255.255.254.0 is directly connected, outside
0.0.0.0 0.0.0.0 [1/0] via 10.86.194.1, outside

On the ASA 5505, the following route is also shown. It is the internal loopback interface, which is used
by the VPN hardware client feature for individual user authentication.
C 127.1.0.0 255.255.0.0 is directly connected, _internal_loopback

How the Routing Table Is Populated
The ASA routing table can be populated by statically defined routes, directly connected routes, and
routes discovered by the RIP, EIGRP, and OSPF routing protocols. Because the ASA can run multiple
routing protocols in addition to having static and connected routes in the routing table, it is possible that
the same route is discovered or entered in more than one manner. When two routes to the same
destination are put into the routing table, the one that remains in the routing table is determined as
follows:
•

If the two routes have different network prefix lengths (network masks), then both routes are
considered unique and are entered into the routing table. The packet forwarding logic then
determines which of the two to use.
For example, if the RIP and OSPF processes discovered the following routes:
– RIP: 192.168.32.0/24
– OSPF: 192.168.32.0/19

Cisco ASA 5500 Series Configuration Guide using the CLI

21-6

Chapter 21

Routing Overview
Information About 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.
You can change the administrative distances for routes discovered by or redistributed into a routing
protocol. If two routes from two different routing protocols have the same administrative distance,
then the route with the lower default administrative distance is entered into the routing table. In the
case of EIGRP and OSPF routes, if the EIGRP route and the OSPF route have the same
administrative distance, then the EIGRP route is chosen by default.

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. Table 21-1 shows the default
administrative distance values for the routing protocols supported by the ASA.
Table 21-1

Default Administrative Distance for Supported Routing Protocols

Route Source

Default Administrative Distance

Connected interface

0

Static route

1

EIGRP Summary Route

5

Internal EIGRP

90

OSPF

110

RIP

120

EIGRP external route

170

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

21-7

Chapter 21

Routing Overview

Information About the Routing Table

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 OSPF and RIP 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.

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.

How Forwarding Decisions Are Made
Forwarding decisions are made as follows:
•

If the destination does not match an entry in the routing table, the packet is forwarded through the
interface specified for the default route. If a default route has not been configured, the packet is
discarded.

•

If the destination matches a single entry in the routing table, the packet is forwarded through the
interface associated with that route.

•

If the destination matches more than one entry in the routing table, and the entries all have the same
network prefix length, the packets for that destination are distributed among the interfaces
associated with that route.

•

If the destination matches more than one entry in the routing table, and the entries have different
network prefix lengths, then the packet is forwarded out of the interface associated with the route
that has the longer network prefix length.

For example, a packet destined for 192.168.32.1 arrives on an interface of an ASA with the following
routes in the routing table:
hostname# show route
....
R
192.168.32.0/24 [120/4] via 10.1.1.2
O
192.168.32.0/19 [110/229840] via 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 the
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

21-8

Chapter 21

Routing Overview
Information About IPv6 Support

Dynamic Routing and Failover
Because static routing systems cannot react to network changes, they generally are considered unsuitable
for large, constantly changing networks. Most of the dominant routing algorithms are dynamic routing
algorithms, which adjust to changing network circumstances by analyzing incoming routing update
messages. If the message indicates that a network change has occurred, the routing software recalculates
routes and sends out new routing update messages. These messages permeate the network, stimulating
routers to rerun their algorithms and change their routing tables accordingly.
Dynamic routing algorithms can be supplemented with static routes where appropriate. A router of last
resort (a router to which all unroutable packets are sent), for example, can be designated to act as a
repository for all unroutable packets, ensuring that all messages are at least handled in some way.
Dynamic routes are synchronized on the standby unit when the routing table changes on the active unit,
which means that all additions, deletions, or changes on the active unit are immediately propagated to
the standby unit. If the standby unit becomes active after the primary unit has been active for a period of
time, routes become synchronized as a part of the failover bulk synchronization process, so the routing
table on the active/standby failover pair should appear the same.
For more information about static routes and how to configure them, see the “Configuring Static and
Default Routes” section on page 22-2.

Information About IPv6 Support
Many, but not all, features on the ASA support IPv6 traffic. This section describes the commands and
features that support IPv6 and includes the following topics:
•

Features That Support IPv6, page 21-9

•

IPv6-Enabled Commands, page 21-10

•

Entering IPv6 Addresses in Commands, page 21-11

Features That Support IPv6
The following features support IPv6:

Note

For features that use the Modular Policy Framework, be sure to use the match any command to match
IPv6 traffic; other match commands do not support IPv6.
•

The following application inspections support IPv6 traffic:
– FTP
– HTTP
– ICMP
– SIP
– SMTP
– IPsec-pass-thru

•

IPS

Cisco ASA 5500 Series Configuration Guide using the CLI

21-9

Chapter 21
Information About IPv6 Support

•

NetFlow Secure Event Logging filtering

•

Connection limits, timeouts, and TCP randomization

•

TCP Normalization

•

TCP state bypass

•

Access group, using an IPv6 access list

•

Static Routes

•

VPN (all types)

•

Failover

•

Transparent firewall mode

IPv6-Enabled Commands
The following ASA commands can accept and display IPv6 addresses:
•

capture

•

configure

•

copy

•

failover interface ip

•

http

•

name

•

object-group

•

ping

•

show conn

•

show local-host

•

show tcpstat

•

ssh

•

telnet

•

tftp-server

•

who

•

write

The following commands were modified to work for IPv6:
•

debug

•

fragment

•

ip verify

•

mtu

•

icmp (entered as ipv6 icmp)

Cisco ASA 5500 Series Configuration Guide using the CLI

21-10

Routing Overview

Chapter 21

Routing Overview
Disabling Proxy ARPs

Entering IPv6 Addresses in Commands
When entering IPv6 addresses in commands that support them, enter the IPv6 address using standard
IPv6 notation, for example:
ping fe80::2e0:b6ff:fe01:3b7a.

The ASA correctly recognizes and processes the IPv6 address. However, you must enclose the IPv6
address in square brackets ([ ]) in the following situations:
•

You need to specify a port number with the address, for example:
[fe80::2e0:b6ff:fe01:3b7a]:8080.

•

The command uses a colon as a separator, such as the write net command and config net command,
for example:
configure net [fe80::2e0:b6ff:fe01:3b7a]:/tftp/config/asaconfig.

Disabling Proxy ARPs
When a host sends IP traffic to another device on the same Ethernet network, the host needs to know the
MAC address of the device. ARP is a Layer 2 protocol that resolves an IP address to a MAC address. A
host sends an ARP request asking “Who is this IP address?” The device owning the IP address replies,
“I own that IP address; here is my MAC address.”
Proxy ARP is used when a device responds to an ARP request with its own MAC address, even though
the device does not own the IP address. The ASA uses proxy ARP when you configure NAT and specify
a mapped address that is on the same network as the ASA interface. The only way traffic can reach the
hosts is if the ASA uses proxy ARP to claim that the MAC address is assigned to destination mapped
addresses.
Under rare circumstances, you might want to disable proxy ARP for NAT addresses.
If you have a VPN client address pool that overlaps with an existing network, the ASA by default sends
proxy ARPs on all interfaces. If you have another interface that is on the same Layer 2 domain, it will
see the ARP requests and will answer with the MAC address of its interface. The result of this is that the
return traffic of the VPN clients towards the internal hosts will go to the wrong interface and will get
dropped. In this case, you need to disable proxy ARPs for the interface on which you do not want proxy
ARPs.
To disable proxy ARPs, enter the following command:
Command

Purpose

sysopt noproxyarp interface

Disables proxy ARPs.

Example:
hostname(config)# sysopt noproxyarp exampleinterface

Cisco ASA 5500 Series Configuration Guide using the CLI

21-11

Chapter 21
Disabling Proxy ARPs

Cisco ASA 5500 Series Configuration Guide using the CLI

21-12

Routing Overview

C H A P T E R

22

Configuring Static and Default Routes
This chapter describes how to configure static and default routes on the ASA and includes the following
sections:
•

Information About Static and Default Routes, page 22-1

•

Licensing Requirements for Static and Default Routes, page 22-2

•

Guidelines and Limitations, page 22-2

•

Configuring Static and Default Routes, page 22-2

•

Monitoring a Static or Default Route, page 22-6

•

Configuration Examples for Static or Default Routes, page 22-8

•

Feature History for Static and Default Routes, page 22-8

Information About Static and Default Routes
To route traffic to a nonconnected host or network, you must define a static route to the host or network
or, at a minimum, a default route for any networks to which the ASA is not directly connected; for
example, when there is a router between a network and the ASA.
Without a static or default route defined, traffic to nonconnected hosts or networks generates the
following syslog message:
%ASA-6-110001: No route to dest_address from source_address

Multiple context mode does not support dynamic routing,
You might want to use static routes in single context mode in the following cases:
•

Your networks use a different router discovery protocol from 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.

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. However, in some cases 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.
In transparent firewall mode, for traffic that originates on the ASA and is destined for a nondirectly
connected network, you need to configure either a default route or static routes so the ASA knows out
of which interface to send traffic. Traffic that originates on the ASA might include communications to a

Cisco ASA 5500 Series Configuration Guide using the CLI

22-1

Chapter 22

Configuring Static and Default Routes

Licensing Requirements for Static and Default Routes

syslog server, Websense or N2H2 server, or AAA server. If you have servers that cannot all be reached
through a single default route, then you must configure static routes. Additionally, the ASA supports up
to three equal cost routes on the same interface for load balancing.

Licensing Requirements for Static and Default Routes
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6.
Failover Guidelines

Supports stateful failover of dynamic routing protocols.
Additional Guidelines

IPv6 static routes are not supported in transparent mode in ASDM.

Configuring Static and Default Routes
This section explains how to configure a static route and a static default route, and includes the following
topics:
•

Configuring a Static Route, page 22-3

•

Configuring a Default Static Route, page 22-4

•

Configuring IPv6 Default and Static Routes, page 22-5

Cisco ASA 5500 Series Configuration Guide using the CLI

22-2

Chapter 22

Configuring Static and Default Routes
Configuring Static and Default Routes

Configuring a Static Route
Static routing algorithms are basically table mappings established by the network administrator before
the beginning of routing. These mappings do not change unless the network administrator alters them.
Algorithms that use static routes are simple to design and work well in environments where network
traffic is relatively predictable and where network design is relatively simple. Because of this fact, static
routing systems cannot react to network changes.
Static routes remain in the routing table even if the specified gateway becomes unavailable. If the
specified gateway becomes unavailable, you need to remove the static route from the routing table
manually. However, static routes are removed from the routing table if the specified interface goes down,
and are reinstated when the interface comes back up.

Note

If you create a static route with an administrative distance greater than the administrative distance of the
routing protocol running on the ASA, then a route to the specified destination discovered by the routing
protocol takes precedence over the static route. The static route is used only if the dynamically
discovered route is removed from the routing table.
You can define up to three equal cost routes to the same destination per interface. Equal-cost multi-path
(ECMP) routing is not supported across multiple interfaces. With ECMP, the traffic is not necessarily
divided evenly between the routes; traffic is distributed among the specified gateways based on an
algorithm that hashes the source and destination IP addresses.
To configure a static route, see the following section:
•

Adding or Editing a Static Route, page 22-3

Adding or Editing a Static Route
To add or edit a static route, enter the following command:
Command

Purpose

route if_name dest_ip mask gateway_ip
[distance]

Enables you to add a static route.

Example:
hostname(config)# route outside 10.10.10.0
255.255.255.0 192.168.1.1 [1]

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 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

22-3

Chapter 22

Configuring Static and Default Routes

Configuring Static and Default Routes

Examples
The following example shows static routes that are equal cost routes that direct traffic to three different
gateways on the outside interface. The ASA distributes the traffic among the specified gateways.
hostname(config)# route outside 10.10.10.0 255.255.255.0 192.168.1.1
hostname(config)# route outside 10.10.10.0 255.255.255.0 192.168.1.2
hostname(config)# route outside 10.10.10.0 255.255.255.0 192.168.1.3

Configuring a Default Static Route
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. Routes that identify a specific destination take precedence over the default route.

Note

In Versions 7.0(1) and later, 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 up to three equal cost default route entries per device. Defining more than one equal cost
default route entry causes the traffic sent to the default route to be distributed among the specified
gateways. When defining more than one default route, you must specify the same interface for each
entry.
If you attempt to define more than three equal cost default routes or a default route with a different
interface than a previously defined default route, you receive the following message:
“ERROR: Cannot add route entry, possible conflict with existing routes.”

You can define a separate default route for tunneled traffic along with the standard default route. 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. For traffic emerging from a tunnel,
this route overrides any other configured or learned default routes.

Limitations on Configuring a Default Static Route
The following restrictions apply to default routes with the tunneled option:
•

Do not enable unicast RPF (ip verify reverse-path command) on the egress interface of a tunneled
route, because this setting causes the session to fail.

•

Do not enable TCP intercept on the egress interface of the tunneled route, because this setting causes
the session to fail.

•

Do not use the VoIP inspection engines (CTIQBE, H.323, GTP, MGCP, RTSP, SIP, SKINNY), the
DNS inspect engine, or the DCE RPC inspection engine with tunneled routes, because these
inspection engines ignore the tunneled route.

•

You cannot define more than one default route with the tunneled option.

•

ECMP for tunneled traffic is not supported.

To add or edit a tunneled default static route, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

22-4

Chapter 22

Configuring Static and Default Routes
Configuring Static and Default Routes

Command

Purpose

route if_name 0.0.0.0 0.0.0.0 gateway_ip
[distance | tunneled]

Enables you to add a static route.

Example:
hostname(config)# route outside 0 0
192.168.2.4 tunneled

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
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.

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:
hostname(config)# route outside 0 0 192.168.1 1

Configuring IPv6 Default and Static Routes
The ASA automatically routes IPv6 traffic between directly connected hosts if the interfaces to which
the hosts are attached are enabled for IPv6 and the IPv6 ACLs allow the traffic.
To configure an IPv6 default route and static routes, perform the following steps:

Detailed Steps

Step 1

Step 2

Command

Purpose

ipv6 route if_name ::/0 next_hop_ipv6_addr

Adds a default IPv6 route.

Example:

The example routes packets for network 7fff::0/32 to a networking
device on the inside interface at 3FFE:1100:0:CC00::1

hostname(config)# ipv6 route inside
7fff::0/32 3FFE:1100:0:CC00::1

The address ::/0 is the IPv6 equivalent of any.

ipv6 route if_name destination
next_hop_ipv6_addr [admin_distance]

Adds an IPv6 static route to the IPv6 routing table.

Example:

The example routes packets for network 7fff::0/32 to a networking
device on the inside interface at 3FFE:1100:0:CC00::1, and with
an administrative distance of 110.

hostname(config)# ipv6 route inside
7fff::0/32 3FFE:1100:0:CC00::1 [110]

Cisco ASA 5500 Series Configuration Guide using the CLI

22-5

Chapter 22

Configuring Static and Default Routes

Monitoring a Static or Default Route

Note

The ipv6 route command works the same way as the route command, which is used to define IPv4 static
routes.

Monitoring a Static or Default Route
One of the problems with static routes is that there is no inherent mechanism for determining if the route
is up or down. They remain in the routing table even if the next hop gateway becomes unavailable. Static
routes are only removed from the routing table if the associated interface on the ASA goes down.
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. For example, you can define a default route to
an ISP gateway and a backup default route to a secondary ISP in case the primary ISP becomes
unavailable.
The ASA implements this feature by associating a static route with a monitoring target that you define,
and monitors the target using ICMP echo requests. If an echo reply is not received within a specified
time period, the object is considered down and the associated route is removed from the routing table. A
previously configured backup route is used in place of the removed route.
When selecting a monitoring target, you need to make sure that it can respond to ICMP echo requests.
The target can be any network object that you choose, but you should consider using the following:

Note

•

The ISP gateway (for dual ISP support) address

•

The next hop gateway address (if you are concerned about the availability of the gateway)

•

A server on the target network, such as a AAA server, that the ASA needs to communicate with

•

A persistent network object on the destination network

A desktop or notebook computer that may be shut down at night is not a good choice.
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, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

22-6

Chapter 22

Configuring Static and Default Routes
Monitoring a Static or Default Route

Detailed Steps

Step 1

Command

Purpose

sla monitor sla_id

Configures the tracked object monitoring parameters by defining
the monitoring process.

Example:

If you are configuring a new monitoring process, you enter sla
monitor configuration mode.

hostname(config)# sla monitor sla_id

If you are changing the monitoring parameters for an unscheduled
monitoring process that already has a type defined, you
automatically enter sla protocol configuration mode.
Step 2

type echo protocol ipIcmpEcho target_ip
interface if_name

Example:
hostname(config-sla-monitor)# type echo
protocol ipIcmpEcho target_ip interface
if_name

Step 3

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.
Schedules the monitoring process.

Example:

However, you can schedule this monitoring process to begin in the
future and to only occur at specified times.

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.

track track_id rtr sla_id reachability

Associates a tracked static route with the SLA monitoring
process.

Example:

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.

hostname(config)# track track_id rtr
sla_id reachability

Step 5

If you are changing the monitoring parameters for an unscheduled
monitoring process that already has a type defined, you
automatically enter sla protocol configuration mode and cannot
change this setting.

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]

hostname(config)# 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]

Step 4

Specifies the monitoring protocol.

Do one of the following to define the static route to be installed in the routing table while the tracked object is
reachable.
These options allow you to track a static route or a default route obtained through DHCP or PPPOE.
route if_name dest_ip mask gateway_ip
[admin_distance] track track_id

Tracks a static route.
You cannot use the tunneled option with the route command in
static route tracking.

Example:
hostname(config)# route if_name dest_ip
mask gateway_ip [admin_distance] track
track_id

Cisco ASA 5500 Series Configuration Guide using the CLI

22-7

Chapter 22

Configuring Static and Default Routes

Configuration Examples for Static or Default Routes

Command
Example:

Purpose
Tracks a default route obtained through DHCP,

hostname(config)# interface phy_if
hostname(config-if)# dhcp client route
track track_id
hostname(config-if)# ip address dhcp
setroute
hostname(config-if)# exit

Example:

Remember that you must use the setroute keyword with the ip
address dhcp command to obtain the default route using DHCP.

Tracks a default route obtained through PPPoE.

hostname(config)# interface phy_if
hostname(config-if)# pppoe client route
track track_id
hostname(config-if)# ip address pppoe
setroute
hostname(config-if)# exit

You must use the setroute keyword with the ip address pppoe
command to obtain the default route using PPPoE.

Configuration Examples for Static or Default Routes
The following example shows how to create a static route that sends all traffic destined for 10.1.1.0/24
to the router 10.1.2.45, which is connected to the inside interface, defines three equal cost static routes
that direct traffic to three different gateways on the outside interface, and adds a default route for
tunneled traffic. The ASA then distributes the traffic among the specified gateways:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

route
route
route
route
route

inside 10.1.1.0 255.255.255.0 10.1.2.45 1
outside 10.10.10.0 255.255.255.0 192.168.2.1
outside 10.10.10.0 255.255.255.0 192.168.2.2
outside 10.10.10.0 255.255.255.0 192.168.2.3
outside 0 0 192.168.2.4 tunneled

Unencrypted traffic received by the ASA for which there is no static or learned route is distributed among
the gateways with the IP addresses 192.168.2.1, 192.168.2.2, and 192.168.2.3. Encrypted traffic received
by the ASA for which there is no static or learned route is passed to the gateway with the IP address
192.168.2.4.
The following example creates a static route that sends all traffic destined for 10.1.1.0/24 to the router
(10.1.2.45) connected to the inside interface:
hostname(config)# route inside 10.1.1.0 255.255.255.0 10.1.2.45 1

Feature History for Static and Default Routes
Table 22-1 lists each feature change and the platform release in which it was implemented.
Table 22-1

Feature History for Static and Default Routes

Feature Name

Platform
Releases

Feature Information

Routing

7.0(1)

Static and default routing were introduced.
We introduced the route command.

Cisco ASA 5500 Series Configuration Guide using the CLI

22-8

Chapter 22

Configuring Static and Default Routes
Feature History for Static and Default Routes

Cisco ASA 5500 Series Configuration Guide using the CLI

22-9

Chapter 22
Feature History for Static and Default Routes

Cisco ASA 5500 Series Configuration Guide using the CLI

22-10

Configuring Static and Default Routes

C H A P T E R

23

Defining Route Maps
This chapter describes route maps and includes the following sections:
•

Information About Route Maps, page 23-1

•

Licensing Requirements for Route Maps, page 23-3

•

Guidelines and Limitations, page 23-3

•

Defining a Route Map, page 23-4

•

Customizing a Route Map, page 23-4

•

Configuration Example for Route Maps, page 23-6

•

Feature History for Route Maps, page 23-6

Information About Route Maps
Route maps are used when redistributing routes into an OSPF, RIP, or EIGRP routing process. They are
also used when generating a default route into an OSPF routing process. A route map defines which of
the routes from the specified routing protocol are allowed to be redistributed into the target routing
process.
Route maps have many features in common with widely known ACLs. These are some of the traits
common to both:
•

They are an ordered sequence of individual statements, each has a permit or deny result. Evaluation
of ACL or route maps consists of a list scan, in a predetermined order, and an evaluation of the
criteria of each statement that matches. A list scan is aborted once the first statement match is found
and an action associated with the statement match is performed.

•

They are generic mechanisms—Criteria matches and match interpretation are dictated by the way
that they are applied. The same route map applied to different tasks might be interpreted differently.

These are some of the differences between route maps and ACLs:
•

Route maps frequently use ACLs as matching criteria.

•

The main result from the evaluation of an access list is a yes or no answer—An ACL either permits
or denies input data. Applied to redistribution, an ACL determines if a particular route can (route
matches ACLs permit statement) or can not (matches deny statement) be redistributed. Typical route
maps not only permit (some) redistributed routes but also modify information associated with the
route, when it is redistributed into another protocol.

•

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

23-1

Chapter 23

Defining Route Maps

Information About Route Maps

•

Each ACL ends with an implicit deny statement, by design convention; there is no similar
convention for route maps. If the end of a route map is reached during matching attempts, the result
depends on the specific application of the route map. Fortunately, route 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 deny statement at the end.

The dynamic protocol redistribute command allows you to apply a route map. In ASDM, this capability
for redistribution can be found when you add or edit a new route map (see the “Defining a Route Map”
section on page 23-4). Route maps are preferred if you intend to either modify route information during
redistribution or if you need more powerful matching capability than an ACL can provide. If you simply
need to selectively permit some routes based on their prefix or mask, we recommends that you use a route
map to map to an ACL (or equivalent prefix list) directly in the redistribute command. If you use a route
map to selectively permit some routes based on their prefix or mask, you typically use more
configuration commands to achieve the same goal.

Note

You must use a standard ACL as the match criterion for your route map. Using an extended ACL will
not work, and your routes will never be redistributed. We recommend that you number clauses in
intervals of 10, to reserve numbering space in case you need to insert clauses in the future.
This section includes the following topics:
•

Permit and Deny Clauses, page 23-2

•

Match and Set Clause Values, page 23-2

Permit and Deny Clauses
Route maps can have permit and deny clauses. In the route-map ospf-to-eigrp command, there is one
deny clause (with sequence number 10) and two permit clauses. The deny clause rejects route matches
from redistribution. Therefore, the following rules apply:
•

If you use an ACL in a route map using a permit clause, routes that are permitted by the ACL are
redistributed.

•

If you use an ACL in a route map deny clause, routes that are permitted by the ACL are not
redistributed.

•

If you use an ACL in a route map permit or deny clause, and the ACL denies a route, then the route
map clause match is not found and the next route-map clause is evaluated.

Match and Set Clause Values
Each route map clause has two types of values:
•

A match value selects routes to which this clause should be applied.

•

A set value modifies information that will be redistributed into the target protocol.

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 succeed, 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 Value
tab in ASDM or 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 whose match command(s), or Match Clause
as set from the Match Clause tab in ASDM, match the route or until the end of the route map is reached.

Cisco ASA 5500 Series Configuration Guide using the CLI

23-2

Chapter 23

Defining Route Maps
Licensing Requirements for Route Maps

A match or set value in each clause can be missed or repeated several times, if one of these conditions
exists:

Note

•

If several match commands or Match Clause values in ASDM 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 command or Match Clause value in ASDM refers to several objects in one command,
either of them should match (the logical OR algorithm is applied). For example, in the match ip
address 101 121 command, a route is permitted if access list 101 or access list 121 permits it.

•

If a match command or Match Clause value in ASDM is not present, all routes match the clause. In
the previous example, all routes that reach clause 30 match; therefore, the end of the route map is
never reached.

•

If a set command, or Set Value in ASDM, is not present in a route map permit clause, then the route
is redistributed without modification of its current attributes.

Do not configure a set command 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 command, or Match or Set Value as set on the Match or Set
Value tab in ASDM, performs an action. An empty permit clause allows a redistribution of the remaining
routes without modification. An empty deny clause does not allows a redistribution of other routes (this
is the default action if a route map is completely scanned, but no explicit match is found).

Licensing Requirements for Route Maps
The following table shows the licensing requirements for route maps:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode.
Firewall Mode Guidelines

Supported only in routed firewall mode. Transparent firewall mode is not supported.
IPv6 Guidelines

Does not support IPv6.

Cisco ASA 5500 Series Configuration Guide using the CLI

23-3

Chapter 23

Defining Route Maps

Defining a Route Map

Defining a Route Map
You must define a route map when specifying which of the routes from the specified routing protocol
are allowed to be redistributed into the target routing process.
To define a route map, enter the following command:
Command

Purpose

route-map name {permit | deny}
[sequence_number]

Creates the route map entry. Enters route-map configuration mode.
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:
hostname(config)# route-map name {permit}
[12]

Customizing a Route Map
This section describes how to customize the route map and includes the following topics:
•

Defining a Route to Match a Specific Destination Address, page 23-4

•

Configuring the Metric Values for a Route Action, page 23-5

Defining a Route to Match a Specific Destination Address
To define a route to match a specified destination address, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

route-map name {permit | deny}
[sequence_number]

Creates the route map entry. Enters route-map configuration
mode.

Example:

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.

hostname(config)# route-map name {permit}
[12]

Step 2

Enter one of the following match commands to match routes to a specified destination address:
match ip address acl_id [acl_id] [...]
[prefix-list]

Example:
hostname(config-route-map)# match ip
address acl_id [acl_id] [...]
[prefix-list]

Cisco ASA 5500 Series Configuration Guide using the CLI

23-4

Matches any routes that have a destination network that matches
a standard ACL or prefix list.
If you specify more than one ACL, then the route can match any
of the ACLs.

Chapter 23

Defining Route Maps
Customizing a Route Map

Command

Purpose

match metric metric_value

Matches any routes that have a specified metric.
The metric_value can range from 0 to 4294967295.

Example:
hostname(config-route-map)# match metric
200
match ip next-hop acl_id [acl_id] [...]

Matches any routes that have a next hop router address that
matches a standard ACL.

Example:

If you specify more than one ACL, then the route can match any
of the ACLs.

hostname(config-route-map)# match ip
next-hop acl_id [acl_id] [...]
match interface if_name

Matches any routes with the specified next hop interface.

Example:

If you specify more than one interface, then the route can match
either interface.

hostname(config-route-map)# match
interface if_name
match ip route-source acl_id [acl_id]
[...]

Matches any routes that have been advertised by routers that
match a standard ACL.
If you specify more than one ACL, then the route can match any
of the ACLs.

Example:
hostname(config-route-map)# match ip
route-source acl_id [acl_id] [...]
match route-type {internal | external
[type-1 | type-2]}

Matches the route type.

Example:
hostname(config-route-map)# match
route-type internal type-1

Configuring the Metric Values for a Route Action
If a route matches the match commands, then the following set commands determine the action to
perform on the route before redistributing it.
To configure the metric value for a route action, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

route-map name {permit | deny}
[sequence_number]

Creates the route map entry.

Example:

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.

hostname(config)# route-map name {permit}
[12]

Step 2

To set a metric for the route map, enter one or more of the following set commands:

Cisco ASA 5500 Series Configuration Guide using the CLI

23-5

Chapter 23

Defining Route Maps

Configuration Example for Route Maps

Command

Purpose

set metric metric_value

Sets the metric value.
The metric_value argument can range from 0 to 294967295.

Example:
hostname(config-route-map)# set metric 200

Sets the metric type.

set metric-type {type-1 | type-2}

The metric-type argument can be type-1 or type-2.
Example:
hostname(config-route-map)# set
metric-type type-2

Configuration Example for Route Maps
The following example shows how to redistribute routes with a hop count equal to 1 into OSPF.
The ASA redistributes these routes as external LSAs with a metric of 5 and a metric type of Type 1.
hostname(config)# route-map
hostname(config-route-map)#
hostname(config-route-map)#
hostname(config-route-map)#

1-to-2 permit
match metric 1
set metric 5
set metric-type type-1

The following example shows how to redistribute the 10.1.1.0 static route into eigrp process 1 with the
configured metric value:
hostname(config)# route outside 10.1.1.0 255.255.255.0 192.168.1.1
hostname(config-route-map)# access-list mymap2 line 1 permit 10.1.1.0 255.255.255.0
hostname(config-route-map)# route-map mymap2 permit 10
hostname(config-route-map)# match ip address mymap2
hostname(config-route-map)# router eigrp 1
hostname(config)# redistribute static metric 250 250 1 1 1 route-map mymap2

Feature History for Route Maps
Table 23-1 lists each feature change and the platform release in which it was implemented.
Table 23-1

Feature History for Route Maps

Feature Name

Platform
Releases

Feature Information

Route maps

7.0(1)

We introduced this feature.
We introduced the following command: route-map.

Enhanced support for static and dynamic route
maps

8.0(2)

Support for stateful failover of dynamic routing 8.4(1)
protocols (EIGRP, OSPF, and RIP) and
debugging of general routing-related operations

Cisco ASA 5500 Series Configuration Guide using the CLI

23-6

Enhanced support for dynamic and static route maps was
added.
We introduced the following commands: debug route,
show debug route.
We modified the following command: show route.

CH A P T E R

24

Configuring OSPF
This chapter describes how to configure the ASA to route data, perform authentication, and redistribute
routing information using the Open Shortest Path First (OSPF) routing protocol.
The chapter includes the following sections:
•

Information About OSPF, page 24-1

•

Licensing Requirements for OSPF, page 24-2

•

Guidelines and Limitations, page 24-3

•

Configuring OSPF, page 24-3

•

Customizing OSPF, page 24-4

•

Restarting the OSPF Process, page 24-14

•

Configuration Example for OSPF, page 24-14

•

Monitoring OSPF, page 24-16

•

Feature History for OSPF, page 24-17

Information 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.

•

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

24-1

Chapter 24

Configuring OSPF

Licensing Requirements for OSPF

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:
•

Support of intra-area, interarea, and external (Type I and Type II) routes.

•

Support of a virtual link.

•

OSPF LSA flooding.

•

Authentication to OSPF packets (both password and MD5 authentication).

•

Support for configuring the ASA as a designated router or a designated backup router. The ASA also
can be set up as an ABR.

•

Support for 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 (like
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.
You can have two OSPF routing processes, one RIP routing process, and one EIGRP routing process
running on the ASA at the same time.

Licensing Requirements for OSPF
The following table shows the licensing requirements for this feature:

Cisco ASA 5500 Series Configuration Guide using the CLI

24-2

Chapter 24

Configuring OSPF
Guidelines and Limitations

Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode.
Firewall Mode Guidelines

Supported in routed firewall mode only. Transparent firewall mode is not supported.
IPv6 Guidelines

Does not support IPv6.

Configuring OSPF
This section describes how to enable an OSPF process on the ASA.
After you enable OSPF, you need to define a route map. For more information, see the “Defining a Route
Map” section on page 23-4. Then you generate a default route. For more information, see the
“Configuring Static and Default Routes” section on page 22-2.
After you have defined a route map for the OSPF process, you can customize the OSPF process to suit
your particular needs, To learn how to customize the OSPF process on the ASA, see the “Customizing
OSPF” section on page 24-4.
To enable OSPF, you need to create an OSPF 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 OSPF process instances. Each OSPF process has its own associated areas and
networks.
To enable OSPF, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

24-3

Chapter 24

Configuring OSPF

Customizing OSPF

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for this OSPF process.

Example:

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.

hostname(config)# router ospf 2

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

network ip_address mask area area_id

Defines the IP addresses on which OSPF runs and the area ID for
that interface.

Example:

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-4294967295. You cannot change the area ID
when editing an existing area.

hostname(config)# router ospf 2
hostname(config-router)# network 10.0.0.0
255.0.0.0 area 0

Customizing OSPF
This section explains how to customize the OSPF process and includes the following topics:
•

Redistributing Routes Into OSPF, page 24-4

•

Configuring Route Summarization When Redistributing Routes Into OSPF, page 24-6

•

Configuring Route Summarization Between OSPF Areas, page 24-7

•

Configuring OSPF Interface Parameters, page 24-8

•

Configuring OSPF Area Parameters, page 24-10

•

Configuring OSPF NSSA, page 24-11

•

Defining Static OSPF Neighbors, page 24-12

•

Configuring Route Calculation Timers, page 24-13

•

Logging Neighbors Going Up or Down, page 24-13

Redistributing Routes Into OSPF
The ASA can control the redistribution of routes between OSPF routing 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
the “Configuring Static and Default Routes” section on page 22-2, and then define a route map according
to the “Defining a Route Map” section on page 23-4.
To redistribute static, connected, RIP, or OSPF routes into an OSPF process, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

24-4

Chapter 24

Configuring OSPF
Customizing OSPF

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for the OSPF process that you want to redistribute.

Example:

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.

hostname(config)# router ospf 2

Step 2

Do one of the following to redistribute the selected route type into the OSPF routing process:
redistribute connected
[[metric metric-value]
[metric-type {type-1 | type-2}]
[tag tag_value] [subnets] [route-map
map_name]

Redistributes connected routes into the OSPF routing process.

Example:
hostname(config)# redistribute connected 5
type-1 route-map-practice
redistribute static [metric metric-value]
[metric-type {type-1 | type-2}]
[tag tag_value] [subnets] [route-map
map_name

Redistributes static routes into the OSPF routing process.

Example:
hostname(config)# redistribute static 5
type-1 route-map-practice
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:
hostname(config)# route-map 1-to-2 permit
hostname(config-route-map)# match metric 1
hostname(config-route-map)# set metric 5
hostname(config-route-map)# set
metric-type type-1
hostname(config-route-map)# router ospf 2
hostname(config-router)# redistribute ospf
1 route-map 1-to-2

Allows you to redistribute routes from an OSPF routing process
into another OSPF routing process.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

24-5

Chapter 24

Configuring OSPF

Customizing OSPF

Command

Purpose

redistribute rip [metric metric-value]
[metric-type {type-1 | type-2}]
[tag tag_value] [subnets] [route-map
map_name]

Allows you to redistribute routes from a RIP routing process into
the OSPF routing process.

Example:
hostname(config)# redistribute rip 5
hostname(config-route-map)# match metric 1
hostname(config-route-map)# set metric 5
hostname(config-route-map)# set
metric-type type-1
hostname(config-router)# redistribute ospf
1 route-map 1-to-2
redistribute eigrp as-num
[metric metric-value]
[metric-type {type-1 | type-2}]
[tag tag_value] [subnets] [route-map
map_name]

Allows you to redistribute routes from an EIGRP routing process
into the OSPF routing process.

Example:
hostname(config)# redistribute eigrp 2
hostname(config-route-map)# match metric 1
hostname(config-route-map)# set metric 5
hostname(config-route-map)# set
metric-type type-1
hostname(config-router)# redistribute ospf
1 route-map 1-to-2

Configuring Route Summarization When Redistributing Routes Into OSPF
When routes from other protocols are redistributed into OSPF, each route is advertised individually in
an external LSA. However, you can configure the ASA to advertise a single route for all the redistributed
routes that are included for a specified network address and mask. This configuration decreases the size
of the OSPF link-state database.
Routes that match the specified IP Address mask pair can be suppressed. The tag value can be used as a
match value for controlling redistribution through route maps.

Cisco ASA 5500 Series Configuration Guide using the CLI

24-6

Chapter 24

Configuring OSPF
Customizing OSPF

To configure the software advertisement on one summary route for all redistributed routes included for
a network address and mask, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for this OSPF process.

Example:

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.

hostname(config)# router ospf 1

Step 2

summary-address ip_address mask
[not-advertise] [tag tag]

Sets the summary 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.

Example:
hostname(config)# router ospf 1
hostname(config-router)# summary-address
10.1.0.0 255.255.0.0

Configuring Route Summarization Between OSPF Areas
Route summarization is the consolidation of advertised addresses. This feature causes a single summary
route to be advertised to other areas by an area boundary router. In OSPF, an area boundary router
advertises 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:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for this OSPF process.

Example:

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.

hostname(config)# router ospf 1

Step 2

area area-id range ip-address mask
[advertise | not-advertise]

Sets the address range.
In this example, the address range is set between OSPF areas.

Example:
hostname(config)# router ospf 1
hostname(config-router)# area 17 range
12.1.0.0 255.255.0.0

Cisco ASA 5500 Series Configuration Guide using the CLI

24-7

Chapter 24

Configuring OSPF

Customizing OSPF

Configuring OSPF Interface Parameters
You can change some interface-specific OSPF parameters, if necessary.

Prerequisites
You are not required to change any of these parameters, but the following interface parameters must be
consistent across all routers in an attached network: ospf hello-interval, ospf dead-interval, and ospf
authentication-key. If you configure any of these parameters, be sure that the configurations for all
routers on your network have compatible values.
To configure OSPF interface parameters, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for the OSPF process that you want to redistribute.

Example:

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.

hostname(config)# router ospf 2

Step 2

network ip_address mask area area_id

Defines the IP addresses on which OSPF runs and the area ID for
that interface.

Example:
hostname(config)# router ospf 2
hostname(config-router)# network 10.0.0.0
255.0.0.0 area 0

Step 3

hostname(config)# interface interface_name

Allows you to enter interface configuration mode.

Example:
hostname(config)# interface my_interface

Step 4

Do one of the following to configure optional OSPF interface parameters:
ospf authentication [message-digest | null]

Example:
hostname(config-interface)# ospf
authentication message-digest

Cisco ASA 5500 Series Configuration Guide using the CLI

24-8

Specifies the authentication type for an interface.

Chapter 24

Configuring OSPF
Customizing OSPF

Command

Purpose

ospf authentication-key key

Allows you to assign a password to be used by neighboring OSPF
routers on a network segment that is using the OSPF simple
password authentication.

Example:
hostname(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.

ospf cost cost

Allows you to explicitly specify the cost of sending a packet on
an OSPF interface. The cost is an integer from 1 to 65535.

Example:

In this example, the cost is set to 20.

hostname(config-interface)# ospf cost 20
ospf dead-interval seconds

Example:
hostname(config-interface)# ospf
dead-interval 40
ospf hello-interval seconds

Example:

Allows you to 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. The value must be the same for all nodes
on the network.
In this example, the dead interval is set to 40.
Allows you to specify the length of time between the hello
packets that the ASA sends on an OSPF interface. The value must
be the same for all nodes on the network.

hostname(config-interface)# ospf
hello-interval 10

In this example, the hello interval is set to 10.

ospf message-digest-key key_id md5 key

Enables OSPF MD5 authentication.
The following argument values can be set:

Example:
hostname(config-interface)# ospf
message-digest-key 1 md5 cisco

•

key_id—An identifier in the range from 1 to 255.

•

key—An alphanumeric password of up to 16 bytes.

Usually, one key per interface is used to generate authentication
information when sending packets and to authenticate incoming
packets. The same key identifier on the neighbor router must have
the same key value.
We recommend that you not keep more than one key per interface.
Every time you add a new key, you should remove the old key to
prevent the local system from continuing to communicate with a
hostile system that knows the old key. Removing the old key also
reduces overhead during rollover.
ospf priority number_value

Allows you to set the priority to help determine the OSPF
designated router for a network.

Example:

The number_value argument ranges from 0 to 255.

hostname(config-interface)# ospf priority
20

In this example, the priority number value is set to 20.

Cisco ASA 5500 Series Configuration Guide using the CLI

24-9

Chapter 24

Configuring OSPF

Customizing OSPF

Command

Purpose

ospf retransmit-interval seconds

Allows you to specify the number of seconds between LSA
retransmissions for adjacencies belonging to an OSPF interface.

Example:

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 65535 seconds. The default value
is 5 seconds.

hostname(config-interface)# ospf
retransmit-interval seconds

In this example, the retransmit-interval value is set to 15.
ospf transmit-delay seconds

Example:

Sets the estimated number of seconds required to send a link-state
update packet on an OSPF interface. The seconds value ranges
from 1 to 65535 seconds. The default value is 1 second.

hostname(config-interface)# ospf
transmit-delay 5

In this example, the transmit-delay is 5 seconds.

ospf network point-to-point non-broadcast

Specifies the interface as a point-to-point, nonbroadcast network.

Example:
hostname(config-interface)# ospf network
point-to-point non-broadcast

When you designate an interface as point-to-point, nonbroadcast,
you must manually define the OSPF neighbor; dynamic neighbor
discovery is not possible. See the “Defining Static OSPF
Neighbors” section on page 24-12 for more information.
Additionally, you can only define one OSPF neighbor on that
interface.

Configuring OSPF Area Parameters
You can configure several OSPF area parameters. These area parameters (shown in the following task
list) include setting authentication, defining stub areas, and assigning specific costs to the default
summary route. Authentication provides password-based protection against unauthorized access to an
area.
Stub areas are areas into which information on external routes is not sent. Instead, there is a default
external route generated by the ABR into the stub area for destinations outside the autonomous system.
To take advantage of the OSPF stub area support, default routing must be used in the stub area. To further
reduce the number of LSAs sent into a stub area, you can use the no-summary keyword of the area stub
command on the ABR to prevent it from sending a summary link advertisement (LSA Type 3) into the
stub area.
To specify area parameters for your network, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for the OSPF process that you want to redistribute.

Example:

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.

hostname(config)# router ospf 2

Step 2

Do one of the following to configure optional OSPF area parameters:

Cisco ASA 5500 Series Configuration Guide using the CLI

24-10

Chapter 24

Configuring OSPF
Customizing OSPF

Command

Purpose

area area-id authentication

Enables authentication for an OSPF area.

Example:
hostname(config-router)# area 0
authentication
area area-id authentication message-digest

Enables MD5 authentication for an OSPF area.

Example:
hostname(config-router)# area 0
authentication message-digest

Configuring OSPF NSSA
The OSPF implementation of an NSSA is similar to an OSPF stub area. NSSA does not flood Type 5
external LSAs from the core into the area, but it can import autonomous system external routes in a
limited way within the area.
NSSA imports Type 7 autonomous system external routes within an NSSA area by redistribution. These
Type 7 LSAs are translated into Type 5 LSAs by NSSA ABRs, which are flooded throughout the whole
routing domain. Summarization and filtering are supported during the translation.
You can simplify administration if you are an ISP or a network administrator that must connect a central
site using OSPF to a remote site that is using a different routing protocol using NSSA.
Before the implementation of NSSA, the connection between the corporate site border router and the
remote router could not be run as an OSPF stub area because routes for the remote site could not be
redistributed into the stub area, and two routing protocols needed to be maintained. A simple protocol
such as RIP was usually run and handled the redistribution. With NSSA, you can extend OSPF to cover
the remote connection by defining the area between the corporate router and the remote router as an
NSSA.
Before you use this feature, consider these guidelines:
•

You can set a Type 7 default route that can be used to reach external destinations. When configured,
the router generates a Type 7 default into the NSSA or the NSSA area boundary router.

•

Every router within the same area must agree that the area is NSSA; otherwise, the routers will not
be able to communicate.

To specify area parameters for your network to configure OSPF NSSA, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for the OSPF process that you want to redistribute.

Example:

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.

hostname(config)# router ospf 2

Step 2

Do one of the following to configure optional OSPF NSSA parameters:

Cisco ASA 5500 Series Configuration Guide using the CLI

24-11

Chapter 24

Configuring OSPF

Customizing OSPF

Command

Purpose

area area-id nssa [no-redistribution]
[default-information-originate]

Defines an NSSA area.

Example:
hostname(config-router)# area 0 nssa
summary-address ip_address mask
[not-advertise] [tag tag]

Example:
hostname(config)# router ospf 1
hostname(config-router)# summary-address
10.1.0.0 255.255.0.0

Note

Sets the summary address and helps reduce the size of the routing
table. 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.

OSPF does not support summary-address 0.0.0.0 0.0.0.0.

Defining Static OSPF Neighbors
You need to define static OSPF neighbors to advertise OSPF routes over a point-to-point, non-broadcast
network. This feature lets you broadcast OSPF advertisements across an existing VPN connection
without having to encapsulate the advertisements in a GRE tunnel.
Before you begin, you must create a static route to the OSPF neighbor. See Chapter 22, “Configuring
Static and Default Routes,” for more information about creating static routes.
To define a static OSPF neighbor, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for this OSPF process.

Example:

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.

hostname(config)# router ospf 2

Step 2

neighbor addr [interface if_name]

Example:
hostname(config-router)# neighbor
255.255.0.0 [interface my_interface]

Cisco ASA 5500 Series Configuration Guide using the CLI

24-12

Defines the OSPF neighborhood.
The addr argument is the IP address of the OSPF neighbor. The
if_name argument is the interface used to communicate with the
neighbor. If the OSPF neighbor is not on the same network as any
of the directly connected interfaces, you must specify the
interface.

Chapter 24

Configuring OSPF
Customizing OSPF

Configuring Route Calculation Timers
You can configure the delay time between when OSPF receives a topology change and when it starts an
SPF calculation. You also can configure the hold time between two consecutive SPF calculations.
To configure route calculation timers, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for this OSPF process.

Example:

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.

hostname(config)# router ospf 2

Step 2

timers spf spf-delay spf-holdtime

Configures the route calculation times.

The spf-delay argument is the delay time (in seconds) between
when OSPF receives a topology change and when it starts an SPF
hostname(config-router)# timers spf 10 120 calculation. It can be an integer from 0 to 65535. The default time
is 5 seconds. A value of 0 means that there is no delay; that is, the
SPF calculation is started immediately.
Example:

The spf-holdtime argument is the minimum time (in seconds)
between two consecutive SPF calculations. It can be an integer
from 0 to 65535. The default time is 10 seconds. A value of 0
means that there is no delay; that is, two SPF calculations can be
performed, one immediately after the other.

Logging Neighbors Going Up or Down
By default, a syslog message is generated when an OSPF neighbor goes up or down.
Configure log-adj-changes router configuration command if you want to know about OSPF neighbors
going up or down without turning on the debug ospf adjacency command. The log-adj-changes router
configuration command provides a higher level view of the peer relationship with less output. Configure
the log-adj-changes detail command if you want to see messages for each state change.

Cisco ASA 5500 Series Configuration Guide using the CLI

24-13

Chapter 24

Configuring OSPF

Restarting the OSPF Process

To log neighbors going up or down, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router ospf process_id

Creates an OSPF routing process and enters router configuration
mode for this OSPF process.

Example:

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.

hostname(config)# router ospf 2

Step 2

Configures logging for neighbors going up or down.

log-adj-changes [detail]

Example:
hostname(config-router)# log-adj-changes
[detail]

Restarting the OSPF Process
To remove the entire OSPF configuration that you have enabled, enter the following command:
Command

Purpose

clear ospf pid {process | redistribution |
counters [neighbor [neighbor-interface]
[neighbor-id]]}

Removes the entire OSPF configuration that you have enabled. After the
configuration is cleared, you must reconfigure OSPF using the router ospf
command.

Example:
hostname(config)# clear ospf

Configuration Example for OSPF
The following example shows how to enable and configure OSPF with various optional processes:
Step 1

To enable OSPF, enter the following commands:
hostname(config)# router ospf 2
hostname(config-router)# network 10.0.0.0 255.0.0.0 area 0

Step 2

(Optional) To redistribute routes from one OSPF process to another OSPF process, enter the following
commands:
hostname(config)# route-map 1-to-2 permit
hostname(config-route-map)# match metric 1
hostname(config-route-map)# set metric 5
hostname(config-route-map)# set metric-type type-1
hostname(config-route-map)# router ospf 2
hostname(config-router)# redistribute ospf 1 route-map 1-to-2

Cisco ASA 5500 Series Configuration Guide using the CLI

24-14

Chapter 24

Configuring OSPF
Configuration Example for OSPF

Step 3

(Optional) To configure OSPF interface parameters, enter the following commands:
hostname(config)# router ospf 2
hostname(config-router)# network 10.0.0.0 255.0.0.0 area 0
hostname(config-router)# interface inside
hostname(config-interface)# ospf cost 20
hostname(config-interface)# ospf retransmit-interval 15
hostname(config-interface)# ospf transmit-delay 10
hostname(config-interface)# ospf priority 20
hostname(config-interface)# ospf hello-interval 10
hostname(config-interface)# ospf dead-interval 40
hostname(config-interface)# ospf authentication-key cisco
hostname(config-interface)# ospf message-digest-key 1 md5 cisco
hostname(config-interface)# ospf authentication message-digest

Step 4

(Optional) To configure OSPF area parameters, enter the following commands:
hostname(config)# router
hostname(config-router)#
hostname(config-router)#
hostname(config-router)#
hostname(config-router)#

Step 5

ospf
area
area
area
area

2
0 authentication
0 authentication message-digest
17 stub
17 default-cost 20

(Optional) To configure the route calculation timers and show the log neighbor up and down messages,
enter the following commands:
hostname(config-router)# timers spf 10 120
hostname(config-router)# log-adj-changes [detail]

Step 6

To restart the OSPF process, enter the following commands:
hostname(config)# clear ospf pid {process | redistribution | counters
[neighbor [neighbor-interface] [neighbor-id]]}

Step 7

(Optional) To show current OSPF configuration settings, enter the show ospf command.
The following is sample output from the show ospf command:
hostname(config)# show ospf
Routing Process “ospf 2” with ID 10.1.89.2 and Domain ID 0.0.0.2
Supports only single TOS(TOS0) routes
Supports opaque LSA
SPF schedule delay 5 secs, Hold time between two SPFs 10 secs
Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs
Number of external LSA 5. Checksum Sum 0x 26da6
Number of opaque AS LSA 0. Checksum Sum 0x
0
Number of DCbitless external and opaque AS LSA 0
Number of DoNotAge external and opaque AS LSA 0
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
External flood list length 0
Area BACKBONE(0)
Number of interfaces in this area is 1
Area has no authentication
SPF algorithm executed 2 times
Area ranges are
Number of LSA 5. Checksum Sum 0x 209a3
Number of opaque link LSA 0. Checksum Sum 0x
0
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0

Cisco ASA 5500 Series Configuration Guide using the CLI

24-15

Chapter 24

Configuring OSPF

Monitoring OSPF

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 OSPF routing statistics, enter one of the following commands:
Command

Purpose

show ospf [process-id [area-id]]

Displays general information about OSPF routing
processes.

show ospf border-routers

Displays the internal OSPF routing table entries to
the ABR and ASBR.

show ospf [process-id [area-id]] database

Displays lists of information related to the OSPF
database for a specific router.

show ospf flood-list if-name

Displays a list of LSAs waiting to be flooded over
an interface (to observe OSPF packet pacing).
OSPF 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.

Pacing is also used between resends to increase
efficiency and minimize lost retransmissions. You
also can display the LSAs waiting to be sent out of
an interface. Pacing enables OSPF update and
retransmission packets to be sent more efficiently.
There are no configuration tasks for this feature; it
occurs automatically.
show ospf interface [if_name]

Displays OSPF-related interface information.

show ospf neighbor [interface-name]
[neighbor-id] [detail]

Displays OSPF neighbor information on a
per-interface basis.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

24-16

Chapter 24

Configuring OSPF
Feature History for OSPF

Command

Purpose

show ospf [process-id] summary-address

Displays a list of all summary address
redistribution information configured under an
OSPF process.

show ospf [process-id] virtual-links

Displays OSPF-related virtual links information.

Feature History for OSPF
Table 24-1 lists each feature change and the platform release in which it was implemented.
Table 24-1

Feature History for Static and Default Routes

Feature Name

Platform
Releases

OSPF support

7.0(1)

Feature Information
Support was added for route data, authentication, and
redistribution and monitoring of routing information using
the Open Shortest Path First (OSPF) routing protocol.
We introduced the route ospf command.

Cisco ASA 5500 Series Configuration Guide using the CLI

24-17

Chapter 24
Feature History for OSPF

Cisco ASA 5500 Series Configuration Guide using the CLI

24-18

Configuring OSPF

CH A P T E R

25

Configuring RIP
This chapter describes how to configure the ASA to route data, perform authentication, and redistribute
routing information using the Routing Information Protocol (RIP).
This chapter includes the following sections:
•

Information About RIP, page 25-1

•

Licensing Requirements for RIP, page 25-3

•

Guidelines and Limitations, page 25-3

•

Configuring RIP, page 25-4

•

Customizing RIP, page 25-4

•

Monitoring RIP, page 25-11

•

Configuration Example for RIP, page 25-11

•

Feature History for RIP, page 25-11

Information About RIP
This section includes the following topics:
•

Routing Update Process, page 25-2

•

RIP Routing Metric, page 25-2

•

RIP Stability Features, page 25-2

•

RIP Timers, page 25-2

The Routing Information Protocol, or RIP, as it is more commonly called, is one of the most enduring
of all routing protocols. RIP has four basic components: routing update process, RIP routing metrics,
routing stability, and routing timers. Devices that support RIP send routing-update messages at regular
intervals and when the network topology changes. These RIP packets include information about the
networks that the devices can reach, as well as the number of routers or gateways that a packet must
travel through to reach the destination address. RIP generates more traffic than OSPF, but is easier to
configure.
RIP is a distance-vector routing protocol that uses hop count as the metric for path selection. When RIP
is enabled on an interface, the interface exchanges RIP broadcasts with neighboring devices to
dynamically learn about and advertise routes.

Cisco ASA 5500 Series Configuration Guide using the CLI

25-1

Chapter 25

Configuring RIP

Information About RIP

The ASA supports both RIP Version 1 and RIP Version 2. RIP Version 1 does not send the subnet mask
with the routing update. RIP Version 2 sends the subnet mask with the routing update and supports
variable-length subnet masks. Additionally, RIP Version 2 supports neighbor authentication when
routing updates are exchanged. This authentication ensures that the ASA receives reliable routing
information from a trusted source.
RIP has advantages over static routes because the initial configuration is simple, and you do not need to
update the configuration when the topology changes. The disadvantage to RIP is that there is more
network and processing overhead than in static routing.

Routing Update Process
RIP sends routing-update messages at regular intervals and when the network topology changes. When
a router receives a routing update that includes changes to an entry, it updates its routing table to reflect
the new route. The metric value for the path is increased by 1, and the sender is indicated as the next hop.
RIP routers maintain only the best route (the route with the lowest metric value) to a destination. After
updating its routing table, the router immediately begins transmitting routing updates to inform other
network routers of the change. These updates are sent independently of the regularly scheduled updates
that RIP routers send.

RIP Routing Metric
RIP uses a single routing metric (hop count) to measure the distance between the source and a destination
network. Each hop in a path from source to destination is assigned a hop count value, which is typically
1. When a router receives a routing update that contains a new or changed destination network entry, the
router adds 1 to the metric value indicated in the update and enters the network in the routing table. The
IP address of the sender is used as the next hop.

RIP Stability Features
RIP prevents routing loops from continuing indefinitely by implementing a limit on the number of hops
allowed in a path from the source to a destination. The maximum number of hops in a path is 15. If a
router receives a routing update that contains a new or changed entry, and if increasing the metric value
by 1 causes the metric to be infinity (that is, 16), the network destination is considered unreachable. The
downside of this stability feature is that it limits the maximum diameter of a RIP network to less than 16
hops.
RIP includes a number of other stability features that are common to many routing protocols. These
features are designed to provide stability despite potentially rapid changes in network topology. For
example, RIP implements the split horizon and hold-down mechanisms to prevent incorrect routing
information from being propagated.

RIP Timers
RIP uses numerous timers to regulate its performance. These include a routing-update timer, a
route-timeout timer, and a route-flush timer. The routing-update timer clocks the interval between
periodic routing updates. Generally, it is set to 30 seconds, with a small random amount of time added
whenever the timer is reset. This is done to help prevent congestion, which could result from all routers

Cisco ASA 5500 Series Configuration Guide using the CLI

25-2

Chapter 25

Configuring RIP
Licensing Requirements for RIP

simultaneously attempting to update their neighbors. Each routing table entry has a route-timeout timer
associated with it. When the route-timeout timer expires, the route is marked invalid but is retained in
the table until the route-flush timer expires.

Licensing Requirements for RIP
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode only.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Does not support IPv6.
Additional Guidelines

The following information applies to RIP Version 2 only:
•

If using neighbor authentication, the authentication key and key ID must be the same on all neighbor
devices that provide RIP Version 2 updates to the interface.

•

With RIP Version 2, the ASA transmits and receives default route updates using the multicast
address 224.0.0.9. In passive mode, it receives route updates at that address.

•

When RIP Version 2 is configured on an interface, the multicast address 224.0.0.9 is registered on
that interface. When a RIP Version 2 configuration is removed from an interface, that multicast
address is unregistered.

Limitations
•

The ASA cannot pass RIP updates between interfaces.

•

RIP Version 1 does not support variable-length subnet masks.

•

RIP has a maximum hop count of 15. A route with a hop count greater than 15 is considered
unreachable.

•

RIP convergence is relatively slow compared to other routing protocols.

•

You can only enable a single RIP process on the ASA.

Cisco ASA 5500 Series Configuration Guide using the CLI

25-3

Chapter 25

Configuring RIP

Configuring RIP

Configuring RIP
This section describes how to enable and restart the RIP process on the ASA.
After you have enabled RIP, see the “Customizing RIP” section on page 25-4 to learn how to customize
the RIP process on the ASA.

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. For
information, see the “Configuring a Default Static Route” section on page 22-4 and then define a route
map. For information, see the “Defining a Route Map” section on page 23-4.

Enabling RIP
You can only enable one RIP routing process on the ASA. After you enable the RIP routing process, you
must define the interfaces that will participate in that routing process using the network command. By
default, the ASA sends RIP Version 1 updates and accepts RIP Version 1 and Version 2 updates.
To enable the RIP routing process, enter the following command:
Command

Purpose

router rip

Starts the RIP routing process and places you in router configuration mode.

Example:

Use the no router rip command to remove the entire RIP configuration
that you have enabled. After the configuration is cleared, you must
reconfigure RIP using the router rip command.

hostname(config)# router rip

Customizing RIP
This section describes how to configure RIP and includes the following topics:
•

Configuring the RIP Version, page 25-5

•

Configuring Interfaces for RIP, page 25-6

•

Configuring the RIP Send and Receive Version on an Interface, page 25-6

•

Configuring Route Summarization, page 25-7

•

Filtering Networks in RIP, page 25-8

•

Redistributing Routes into the RIP Routing Process, page 25-8

•

Enabling RIP Authentication, page 25-9

•

. Restarting the RIP Process, page 25-10

Cisco ASA 5500 Series Configuration Guide using the CLI

25-4

Chapter 25

Configuring RIP
Customizing RIP

Configuring the RIP Version
To specify the version of RIP used by the ASA, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router rip

Starts the RIP routing process and places you in router
configuration mode.

Example:
hostname(config)# router rip

Step 2

network network_address

Specifies the interfaces that will participate in the RIP routing
process.

Example:

If an interface belongs to a network defined by this command, the
interface will participate in the RIP routing process. If an
interface does not belong to a network defined by this command,
the interface will not send or receive RIP updates.

hostname(config)# router rip
hostname(config-router)# network 10.0.0.0

Step 3

Enter one of the following numbers to customize an interface to participate in RIP routing:
version [1 | 2]

Specifies the version of RIP used by the ASA.
You can override this setting on a per-interface basis.

Example:
hostname(config-router):# version [1]

In this example, Version 1 is entered.

Cisco ASA 5500 Series Configuration Guide using the CLI

25-5

Chapter 25

Configuring RIP

Customizing RIP

Configuring Interfaces for RIP
If you have an interface that you do not want to have participate in RIP routing, but that is attached to a
network that you want advertised, you can configure the network (using the network command) that
includes the network to which the interface is attached, and configure the passive interfaces (using the
passive-interface command) to prevent that interface from using RIP. Additionally, you can specify the
version of RIP that is used by the ASA for updates.
To configure interfaces for RIP, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router rip

Starts the RIP routing process and places you in router
configuration mode.

Example:
hostname(config)# router rip

Step 2

network network_address

Specifies the interfaces that will participate in the RIP routing
process.

Example:

If an interface belongs to a network defined by this command, the
interface will participate in the RIP routing process. If an
interface does not belong to a network defined by this command,
it will not send or receive RIP updates.

hostname(config)# router rip
hostname(config-router)# network 10.0.0.0

Step 3

passive-interface

[default | if_name]

Specifies an interface to operate in passive mode.

Using the default keyword causes all interfaces to operate in
passive mode. Specifying an interface name sets only that
hostname(config-router)# passive-interface interface to passive mode. In passive mode, RIP routing updates
[default]
are accepted by, but not sent out of, the specified interface. You
can enter this command for each interface that you want to set to
passive mode.
Example:

Configuring the RIP Send and Receive Version on an Interface
You can override the globally-set version of RIP that the ASA uses to send and receive RIP updates on
a per-interface basis.
To configure the RIP version for sending and receiving updates, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

interface phy_if

Enters interface configuration mode for the interface that you are
configuring.

Example:
hostname(config)# interface phy_if

Step 2

Do one of the following to send or receive RIP updates on a per-interface basis.

Cisco ASA 5500 Series Configuration Guide using the CLI

25-6

Chapter 25

Configuring RIP
Customizing RIP

Command

Purpose

rip send version {[1] [2]}

Specifies the version of RIP to use when sending RIP updates out
of the interface.

Example:

In this example, Version 1 is selected.

hostname(config-if)# rip send version 1
rip receive version {[1] [2]}

Specifies the version of RIP advertisements permitted to be
received by an interface.

Example:

In this example, Version 2 is selected.

hostname(config-if)# rip receive version 2

RIP updates received on the interface that do not match the
allowed version are dropped.

Configuring Route Summarization
Note

RIP Version 1 always uses automatic route summarization. You cannot disable this feature for RIP
Version 1. RIP Version 2 uses automatic route summarization by default.
The RIP routing process summarizes on network number boundaries, which can cause routing problems
if you have noncontiguous networks.
For example, if you have a router with the networks 192.168.1.0, 192.168.2.0, and 192.168.3.0
connected to it, and those networks all participate in RIP, the RIP routing process creates the summary
address 192.168.0.0 for those routes. If an additional router is added to the network with the networks
192.168.10.0 and 192.168.11.0, and those networks participate in RIP, they will also be summarized as
192.168.0.0. To prevent the possibility of traffic being routed to the wrong location, you should disable
automatic route summarization on the routers that are creating conflicting summary addresses.
Because RIP Version 1 always uses automatic route summarization, and RIP Version 2 always uses
automatic route summarization by default, when configuring automatic route summarization, you only
need to disable it.
To disable automatic route summarization, enter the following command:

Detailed Steps

Step 1

Command

Purpose

router rip

Enables the RIP routing process and places you in router
configuration mode.

Example:
hostname(config)# router rip

Step 2

no auto-summarize

Disables automatic route summarization.

Example:
hostname(config-router):# no
auto-summarize

Cisco ASA 5500 Series Configuration Guide using the CLI

25-7

Chapter 25

Configuring RIP

Customizing RIP

Filtering Networks in RIP
To filter the networks received in updates, perform the following steps:

Note

Before you begin, you must create a standard access list that permits the networks that you want the RIP
process to allow in the routing table and denies the networks that you want the RIP process to discard.

Detailed Steps

Step 1

Command

Purpose

router rip

Enables the RIP routing process and places you in router
configuration mode.

Example:
hostname(config)# router rip

Step 2

distribute-list acl in [interface if_name]
distribute-list acl out [connected | eigrp
| interface if_name | ospf | rip | static]

Example:
hostname(config-router)# distribute-list
acl2 in [interface interface1]
hostname(config-router)# distribute-list
acl3 out [connected]

Filters the networks sent in updates.
You can specify an interface to apply the filter to only those
updates that are received or sent by that interface. You can enter
this command for each interface to which you want to apply a
filter. If you do not specify an interface name, the filter is applied
to all RIP updates.

Redistributing Routes into the RIP Routing Process
You can redistribute routes from the OSPF, EIGRP, static, and connected routing processes into the RIP
routing process.

Note

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. See Chapter 23, “Defining a
Route Map,” for more information about creating a route map.

Cisco ASA 5500 Series Configuration Guide using the CLI

25-8

Chapter 25

Configuring RIP
Customizing RIP

To redistribute a route into the RIP routing process, enter one of the following commands:
Command

Purpose

Choose one of the following commands to redistribute the selected route type into the RIP routing process. You must specify
the RIP metric values in the redistribute command if you do not have a default-metric command in the RIP router
configuration.
redistribute connected [metric
metric-value | transparent] [route-map
route-map-name]

Redistributes connected routes into the RIP routing process.

Example:
hostname(config-router): # redistribute
connected [metric metric-value |
transparent] [route-map route-map-name]
redistribute static [metric {metric_value
| transparent}] [route-map map_name]

Redistributes static routes into the EIGRP routing process.

Example:
hostname(config-router):# redistribute
static [metric {metric_value |
transparent}] [route-map map_name]
redistribute ospf pid [match {internal |
external [1 | 2] | nssa-external [1 | 2]}]
[metric {metric_value | transparent}]
[route-map map_name]

Redistributes routes from an OSPF routing process into the RIP routing
process.

Example:
hostname(config-router):# redistribute
ospf pid [match {internal | external [1 |
2] | nssa-external [1 | 2]}] [metric
{metric_value | transparent}] [route-map
map_name]
redistribute eigrp as-num [metric
{metric_value | transparent}] [route-map
map_name]

Redistributes routes from an EIGRP routing process into the RIP routing
process.

Example:
hostname(config-router):# redistribute
eigrp as-num [metric {metric_value |
transparent}] [route-map map_name]

Enabling RIP Authentication
Note

The ASA supports RIP message authentication for RIP Version 2 messages.

Cisco ASA 5500 Series Configuration Guide using the CLI

25-9

Chapter 25

Configuring RIP

Customizing RIP

RIP route authentication provides MD5 authentication of routing updates from the RIP routing protocol.
The MD5 keyed digest in each RIP packet prevents the introduction of unauthorized or false routing
messages from unapproved sources.
RIP route authentication is configured on a per-interface basis. All RIP neighbors on interfaces
configured for RIP message authentication must be configured with the same authentication mode and
key for adjacencies to be established.

Note

Before you can enable RIP route authentication, you must enable RIP.
To enable RIP authentication on an interface, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router rip as-num

Creates the RIP routing process and enters router configuration
mode for this RIP process.

Example:

The as-num argument is the autonomous system number of the
RIP routing process.

hostname(config)# router rip 2

Step 2

Enters interface configuration mode for the interface on which
you are configuring RIP message authentication.

interface phy_if

Example:
hostname(config)# interface phy_if

Step 3

rip authentication mode {text | md5}

Sets the authentication mode. By default, text authentication is
used. We recommend that you use MD5 authentication.

Example:
hostname(config-if)# rip authentication
mode md5

Step 4

rip authentication key key key-id key-id

Configures the authentication key used by the MD5 algorithm.
The key argument can include up to 16 characters.

Example:
hostname(config-if)# rip authentication
key cisco key-id 200

.

The key-id argument is a number from 0 to 255.

Restarting the RIP Process
To remove the entire RIP configuration, enter the following command:

Command

Purpose

clear rip pid {process | redistribution |
counters [neighbor [neighbor-interface]
[neighbor-id]]}

Removes the entire RIP configuration that you have enabled. After the
configuration is cleared, you must reconfigure RIP again using the router
rip command.

Example:
hostname(config)# clear rip

Cisco ASA 5500 Series Configuration Guide using the CLI

25-10

Chapter 25

Configuring RIP
Monitoring RIP

Monitoring RIP
We recommend that you only use the debug commands to troubleshoot specific problems or during
troubleshooting sessions with the Cisco TAC.
Debugging output is assigned high priority in the CPU process and can render the ASA unusable. It is
best to use debug commands during periods of lower network traffic and fewer users. Debugging during
these periods decreases the likelihood that increased debug command processing overhead will affect
performance. For examples and descriptions of the command output, see the command reference.
To monitor or debug various RIP routing statistics, enter one of the following commands:
Command

Purpose

Monitoring RIP Routing
show rip database

Display the contents of the RIP routing database.

show running-config router
rip

Displays the RIP commands.

Debugging RIP
debug rip events

Displays RIP processing events.

debug rip database

Displays RIP database events.

Configuration Example for RIP
The following example shows how to enable and configure RIP with various optional processes:
hostname(config)# router rip 2
hostname(config-router)# default-information originate
hostname(config-router)# version [1]
hostname(config-router)# network 225.25.25.225
hostname(config-router)# passive-interface [default]
hostname(config-router)# redistribute connected [metric bandwidth delay reliability
loading mtu] [route-map map_name]

Feature History for RIP
Table 25-1 lists each feature change and the platform release in which it was implemented.
Table 25-1

Feature History for RIP

Feature Name

Releases

Feature Information

RIP support

7.0(1)

Support was added for routing data, performing
authentication, and redistributing and monitoring routing
information using the Routing Information Protocol (RIP).
We introduced the route rip command.

Cisco ASA 5500 Series Configuration Guide using the CLI

25-11

Chapter 25
Feature History for RIP

Cisco ASA 5500 Series Configuration Guide using the CLI

25-12

Configuring RIP

CH A P T E R

26

Configuring Multicast Routing
This chapter describes how to configure the ASA to use the multicast routing protocol and includes the
following sections:
•

Information About Multicast Routing, page 26-1

•

Licensing Requirements for Multicast Routing, page 26-2

•

Guidelines and Limitations, page 26-3

•

Enabling Multicast Routing, page 26-3

•

Customizing Multicast Routing, page 26-4

•

Configuration Example for Multicast Routing, page 26-14

•

Additional References, page 26-15

•

Feature History for Multicast Routing, page 26-15

Information About Multicast Routing
Multicast routing is a bandwidth-conserving technology that reduces traffic by simultaneously
delivering a single stream of information to thousands of corporate recipients and homes. Applications
that take advantage of multicast routing include videoconferencing, corporate communications, distance
learning, and distribution of software, stock quotes, and news.
Multicast routing protocols delivers source traffic to multiple receivers without adding any additional
burden on the source or the receivers while using the least network bandwidth of any competing
technology. Multicast packets are replicated in the network by Cisco routers enabled with Protocol
Independent Multicast (PIM) and other supporting multicast protocols resulting in the most efficient
delivery of data to multiple receivers possible.
The ASA supports both stub multicast routing and PIM multicast routing. However, you cannot
configure both concurrently on a single ASA.

Note

The UDP and non-UDP transports are both supported for multicast routing. However, the non-UDP
transport has no FastPath optimization.
This section includes the following topics:
•

Stub Multicast Routing, page 26-2

•

PIM Multicast Routing, page 26-2

Cisco ASA 5500 Series Configuration Guide using the CLI

26-1

Chapter 26

Configuring Multicast Routing

Licensing Requirements for Multicast Routing

•

Multicast Group Concept, page 26-2

Stub Multicast Routing
Stub multicast routing provides dynamic host registration and facilitates multicast routing. When
configured for stub multicast routing, the ASA acts as an IGMP proxy agent. Instead of fully
participating in multicast routing, the ASA forwards IGMP messages to an upstream multicast router,
which sets up delivery of the multicast data. When configured for stub multicast routing, the ASA cannot
be configured for PIM.
The ASA supports both PIM-SM and bidirectional PIM. PIM-SM is a multicast routing protocol that
uses the underlying unicast routing information base or a separate multicast-capable routing information
base. It builds unidirectional shared trees rooted at a single Rendezvous Point per multicast group and
optionally creates shortest-path trees per multicast source.

PIM Multicast Routing
Bi-directional PIM is a variant of PIM-SM that builds bi-directional shared trees connecting multicast
sources and receivers. Bi-directional trees are built using a DF election process operating on each link
of the multicast topology. With the assistance of the DF, multicast data is forwarded from sources to the
Rendezvous Point, and therefore along the shared tree to receivers, without requiring source-specific
state. The DF election takes place during Rendezvous Point discovery and provides a default route to the
Rendezvous Point.

Note

If the ASA is the PIM RP, use the untranslated outside address of the ASA as the RP address.

Multicast Group Concept
Multicast is based on the concept of a group. An arbitrary group of receivers expresses an interest in
receiving a particular data stream. This group does not have any physical or geographical
boundaries—the hosts can be located anywhere on the Internet. Hosts that are interested in receiving data
flowing to a particular group must join the group using IGMP. Hosts must be a member of the group to
receive the data stream.

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.

Licensing Requirements for Multicast Routing
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

26-2

Chapter 26

Configuring Multicast Routing
Guidelines and Limitations

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode. In multiple context mode, unshared interfaces and shared interfaces
are not supported.
Firewall Mode Guidelines

Supported only in routed firewall mode. Transparent firewall mode is not supported.
IPv6 Guidelines

Does not support IPv6.

Enabling Multicast Routing
Enabling multicast routing lets you enable multicast routing on the ASA. Enabling multicast routing
enables IGMP and PIM on all interfaces by default. IGMP is used to learn whether members of a group
are present on directly attached subnets. Hosts join multicast groups by sending IGMP report messages.
PIM is used to maintain forwarding tables to forward multicast datagrams.

Note

Only the UDP transport layer is supported for multicast routing.
To enable multicast routing, enter the following command:

Command

Purpose

multicast-routing

Enables multicast routing.

Example:

The number of entries in the multicast routing tables are limited by the
amount of RAM on the ASA.

hostname(config)# multicast-routing

Table 26-1 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.
Table 26-1

Entry Limits for Multicast Tables

Table

16 MB 128 MB 128+ MB

MFIB

1000

3000

5000

IGMP
Groups

1000

3000

5000

PIM Routes 3000

7000

12000

Cisco ASA 5500 Series Configuration Guide using the CLI

26-3

Chapter 26

Configuring Multicast Routing

Customizing Multicast Routing

Customizing Multicast Routing
This section describes how to customize multicast routing and includes the following topics:
•

Configuring Stub Multicast Routing and Forwarding IGMP Messages, page 26-4

•

Configuring a Static Multicast Route, page 26-4

•

Configuring IGMP Features, page 26-5

•

Configuring PIM Features, page 26-9

•

Configuring a Bidirectional Neighbor Filter, page 26-13

•

Configuring a Multicast Boundary, page 26-14

Configuring Stub Multicast Routing and Forwarding IGMP Messages
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.
To forward the host join and leave messages, enter the following command from the interface attached
to the stub area:

Command

Purpose

igmp forward interface if_name

Configures stub multicast routing and forwards IGMP messages.

Example:
hostname(config-if)# igmp forward
interface interface1

Configuring a Static Multicast Route
Configuring static multicast routes lets you separate multicast traffic from unicast traffic. For example,
when a path between a source and destination does not support multicast routing, the solution is to
configure two multicast devices with a GRE tunnel between them and to send the multicast packets over
the tunnel.
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.
To configure a static multicast route or a static multicast route for a stub area, enter one of the following
commands:

Cisco ASA 5500 Series Configuration Guide using the CLI

26-4

Chapter 26

Configuring Multicast Routing
Customizing Multicast Routing

Command

Purpose

mroute src_ip src_mask {input_if_name |
rpf_neighbor} [distance]

Configures a static multicast route.

Example:
hostname(config)# mroute src_ip src_mask
{input_if_name | rpf_neighbor} [distance]
mroute src_ip src_mask input_if_name
[dense output_if_name] [distance]

Configures a static multicast route for a stub area.
The dense output_if_name keyword and argument pair is only supported
for stub multicast routing.

Example:
hostname(config)# mroute src_ip src_mask
input_if_name [dense output_if_name]
[distance]

Configuring IGMP Features
IP hosts use the Internet Group Management Protocol (IGMP) to report their group memberships to
directly connected multicast routers.
IGMP is used to dynamically register individual hosts in a multicast group on a particular LAN. Hosts
identify group memberships by sending IGMP messages to their local multicast router. Under IGMP,
routers listen to IGMP messages and periodically send out queries to discover which groups are active
or inactive on a particular subnet.
IGMP uses group addresses (Class D IP address) as group identifiers. Host group address can be in the
range of 224.0.0.0 to 239.255.255.255. The address 224.0.0.0 is never assigned to any group. The
address 224.0.0.1 is assigned to all systems on a subnet. The address 224.0.0.2 is assigned to all routers
on a subnet.
When you enable multicast routing on the ASA, IGMP Version 2 is automatically enabled on all
interfaces.

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 and includes the
following topics:
•

Disabling IGMP on an Interface, page 26-6

•

Configuring IGMP Group Membership, page 26-6

•

Configuring a Statically Joined IGMP Group, page 26-6

•

Controlling Access to Multicast Groups, page 26-7

•

Limiting the Number of IGMP States on an Interface, page 26-7

•

Modifying the Query Messages to Multicast Groups, page 26-8

•

Changing the IGMP Version, page 26-9

Cisco ASA 5500 Series Configuration Guide using the CLI

26-5

Chapter 26

Configuring Multicast Routing

Customizing Multicast Routing

Disabling IGMP on an Interface
You can disable IGMP on specific interfaces. This information is useful if you know that there are no
multicast hosts on a specific interface and you want to prevent the ASA from sending host query
messages on that interface.
To disable IGMP on an interface, enter the following command:
Command

Purpose

no igmp

Disables IGMP on an interface.
To reenable IGMP on an interface, use the igmp command.

Example:
hostname(config-if)# no igmp

Note

Only the no igmp command appears in the interface configuration.

Configuring IGMP Group Membership
You can configure the ASA to be a member of a multicast group. Configuring the ASA to join a multicast
group causes upstream routers to maintain multicast routing table information for that group and keep
the paths for that group active.

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 the “Configuring a Statically Joined IGMP Group” section on
page 26-6.
To have the ASA join a multicast group, enter the following command:

Command

Purpose

igmp join-group group-address

Configures the ASA to be a member of a multicast group.
The group-address argument is the IP address of the group.

Example:
hostname(config-if)# igmp join-group
mcast-group

Configuring a Statically Joined IGMP Group
Sometimes a group member cannot report its membership in the group because of some configuration,
or there may be no members of a group on the network segment. However, you still want multicast traffic
for that group to be sent to that network segment. You can have multicast traffic for that group sent to
the segment by configuring a statically joined IGMP group.
Enter the igmp static-group command. The ASA does not accept the multicast packets, but instead
forwards them to the specified interface.
To configure a statically joined multicast group on an interface,enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

26-6

Chapter 26

Configuring Multicast Routing
Customizing Multicast Routing

Command

Purpose

igmp static-group

Configures the ASA statically to join a multicast group on an interface.
The group-address argument is the IP address of the group.

Example:
hostname(config-if)# igmp static-group
group-address

Controlling Access to Multicast Groups
To control the multicast groups that hosts on the ASA interface can join, perform the following steps:

Detailed Steps

Command
Step 1

Purpose

Do one of the following to create a standard or extended access list:
access-list name standard [permit | deny]
ip_addr mask

Creates a standard access list for the multicast traffic.
You can create more than one entry for a single access list. You
can use extended or standard access lists.

Example:
hostname(config)# access-list acl1
standard permit 192.52.662.25
access-list name extended [permit | deny]
protocol src_ip_addr src_mask dst_ip_addr
dst_mask

The ip_addr mask argument is the IP address of the multicast
group being permitted or denied.
Creates an extended access list.
The dst_ip_addr argument is the IP address of the multicast group
being permitted or denied.

Example:
hostname(config)# access-list acl2
extended permit protocol src_ip_addr
src_mask dst_ip_addr dst_mask

Step 2

igmp access-group acl

Applies the access list to an interface.

Example:

The acl argument is the name of a standard or extended IP access
list.

hostname(config-if)# igmp access-group acl

Limiting the Number of IGMP States on an Interface
You can limit the number of IGMP states resulting from IGMP membership reports on a per-interface
basis. Membership reports exceeding the configured limits are not entered in the IGMP cache, and traffic
for the excess membership reports is not forwarded.
To limit the number of IGMP states on an interface, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

26-7

Chapter 26

Configuring Multicast Routing

Customizing Multicast Routing

Command

Purpose

igmp limit number

Limits the number of IGMP states on an interface.

Example:
hostname(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.

Modifying the Query Messages to Multicast Groups
Note

The igmp query-timeout and igmp query-interval commands require IGMP Version 2.
The ASA sends query messages to discover which multicast groups have members on the networks
attached to the interfaces. Members respond with IGMP report messages indicating that they want to
receive multicast packets for specific groups. Query messages are addressed to the all-systems multicast
group, which has an address of 224.0.0.1, with a time-to-live value of 1.
These messages are sent periodically to refresh the membership information stored on the ASA. If the
ASA discovers that there are no local members of a multicast group still attached to an interface, it stops
forwarding multicast packet for that group to the attached network, and it sends a prune message back
to the source of the packets.
By default, the PIM designated router on the subnet is responsible for sending the query messages. By
default, they are sent once every 125 seconds.
When changing the query response time, by default, the maximum query response time advertised in
IGMP queries is 10 seconds. If the ASA does not receive a response to a host query within this amount
of time, it deletes the group.
To change the query interval, query response time, and query timeout value, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

igmp query-interval seconds

Sets the query interval time in seconds.
Valid values range from 0 to 500; 125 is the default value.

Example:
hostname(config-if)# igmp query-interval
30

Cisco ASA 5500 Series Configuration Guide using the CLI

26-8

If the ASA does not hear a query message on an interface for the
specified timeout value (by default, 255 seconds), then the ASA
becomes the designated router and starts sending the query
messages.

Chapter 26

Configuring Multicast Routing
Customizing Multicast Routing

Step 2

Command

Purpose

igmp query-timeout seconds

Changes the timeout value of the query.
Valid values range from 0 to 500; 225 is the default value.

Example:
hostname(config-if)# igmp query-timeout 30

Step 3

igmp query-max-response-time seconds

Changes the maximum query response time.

Example:
hostname(config-if)# igmp
query-max-response-time 30

Changing the IGMP Version
By default, the ASA runs IGMP Version 2, which enables several additional features such as the igmp
query-timeout and igmp query-interval commands.
All multicast routers on a subnet must support the same version of IGMP. The ASA does not
automatically detect Version 1 routers and switch to Version 1. However, a mix of IGMP Version 1 and
2 hosts on the subnet works; the ASA running IGMP Version 2 works correctly when IGMP Version 1
hosts are present.
To control which version of IGMP is running on an interface, enter the following command:
Command

Purpose

igmp version {1 | 2}

Controls the version of IGMP that you want to run on the interface.

Example:
hostname(config-if)# igmp version 2

Configuring PIM Features
Routers use PIM to maintain forwarding tables for forwarding multicast diagrams. When you enable
multicast routing on the ASA, PIM and IGMP are automatically enabled on all interfaces.

Note

PIM is not supported with PAT. The PIM protocol does not use ports, and PAT only works with protocols
that use ports.
This section describes how to configure optional PIM settings and includes the following topics:
•

Enabling and Disabling PIM on an Interface, page 26-10

•

Configuring a Static Rendezvous Point Address, page 26-10

•

Configuring the Designated Router Priority, page 26-11

•

Configuring and Filtering PIM Register Messages, page 26-11

•

Configuring PIM Message Intervals, page 26-12

•

Filtering PIM Neighbors, page 26-12

Cisco ASA 5500 Series Configuration Guide using the CLI

26-9

Chapter 26

Configuring Multicast Routing

Customizing Multicast Routing

Enabling and Disabling PIM on an Interface
You can enable or disable PIM on specific interfaces. To enable or disable PIM on an interface, perform
the following steps:

Detailed Steps

Step 1

Command

Purpose

pim

Enables or reenables PIM on a specific interface.

Example:
hostname(config-if)# pim

Step 2

Disables PIM on a specific interface.

no pim

Example:
hostname(config-if)# no pim

Note

Only the no pim command appears in the interface configuration.

Configuring a Static Rendezvous Point Address
All routers within a common PIM sparse mode or bidir domain require knowledge of the PIM RP
address. The address is statically configured using the pim rp-address command.

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
access list determines the PIM RP group mapping. If an access list is not specified, then the RP for the
group is applied to the entire multicast group range (224.0.0.0/4).
To configure the address of the PIM PR, enter the following command:

Command

Purpose

pim rp-address ip_address [acl] [bidir]

Enables or reenables PIM on a specific interface.

Example:

The ip_address argument is the unicast IP address of the router assigned to
be a PIM RP.

hostname(config)# pim rp-address
10.86.75.23 [acl1] [bidir]

The acl argument is the name or number of a standard access list 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

26-10

Chapter 26

Configuring Multicast Routing
Customizing Multicast Routing

Note

The ASA always advertises the bidirectional capability in the PIM hello messages, regardless of the
actual bidirectional configuration.

Configuring the Designated Router Priority
The DR is responsible for sending PIM register, join, and prune messages to the RP. When there is more
than one multicast router on a network segment, selecting the DR is based on the DR priority. If multiple
devices have the same DR priority, then the device with the highest IP address becomes the DR.
By default, the ASA has a DR priority of 1. To change this value, enter the following command:
Command

Purpose

pim dr-priority num

Changes the designated router priority.
The num argument can be any number ranging from 1 to 4294967294.

Example:
hostname(config-if)# pim dr-priority 500

Configuring and Filtering PIM Register Messages
When the ASA is acting as an RP, you can restrict specific multicast sources from registering with it to
prevent unauthorized sources from registering with the RP. The Request Filter pane lets you define the
multicast sources from which the ASA will accept PIM register messages.
To filter PIM register messages, enter the following command:
Command

Purpose

pim accept-register {list acl | route-map
map-name}

Configures the ASA to filter PIM register messages.
In the example, the ASA filters PIM register messages acl1 and route map
map2.

Example:
hostname(config)# pim accept-register
{list acl1 | route-map map2}

Cisco ASA 5500 Series Configuration Guide using the CLI

26-11

Chapter 26

Configuring Multicast Routing

Customizing Multicast Routing

Configuring PIM Message Intervals
Router query messages are used to select the PIM DR. The PIM DR is responsible for sending router
query messages. By default, router query messages are sent every 30 seconds. Additionally, every 60
seconds, the ASA sends PIM join or prune messages.
To change these intervals, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

pim hello-interval seconds

Sends router query messages.

Example:

Valid values for the seconds argument range from 1 to 3600
seconds.

hostname(config-if)# pim hello-interval 60

Step 2

pim join-prune-interval seconds

Changes the amount of time (in seconds) that the ASA sends PIM
join or prune messages.

Example:

Valid values for the seconds argument range from 10 to 600
seconds.

hostname(config-if)# pim
join-prune-interval 60

Filtering PIM Neighbors
You can define the routers that can become PIM neighbors. By filtering the routers that can become PIM
neighbors, you can do the following:
•

Prevent unauthorized routers from becoming PIM neighbors.

•

Prevent attached stub routers from participating in PIM.

To define neighbors that can become a PIM neighbor, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

access-list pim_nbr deny router-IP_addr
PIM neighbor

Uses a standard access list to define the routers that you want to
have participate in PIM.

Example:

In the example, the following access list, when used with the pim
neighbor-filter command, prevents the 10.1.1.1 router from
becoming a PIM neighbor.

hostname(config)# access-list pim_nbr deny
10.1.1.1 255.255.255.255

Step 2

pim neighbor-filter pim_nbr

Filters neighbor routers.

Example:

In the example, the 10.1.1.1 router is prevented from becoming a
PIM neighbor on interface GigabitEthernet0/3.

hostname(config)# interface
GigabitEthernet0/3
hostname(config-if)# pim neighbor-filter
pim_nbr

Cisco ASA 5500 Series Configuration Guide using the CLI

26-12

Chapter 26

Configuring Multicast Routing
Customizing Multicast Routing

Configuring a Bidirectional Neighbor Filter
The Bidirectional Neighbor Filter pane shows the PIM bidirectional neighbor filters, if any, that are
configured on the ASA. A PIM bidirectional neighbor filter is an ACL that defines the neighbor devices
that can participate in the DF election. If a PIM bidirectional neighbor filter is not configured for an
interface, then there are no restrictions. If a PIM bidirectional neighbor filter is configured, only those
neighbors permitted by the ACL can participate in the DF election process.
When a PIM bidirectional neighbor filter configuration is applied to the ASA, an ACL appears in the
running configuration with the name interface-name_multicast, in which the interface-name is the name
of the interface to which the multicast boundary filter is applied. If an ACL with that name already exists,
a number is appended to the name (for example, inside_multicast_1). This ACL defines which devices
can become PIM neighbors of the ASA.
Bidirectional PIM allows multicast routers to keep reduced state information. All of the multicast routers
in a segment must be bidirectionally enabled for bidir to elect a DF.
The PIM bidirectional neighbor filters enable the transition from a sparse-mode-only network to a bidir
network by letting you specify the routers that should participate in the DF election, while still allowing
all routers to participate in the sparse-mode domain. The bidir-enabled routers can elect a DF from
among themselves, even when there are non-bidir routers on the segment. Multicast boundaries on the
non-bidir routers prevent PIM messages and data from the bidir groups from leaking in or out of the bidir
subset cloud.
When a PIM bidirectional neighbor filter is enabled, the routers that are permitted by the ACL are
considered to be bidirectionally capable. Therefore, the following is true:
•

If a permitted neighbor does not support bidir, then the DF election does not occur.

•

If a denied neighbor supports bidir, then the DF election does not occur.

•

If a denied neighbor does not support bidir, the DF election can occur.

To define the neighbors that can become a PIM bidirectional neighbor filter, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

access-list pim_nbr deny router-IP_addr
PIM neighbor

Uses a standard access list to define the routers that you want to
have participate in PIM.

Example:

In the example, the following access list, when used with the pim
neighbor-filter command, prevents the 10.1.1.1 router from
becoming a PIM neighbor.

hostname(config)# access-list pim_nbr deny
10.1.1.1 255.255.255.255

Step 2

pim bidirectional-neighbor-filter pim_nbr

Filters neighbor routers.

Example:

In the example, the 10.1.1.1 router is prevented from becoming a
PIM bidirectional neighbor on interface GigabitEthernet0/3.

hostname(config)# interface
GigabitEthernet0/3
hostname(config-if)# pim bidirectional
neighbor-filter pim_nbr

Cisco ASA 5500 Series Configuration Guide using the CLI

26-13

Chapter 26

Configuring Multicast Routing

Configuration Example for Multicast Routing

Configuring a Multicast Boundary
Address scoping defines domain boundaries so that domains with RPs that have the same IP address do
not leak into each other. Scoping is performed on the subnet boundaries within large domains and on the
boundaries between the domain and the Internet.
You can set up an administratively scoped boundary on an interface for multicast group addresses by
entering the multicast boundary command. 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 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.
To configure a multicast boundary, enter the following command:
Command

Purpose

multicast boundary acl [filter-autorp]

Configures a multicast boundary.

Example:
hostname(config-if)# multicast boundary
acl1 [filter-autorp]

Configuration Example for Multicast Routing
The following example shows how to enable and configure multicast routing with various optional
processes:
Step 1

Enable multicast routing:
hostname(config)# multicast-routing

Step 2

Configure a static multicast route:
hostname(config)# mroute src_ip src_mask {input_if_name | rpf_neighbor} [distance]
hostname(config)# exit

Step 3

Configure the ASA to be a member of a multicast group:
hostname(config)# interface
hostname(config-if)# igmp join-group group-address

Cisco ASA 5500 Series Configuration Guide using the CLI

26-14

Chapter 26

Configuring Multicast Routing
Additional References

Additional References
For additional information related to routing, see the following sections:
•

Related Documents, page 26-15

•

RFCs, page 26-15

Related Documents
Related Topic

Document Title

Technical details about the IGMP and multicast routing IETF draft-ietf-idmr-igmp-proxy-01.txt
standards used for implementing the SMR feature

RFCs
RFC

Title

RFC 2113

IP Router Alert Option

RFC 2236

IGMPv2

RFC 2362

PIM-SM

RFC 2588

IP Multicast and Firewalls

Feature History for Multicast Routing
Table 26-2 lists each feature change and the platform release in which it was implemented.
Table 26-2

Feature History for Multicast Routing

Feature Name

Platform
Releases

Multicast routing support

7.0(1)

Feature Information
Support was added for multicast routing data,
authentication, and redistribution and monitoring of routing
information using the multicast routing protocol.
We introduced the multicast-routing command.

Cisco ASA 5500 Series Configuration Guide using the CLI

26-15

Chapter 26
Feature History for Multicast Routing

Cisco ASA 5500 Series Configuration Guide using the CLI

26-16

Configuring Multicast Routing

CH A P T E R

27

Configuring EIGRP
This chapter describes how to configure the ASA to route data, perform authentication, and redistribute
routing information using the Enhanced Interior Gateway Routing Protocol (EIGRP).
This chapter includes the following sections:
•

Information About EIGRP, page 27-1

•

Licensing Requirements for EIGRP, page 27-2

•

Guidelines and Limitations, page 27-2

•

Configuring EIGRP, page 27-3

•

Customizing EIGRP, page 27-4

•

Monitoring EIGRP, page 27-17

•

Configuration Example for EIGRP, page 27-18

•

Feature History for EIGRP, page 27-19

Information 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-1

Chapter 27

Configuring EIGRP

Licensing Requirements 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.

Licensing Requirements for EIGRP
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode.
Firewall Mode Guidelines

Supported only in routed firewall mode. Transparent firewall mode is not supported.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-2

Chapter 27

Configuring EIGRP
Configuring EIGRP

IPv6 Guidelines

Does not support IPv6.

Configuring 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.
•

Enabling EIGRP, page 27-3

•

Enabling EIGRP Stub Routing, page 27-3

Enabling EIGRP
You can only enable one EIGRP routing process on the ASA.
To enable EIGRP, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

network ip-addr [mask]

Example:
hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

Configures the interfaces and networks that participate in EIGRP
routing. 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 the “Configuring Interfaces for EIGRP” section on
page 27-6.

Enabling EIGRP Stub Routing
You can enable, and configure the ASA as an EIGRP stub router. Stub routing decreases memory and
processing requirements on the ASA. As a stub router, the ASA does not need to maintain a complete
EIGRP routing table because it forwards all nonlocal traffic to a distribution router. Generally, the
distribution router need not send anything more than a default route to the stub router.
Only specified routes are propagated from the stub router to the distribution router. As a stub router, the
ASA responds to all queries for summaries, connected routes, redistributed static routes, external routes,
and internal routes with the message “inaccessible.” When the ASA is configured as a stub, it sends a
special peer information packet to all neighboring routers to report its status as a stub router. Any

Cisco ASA 5500 Series Configuration Guide using the CLI

27-3

Chapter 27

Configuring EIGRP

Customizing EIGRP

neighbor that receives a packet 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.
To enable the ASA as an EIGRP stub routing process, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

network ip-addr [mask]

Example:
hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

Configures the interfaces and networks that participate in EIGRP
routing. 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 the section “Configuring Passive Interfaces”
section on page 27-7.

Step 3

eigrp stub {receive-only | [connected]
[redistributed] [static] [summary]}

Example:

Configures the stub routing process. 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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0
hostname(config-router)# eigrp stub
{receive-only | [connected]
[redistributed] [static] [summary]}

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.

Customizing EIGRP
This section describes how to customize the EIGRP routing and includes the following topics:
•

Defining a Network for an EIGRP Routing Process, page 27-5

•

Configuring Interfaces for EIGRP, page 27-6

•

Configuring the Summary Aggregate Addresses on Interfaces, page 27-8

•

Changing the Interface Delay Value, page 27-9

Cisco ASA 5500 Series Configuration Guide using the CLI

27-4

Chapter 27

Configuring EIGRP
Customizing EIGRP

•

Enabling EIGRP Authentication on an Interface, page 27-9

•

Defining an EIGRP Neighbor, page 27-10

•

Redistributing Routes Into EIGRP, page 27-11

•

Filtering Networks in EIGRP, page 27-12

•

Customizing the EIGRP Hello Interval and Hold Time, page 27-13

•

Disabling Automatic Route Summarization, page 27-14

•

Configuring Default Information in EIGRP, page 27-15

•

Disabling EIGRP Split Horizon, page 27-16

•

Restarting the EIGRP Process, page 27-17

Defining a Network for an EIGRP Routing Process
The Network table lets you specify the networks used by the EIGRP routing process. For an interface to
participate in EIGRP routing, it must fall within the range of addresses defined by the network entries.
For directly connected and static networks to be advertised, they must also fall within the range of the
network entries.
The Network table displays the networks configured for the EIGRP routing process. Each row of the
table displays the network address and associated mask configured for the specified EIGRP routing
process.
To add or define a network, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

network ip-addr [mask]

Example:
hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

Configures the interfaces and networks that participate in EIGRP
routing. 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 the “Configuring Passive Interfaces” section on
page 27-7.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-5

Chapter 27

Configuring EIGRP

Customizing EIGRP

Configuring Interfaces for EIGRP
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, you can configure a network command that includes the network
to which the interface is attached, and use the passive-interface command to prevent that interface from
sending or receiving EIGRP updates.
To configure interfaces for EIGRP, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

hostname(config-router)# network ip-addr
[mask]

Configures the interfaces and networks that participate in EIGRP
routing. You can configure one or more network statements with
this command.

Example:

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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

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 the “Defining a Network for an EIGRP Routing
Process” section on page 27-5.
Step 3

(Optional) Do one of the following to customize an interface to participate in EIGRP routing:
no default-information {in | out | WORD}

Allows you to control the sending or receiving of candidate
default route information.

Example:

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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0
hostname(config-router)# no
default-information {in | out | WORD}

authentication mode eigrp as-num md5

Example:
hostname(config)# authentication mode
eigrp 2 md5

See the “Configuring Default Information in EIGRP” section on
page 27-15 for more information on this particular option.
Enables MD5 authentication of EIGRP packets.
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:
% Asystem(100) specified does not exist

See the “Enabling EIGRP Authentication on an Interface” section
on page 27-9 for more information on this particular option.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-6

Chapter 27

Configuring EIGRP
Customizing EIGRP

Command
delay value

Purpose
The value argument entered is in tens of microseconds. To set the
delay for 2000 microseconds, you enter a value of 200.

Example:

To view the delay value assigned to an interface, use the show
interface command.

hostname(config-if)# delay 200

See the “Changing the Interface Delay Value” section on
page 27-9 for more information on this particular option.
hello-interval eigrp as-num seconds

Example:

Allows you to change the hello interval. See the “Customizing the
EIGRP Hello Interval and Hold Time” section on page 27-13 for
more information on this particular option.

hostname(config)# hello-interval eigrp 2
60
hold-time eigrp as-num seconds

Example:

Allows you to change the hold time. See the “Customizing the
EIGRP Hello Interval and Hold Time” section on page 27-13 for
more information on this particular option.

hostname(config)# hold-time eigrp 2 60

Configuring Passive Interfaces
You can configure one or more interfaces as passive interfaces. In EIGRP, a passive interface does not
send or receive routing updates.
To configure passive interfaces, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Cisco ASA 5500 Series Configuration Guide using the CLI

27-7

Chapter 27

Configuring EIGRP

Customizing EIGRP

Step 2

Command

Purpose

hostname(config-router)# network ip-addr
[mask]

Configures the interfaces and networks that participate in EIGRP
routing. You can configure one or more network statements with
this command.

Example:

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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

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 the “Defining a Network for an EIGRP Routing
Process” section on page 27-5.
Step 3

passive-interface {default | if-name}

Prevents an interface from sending or receiving EIGRP routing
message.

Example:

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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0
hostname(config-router)# passive-interface
{default}

Configuring the Summary Aggregate Addresses on Interfaces
You can configure a summary addresses on a per-interface basis. You need to manually define summary
addresses if you want to create summary addresses that do not occur at a network number boundary or
if you want to use summary addresses on an ASA with automatic route summarization disabled. If any
more specific routes are in the routing table, EIGRP will advertise the summary address out the interface
with a metric equal to the minimum of all more specific routes.
To create a summary address, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

interface phy_if

Enters interface configuration mode for the interface on which
you are changing the delay value used by EIGRP.

Example:
hostname(config)# interface phy_if

Step 2

summary-address eigrp as-num address mask
[distance]

Example:
hostname(config-if)# summary-address eigrp
2 address mask [20]

Cisco ASA 5500 Series Configuration Guide using the CLI

27-8

Creates the summary address.
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.

Chapter 27

Configuring EIGRP
Customizing EIGRP

Changing the Interface Delay Value
The interface delay value is used in EIGRP distance calculations. You can modify this value on a
per-interface basis.
To change the interface delay value, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

interface phy_if

Enters interface configuration mode for the interface on which
you are changing the delay value used by EIGRP.

Example:
hostname(config)# interface phy_if

Step 2

delay value

The value argument entered is in tens of microseconds. To set the
delay for 2000 microseconds, you enter a value of 200.

Example:

To view the delay value assigned to an interface, use the show
interface command.

hostname(config-if)# delay 200

Enabling EIGRP Authentication on an Interface
EIGRP route authentication provides MD5 authentication of routing updates from the EIGRP routing
protocol. The MD5 keyed digest in each EIGRP packet prevents the introduction of unauthorized or false
routing messages from unapproved sources.
EIGRP route authentication is configured on a per-interface basis. All EIGRP neighbors on interfaces
configured for EIGRP message authentication must be configured with the same authentication mode
and key for adjacencies to be established.

Note

Before you can enable EIGRP route authentication, you must enable EIGRP.
To enable EIGRP authentication on an interface, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

27-9

Chapter 27

Configuring EIGRP

Customizing EIGRP

Detailed Steps

Step 1

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

network ip-addr [mask]

Example:
hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

Configures the interfaces and networks that participate in EIGRP
routing. 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 the “Configuring EIGRP” section on page 27-3.

Step 3

interface phy_if

Enters interface configuration mode for the interface on which
you are configuring EIGRP message authentication.

Example:
hostname(config)# interface phy_if

Step 4

authentication mode eigrp as-num md5

Example:
hostname(config)# authentication mode
eigrp 2 md5

Enables MD5 authentication of EIGRP packets.
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:
% Asystem(100) specified does not exist

Step 5

authentication key eigrp as-num key key-id
key-id

Example:
hostname(config)# authentication key eigrp
2 cisco key-id 200

Configures the key used by the MD5 algorithm.
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:
% Asystem(100) specified does not exist

The key argument can include up to 16 characters.
The key-id argument is a number that can range from 0 to 255.

Defining an EIGRP Neighbor
EIGRP hello packets are sent as multicast packets. If an EIGRP neighbor is located across a non
broadcast network, such as a tunnel, you must manually define that neighbor. When you manually define
an EIGRP neighbor, hello packets are sent to that neighbor as unicast messages.
To manually define an EIGRP neighbor, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

27-10

Chapter 27

Configuring EIGRP
Customizing EIGRP

Detailed Steps

Step 1

Step 2

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:
hostname(config)# router eigrp 2

The as-num argument is the autonomous system number of the
EIGRP routing process.

neighbor ip-addr interface if_name

Defines the static neighbor.
The ip-addr argument is the IP address of the neighbor.

Example:
hostname(config)# router eigrp 2
hostname(config-router)# neighbor 10.0.0.0
interface interface1

The if-name argument is the name of the interface, as specified by
the nameif command, through which that neighbor is available.
You can define multiple neighbors for an EIGRP routing process.

Redistributing Routes Into EIGRP
You can redistribute routes discovered by RIP and OSPF into the EIGRP routing process. You can also
redistribute static and connected routes into the EIGRP routing process. You do not need to redistribute
connected routes if they fall within the range of a network statement in the EIGRP configuration.

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. See Chapter 23,
“Defining Route Maps,” for more information about creating a route map.
To redistribute routes into the EIGRP routing process, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

default-metric bandwidth delay reliability
loading mtu

Example:
hostname(config)# router eigrp 2
hostname(config-router)# default-metric
bandwidth delay reliability loading mtu

Step 3

(Optional) Specifies the default metrics that should be applied to
routes redistributed into the EIGRP routing process.
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.

Do one of the following to redistribute the selected route type into the EIGRP routing process. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-11

Chapter 27

Configuring EIGRP

Customizing EIGRP

Command

Purpose

redistribute connected [metric bandwidth
delay reliability loading mtu] [route-map
map_name]

Redistributes connected routes into the EIGRP routing process.

Example:
hostname(config-router): redistribute
connected [metric bandwidth delay
reliability loading mtu] [route-map
map_name]
redistribute static [metric bandwidth
delay reliability loading mtu] [route-map
map_name]

Redistributes static routes into the EIGRP routing process.

Example:
hostname(config-router): redistribute
static [metric bandwidth delay reliability
loading mtu] [route-map map_name]
redistribute ospf pid [match {internal |
external [1 | 2] | nssa-external [1 | 2]}]
[metric bandwidth delay reliability
loading mtu] [route-map map_name]

Redistributes routes from an OSPF routing process into the
EIGRP routing process.

Example:
hostname(config-router): redistribute ospf
pid [match {internal | external [1 | 2] |
nssa-external [1 | 2]}] [metric bandwidth
delay reliability loading mtu] [route-map
map_name]
redistribute rip [metric bandwidth delay
reliability load mtu] [route-map map_name]

Redistributes routes from a RIP routing process into the EIGRP
routing process.

Example:
(config-router): redistribute rip [metric
bandwidth delay reliability load mtu]
[route-map map_name]

Filtering Networks in EIGRP
Note

Before you begin this process, you must create a standard access list that defines the routes that you want
to advertise. That is, create a standard access list that defines the routes that you want to filter from
sending or receiving updates.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-12

Chapter 27

Configuring EIGRP
Customizing EIGRP

To filter networks in EIGRP, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

hostname(config-router)# network ip-addr
[mask]

Configures the interfaces and networks that participate in EIGRP
routing. You can configure one or more network statements with
this command.

Example:

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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

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 the “Configuring Interfaces for EIGRP” section on
page 27-6.
Step 3

Do one of the following to filter networks sent or received in EIGRP routing updates. You can enter multiple
distribute-list commands in your EIGRP router configuration.
distribute-list acl out [connected | ospf
| rip | static | interface if_name]

Filters networks sent in EIGRP routing updates.
You can specify an interface to apply the filter to only those
updates that are sent by that specific interface.

Example:
hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0
hostname(config-router): distribute-list
acl out [connected]
distribute-list acl in [interface if_name]

Filters networks received in EIGRP routing updates.

Example:

You can specify an interface to apply the filter to only those
updates that are received by that interface.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0
hostname(config-router): distribute-list
acl in [interface interface1]

Customizing the EIGRP Hello Interval and Hold Time
The ASA periodically sends hello packets to discover neighbors and to learn when neighbors become
unreachable or inoperative. By default, hello packets are sent every 5 seconds.
The hello packet advertises the ASA hold time. The hold time indicates to EIGRP neighbors the length
of time the neighbor should consider the ASA reachable. If the neighbor does not receive a hello packet
within the advertised hold time, then the ASA is considered unreachable. By default, the advertised hold
time is 15 seconds (three times the hello interval).

Cisco ASA 5500 Series Configuration Guide using the CLI

27-13

Chapter 27

Configuring EIGRP

Customizing EIGRP

Both the hello interval and the advertised hold time are configured on a per-interface basis. We
recommend setting the hold time to be at minimum three times the hello interval.
To configure the hello interval and advertised hold time, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

interface phy_if

Enters interface configuration mode for the interface on which
you are configuring the hello interval or advertised hold time.

Example:
hostname(config)# interface phy_if

Step 2

hello-interval eigrp as-num seconds

Changes the hello interval.

Example:
hostname(config)# hello-interval eigrp 2
60

Step 3

hold-time eigrp as-num seconds

Changes the hold time.

Example:
hostname(config)# hold-time eigrp 2 60

Disabling Automatic Route Summarization
Automatic route summarization is enabled by default. The EIGRP routing process summarizes on
network number boundaries. This can cause routing problems if you have noncontiguous networks.
For example, if you have a router with the networks 192.168.1.0, 192.168.2.0, and 192.168.3.0
connected to it, and those networks all participate in EIGRP, the EIGRP routing process creates the
summary address 192.168.0.0 for those routes. If an additional router is added to the network with the
networks 192.168.10.0 and 192.168.11.0, and those networks participate in EIGRP, they will also be
summarized as 192.168.0.0. To prevent the possibility of traffic being routed to the wrong location, you
should disable automatic route summarization on the routers creating the conflicting summary
addresses.
To disable automatic route summarization, enter the following commands:

Cisco ASA 5500 Series Configuration Guide using the CLI

27-14

Chapter 27

Configuring EIGRP
Customizing EIGRP

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Step 2

no auto-summary

You cannot configure this value. Automatic summary addresses
have an administrative distance of 5.

Example:
hostname(config-router)# no auto-summary

Configuring Default Information in EIGRP
You can control the sending and receiving of default route information in EIGRP updates. By default,
default routes are sent and accepted. Configuring the ASA to disallow default information to be received
causes the candidate default route bit to be blocked on received routes. Configuring the ASA to disallow
default information to be sent disables the setting of the default route bit in advertised routes.
To configure default routing information, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

router eigrp as-num

Creates an EIGRP routing process and enters router configuration
mode for this EIGRP process.

Example:

The as-num argument is the autonomous system number of the
EIGRP routing process.

hostname(config)# router eigrp 2

Cisco ASA 5500 Series Configuration Guide using the CLI

27-15

Chapter 27

Configuring EIGRP

Customizing EIGRP

Step 2

Command

Purpose

hostname(config-router)# network ip-addr
[mask]

Configures the interfaces and networks that participate in EIGRP
routing. You can configure one or more network statements with
this command.

Example:

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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0

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 the “Configuring Interfaces for EIGRP” section on
page 27-6.
Step 3

no default-information {in | out | WORD}

Controls the sending or receiving of candidate default route
information.

Example:

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.

hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0
255.0.0.0
hostname(config-router)# no
default-information {in | out | WORD}

Disabling EIGRP Split Horizon
Split horizon controls the sending of EIGRP update and query packets. When split horizon is enabled on
an interface, update and query packets are not sent for destinations for which this interface is the next
hop. Controlling update and query packets in this manner reduces the possibility of routing loops.
By default, split horizon is enabled on all interfaces.
Split horizon blocks route information from being advertised by a router out of any interface from which
that information originated. This behavior usually optimizes communications among multiple routing
devices, particularly when links are broken. However, with nonbroadcast networks, there may be
situations where this behavior is not desired. For these situations, including networks in which you have
EIGRP configured, you may want to disable split horizon.
If you disable split horizon on an interface, you must disable it for all routers and access servers on that
interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-16

Chapter 27

Configuring EIGRP
Monitoring EIGRP

To disable EIGRP split horizon, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

interface phy_if

Enters interface configuration mode for the interface on which
you are changing the delay value used by EIGRP.

Example:
hostname(config)# interface phy_if

Step 2

no split-horizon eigrp as-number

Disables the split horizon.

Example:
hostname(config-if)# no split-horizon
eigrp 2

Restarting the EIGRP Process
To restart an EIGRP process or clear redistribution or counters, enter the following command:
Command

Purpose

clear eigrp pid {1-65535 | neighbors | topology |
events)}

Restarts an EIGRP process or clears redistribution or counters.

Example:
hostname(config)# clear eigrp pid 10 neighbors

Monitoring EIGRP
You can use the following commands to monitor the EIGRP 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 or disable various EIGRP routing statistics, enter one of the following commands:
Command

Purpose

Monitoring EIGRP Routing
show eigrp [as-number] events [{start end}
| type]

Displays the EIGRP event log.

show eigrp [as-number] neighbors [detail |
static] [if-name]

Displays the EIGRP neighbor table.

show eigrp [as-number] interfaces [if-name]
[detail]

Displays the interfaces participating in EIGRP
routing.

show eigrp [as-number] topology [ip-addr
[mask] | active | all-links | pending |
summary | zero-successors]

Displays the EIGRP topology table.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-17

Chapter 27

Configuring EIGRP

Configuration Example for EIGRP

Command (continued)

Purpose (continued)

show eigrp [as-number] traffic

Displays EIGRP traffic statistics.

router-id

Displays the router-id for this EIGRP process.

Disabling EIGRP Logging Messages

Note

no eigrp log-neighbor-changes

Disables the logging of neighbor change
messages. Enter this command in router
configuration mode for the EIGRP routing
process.

no eigrp log-neighbor-warnings

Disables the logging of neighbor warning
messages.

By default, neighbor change and neighbor warning messages are logged.

Configuration Example for EIGRP
The following example shows how to enable and configure EIGRP with various optional processes:
Step 1

To enable EIGRP, enter the following commands:
hostname(config)# router eigrp 2
hostname(config-router)# network 10.0.0.0 255.0.0.0

Step 2

To configure an interface from sending or receiving EIGRP routing messages, enter the following
command:
hostname(config-router)# passive-interface {default}

Step 3

To define an EIGRP neighbor, enter the following command:
hostname(config-router)# neighbor 10.0.0.0 interface interface1

Step 4

To configure the interfaces and networks that participate in EIGRP routing, enter the following
command:
hostname(config-router)# network 10.0.0.0 255.0.0.0

Step 5

To change the interface delay value used in EIGRP distance calculations, enter the following commands:
hostname(config-router)# exit
hostname(config)# interface phy_if
hostname(config-if)# delay 200

Cisco ASA 5500 Series Configuration Guide using the CLI

27-18

Chapter 27

Configuring EIGRP
Feature History for EIGRP

Feature History for EIGRP
Table 27-1 lists each feature change and the platform release in which it was implemented.
Table 27-1

Feature History for EIGRP

Feature Name

Platform
Releases

EIGRP support

7.0(1)

Feature Information
Support was added for routing data, performing
authentication, and redistributing and monitoring routing
information using the Enhanced Interior Gateway Routing
Protocol (EIGRP).
We introduced the following command: route eigrp.

Cisco ASA 5500 Series Configuration Guide using the CLI

27-19

Chapter 27
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-20

Configuring EIGRP

Chapter 27

Configuring EIGRP
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-21

Chapter 27
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-22

Configuring EIGRP

Chapter 27

Configuring EIGRP
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-23

Chapter 27
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-24

Configuring EIGRP

Chapter 27

Configuring EIGRP
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-25

Chapter 27
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-26

Configuring EIGRP

Chapter 27

Configuring EIGRP
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-27

Chapter 27
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-28

Configuring EIGRP

Chapter 27

Configuring EIGRP
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-29

Chapter 27
Feature History for EIGRP

Cisco ASA 5500 Series Configuration Guide using the CLI

27-30

Configuring EIGRP

CH A P T E R

28

Configuring IPv6 Neighbor Discovery
This chapter describes how to enable and configure IPv6 neighbor discovery on the ASA and includes
the following sections:
•

Information About IPv6 Neighbor Discovery, page 28-1

•

Licensing Requirements for IPv6 Neighbor Discovery, page 28-4

•

Guidelines and Limitations, page 28-4

•

Default Settings for IPv6 Neighbor Discovery, page 28-6

•

Configuring the Neighbor Solicitation Message Interval, page 28-7

•

Configuring the Neighbor Reachable Time, page 28-7

•

Configuring the Router Advertisement Transmission Interval, page 28-8

•

Configuring the Router Lifetime Value, page 28-8

•

Configuring DAD Settings, page 28-9

•

Configuring IPv6 Addresses on an Interface, page 28-9

•

Suppressing Router Advertisement Messages, page 28-10

•

Configuring the IPv6 Prefix, page 28-11

•

Configuring a Static IPv6 Neighbor, page 28-12

•

Monitoring IPv6 Neighbor Discovery, page 28-13

•

Additional References, page 28-13

•

Feature History for IPv6 Neighbor Discovery, page 28-14

Information About IPv6 Neighbor Discovery
The IPv6 neighbor discovery process uses ICMPv6 messages and solicited-node multicast addresses to
determine the link-layer address of a neighbor on the same network (local link), verify the readability of
a neighbor, and keep track of neighboring routers.
Nodes (hosts) use neighbor discovery to determine the link-layer addresses for neighbors known to
reside on attached links and to quickly purge cashed values that become invalid. Hosts also use neighbor
discovery to find neighboring routers that are willing to forward packets on their behalf. In addition,
nodes use the protocol to actively keep track of which neighbors are reachable and which are not, and to
detect changed link-layer addresses. When a router or the path to a router fails, a host actively searches
for functioning alternates.

Cisco ASA 5500 Series Configuration Guide using the CLI

28-1

Chapter 28

Configuring IPv6 Neighbor Discovery

Information About IPv6 Neighbor Discovery

This section includes the following topics:
•

Neighbor Solicitation Messages, page 28-2

•

Neighbor Reachable Time, page 28-3

•

Router Advertisement Messages, page 28-3

•

Static IPv6 Neighbors, page 28-4

Neighbor Solicitation Messages
Neighbor solicitation messages (ICMPv6 Type 135) are sent on the local link by nodes attempting to
discover the link-layer addresses of other nodes on the local link. The neighbor solicitation message is
sent to the solicited-node multicast address. The source address in the neighbor solicitation message is
the IPv6 address of the node sending the neighbor solicitation message. The neighbor solicitation
message also includes the link-layer address of the source node.
After receiving a neighbor solicitation message, the destination node replies by sending a neighbor
advertisement message (ICPMv6 Type 136) on the local link. The source address in the neighbor
advertisement message is the IPv6 address of the node sending the neighbor advertisement message; the
destination address is the IPv6 address of the node that sent the neighbor solicitation message. The data
portion of the neighbor advertisement message includes the link-layer address of the node sending the
neighbor advertisement message.
After the source node receives the neighbor advertisement, the source node and destination node can
communicate. Figure 28-1 shows the neighbor solicitation and response process.
Figure 28-1

IPv6 Neighbor Discovery—Neighbor Solicitation Message

ICMPv6 Type = 135
Src = A
Dst = solicited-node multicast of B
Data = link-layer address of A
Query = what is your link address?

A and B can now exchange
packets on this link

132958

ICMPv6 Type = 136
Src = B
Dst = A
Data = link-layer address of B

Neighbor solicitation messages are also used to verify the reachability of a neighbor after the link-layer
address of a neighbor is identified. When a node wants to verifying the reachability of a neighbor, the
destination address in a neighbor solicitation message is the unicast address of the neighbor.
Neighbor advertisement messages are also sent when there is a change in the link-layer address of a node
on a local link. When there is such a change, the destination address for the neighbor advertisement is
the all-nodes multicast address.

Cisco ASA 5500 Series Configuration Guide using the CLI

28-2

Chapter 28

Configuring IPv6 Neighbor Discovery
Information About IPv6 Neighbor Discovery

Neighbor Reachable Time
The neighbor reachable time enables detecting unavailable neighbors. Shorter configured times enable
detecting unavailable neighbors more quickly, however, shorter times consume more IPv6 network
bandwidth and processing resources in all IPv6 network devices. Very short configured times are not
recommended in normal IPv6 operation.

Router Advertisement Messages
An ASA can participate in router advertisements so that neighboring devices can dynamically learn a
default router address. Router advertisement messages (ICMPv6 Type 134) are periodically sent out each
IPv6 configured interface of the ASA. The router advertisement messages are sent to the all-nodes
multicast address. Figure 28-2 shows the router advertisement messages that are sent from IPv6
configured interfaces on the ASA.
IPv6 Neighbor Discovery—Router Advertisement Message

Router
advertisement

Router
advertisement

Router advertisement packet definitions:
ICMPv6 Type = 134
Src = router link-local address
Dst = all-nodes multicast address
Data = options, prefix, lifetime, autoconfig flag

132917

Figure 28-2

Router advertisement messages typically include the following information:
•

One or more IPv6 prefix that nodes on the local link can use to automatically configure their IPv6
addresses.

•

Lifetime information for each prefix included in the advertisement.

•

Sets of flags that indicate the type of autoconfiguration (stateless or stateful) that can be completed.

•

Default router information (whether the router sending the advertisement should be used as a default
router and, if so, the amount of time (in seconds) the router should be used as a default router).

•

Additional information for hosts, such as the hop limit and MTU a host should use in packets that it
originates.

•

The amount of time between neighbor solicitation message retransmissions on a given link.

•

The amount of time a node considers a neighbor reachable.

Router advertisements are also sent in response to router solicitation messages (ICMPv6 Type 133).
Router solicitation messages are sent by hosts at system startup so that the host can immediately
autoconfigure without needing to wait for the next scheduled router advertisement message. Because
router solicitation messages are usually sent by hosts at system startup, and the host does not have a
configured unicast address, the source address in router solicitation messages is usually the unspecified
IPv6 address (0:0:0:0:0:0:0:0). If the host has a configured unicast address, the unicast address of the
interface sending the router solicitation message is used as the source address in the message. The

Cisco ASA 5500 Series Configuration Guide using the CLI

28-3

Chapter 28

Configuring IPv6 Neighbor Discovery

Licensing Requirements for IPv6 Neighbor Discovery

destination address in router solicitation messages is the all-routers multicast address with a scope of the
link. When a router advertisement is sent in response to a router solicitation, the destination address in
the router advertisement message is the unicast address of the source of the router solicitation message.
You can configure the following settings for router advertisement messages:
•

The time interval between periodic router advertisement messages.

•

The router lifetime value, which indicates the amount of time IPv6 nodes should consider the ASA
to be the default router.

•

The IPv6 network prefixes in use on the link.

•

Whether or not an interface transmits router advertisement messages.

Unless otherwise noted, the router advertisement message settings are specific to an interface and are
entered in interface configuration mode.

Static IPv6 Neighbors
You can manually define a neighbor in the IPv6 neighbor cache. 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. Static entries in the IPv6 neighbor
discovery cache are not modified by the neighbor discovery process.

Licensing Requirements for IPv6 Neighbor Discovery
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed mode only. Transparent mode is not supported.
Additional Guidelines and Limitations
•

The interval value is included in all IPv6 router advertisements that are sent out of this interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

28-4

Chapter 28

Configuring IPv6 Neighbor Discovery
Guidelines and Limitations

•

The configured time enables detecting unavailable neighbors. Shorter configured times enable
detecting unavailable neighbors more quickly; however, shorter times consume more IPv6 network
bandwidth and processing resources in all IPv6 network devices. Very short configured times are not
recommended in normal IPv6 operation.

•

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 by using the ipv6 nd ra-lifetime command. To
prevent synchronization with other IPv6 nodes, randomly adjust the actual value used to within 20
percent of the specified value.

•

The ipv6 nd prefix command allows control over the individual parameters per prefix, including
whether or not the prefix should be advertised.

•

By default, prefixes configured as addresses on an interface using the ipv6 address command are
advertised in router advertisements. If you configure prefixes for advertisement using the ipv6 nd
prefix command, then only these prefixes are advertised.

•

The default keyword can be used to set default parameters for all prefixes.

•

A date can be set to specify the expiration of a prefix. The valid and preferred lifetimes are counted
down in real time. When the expiration date is reached, the prefix will no longer be advertised.

•

When onlink is on (by default), the specified prefix is assigned to the link. Nodes sending traffic to
such addresses that contain the specified prefix consider the destination to be locally reachable on
the link.

•

When autoconfig is on (by default), it indicates to hosts on the local link that the specified prefix
can be used for IPv6 autoconfiguration.

•

For stateless autoconfiguration to work correctly, the advertised prefix length in router
advertisement messages must always be 64 bits.

•

The router lifetime value is included in all IPv6 router advertisements sent out of the interface. The
value indicates the usefulness of the ASA as a default router on this interface.

•

Setting the value to a non-zero value indicates that the ASA should be considered a default router
on this interface. The non-zero value for the router lifetime value should not be less than the router
advertisement interval.

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]).

•

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

28-5

Chapter 28

Configuring IPv6 Neighbor Discovery

Default Settings for IPv6 Neighbor Discovery

•

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.

Default Settings for IPv6 Neighbor Discovery
Table 28-1 lists the default settings for IPv6 neighbor discovery.
Table 28-1

Default IPv6 Neighbor Discovery Parameters

Parameters

Default

value for the neighbor solicitation transmission
message interval

1000 seconds between neighbor solicitation
transmissions.

value for the neighbor reachable time

The default is 0.

value for the router advertisement transmission
interval

The default is 200 seconds.

value for the router lifetime

The default is 1800 seconds.

value for the number of consecutive neighbor
solicitation messages sent during DAD

The default is one message.

prefix lifetime

The default lifetime is 2592000 seconds (30 days),
and a preferred lifetime is 604800 seconds (7
days).

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

28-6

Chapter 28

Configuring IPv6 Neighbor Discovery
Configuring the Neighbor Solicitation Message Interval

Configuring the Neighbor Solicitation Message Interval
To configure the interval between IPv6 neighbor solicitation retransmissions on an interface, enter the
following command:
Command

Purpose

ipv6 nd ns-interval value

Sets the interval between IPv6 neighbor solicitation retransmissions on an
interface.

Example:

Valid values for the value argument range from 1000 to 3600000
milliseconds.

hostname (config-if)# ipv6 nd ns-interval
9000

This information is also sent in router advertisement messages.

Examples
The following example configures an IPv6 neighbor solicitation transmission interval of 9000
milliseconds for GigabitEthernet 0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 nd ns-interval 9000

Configuring the Neighbor Reachable Time
To configure the amount of time that a remote IPv6 node is considered reachable after a reachability
confirmation event has occurred, enter the following command:
Command

Purpose

ipv6 nd reachable-time value

Sets the amount of time that a remote IPv6 node is reachable.
Valid values for the value argument range from 0 to 3600000 milliseconds.

Example:
hostname (config-if)# ipv6 nd
reachable-time 1700000

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.

Examples
The following example configures an IPv6 reachable time of 1700000 milliseconds for the selected
interface, GigabitEthernet 0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 nd reachable-time 1700000

Cisco ASA 5500 Series Configuration Guide using the CLI

28-7

Chapter 28

Configuring IPv6 Neighbor Discovery

Configuring the Router Advertisement Transmission Interval

Configuring the Router Advertisement Transmission Interval
To configure the interval between IPv6 router advertisement transmissions on an interface, enter the
following command:
Command

Purpose

ipv6 nd ra-interval [msec] value

Sets the interval between IPv6 router advertisement transmissions.

Example:

The optional msec keyword indicates that the value provided is in
milliseconds. If this keyword is not present, the value provided is in
seconds.

hostname (config-if)# ipv6 nd ra-interval
201

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 the “Configuring the Router Lifetime Value”
section on page 28-8. To prevent synchronization with other IPv6 nodes,
randomly adjust the actual value used to within 20 percent of the desired
value.

Examples
The following example configures an IPv6 router advertisement interval of 201 seconds for the selected
interface, GigabitEthernet 0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 nd ra-interval 201

Configuring the Router Lifetime Value
To configure the router lifetime value in IPv6 router advertisements on an interface, enter the following
command:
Command

Purpose

ipv6 nd ra-lifetime [msec] value

Specifies the length of time that nodes on the local link should consider the
ASA as the default router on the link.

Example:

The optional msec keyword indicates that the value provided is in
milliseconds. If this keyword is not present, the value provided is in
seconds.

hostname (config-if)# ipv6 nd ra-lifetime
2000

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

28-8

Chapter 28

Configuring IPv6 Neighbor Discovery
Configuring DAD Settings

Examples
The following example configures an IPv6 router lifetime value of 2000 seconds for the selected
interface, GigabitEthernet 0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 nd ra-lifetime 2000

Configuring DAD Settings
To specify DAD settings on the interface, enter the following command:
Command

Purpose

ipv6 nd dad attempts value

Specifies the uniqueness of new unicast IPv6 addresses before they are
assigned and ensures that duplicate IPv6 addresses are detected in the
network on a link basis.

Example:
hostname (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.

Examples
The following example configures a DAD attempt value of 20 for the selected interface, GigabitEthernet
0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 nd dad attempts 20

Configuring IPv6 Addresses on an Interface
To configure IPv6 addresses on an interface, enter the following command:
Command

Purpose

ipv6 address

Specifies the IPv6 address for the selected interface.

Example:
hostname (config-if)# ipv6 address
fe80::20d:88ff:feee:6a82

Examples
The following example configures a link-local IPv6 address for the selected interface, GigabitEthernet
0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 address fe80::20d:88ff:feee:6a82

Cisco ASA 5500 Series Configuration Guide using the CLI

28-9

Chapter 28

Configuring IPv6 Neighbor Discovery

Suppressing Router Advertisement Messages

Suppressing Router Advertisement Messages
Router advertisement messages are automatically sent in response to router solicitation messages. You
may want to disable these messages on any interface for which you do not want the ASA to supply the
IPv6 prefix (for example, the outside interface).
To suppress the router lifetime value in IPv6 router advertisements on an interface, enter the following
command:
Command

Purpose

ipv6 nd suppress-ra seconds

Suppresses the router lifetime value.

Example:
hostname (config-if)# ipv6 nd suppress-ra
2001:DB8::/32 1000 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.
Entering this command causes the ASA to appear as a regular IPv6
neighbor on the link and not as an IPv6 router.

Examples
The following example suppresses an IPv6 router advertisement transmission for the specified interface,
which is GigabitEthernet 0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 nd suppress-ra 2001:DB8::/32 1000 900

Cisco ASA 5500 Series Configuration Guide using the CLI

28-10

Chapter 28

Configuring IPv6 Neighbor Discovery
Configuring the IPv6 Prefix

Configuring the IPv6 Prefix
To configure the which IPv6 prefixes are included in IPv6 router advertisements, enter the following
command:
Command

Purpose

ipv6 nd prefix ipv6-prefix/prefix-length |
default [[valid-lifetime
preferred-lifetime] | [at valid-date
preferred-date] | infinite | no-advertise
| off-link | no-autoconfig]

Configures which IPv6 prefixes are included in IPv6 router advertisements.
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.

Example:
hostname (config-if)# ipv6 nd prefix
2001:DB8::/32 1000 900

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).

Cisco ASA 5500 Series Configuration Guide using the CLI

28-11

Chapter 28

Configuring IPv6 Neighbor Discovery

Configuring a Static IPv6 Neighbor

Examples
The following example includes the IPv6 prefix 2001:DB8::/32, with a valid lifetime of 1000 seconds
and a preferred lifetime of 900 seconds, in router advertisements sent out on the specified interface,
which is GigabitEthernet 0/0:
hostname (config)# interface gigabitethernet 0/0
hostname (config-if)# ipv6 nd prefix 2001:DB8::/32 1000 900

Configuring a Static IPv6 Neighbor
To configure a static entry in the IPv6 neighbor discovery cache, enter the following command:
Command

Purpose

ipv6 neighbor ipv6_address if_name
mac_address

Configures a static entry in the IPv6 neighbor discovery cache.

Example:
hostname)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.

Examples
The following example adds a static entry for an inside host with an IPv6 address of 3001:1::45A and a
MAC address of 002.7D1a.9472 to the neighbor discovery cache:
hostname)config-if)# ipv6 neighbor 3001:1::45A inside 002.7D1A.9472

Cisco ASA 5500 Series Configuration Guide using the CLI

28-12

Chapter 28

Configuring IPv6 Neighbor Discovery
Monitoring IPv6 Neighbor Discovery

Monitoring IPv6 Neighbor Discovery
To monitor IPv6 neighbor discovery parameters, enter the following command:
Command

Purpose

show ipv6 interface

Displays the usability status of interfaces configured for IPv6. Including
the interface name, such as “outside” and displays the settings for the
specified interface. Excludes the name from the command and displays
the settings for all interfaces that have IPv6 enabled on them. Output for
the command shows the following:
•

The name and status of the interface.

•

The link-local and global unicast addresses.

•

The multicast groups to which the interface belongs.

•

ICMP redirect and error message settings.

•

Neighbor discovery settings.

•

The actual time when the command is set to 0.

•

The neighbor discovery reachable time that is being used.

Additional References
For additional information related to implementing IPv6 prefixes, see the following topics:
•

Related Documents for IPv6 Prefixes, page 28-14

•

RFCs for IPv6 Prefixes and Documentation, page 28-14

Cisco ASA 5500 Series Configuration Guide using the CLI

28-13

Chapter 28

Configuring IPv6 Neighbor Discovery

Feature History for IPv6 Neighbor Discovery

Related Documents for IPv6 Prefixes
Related Topic

Document Title

ipv6 commands

command reference

RFCs for IPv6 Prefixes and Documentation
RFC

Title

RFC 2373 includes complete documentation to show IP Version 6 Addressing Architecture
how IPv6 network address numbers must be shown in
router advertisements. The command argument
ipv6-prefix indicates this network number, in which the
address must be specified in hexadecimal format using
16-bit values between colons.
RFC 3849 specifies the requirements for using IPv6
address prefixes in documentation. The IPv6 unicast
address prefix that has been reserved for use in
documentation is 2001:DB8::/32.

IPv6 Address Prefix Reserved for Documentation

Feature History for IPv6 Neighbor Discovery
Table 28-2 lists each feature change and the platform release in which it was implemented.
Table 28-2

Feature History for IPv6 Neighbor Discovery

Feature Name

Releases

Feature Information

IPv6 Neighbor Discovery

7.0(1)

We introduced this feature.
We introduced the following commands: ipv6 nd
ns-interval, ipv6 nd ra-lifetime, ipv6 nd suppress-ra,
ipv6 neighbor, ipv6 nd prefix, ipv6 nd dad-attempts,
ipv6 nd reachable-time, ipv6 address, ipv6
enforce-eui64.

Cisco ASA 5500 Series Configuration Guide using the CLI

28-14

PA R T

7

Configuring Network Address Translation

CH A P T E R

29

Information About NAT
This chapter provides an overview of how Network Address Translation (NAT) works on the ASA. This
chapter includes the following sections:

Note

•

Why Use NAT?, page 29-1

•

NAT Terminology, page 29-2

•

NAT Types, page 29-3

•

NAT in Routed and Transparent Mode, page 29-12

•

NAT for VPN, page 29-14

•

How NAT is Implemented, page 29-16

•

NAT Rule Order, page 29-20

•

Routing NAT Packets, page 29-21

•

DNS and NAT, page 29-24

•

Where to Go Next, page 29-27

To start configuring NAT, see Chapter 30, “Configuring Network Object NAT,” or Chapter 31,
“Configuring Twice NAT.”

Why Use NAT?
Each computer and device within an IP network is assigned a unique IP address that identifies the host.
Because of a shortage of public IPv4 addresses, most of these IP addresses are private, not routable
anywhere outside of the private company network. RFC 1918 defines the private IP addresses you can
use internally 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

Cisco ASA 5500 Series Configuration Guide using the CLI

29-1

Chapter 29

Information About NAT

NAT Terminology

One of the main functions of NAT is to enable private IP networks to connect to the Internet. NAT
replaces a private IP address with a public IP address, translating the private addresses in the internal
private network into legal, routable addresses that can be used on the public Internet. In this way, NAT
conserves public addresses because it can be configured to advertise at a minimum only one public
address for the entire network to the outside world.
Other functions of NAT include:

Note

•

Security—Keeping internal IP addresses hidden discourages direct attacks.

•

IP routing solutions—Overlapping IP addresses are not a problem when you use NAT.

•

Flexibility—You can change internal IP addressing schemes without affecting the public addresses
available externally; for example, for a server accessible to the Internet, you can maintain a fixed IP
address for Internet use, but internally, you can change the server address.

NAT is not required. If you do not configure NAT for a given set of traffic, that traffic will not be
translated, but will have all of the security policies applied as normal.

NAT Terminology
This document uses the following terminology:
•

Real address/host/network/interface—The real address is the address that is defined on the host,
before it is translated. In a typical NAT scenario where you want to translate the inside network when
it accesses the outside, the inside network would be the “real” network. Note that you can translate
any network connected to the ASA, not just an inside network, Therefore if you configure NAT to
translate outside addresses, “real” can refer to the outside network when it accesses the inside
network.

•

Mapped address/host/network/interface—The mapped address is the address that the real address is
translated to. In a typical NAT scenario where you want to translate the inside network when it
accesses the outside, the outside network would be the “mapped” network.

•

Bidirectional initiation—Static NAT allows connections to be initiated bidirectionally, meaning
both to the host and from the host.

•

Source and destination NAT—For any given packet, both the source and destination IP addresses are
compared to the NAT rules, and one or both can be translated/untranslated. For static NAT, the rule
is bidirectional, so be aware that “source” and “destination” are used in commands and descriptions
throughout this guide even though a given connection might originate at the “destination” address.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-2

Chapter 29

Information About NAT
NAT Types

NAT Types
•

NAT Types Overview, page 29-3

•

Static NAT, page 29-3

•

Dynamic NAT, page 29-8

•

Dynamic PAT, page 29-10

•

Identity NAT, page 29-11

NAT Types Overview
You can implement NAT using the following methods:
•

Static NAT—A consistent mapping between a real and mapped IP address. Allows bidirectional
traffic initiation. See the “Static NAT” section on page 29-3.

•

Dynamic NAT—A group of real IP addresses are mapped to a (usually smaller) group of mapped IP
addresses, on a first come, first served basis. Only the real host can initiate traffic. See the “Dynamic
NAT” section on page 29-8.

•

Dynamic Port Address Translation (PAT)—A group of real IP addresses are mapped to a single IP
address using a unique source port of that IP address. See the “Dynamic PAT” section on page 29-10.

•

Identity NAT—A real address is statically transalted to itself, essentially bypassing NAT. You might
want to configure NAT this way when you want to translate a large group of addresses, but then want
to exempt a smaller subset of addresses. See the “Identity NAT” section on page 29-11.

Static NAT
This section describes static NAT and includes the following topics:
•

Information About Static NAT, page 29-3

•

Information About Static NAT with Port Translation, page 29-4

•

Information About One-to-Many Static NAT, page 29-6

•

Information About Other Mapping Scenarios (Not Recommended), page 29-7

Information About Static NAT
Static NAT creates a fixed translation of a real address to a mapped address. Because the mapped address
is the same for each consecutive connection, static NAT allows bidirectional connection initiation, both
to and from the host (if an access rule exists that allows it). With dynamic NAT and PAT, on the other
hand, each host uses a different address or port for each subsequent translation, so bidirectional initiation
is not supported.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-3

Chapter 29

Information About NAT

NAT Types

Figure 29-1 shows a typical static NAT scenario. The translation is always active so both real and remote
hosts can initiate connections.
Figure 29-1

Static NAT

Security
Appliance
209.165.201.1

10.1.1.2

209.165.201.2
130035

10.1.1.1

Inside Outside

Information About Static NAT with Port Translation
Static NAT with port translation lets you specify a real and mapped protocol (TCP or UDP) and port.
This section includes the following topics:
•

Information About Static NAT with Port Address Translation, page 29-4

•

Static NAT with Identity Port Translation, page 29-5

•

Static NAT with Port Translation for Non-Standard Ports, page 29-5

•

Static Interface NAT with Port Translation, page 29-5

Information About Static NAT with Port Address Translation
When you specify the port with static NAT, you can choose to map the port and/or the IP address to the
same value or to a different value.
Figure 29-2 shows a typical static NAT with port translation scenario showing both a port that is mapped
to itself and a port that is mapped to a different value; the IP address is mapped to a different value in
both cases. The translation is always active so both translated and remote hosts can initiate connections.
Figure 29-2

Typical Static NAT with Port Translation Scenario

10.1.1.1:23

209.165.201.1:23

10.1.1.2:8080

209.165.201.2:80

Inside Outside

Note

For applications that require application inspection for secondary channels (for example, FTP and VoIP),
the ASA automatically translates the secondary ports.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-4

130044

Security
Appliance

Chapter 29

Information About NAT
NAT Types

Static NAT with Identity Port Translation
The following static NAT with port translation example provides a single address for remote users to
access FTP, HTTP, and SMTP. These servers are actually different devices on the real network, but for
each server, you can specify static NAT with port translation rules that use the same mapped IP address,
but different ports. (See Figure 29-3. See the “Single Address for FTP, HTTP, and SMTP (Static
NAT-with-Port-Translation)” section on page 30-18 for details on how to configure this example.)
Figure 29-3

Static NAT with Port Translation

Host

Undo Translation
209.165.201.3:21
10.1.2.27

Outside

Undo Translation
209.165.201.3:25
10.1.2.29
Undo Translation
209.165.201.3:80
10.1.2.28

Inside

SMTP server
10.1.2.29

HTTP server
10.1.2.28

130031

FTP server
10.1.2.27

Static NAT with Port Translation for Non-Standard Ports
You can also use static NAT with port translation to translate a well-known port to a non-standard port
or vice versa. For example, if inside web servers use port 8080, you can allow outside users to connect
to port 80, and then undo translation to the original port 8080. Similarly, to provide extra security, you
can tell web users to connect to non-standard port 6785, and then undo translation to port 80.

Static Interface NAT with Port Translation
You can configure static NAT to map a real address to an interface address/port combination. For
example, if you want to redirect Telnet access for the ASA outside interface to an inside host, then you
can map the inside host IP address/port 23 to the ASA interface address/port 23. (Note that although
Telnet to the ASA is not allowed to the lowest security interface, static NAT with interface port
translation redirects the Telnet session instead of denying it).

Cisco ASA 5500 Series Configuration Guide using the CLI

29-5

Chapter 29

Information About NAT

NAT Types

Information About One-to-Many Static NAT
Typically, you configure static NAT with a one-to-one mapping. However, in some cases, you might want
to configure a single real address to several mapped addresses (one-to-many). When you configure
one-to-many static NAT, when the real host initiates traffic, it always uses the first mapped address.
However, for traffic initiated to the host, you can initiate traffic to any of the mapped addresses, and they
will be untranslated to the single real address.
Figure 29-4 shows a typical one-to-many static NAT scenario. Because initiation by the real host always
uses the first mapped address, the translation of real host IP/1st mapped IP is technically the only
bidirectional translation.
Figure 29-4

One-to-Many Static NAT

10.1.2.27

209.165.201.3

10.1.2.27

209.165.201.4

10.1.2.27

209.165.201.5
Inside Outside

Cisco ASA 5500 Series Configuration Guide using the CLI

29-6

248771

Security
Appliance

Chapter 29

Information About NAT
NAT Types

For example, you have a load balancer at 10.1.2.27. Depending on the URL requested, it redirects traffic
to the correct web server (see Figure 29-5). (See the “Inside Load Balancer with Multiple Mapped
Addresses (Static NAT, One-to-Many)” section on page 30-17 for details on how to configure this
example.)
Figure 29-5

One-to-Many Static NAT

Host

Undo Translation
209.165.201.5
10.1.2.27

Outside
Undo Translation
209.165.201.3
10.1.2.27

Undo Translation
209.165.201.4
10.1.2.27

Inside

Web Servers

248633

Load Balancer
10.1.2.27

Information About Other Mapping Scenarios (Not Recommended)
The ASA has the flexibility to allow any kind of static mapping scenario: one-to-one, one-to-many, but
also few-to-many, many-to-few, and many-to-one mappings. We recommend using only one-to-one or
one-to-many mappings. These other mapping options might result in unintended consequences.
Functionally, few-to-many is the same as one-to-many; but because the configuration is more
complicated and the actual mappings may not be obvious at a glance, we recommend creating a
one-to-many configuration for each real address that requires it. For example, for a few-to-many
scenario, the few real addresses are mapped to the many mapped addresses in order (A to 1, B to 2, C to
3). When all real addresses are mapped, the next mapped address is mapped to the first real address, and
so on until all mapped addresses are mapped (A to 4, B to 5, C to 6). This results in multiple mapped
addresses for each real address. Just like a one-to-many configuration, only the first mappings are
bidirectional; subsequent mappings allow traffic to be initiated to the real host, but all traffic from the
real host uses only the first mapped address for the source.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-7

Chapter 29

Information About NAT

NAT Types

Figure 29-6 shows a typical few-to-many static NAT scenario.
Few-to-Many Static NAT

Security
Appliance
10.1.2.27

209.165.201.3

10.1.2.28

209.165.201.4

10.1.2.27

209.165.201.5

10.1.2.28

209.165.201.6

10.1.2.27

209.165.201.7

248769

Figure 29-6

Inside Outside

For a many-to-few or many-to-one configuration, where you have more real addresses than mapped
addresses, you run out of mapped addresses before you run out of real addresses. Only the mappings
between the lowest real IP addresses and the mapped pool result in bidirectional initiation. The
remaining higher real addresses can initiate traffic, but traffic cannot be initiated to them (returning
traffic for a connection is directed to the correct real address because of the unique 5-tuple (source IP,
destination IP, source port, destination port, protocol) for the connection).

Note

Many-to-few or many-to-one NAT is not PAT. If two real hosts use the same source port number and go
to the same outside server and the same TCP destination port, and both hosts are translated to the same
IP address, then both connections will be reset because of an address conflict (the 5-tuple is not unique).
Figure 29-7 shows a typical many-to-few static NAT scenario.
Many-to-Few Static NAT

Security
Appliance
10.1.2.27

209.165.201.3

10.1.2.28

209.165.201.4

10.1.2.29

209.165.201.3

10.1.2.30

209.165.201.4

10.1.2.31

209.165.201.3

248770

Figure 29-7

Inside Outside

Instead of using a static rule this way, we suggest that you create a one-to-one rule for the traffic that
needs bidirectional initiation, and then create a dynamic rule for the rest of your addresses.

Dynamic NAT
This section describes dynamic NAT and includes the following topics:
•

Information About Dynamic NAT, page 29-9

•

Dynamic NAT Disadvantages and Advantages, page 29-10

Cisco ASA 5500 Series Configuration Guide using the CLI

29-8

Chapter 29

Information About NAT
NAT Types

Information About Dynamic NAT
Dynamic NAT translates a group of real addresses to a pool of mapped addresses that are routable on the
destination network. The mapped pool typically includes fewer addresses than the real group. When a
host you want to translate accesses the destination network, the ASA assigns the host an IP address from
the mapped pool. The translation is created only when the real host initiates the connection. The
translation is in place only for the duration of the connection, and a given user does not keep the same
IP address after the translation times out. Users on the destination network, therefore, cannot initiate a
reliable connection to a host that uses dynamic NAT, even if the connection is allowed by an access rule.
Figure 29-8 shows a typical dynamic NAT scenario. Only real hosts can create a NAT session, and
responding traffic is allowed back.
Figure 29-8

Dynamic NAT

Security
Appliance
209.165.201.1

10.1.1.2

209.165.201.2
130032

10.1.1.1

Inside Outside

Figure 29-9 shows a remote host attempting to initiate a connection to a mapped address. This address
is not currently in the translation table; therefore, the ASA drops the packet.
Figure 29-9

Remote Host Attempts to Initiate a Connection to a Mapped Address

Web Server
www.example.com

Outside
209.165.201.2
Security
Appliance

209.165.201.10

10.1.2.1

132217

Inside

10.1.2.27

Cisco ASA 5500 Series Configuration Guide using the CLI

29-9

Chapter 29

Information About NAT

NAT Types

Note

For the duration of the translation, a remote host can initiate a connection to the translated host if an
access rule allows it. Because the address is unpredictable, a connection to the host is unlikely.
Nevertheless, in this case you can rely on the security of the access rule.

Dynamic NAT Disadvantages and Advantages
Dynamic NAT has these disadvantages:
•

If the mapped pool has fewer addresses than the real group, you could run out of addresses if the
amount of traffic is more than expected.
Use PAT or a PAT fallback method if this event occurs often because PAT provides over 64,000
translations using ports of a single address.

•

You have to use a large number of routable addresses in the mapped pool, and routable addresses
may not be available in large quantities.

The advantage of dynamic NAT is that some protocols cannot use PAT. PAT does not work with the
following:
•

IP protocols that do not have a port to overload, such as GRE version 0.

•

Some multimedia applications that have a data stream on one port, the control path on another port,
and are not open standard.

See the “Default Settings” section on page 42-4 for more information about NAT and PAT support.

Dynamic PAT
This section describes dynamic PAT and includes the following topics:
•

Information About Dynamic PAT, page 29-10

•

Dynamic PAT Disadvantages and Advantages, page 29-11

Information About Dynamic PAT
Dynamic PAT translates multiple real addresses to a single mapped IP address by translating the real
address and source port to the mapped address and a unique port. If available, the real source port number
is used for the mapped port. However, if the real port is not available, by default the mapped ports are
chosen from the same range of ports as the real port number: 0 to 511, 512 to 1023, and 1024 to 65535.
Therefore, ports below 1024 have only a small PAT pool that can be used. (8.4(3) and later, not including
8.5(1) or 8.6(1)) If you have a lot of traffic that uses the lower port ranges, you can now specify a flat
range of ports to be used instead of the three unequal-sized tiers.
Each connection requires a separate translation session because the source port differs for each
connection. For example, 10.1.1.1:1025 requires a separate translation from 10.1.1.1:1026.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-10

Chapter 29

Information About NAT
NAT Types

Figure 29-10 shows a typical dynamic PAT scenario. Only real hosts can create a NAT session, and
responding traffic is allowed back. The mapped address is the same for each translation, but the port is
dynamically assigned.
Figure 29-10

Dynamic PAT

209.165.201.1:2020

10.1.1.1:1026

209.165.201.1:2021

10.1.1.2:1025

209.165.201.1:2022
Inside Outside

130034

Security
Appliance
10.1.1.1:1025

After the connection expires, the port translation also expires after 30 seconds of inactivity. The timeout
is not configurable. Users on the destination network cannot reliably initiate a connection to a host that
uses PAT (even if the connection is allowed by an access rule).

Note

For the duration of the translation, a remote host can initiate a connection to the translated host if an
access rule allows it. Because the port address (both real and mapped) is unpredictable, a connection to
the host is unlikely. Nevertheless, in this case you can rely on the security of the access rule.

Dynamic PAT Disadvantages and Advantages
Dynamic PAT lets you use a single mapped address, thus conserving routable addresses. You can even
use the ASA interface IP address as the PAT address.
Dynamic PAT does not work with some multimedia applications that have a data stream that is different
from the control path. See the “Default Settings” section on page 42-4 for more information about NAT
and PAT support.
Dynamic PAT may also create a large number of connections appearing to come from a single IP address,
and servers might interpret the traffic as a DoS attack. (8.4(2)/8.5(1) and later) You can configure a PAT
pool of addresses and use a round-robin assignment of PAT addresses to mitigate this situation.

Identity NAT
You might have a NAT configuration in which you need to translate an IP address to itself. For example,
if you create a broad rule that applies NAT to every network, but want to exclude one network from NAT,
you can create a static NAT rule to translate an address to itself. Identity NAT is necessary for remote
access VPN, where you need to exempt the client traffic from NAT.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-11

Chapter 29

Information About NAT

NAT in Routed and Transparent Mode

Figure 29-11 shows a typical identity NAT scenario.
Figure 29-11

Identity NAT

209.165.201.1

209.165.201.1

209.165.201.2

209.165.201.2

Inside Outside

130036

Security
Appliance

NAT in Routed and Transparent Mode
You can configure NAT in both routed and transparent firewall mode. This section describes typical
usage for each firewall mode and includes the following topics:
•

NAT in Routed Mode, page 29-13

•

NAT in Transparent Mode, page 29-13

Cisco ASA 5500 Series Configuration Guide using the CLI

29-12

Chapter 29

Information About NAT
NAT in Routed and Transparent Mode

NAT in Routed Mode
Figure 29-12 shows a typical NAT example in routed mode, with a private network on the inside.
Figure 29-12

NAT Example: Routed Mode

Web Server
www.cisco.com

Outside
209.165.201.2
Originating
Packet

Security
Appliance

Translation
10.1.2.27
209.165.201.10

Responding
Packet
Undo Translation
209.165.201.10
10.1.2.27

10.1.2.1

10.1.2.27

130023

Inside

1.

When the inside host at 10.1.2.27 sends a packet to a web server, the real source address of the
packet, 10.1.2.27, is changed to a mapped address, 209.165.201.10.

2.

When the server responds, it sends the response to the mapped address, 209.165.201.10, and the
ASA receives the packet because the ASA performs proxy ARP to claim the packet.

3.

The ASA then changes the translation of the mapped address, 209.165.201.10, back to the real
address, 10.1.2.27, before sending it to the host.

NAT in Transparent Mode
Using NAT in transparent mode eliminates the need for the upstream or downstream routers to perform
NAT for their networks.
NAT in transparent mode has the following requirements and limitations:
•

Because the transparent firewall does not have any interface IP addresses, you cannot use interface
PAT.

•

ARP inspection is not supported. Moreover, if for some reason a host on one side of the ASA sends
an ARP request to a host on the other side of the ASA, and the initiating host real address is mapped
to a different address on the same subnet, then the real address remains visible in the ARP request.

Figure 29-13 shows a typical NAT scenario in transparent mode, with the same network on the inside
and outside interfaces. The transparent firewall in this scenario is performing the NAT service so that the
upstream router does not have to perform NAT.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-13

Chapter 29

Information About NAT

NAT for VPN

Figure 29-13

NAT Example: Transparent Mode

www.example.com

Internet
Static route on router:
209.165.201.0/27 to 10.1.1.1

Source Addr Translation
10.1.1.75
209.165.201.15

Static route on ASA:
192.168.1.0/24 to 10.1.1.3
10.1.1.2
Management IP
10.1.1.1
ASA
10.1.1.75
10.1.1.3

Source Addr Translation
192.168.1.2
209.165.201.10

250261

192.168.1.1
Network 2
192.168.1.2

1.

When the inside host at 10.1.1.75 sends a packet to a web server, the real source address of the
packet, 10.1.1.75, is changed to a mapped address, 209.165.201.15.

2.

When the server responds, it sends the response to the mapped address, 209.165.201.15, and the
ASA receives the packet because the upstream router includes this mapped network in a static route
directed to the ASA management IP address. See the “Mapped Addresses and Routing” section on
page 29-22 for more information about required routes.

3.

The ASA then undoes the translation of the mapped address, 209.165.201.15, back to the real
address, 10.1.1.1.75. Because the real address is directly-connected, the ASA sends it directly to the
host.

4.

For host 192.168.1.2, the same process occurs, except for returning traffic, the ASA looks up the
route in its routing table and sends the packet to the downstream router at 10.1.1.3 based on the ASA
static route for 192.168.1.0/24. See the “Transparent Mode Routing Requirements for Remote
Networks” section on page 29-24 for more information about required routes.

NAT for VPN
If you do not allow split-tunneling, then all VPN traffic, even traffic destined for the Internet, goes
through the VPN tunnel. VPN traffic, after being decrypted by the ASA, is essentially the same as any
other inside traffic: when an inside user needs to access the Internet, they need a public IP address
provided by NAT.

Cisco ASA 5500 Series Configuration Guide using the CLI

29-14

Information About NAT
NAT for VPN

Figure 29-14 shows a VPN client that wants to visit a website at www.example.com. In this example, an
interface PAT rule on the outside interface matches the VPN-assigned address 10.1.1.10. With
intra-interface communication enabled, traffic can exit the same interface it entered to reach
www.example.com. A similar example without the need for hairpin networking includes an ASA for
VPN termination, and a separate ASA with NAT as the Internet gateway.
Figure 29-14

Interface PAT for Internet-Bound VPN Traffic (Hairpin, Intra-Interface)

2. ASA replaces src address with local address 1. HTTP request to www.example.com
209.165.201.10

Src: 209.165.201.10

10.1.1.10

ASA Outside IP: 203.0.113.1
Inside

VPN Client
209.165.201.10

Internet

Inside Server
203.0.113.1:6070

Src: 203.0.113.1:6070 www.example.com
3. ASA performs interface PAT for outgoing traffic.
Note: This “hairpin” traffic flow requires you to enable 4. HTTP request to www.example.com
intra-interface communication.

331396

10.1.1.10

Figure 29-15 also shows an interface PAT rule for Internet-bound traffic. However, for any
communication between VPN endpoints such as the ends of a site-to-site tunnel, you do not want to
perform NAT. Therefore you also need to create an identity NAT rule (using twice NAT) for any traffic
that goes to other inside networks connected by VPN.
Figure 29-15

Identity NAT to Allow Communication Between VPN Sites and Clients

2. Identity NAT for 10.1.1.0, 10.2.2.0, & 10.3.3.0
networks when going to other inside networks
connected by VPN
San Jose VPN Client
10.1.1.6
10.1.1.6
VPN IP: 10.3.3.2
1. IM to 10.2.2.78
3. IM received
Src: 10.1.1.6

Src: 10.1.1.6

Internet

10.1.1.6

Boulder

ASA
10.1.1.6

Site-to-Site VPN Tunnel

203.0.113.1:6070

San Jose
ASA

10.2.2.78
www.example.com

Src: 10.1.1.6

B. ASA performs interface PAT for
outgoing traffic. Note: For remote access
A. HTTP to
VPN Clients, this “hairpin” traffic flow
www.example.com requires you to enable
Src: 203.0.113.1:6070
intra-interface communication.
C. HTTP request to www.example.com

331395

Chapter 29

Cisco ASA 5500 Series Configuration Guide using the CLI

29-15

Chapter 29

Information About NAT

How NAT is Implemented

How NAT is Implemented
The ASA can implement address translation in two ways: network object NAT and twice NAT. This
section includes the following topics:
•

Main Differences Between Network Object NAT and Twice NAT, page 29-16

•

Information About Network Object NAT, page 29-17

•

Information About Twice NAT, page 29-17

Main Differences Between Network Object NAT and Twice NAT
The main differences between these two NAT types are:
•

How you define the real address.
– Network object NAT—You define NAT as a parameter for a network object. A network object

names an IP host, range, or subnet so you can then use the object in configuration instead of the
actual IP addresses. The network object IP address serves as the real address. This method lets
you easily add NAT to network objects that might already be used in other parts of your
configuration.
– Twice NAT—You identify a network object or network object group for both the real and

mapped addresses. In this case, NAT is not a parameter of the network object; the network object
or group is a parameter of the NAT configuration. The ability to use a network object group for
the real address means that twice NAT is more scalable.
•

How source and destination NAT is implemented.
– Network object NAT— Each rule can apply to either the source or destination of a packet. So

two rules might be used, one for the source IP address, and one for the destination IP address.
These two rules cannot be tied together to enforce a specific translation for a source/destination
combination.
– Twice NAT—A single rule translates both the source and destination. A matching packet only

matches the one rule, and further rules are not checked. Even if you do not configure the
optional destination address for twice NAT, a matching packet still only matches one twice NAT
rule. The source and destination are tied together, so you can enforce different translations
depending on the source/destination combination. For example, sourceA/destinationA can have
a different translation than sourceA/destinationB.
•

Order of NAT Rules.
– Network object NAT—Automatically ordered in the NAT table.
– Twice NAT—Manually ordered in the NAT table (before or after network object NAT rules).

See the “NAT Rule Order” section on page 29-20 for more information.
We recommend using network object NAT unless you need the extra features that twice NAT provides.
Network object NAT is easier to configure, and might be more reliable for applications such as Voice
over IP (VoIP). (For VoIP, because twice NAT is applicable only between two objects, you might see a
failure in the translation of indirect addresses that do not belong to either of the objects.)

Cisco ASA 5500 Series Configuration Guide using the CLI

29-16

Chapter 29

Information About NAT
How NAT is Implemented

Information About Network Object NAT
All NAT rules that are configured as a parameter of a network object are considered to be network object
NAT rules. Network object NAT is a quick and easy way to configure NAT for a network object, which
can be a single IP address, a range of addresses, or a subnet.
After you configure the network object, you can then identify the mapped address for that object, either
as an inline address or as another network object or network object group.
When a packet enters the ASA, both the source and destination IP addresses are checked against the
network object NAT rules. The source and destination address in the packet can be translated by separate
rules if separate matches are made. These rules are not tied to each other; different combinations of rules
can be used depending on the traffic.
Because the rules are never paired, you cannot specify that sourceA/destinationA should have a different
translation than sourceA/destinationB. Use twice NAT for that kind of functionality (twice NAT lets you
identify the source and destination address in a single rule).
To start configuring network object NAT, see Chapter 30, “Configuring Network Object NAT.”

Information About Twice NAT
Twice NAT lets you identify both the source and destination address in a single rule. Specifying both the
source and destination addresses lets you specify that sourceA/destinationA can have a different
translation than sourceA/destinationB.
The destination address is optional. If you specify the destination address, you can either map it to itself
(identity NAT), or you can map it to a different address. The destination mapping is always a static
mapping.
Twice NAT also lets you use service objects for static NAT with port translation; network object NAT
only accepts inline definition.
To start configuring twice NAT, see Chapter 31, “Configuring Twice NAT.”
Figure 29-16 shows a host on the 10.1.2.0/24 network accessing two different servers. When the host
accesses the server at 209.165.201.11, the real address is translated to 209.165.202.129. When the host
accesses the server at 209.165.200.225, the real address is translated to 209.165.202.130. (See the
“Single Address for FTP, HTTP, and SMTP (Static NAT-with-Port-Translation)” section on page 30-18
for details on how to configure this example.)

Cisco ASA 5500 Series Configuration Guide using the CLI

29-17

Chapter 29

Information About NAT

How NAT is Implemented

Figure 29-16

Twice NAT with Different Destination Addresses

Server 1
209.165.201.11

Server 2
209.165.200.225

209.165.201.0/27

209.165.200.224/27
DMZ

Translation
10.1.2.27
209.165.202.129

Translation
10.1.2.27
209.165.202.130

Inside

Packet
Dest. Address:
209.165.201.11

10.1.2.27

Packet
Dest. Address:
209.165.200.225

130039

10.1.2.0/24

Figure 29-17 shows the use of source and destination ports. The host on the 10.1.2.0/24 network accesses
a single host for both web services and Telnet services. When the host accesses the server for web
services, the real address is translated to 209.165.202.129. When the host accesses the same server for
Telnet services, the real address is translated to 209.165.202.130.
Figure 29-17

Twice NAT with Different Destination Ports

Cisco ASA 5500 Series Configuration Guide using the CLI

29-18

Information About NAT
How NAT is Implemented

Figure 29-18 shows a remote host connecting to a mapped host. The mapped host has a twice static NAT
translation that translates the real address only for traffic to and from the 209.165.201.0/27 network. A
translation does not exist for the 209.165.200.224/27 network, so the translated host cannot connect to
that network, nor can a host on that network connect to the translated host.
Figure 29-18

Twice Static NAT with Destination Address Translation

209.165.201.11

209.165.200.225

209.165.201.0/27

209.165.200.224/27
DMZ

No Translation

Undo Translation
10.1.2.27
209.165.202.128

Inside
10.1.2.0/27

10.1.2.27

130037

Chapter 29

Cisco ASA 5500 Series Configuration Guide using the CLI

29-19

Chapter 29

Information About NAT

NAT Rule Order

NAT Rule Order
Network object NAT rules and twice NAT rules are stored in a single table that is divided into three
sections. Section 1 rules are applied first, then section 2, and finally section 3. Table 29-1 shows the
order of rules within each section.
Table 29-1

NAT Rule Table

Table Section Rule Type

Order of Rules within the Section

Section 1

Applied on a first match basis, in the order they appear in the
configuration. By default, twice NAT rules are added to
section 1.

Twice NAT

Note

Section 2

If you configure EasyVPN remote, the ASA
dynamically adds invisible NAT rules to the end of this
section. Be sure that you do not configure a twice NAT
rule in this section that might match your VPN traffic,
instead of matching the invisible rule. If VPN does not
work due to NAT failure, consider adding twice NAT
rules to section 3 instead.

Network object NAT Section 2 rules are applied in the following order, as
automatically determined by the ASA:
1.

Static rules.

2.

Dynamic rules.

Within each rule type, the following ordering guidelines are
used:
a. Quantity of real IP addresses—From smallest to

largest. For example, an object with one address will
be assessed before an object with 10 addresses.
b. For quantities that are the same, then the IP address

number is used, from lowest to highest. For example,
10.1.1.0 is assessed before 11.1.1.0.
c. If the same IP address is used, then the name of the

network object is used, in alphabetical order. For
example, abracadabra is assessed before catwoman.
Section 3

Twice NAT

Section 3 rules are applied on a first match basis, in the order
they appear in the configuration. You can specify whether to
add a twice NAT rule to section 3 when you add the rule.

For section 2 rules, for example, you have the following IP addresses defined within network objects:
192.168.1.0/24 (static)
192.168.1.0/24 (dynamic)
10.1.1.0/24 (static)
192.168.1.1/32 (static)
172.16.1.0/24 (dynamic) (object def)
172.16.1.0/24 (dynamic) (object abc)

Cisco ASA 5500 Series Configuration Guide using the CLI

29-20

Chapter 29

Information About NAT
NAT Interfaces

The resultant ordering would be:
192.168.1.1/32 (static)
10.1.1.0/24 (static)
192.168.1.0/24 (static)
172.16.1.0/24 (dynamic) (object abc)
172.16.1.0/24 (dynamic) (object def)
192.168.1.0/24 (dynamic)

NAT Interfaces
You can configure a NAT rule to apply to any interface (in other words, all interfaces), or you can identify
specific real and mapped interfaces. You can also specify any interface for the real address, and a specific
interface for the mapped address, or vice versa.
For example, you might want to specify any interface for the real address and specify the outside
interface for the mapped address if you use the same private addresses on multiple interfaces, and you
want to translate them all to the same global pool when accessing the outside (Figure 29-19).
Figure 29-19

Specifying Any Interface

Outside
10.1.2.0

209.165.201.1:xxxx
Security
Appliance

any

Note

Eng

10.1.2.0
Mktg

10.1.2.0
HR

248768

10.1.2.0

For transparent mode, you must choose specific source and destination interfaces.

Routing NAT Packets
The ASA needs to be the destination for any packets sent to the mapped address. The ASA also needs to
determine the egress interface for translated packets. This section describes how the ASA handles
accepting and delivering packets with NAT, and includes the following topics:
•

Mapped Addresses and Routing, page 29-22

•

Transparent Mode Routing Requirements for Remote Networks, page 29-24

•

Determining the Egress Interface, page 29-24

Cisco ASA 5500 Series Configuration Guide using the CLI

29-21

Chapter 29

Information About NAT

Routing NAT Packets

Mapped Addresses and Routing
When you translate the real address to a mapped address, the mapped address you choose determines
how to configure routing, if necessary, for the mapped address.
See additional guidelines about mapped IP addresses in Chapter 30, “Configuring Network Object
NAT,” and Chapter 31, “Configuring Twice NAT.”
See the following mapped address types:
•

Addresses on the same network as the mapped interface.
If you use addresses on the same network as the mapped interface, the ASA uses proxy ARP to
answer any ARP requests for the mapped addresses, thus intercepting traffic destined for a mapped
address. This solution simplifies routing because the ASA does not have to be the gateway for any
additional networks. This solution is ideal if the outside network contains an adequate number of
free addresses, a consideration if you are using a 1:1 translation like dynamic NAT or static NAT.
Dynamic PAT greatly extends the number of translations you can use with a small number of
addresses, so even if the available addresses on the outside network is small, this method can be
used. For PAT, you can even use the IP address of the mapped interface.

Note

•

If you configure the mapped interface to be any interface, and you specify a mapped address
on the same network as one of the mapped interfaces, then if an ARP request for that mapped
address comes in on a different interface, then you need to manually configure an ARP entry
for that network on the ingress interface, specifying its MAC address (see the arp
command). Typically, if you specify any interface for the mapped interface, then you use a
unique network for the mapped addresses, so this situation would not occur.

Addresses on a unique network.
If you need more addresses than are available on the mapped interface network, you can identify
addresses on a different subnet. The upstream router needs a static route for the mapped addresses
that points to the ASA. Alternatively for routed mode, you can configure a static route on the ASA
for the mapped addresses, and then redistribute the route using your routing protocol. For
transparent mode, if the real host is directly-connected, configure the static route on the upstream
router to point to the ASA: in 8.3, specify the global management IP address; in 8.4(1) and later,
specify the bridge group IP address. For remote hosts in transparent mode, in the static route on the
upstream router, you can alternatively specify the downstream router IP address.

•

The same address as the real address (identity NAT).
(8.3(1), 8.3(2), and 8.4(1)) The default behavior for identity NAT has proxy ARP disabled. You
cannot configure this setting.
(8.4(2) and later) The default behavior for identity NAT has proxy ARP enabled, matching other
static NAT rules. You can disable proxy ARP if desired. Note: You can also disable proxy ARP for
regular static NAT if desired, in which case you need to be sure to have proper routes on the upstream
router.
Normally for identity NAT, proxy ARP is not required, and in some cases can cause connectivity
issues. For example, if you configure a broad identity NAT rule for “any” IP address, then leaving
proxy ARP enabled can cause problems for hosts on the network directly-connected to the mapped
interface. In this case, when a host on the mapped network wants to communicate with another host
on the same network, then the address in the ARP request matches the NAT rule (which matches
“any” address). The ASA will then proxy ARP for the address, even though the packet is not actually
destined for the ASA. (Note that this problem occurs even if you have a twice NAT rule; although

Cisco ASA 5500 Series Configuration Guide using the CLI

29-22

Chapter 29

Information About NAT
Routing NAT Packets

the NAT rule must match both the source and destination addresses, the proxy ARP decision is made
only on the “source” address). If the ASA ARP response is received before the actual host ARP
response, then traffic will be mistakenly sent to the ASA (see Figure 29-20).
Figure 29-20

Proxy ARP Problems with Identity NAT

209.165.200.230
3

ARP Response

Too late
209.165.200.231
209.165.200.225

Inside

Outside

ARP for 209.165.200.230.

1

Proxy ARP for 209.165.200.230.

2

Identity NAT for
“any” with Proxy ARP

4

Traffic incorrectly sent to ASA.

In rare cases, you need proxy ARP for identity NAT; for example for virtual Telnet. When using
AAA for network access, a host needs to authenticate with the ASA using a service like Telnet
before any other traffic can pass. You can configure a virtual Telnet server on the ASA to provide
the necessary login. When accessing the virtual Telnet address from the outside, you must configure
an identity NAT rule for the address specifically for the proxy ARP functionality. Due to internal
processes for virtual Telnet, proxy ARP lets the ASA keep traffic destined for the virtual Telnet
address rather than send the traffic out the source interface according to the NAT rule. (See
Figure 29-21).
Figure 29-21

Proxy ARP and Virtual Telnet

Virtual Telnet:
209.165.200.230
Inside

209.165.201.11
Outside

Server
Identity NAT for
209.165.200.230
between inside and outside
with Proxy ARP

Telnet to 209.165.200.230.

Authenticate.

Communicate with server.

1

2

3

Cisco ASA 5500 Series Configuration Guide using the CLI

29-23

Chapter 29

Information About NAT

DNS and NAT

Transparent Mode Routing Requirements for Remote Networks
If the ASA performs NAT for a host that is not on the directly-connected network, then you need to
configure a static route on the ASA for that network. You also need to have a static route for embedded
IP addresses that are at least one hop away from the ASA (such as in VoIP or DNS traffic) when you
have inspection and NAT enabled.

Determining the Egress Interface
In transparent mode, the ASA determines the egress interface for a NAT packet by using the NAT
configuration; you must specify the source and destination interfaces as part of the NAT configuration.
In routed mode, the ASA determines the egress interface for a NAT packet in the following way:
•

If you specify an optional interface, then the ASA uses the NAT configuration to determine the
egress interface. (8.3(1) through 8.4(1)) The only exception is for identity NAT, which always uses
a route lookup, regardless of the NAT configuration. (8.4(2) and later) For identity NAT, the default
behavior is to use the NAT configuration, but you have the option to always use a route lookup
instead.

•

If you do not specify a specific interface, then the ASA uses a route lookup to determine the egress
interface.

DNS and NAT
You might need to configure the ASA to modify DNS replies by replacing the address in the reply with
an address that matches the NAT configuration. You can configure DNS modification when you
configure each translation rule.
This feature rewrites the A record, or address record, in DNS replies that match a NAT rule. For DNS
replies traversing from a mapped interface to any other interface, the A record is rewritten from the
mapped value to the real value. Inversely, for DNS replies traversing from any interface to a mapped
interface, the A record is rewritten from the real value to the mapped value.

Note

If you configure a twice NAT rule, you cannot configure DNS modification if you specify the source
address as well as the destination address. These kinds of rules can potentially have a different
translation for a single address when going to A vs. B. Therefore, the ASA cannot accurately match the
IP address inside the DNS reply to the correct twice NAT rule; the DNS reply does not contain
information about which source/destination address combination was in the packet that prompted the
DNS request.
Figure 29-22 shows a DNS server that is accessible from the outside interface. A server, ftp.cisco.com,
is on the inside interface. You configure the ASA to statically translate the ftp.cisco.com real address
(10.1.3.14) to a mapped address (209.165.201.10) that is visible on the outside network. In this case, you
want to enable DNS reply modification on this static rule so that inside users who have access to
ftp.cisco.com using the real address receive the real address from the DNS server, and not the mapped
address. When an inside host sends a DNS request for the address of ftp.cisco.com, the DNS server
replies with the mapped address (209.165.201.10). The ASA refers to the static rule for the inside server

Cisco ASA 5500 Series Configuration Guide using the CLI

29-24

Information About NAT
DNS and NAT

and translates the address inside the DNS reply to 10.1.3.14. If you do not enable DNS reply
modification, then the inside host attempts to send traffic to 209.165.201.10 instead of accessing
ftp.cisco.com directly.
Figure 29-22

DNS Reply Modification, DNS Server on Outside

DNS Server

1
DNS Query
ftp.cisco.com?

2

Outside

DNS Reply
209.165.201.10

Security
Appliance

3
DNS Reply Modification
209.165.201.10
10.1.3.14
Inside

4
DNS Reply
10.1.3.14

User

ftp.cisco.com
10.1.3.14
Static Translation
on Outside to:
209.165.201.10
130021

Chapter 29

5
FTP Request
10.1.3.14

Figure 29-23 shows a user on the inside network requesting the IP address for ftp.cisco.com, which is
on the DMZ network, from an outside DNS server. The DNS server replies with the mapped address
(209.165.201.10) according to the static rule between outside and DMZ even though the user is not on
the DMZ network. The ASA translates the address inside the DNS reply to 10.1.3.14. If the user needs
to access ftp.cisco.com using the real address, then no further configuration is required. If there is also

Cisco ASA 5500 Series Configuration Guide using the CLI

29-25

Chapter 29

Information About NAT

DNS and NAT

a static rule between the inside and DMZ, then you also need to enable DNS reply modification on this
rule. The DNS reply will then be modified two times.In this case, the ASA again translates the address
inside the DNS reply to 192.168.1.10 according to the static rule between inside and DMZ.
Figure 29-23

DNS Reply Modification, DNS Server, Host, and Server on Separate Networks

DNS Server

1
DNS Query
ftp.cisco.com?

2
DNS Reply
209.165.201.10

Outside

3

ASA

DNS Reply Modification 1
209.165.201.10
10.1.3.14

Static Translation 1
on Outside to:
209.165.201.10
Static Translation 2
on Inside to:
192.168.1.10
ftp.cisco.com
10.1.3.14

DMZ

7

4
DNS Reply Modification 2
192.168.1.10
10.1.3.14

Inside

Translation
192.168.1.10
10.1.3.14

6

5
DNS Reply
192.168.1.10

Cisco ASA 5500 Series Configuration Guide using the CLI

29-26

FTP Request
192.168.1.10
User

Chapter 29

Information About NAT
Where to Go Next

Figure 29-24 shows a web server and DNS server on the outside. The ASA has a static translation for
the outside server. In this case, when an inside user requests the address for ftp.cisco.com from the DNS
server, the DNS server responds with the real address, 209.165.20.10. Because you want inside users to
use the mapped address for ftp.cisco.com (10.1.2.56) you need to configure DNS reply modification for
the static translation.
Figure 29-24

DNS Reply Modification, DNS Server on Host Network

ftp.cisco.com
209.165.201.10
Static Translation on Inside to:
10.1.2.56
DNS Server

7
FTP Request
209.165.201.10

1
DNS Query
ftp.cisco.com?

2

DNS Reply
209.165.201.10

3

Outside

6
Dest Addr. Translation
10.1.2.56
209.165.201.10

Security
Appliance

5

DNS Reply Modification
209.165.201.10
10.1.2.56
Inside

4

FTP Request
10.1.2.56

User
10.1.2.27

130022

DNS Reply
10.1.2.56

Where to Go Next
To configure network object NAT, see Chapter 30, “Configuring Network Object NAT.”
To configure twice NAT, see Chapter 31, “Configuring Twice NAT.”

Cisco ASA 5500 Series Configuration Guide using the CLI

29-27

Chapter 29
Where to Go Next

Cisco ASA 5500 Series Configuration Guide using the CLI

29-28

Information About NAT

CH A P T E R

30

Configuring Network Object NAT
All NAT rules that are configured as a parameter of a network object are considered to be network object
NAT rules. Network object NAT is a quick and easy way to configure NAT for a single IP address, a range
of addresses, or a subnet. After you configure the network object, you can then identify the mapped
address for that object.
This chapter describes how to configure network object NAT, and it includes the following sections:

Note

•

Information About Network Object NAT, page 30-1

•

Licensing Requirements for Network Object NAT, page 30-2

•

Prerequisites for Network Object NAT, page 30-2

•

Guidelines and Limitations, page 30-2

•

Default Settings, page 30-3

•

Configuring Network Object NAT, page 30-3

•

Monitoring Network Object NAT, page 30-14

•

Configuration Examples for Network Object NAT, page 30-15

•

Feature History for Network Object NAT, page 30-22

For detailed information about how NAT works, see Chapter 29, “Information About NAT.”

Information About Network Object NAT
When a packet enters the ASA, both the source and destination IP addresses are checked against the
network object NAT rules. The source and destination address in the packet can be translated by separate
rules if separate matches are made. These rules are not tied to each other; different combinations of rules
can be used depending on the traffic.
Because the rules are never paired, you cannot specify that a source address should be translated to A
when going to destination X, but be translated to B when going to destination Y. Use twice NAT for that
kind of functionality (twice NAT lets you identify the source and destination address in a single rule).
For detailed information about the differences between twice NAT and network object NAT, see the
“How NAT is Implemented” section on page 29-16.
Network object NAT rules are added to section 2 of the NAT rules table. For more information about
NAT ordering, see the “NAT Rule Order” section on page 29-20.

Cisco ASA 5500 Series Configuration Guide using the CLI

30-1

Chapter 30

Configuring Network Object NAT

Licensing Requirements for Network Object NAT

Licensing Requirements for Network Object NAT
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Prerequisites for Network Object NAT
Depending on the configuration, you can configure the mapped address inline if desired or you can create
a separate network object or network object group for the mapped address (the object network or
object-group network command). Network object groups are particularly useful for creating a mapped
address pool with discontinous IP address ranges or multiple hosts or subnets. To create a network object
or group, see the “Configuring Objects and Groups” section on page 13-1.
For specific guidelines for objects and groups, see the configuration section for the NAT type you want
to configure. See also the “Guidelines and Limitations” section.

Guidelines and Limitations
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines
•

Supported in routed and transparent firewall mode.

•

In transparent mode, you must specify the real and mapped interfaces; you cannot use any.

•

In transparent mode, you cannot configure interface PAT, because the transparent mode interfaces
do not have IP addresses. You also cannot use the management IP address as a mapped address.

IPv6 Guidelines

Does not support IPv6.
Additional Guidelines
•

You can only define a single NAT rule for a given object; if you want to configure multiple NAT
rules for an object, you need to create multiple objects with different names that specify the same
IP address, for example, object network obj-10.10.10.1-01, object network obj-10.10.10.1-02,
and so on.

Cisco ASA 5500 Series Configuration Guide using the CLI

30-2

Chapter 30

Configuring Network Object NAT
Default Settings

•

If you change the NAT configuration, and you do not want to wait for existing translations to time
out before the new NAT configuration is used, you can clear the translation table using the clear
xlate command. However, clearing the translation table disconnects all current connections that use
translations.

If you remove a dynamic NAT or PAT rule, and then add a new rule with mapped addresses
that overlap the addresses in the removed rule, then the new rule will not be used until all
connections associated with the removed rule time out or are cleared using the clear xlate
command. This safeguard ensures that the same address is not assigned to multiple hosts.

Note

•

Objects and object groups used in NAT cannot be undefined; they must include IP addresses.

•

You can use the same mapped object or group in multiple NAT rules.

•

The mapped IP address pool cannot include:
– The mapped interface IP address. If you specify any interface for the rule, then all interface IP

addresses are disallowed. For interface PAT (routed mode only), use the interface keyword
instead of the IP address.
– (Transparent mode) The management IP address.
– (Dynamic NAT) The standby interface IP address when VPN is enabled.
– Existing VPN pool addresses.
•

For application inspection limitations with NAT or PAT, see the “Default Settings” section on
page 42-4 in Chapter 42, “Getting Started with Application Layer Protocol Inspection.”

Default Settings
•

(Routed mode) The default real and mapped interface is Any, which applies the rule to all interfaces.

•

(8.3(1), 8.3(2), and 8.4(1)) The default behavior for identity NAT has proxy ARP disabled. You
cannot configure this setting. (8.4(2) and later) The default behavior for identity NAT has proxy
ARP enabled, matching other static NAT rules. You can disable proxy ARP if desired. See the
“Routing NAT Packets” section on page 29-21 for more information.

•

If you specify an optional interface, then the ASA uses the NAT configuration to determine the
egress interface. (8.3(1) through 8.4(1)) The only exception is for identity NAT, which always uses
a route lookup, regardless of the NAT configuration. (8.4(2) and later) For identity NAT, the default
behavior is to use the NAT configuration, but you have the option to always use a route lookup
instead. See the “Routing NAT Packets” section on page 29-21 for more information.

Configuring Network Object NAT
This section describes how to configure network object NAT and includes the following topics:
•

Configuring Dynamic NAT, page 30-4

•

Configuring Dynamic PAT (Hide), page 30-6

•

Configuring Static NAT or Static NAT-with-Port-Translation, page 30-10

•

Configuring Identity NAT, page 30-12

Cisco ASA 5500 Series Configuration Guide using the CLI

30-3

Chapter 30

Configuring Network Object NAT

Configuring Network Object NAT

Configuring Dynamic NAT
This section describes how to configure network object NAT for dynamic NAT. For more information,
see the “Dynamic NAT” section on page 29-8.

Detailed Steps

Step 1

Command

Purpose

Network object:

To specify the mapped addresses (that you want to translate to),
configure a network object or network object group. A network
object group can contain objects and/or inline addresses.

object network obj_name
range ip_address_1 ip_address_2

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
host ip_address} |
group-object grp_obj_name}

Note

The object or group cannot contain a subnet.

If a mapped network object contains both ranges and host IP
addresses, then the ranges are used for dynamic NAT, and then the
host IP addresses are used as a PAT fallback.
See the “Guidelines and Limitations” section on page 30-2 for
information about disallowed mapped IP addresses.

Example:
hostname(config)# object network TEST
hostname(config-network-object)# range
10.1.1.1 10.1.1.70

For more information about configuring a network object or group,
see the “Configuring Objects” section on page 13-3.

hostname(config)# object network TEST2
hostname(config-network-object)# range
10.1.2.1 10.1.2.70
hostname(config-network-object)#
object-group network MAPPED_IPS
hostname(config-network)# network-object
object TEST
hostname(config-network)# network-object
object TEST2
hostname(config-network)# network-object
host 10.1.2.79

Step 2

object network obj_name

Example:

Configures a network object for which you want to configure NAT,
or enters object network configuration mode for an existing network
object.

hostname(config)# object network
my-host-obj1

Step 3

{host ip_address | subnet subnet_address
netmask | range ip_address_1 ip_address_2}

Example:
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Cisco ASA 5500 Series Configuration Guide using the CLI

30-4

If you are creating a new network object, defines the real IP
address(es) that you want to translate.

Chapter 30

Configuring Network Object NAT
Configuring Network Object NAT

Step 4

Command

Purpose

nat [(real_ifc,mapped_ifc)] dynamic
mapped_obj [interface] [dns]

Configures dynamic NAT for the object IP addresses.
Note

You can only define a single NAT rule for a given object. See
the “Additional Guidelines” section on page 30-2.

Example:
hostname(config-network-object)# nat
(inside,outside) dynamic MAPPED_IPS
interface

See the following guidelines:
•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Mapped IP address—Specify the mapped IP address as:
– An existing network object (see Step 1).
– An existing network object group (see Step 1).

•

Interface PAT fallback—(Optional) The interface keyword
enables interface PAT fallback. After the mapped IP addresses
are used up, then the IP address of the mapped interface is used.
For this option, you must configure a specific interface for the
mapped_ifc. (You cannot specify interface in transparent
mode).

•

DNS—(Optional) The dns keyword translates DNS replies. Be
sure DNS inspection is enabled (it is enabled by default). See the
“DNS and NAT” section on page 29-24 for more information.

Examples
The following example configures dynamic NAT that hides 192.168.2.0 network behind a range of
outside addresses 10.2.2.1 through 10.2.2.10:
hostname(config)# object network
hostname(config-network-object)#
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#

my-range-obj
range 10.2.2.1 10.2.2.10
my-inside-net
subnet 192.168.2.0 255.255.255.0
nat (inside,outside) dynamic my-range-obj

The following example configures dynamic NAT with dynamic PAT backup. Hosts on inside network
10.76.11.0 are mapped first to the nat-range1 pool (10.10.10.10-10.10.10.20). After all addresses in the
nat-range1 pool are allocated, dynamic PAT is performed using the pat-ip1 address (10.10.10.21). In the
unlikely event that the PAT translations are also use up, dynamic PAT is performed using the outside
interface address.
hostname(config)# object network nat-range1
hostname(config-network-object)# range 10.10.10.10 10.10.10.20
hostname(config-network-object)# object network pat-ip1
hostname(config-network-object)# host 10.10.10.21
hostname(config-network-object)# object-group network nat-pat-grp
hostname(config-network-object)# network-object object nat-range1
hostname(config-network-object)# network-object object pat-ip1
hostname(config-network-object)# object network my_net_obj5
hostname(config-network-object)# subnet 10.76.11.0 255.255.255.0
hostname(config-network-object)# nat (inside,outside) dynamic nat-pat-grp interface

Cisco ASA 5500 Series Configuration Guide using the CLI

30-5

Chapter 30

Configuring Network Object NAT

Configuring Network Object NAT

Configuring Dynamic PAT (Hide)
This section describes how to configure network object NAT for dynamic PAT (hide). For more
information, see the “Dynamic PAT” section on page 29-10.

Guidelines
For a PAT pool:
•

If available, the real source port number is used for the mapped port. However, if the real port is not
available, by default the mapped ports are chosen from the same range of ports as the real port
number: 0 to 511, 512 to 1023, and 1024 to 65535. Therefore, ports below 1024 have only a small
PAT pool that can be used. (8.4(3) and later, not including 8.5(1) or 8.6(1)) If you have a lot of traffic
that uses the lower port ranges, you can now specify a flat range of ports to be used instead of the
three unequal-sized tiers: either 1024 to 65535, or 1 to 65535.

•

(8.4(3) and later, not including 8.5(1) or 8.6(1)) If you use the same PAT pool object in two separate
rules, then be sure to specify the same options for each rule. For example, if one rule specifies
extended PAT and a flat range, then the other rule must also specify extended PAT and a flat range.

For extended PAT for a PAT pool (8.4(3) and later, not including 8.5(1) or 8.6(1)):
•

Many application inspections do not support extended PAT. See the “Default Settings” section on
page 42-4 in Chapter 42, “Getting Started with Application Layer Protocol Inspection,” for a
complete list of unsupported inspections.

•

If you enable extended PAT for a dynamic PAT rule, then you cannot also use an address in the PAT
pool as the PAT address in a separate static NAT-with-port-translation rule. For example, if the PAT
pool includes 10.1.1.1, then you cannot create a static NAT-with-port-translation rule using 10.1.1.1
as the PAT address.

•

If you use a PAT pool and specify an interface for fallback, you cannot specify extended PAT.

•

For VoIP deployments that use ICE or TURN, do not use extended PAT. ICE and TURN rely on the
PAT binding to be the same for all destinations.

For round robin for a PAT pool:
•

(8.4(3) and later, not including 8.5(1) or 8.6(1)) If a host has an existing connection, then subsequent
connections from that host will use the same PAT IP address if ports are available. Note: This
“stickiness” does not survive a failover. If the ASA fails over, then subsequent connections from a
host may not use the initial IP address.

•

(8.4(2), 8.5(1), and 8.6(1)) If a host has an existing connection, then subsequent connections from
that host will likely use different PAT addresses for each connection because of the round robin
allocation. In this case, you may have problems when accessing two websites that exchange
information about the host, for example an e-commerce site and a payment site. When these sites
see two different IP addresses for what is supposed to be a single host, the transaction may fail.

•

Round robin, especially when combined with extended PAT, can consume a large amount of
memory. Because NAT pools are created for every mapped protocol/IP address/port range, round
robin results in a large number of concurrent NAT pools, which use memory. Extended PAT results
in an even larger number of concurrent NAT pools.

Cisco ASA 5500 Series Configuration Guide using the CLI

30-6

Chapter 30

Configuring Network Object NAT
Configuring Network Object NAT

Detailed Steps

Step 1

Command

Purpose

(Optional)

Specify the mapped address(es) (that you want to translate to).
You can configure a single address or, for a PAT pool, multiple
addresses. Configure a network object or network object group. A
network object group can contain objects and/or inline addresses.
Alternatively, you can skip this step if you want to enter a single
IP address as an inline value for the nat command or if you want
to use the interface address by specifying the interface keyword.

Network object:
object network obj_name
{host ip_address | range ip_address_1
ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
host ip_address} |
group-object grp_obj_name}

Example:
hostname(config)# object network PAT_POOL1
hostname(config-network-object)# range
10.5.1.80 10.7.1.80

For mapped addresses used as a PAT pool, all addresses in the
object or group, including ranges, are used as PAT addresses.
Note

The object or group cannot contain a subnet.

See the “Guidelines and Limitations” section on page 30-2 for
information about disallowed mapped IP addresses.
For more information about configuring a network object or
group, see the “Configuring Objects” section on page 13-3.

hostname(config)# object network PAT_POOL2
hostname(config-network-object)# range
10.9.1.1 10.10.1.1
hostname(config)# object network PAT_IP
hostname(config-network-object)# host
10.5.1.79
hostname(config-network-object)#
object-group network PAT_POOLS
hostname(config-network)# network-object
object PAT_POOL1
hostname(config-network)# network-object
object PAT_POOL2
hostname(config-network)# network-object
object PAT_IP

Step 2

object network obj_name

Example:

Configures a network object for which you want to configure
NAT, or enters object network configuration mode for an existing
network object.

hostname(config)# object network
my-host-obj1

Step 3

{host ip_address | subnet subnet_address
netmask | range ip_address_1 ip_address_2}

If you are creating a new network object, defines the real IP
address(es) that you want to translate.

Example:
hostname(config-network-object)# range
10.1.1.1 10.1.1.90

Cisco ASA 5500 Series Configuration Guide using the CLI

30-7

Chapter 30

Configuring Network Object NAT

Configuring Network Object NAT

Step 4

Command

Purpose

nat [(real_ifc,mapped_ifc)] dynamic
{mapped_inline_host_ip | mapped_obj |
pat-pool mapped_obj [round-robin]
[extended] [flat [include-reserve]] |
interface} [interface] [dns]

Configures dynamic PAT for the object IP addresses. You can
only define a single NAT rule for a given object. See the
“Additional Guidelines” section on page 30-2.
See the following guidelines:
•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Mapped IP address—You can specify the mapped IP address
as:

Example:
hostname(config-network-object)# nat
(any,outside) dynamic interface

– An inline host address.
– An existing network object that is defined as a host

address (see Step 1).
– pat-pool—An existing network object or group that

contains multiple addresses.
– interface—(Routed mode only) The IP address of the

mapped interface is used as the mapped address. For this
option, you must configure a specific interface for the
mapped_ifc. You must use this keyword when you want
to use the interface IP address; you cannot enter it inline
or as an object.
•

For a PAT pool, you can specify one or more of the following
options:
– Round robin—The round-robin keyword enables

round-robin address allocation for a PAT pool. Without
round robin, by default all ports for a PAT address will be
allocated before the next PAT address is used. The
round-robin method assigns an address/port from each
PAT address in the pool before returning to use the first
address again, and then the second address, and so on.
(continued)

Cisco ASA 5500 Series Configuration Guide using the CLI

30-8

Chapter 30

Configuring Network Object NAT
Configuring Network Object NAT

Command

Purpose
(continued)
– Extended PAT—(8.4(3) and later, not including 8.5(1) or

8.6(1)) The extended keyword enables extended PAT.
Extended PAT uses 65535 ports per service, as opposed
to per IP address, by including the destination address
and port in the translation information. Normally, the
destination port and address are not considered when
creating PAT translations, so you are limited to 65535
ports per PAT address. For example, with extended PAT,
you can create a translation of 10.1.1.1:1027 when going
to 192.168.1.7:23 as well as a translation of
10.1.1.1:1027 when going to 192.168.1.7:80.
– Flat range—(8.4(3) and later, not including 8.5(1) or

8.6(1)) The flat keyword enables use of the entire 1024
to 65535 port range when allocating ports. When
choosing the mapped port number for a translation, the
ASA uses the real source port number if it is available.
However, without this option, if the real port is not
available, by default the mapped ports are chosen from
the same range of ports as the real port number: 1 to 511,
512 to 1023, and 1024 to 65535. To avoid running out of
ports at the low ranges, configure this setting. To use the
entire range of 1 to 65535, also specify the
include-reserve keyword.
•

Interface PAT fallback—(Optional) The interface keyword
enables interface PAT fallback when entered after a primary
PAT address. After the primary PAT address(es) are used up,
then the IP address of the mapped interface is used. For this
option, you must configure a specific interface for the
mapped_ifc. (You cannot specify interface in transparent
mode).

•

DNS—(Optional) The dns keyword translates DNS replies.
Be sure DNS inspection is enabled (it is enabled by default).
See the “DNS and NAT” section on page 29-24 for more
information.

Examples
The following example configures dynamic PAT that hides the 192.168.2.0 network behind address
10.2.2.2:
hostname(config)# object network my-inside-net
hostname(config-network-object)# subnet 192.168.2.0 255.255.255.0
hostname(config-network-object)# nat (inside,outside) dynamic 10.2.2.2

The following example configures dynamic PAT that hides the 192.168.2.0 network behind the outside
interface address:
hostname(config)# object network my-inside-net
hostname(config-network-object)# subnet 192.168.2.0 255.255.255.0
hostname(config-network-object)# nat (inside,outside) dynamic interface

Cisco ASA 5500 Series Configuration Guide using the CLI

30-9

Chapter 30

Configuring Network Object NAT

Configuring Network Object NAT

Configuring Static NAT or Static NAT-with-Port-Translation
This section describes how to configure a static NAT rule using network object NAT. For more
information, see the “Static NAT” section on page 29-3.

Detailed Steps

Step 1

Command

Purpose

(Optional)

To specify the mapped addresses (that you want to translate to),
configure a network object or network object group. A network
object group can contain objects and/or inline addresses.
Alternatively, you can skip this step if you want to enter the
IP addresses as an inline value for the nat command or if you want
to use the interface address (for static NAT-with-port-translation)
by specifying the interface keyword.

Network object:
object network obj_name
{host ip_address |
subnet subnet_address netmask |
range ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

See the “Guidelines and Limitations” section on page 30-2 for
information about disallowed mapped IP addresses.
For more information about configuring a network object or
group, see the “Configuring Objects” section on page 13-3.

Example:
hostname(config)# object network
MAPPED_IPS
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Step 2

object network obj_name

Example:

Configures a network object for which you want to configure
NAT, or enters object network configuration mode for an existing
network object.

hostname(config)# object network
my-host-obj1

Step 3

{host ip_address | subnet subnet_address
netmask | range ip_address_1 ip_address_2}

Example:
hostname(config-network-object)# subnet
10.2.1.0 255.255.255.0

Cisco ASA 5500 Series Configuration Guide using the CLI

30-10

If you are creating a new network object, defines the real IP
address(es) that you want to translate.

Chapter 30

Configuring Network Object NAT
Configuring Network Object NAT

Step 4

Command

Purpose

nat [(real_ifc,mapped_ifc)] static
{mapped_inline_ip | mapped_obj |
interface} [dns | service {tcp | udp}
real_port mapped_port] [no-proxy-arp]

Configures static NAT for the object IP addresses.

Example:
hostname(config-network-object)# nat
(inside,outside) static MAPPED_IPS service
tcp 80 8080

Note

You can only define a single NAT rule for a given object.
See the “Additional Guidelines” section on page 30-2.

See the following guidelines:
•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Mapped IP Addresses—You can specify the mapped IP
address as:
– An inline IP address. The netmask or range for the

mapped network is the same as that of the real network.
For example, if the real network is a host, then this
address will be a host address. In the case of a range, then
the mapped addresses include the same number of
addresses as the real range. For example, if the real
address is defined as a range from 10.1.1.1 through
10.1.1.6, and you specify 172.20.1.1 as the mapped
address, then the mapped range will include 172.20.1.1
through 172.20.1.6.
– An existing network object or group (see Step 1).
– interface—(Static NAT-with-port-translation only;

routed mode) For this option, you must configure a
specific interface for the mapped_ifc. Be sure to also
configure the service keyword.
Typically, you configure the same number of mapped
addresses as real addresses for a one-to-one mapping. You
can, however, have a mismatched number of addresses. For
more information, see the “Static NAT” section on page 29-3.
•

DNS—(Optional) The dns keyword translates DNS replies.
Be sure DNS inspection is enabled (it is enabled by default).
See the “DNS and NAT” section on page 29-24 for more
information. This option is not available if you specify the
service keyword.

•

Port translation—(Static NAT-with-port-translation only)
Specify tcp or udp and the real and mapped ports. You can
enter either a port number or a well-known port name (such
as ftp).

•

No Proxy ARP—(Optional) Specify no-proxy-arp to disable
proxy ARP for incoming packets to the mapped IP addresses.
See the “Mapped Addresses and Routing” section on
page 29-22 for more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

30-11

Chapter 30

Configuring Network Object NAT

Configuring Network Object NAT

Examples
The following example configures static NAT for the real host 10.1.1.1 on the inside to 10.2.2.2 on the
outside with DNS rewrite enabled.
hostname(config)# object network my-host-obj1
hostname(config-network-object)# host 10.1.1.1
hostname(config-network-object)# nat (inside,outside) static 10.2.2.2 dns

The following example configures static NAT for the real host 10.1.1.1 on the inside to 2.2.2.2 on the
outside using a mapped object.
hostname(config)# object network my-mapped-obj
hostname(config-network-object)# host 10.2.2.2
hostname(config-network-object)# object network my-host-obj1
hostname(config-network-object)# host 10.1.1.1
hostname(config-network-object)# nat (inside,outside) static my-mapped-obj

The following example configures static NAT-with-port-translation for 10.1.1.1 at TCP port 21 to the
outside interface at port 2121.
hostname(config)# object network my-ftp-server
hostname(config-network-object)# host 10.1.1.1
hostname(config-network-object)# nat (inside,outside) static interface service tcp 21 2121

Configuring Identity NAT
This section describes how to configure an identity NAT rule using network object NAT. For more
information, see the “Identity NAT” section on page 29-11.

Detailed Steps

Step 1

Command

Purpose

(Optional)

For the mapped addresses (which will be the same as the real
addresses), configure a network object. Alternatively, you can
skip this step if you want to enter the IP addresses as an inline
value for the nat command.

object network obj_name
{host ip_address |
subnet subnet_address netmask |
range ip_address_1 ip_address_2}

For more information about configuring a network object, see the
“Configuring Objects” section on page 13-3.

Example:
hostname(config)# object network
MAPPED_IPS
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Step 2

object network obj_name

Example:
hostname(config)# object network
my-host-obj1

Cisco ASA 5500 Series Configuration Guide using the CLI

30-12

Configures a network object for which you want to perform
identity NAT, or enters object network configuration mode for an
existing network object.

Chapter 30

Configuring Network Object NAT
Configuring Network Object NAT

Step 3

Command

Purpose

{host ip_address | subnet subnet_address
netmask | range ip_address_1 ip_address_2}

If you are creating a new network object, defines the real IP
address(es) to which you want to perform identity NAT. If you
configured a network object for the mapped addresses in Step 1,
then these addresses must match.

Example:
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Step 4

nat [(real_ifc,mapped_ifc)] static
{mapped_inline_ip | mapped_obj}
[no-proxy-arp] [route-lookup]

Configures identity NAT for the object IP addresses.

Example:

See the following guidelines:

hostname(config-network-object)# nat
(inside,outside) static MAPPED_IPS

Note

You can only define a single NAT rule for a given object.
See the “Additional Guidelines” section on page 30-2.

•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Mapped IP addresses—Be sure to configure the same IP
address for both the mapped and real address. Use one of the
following:
– Network object—Including the same IP address as the

real object (see Step 1).
– Inline IP address—The netmask or range for the mapped

network is the same as that of the real network. For
example, if the real network is a host, then this address
will be a host address. In the case of a range, then the
mapped addresses include the same number of addresses
as the real range. For example, if the real address is
defined as a range from 10.1.1.1 through 10.1.1.6, and
you specify 10.1.1.1 as the mapped address, then the
mapped range will include 10.1.1.1 through 10.1.1.6.
•

No Proxy ARP—Specify no-proxy-arp to disable proxy
ARP for incoming packets to the mapped IP addresses. See
the “Mapped Addresses and Routing” section on page 29-22
for more information.

•

Route lookup—(Routed mode only; interface(s) specified)
Specify route-lookup to determine the egress interface using
a route lookup instead of using the interface specified in the
NAT command. See the “Determining the Egress Interface”
section on page 29-24 for more information.

Example
The following example maps a host address to itself using an inline mapped address:
hostname(config)# object network my-host-obj1
hostname(config-network-object)# host 10.1.1.1
hostname(config-network-object)# nat (inside,outside) static 10.1.1.1

Cisco ASA 5500 Series Configuration Guide using the CLI

30-13

Chapter 30

Configuring Network Object NAT

Monitoring Network Object NAT

The following example maps a host address to itself using a network object:
hostname(config)# object network my-host-obj1-identity
hostname(config-network-object)# host 10.1.1.1
hostname(config-network-object)# object network my-host-obj1
hostname(config-network-object)# host 10.1.1.1
hostname(config-network-object)# nat (inside,outside) static my-host-obj1-identity

Monitoring Network Object NAT
To monitor object NAT, enter one of the following commands:
Command

Purpose

show nat

Shows NAT statistics, including hits for each NAT rule.

show nat pool

Shows NAT pool statistics, including the addresses and ports allocated,
and how many times they were allocated.

show running-config nat

Shows the NAT configuration.
Note

You cannot view the NAT configuration using the show
running-config object command. You cannot reference objects
or object groups that have not yet been created in nat commands.
To avoid forward or circular references in show command output,
the show running-config command shows the object command
two times: first, where the IP address(es) are defined; and later,
where the nat command is defined. This command output
guarantees that objects are defined first, then object groups, and
finally NAT. For example:
hostname# show running-config
...
object network obj1
range 192.168.49.1 192.150.49.100
object network obj2
object 192.168.49.100
object network network-1
subnet 
object network network-2
subnet 
object-group network pool
network-object object obj1
network-object object obj2
...
object network network-1
nat (inside,outside) dynamic pool
object network network-2
nat (inside,outside) dynamic pool

show xlate

Shows current NAT session information.

Cisco ASA 5500 Series Configuration Guide using the CLI

30-14

Chapter 30

Configuring Network Object NAT
Configuration Examples for Network Object NAT

Configuration Examples for Network Object NAT
This section includes the following configuration examples:
•

Providing Access to an Inside Web Server (Static NAT), page 30-15

•

NAT for Inside Hosts (Dynamic NAT) and NAT for an Outside Web Server (Static NAT), page 30-16

•

Inside Load Balancer with Multiple Mapped Addresses (Static NAT, One-to-Many), page 30-17

•

Single Address for FTP, HTTP, and SMTP (Static NAT-with-Port-Translation), page 30-18

•

DNS Server on Mapped Interface, Web Server on Real Interface (Static NAT with DNS
Modification), page 30-19

•

DNS Server and Web Server on Mapped Interface, Web Server is Translated (Static NAT with DNS
Modification), page 30-21

Providing Access to an Inside Web Server (Static NAT)
The following example performs static NAT for an inside web server. The real address is on a private
network, so a public address is required. Static NAT is necessary so hosts can initiate traffic to the web
server at a fixed address. (See Figure 30-1).
Figure 30-1

Static NAT for an Inside Web Server

209.165.201.12

Outside
209.165.201.1
Undo Translation
10.1.2.27
209.165.201.10

Security
Appliance
10.1.2.1

myWebServ
10.1.2.27

Step 1

248772

Inside

Create a network object for the internal web server:
hostname(config)# object network myWebServ

Step 2

Define the web server address:
hostname(config-network-object)# host 10.1.2.27

Cisco ASA 5500 Series Configuration Guide using the CLI

30-15

Chapter 30

Configuring Network Object NAT

Configuration Examples for Network Object NAT

Step 3

Configure static NAT for the object:
hostname(config-network-object)# nat (inside,outside) static 209.165.201.10

NAT for Inside Hosts (Dynamic NAT) and NAT for an Outside Web Server
(Static NAT)
The following example configures dynamic NAT for inside users on a private network when they access
the outside. Also, when inside users connect to an outside web server, that web server address is
translated to an address that appears to be on the inside network. (See Figure 30-2).
Figure 30-2

Dynamic NAT for Inside, Static NAT for Outside Web Server

Web Server
209.165.201.12

Outside
209.165.201.1
10.1.2.10

Translation
209.165.201.20

Security
Appliance

Undo Translation
209.165.201.12
10.1.2.20

10.1.2.1
Inside

248773

myInsNet
10.1.2.0/24

Step 1

Create a network object for the dynamic NAT pool to which you want to translate the inside addresses:
hostname(config)# object network myNatPool
hostname(config-network-object)# range 209.165.201.20 209.165.201.30

Step 2

Create a network object for the inside network:
hostname(config)# object network myInsNet
hostname(config-network-object)# subnet 10.1.2.0 255.255.255.0

Step 3

Enable dynamic NAT for the inside network:
hostname(config-network-object)# nat (inside,outside) dynamic myNatPool

Cisco ASA 5500 Series Configuration Guide using the CLI

30-16

Chapter 30

Configuring Network Object NAT
Configuration Examples for Network Object NAT

Step 4

Create a network object for the outside web server:
hostname(config)# object network myWebServ

Step 5

Define the web server address:
hostname(config-network-object)# host 209.165.201.12

Step 6

Configure static NAT for the web server:
hostname(config-network-object)# nat (outside,inside) static 10.1.2.20

Inside Load Balancer with Multiple Mapped Addresses (Static NAT,
One-to-Many)
The following example shows an inside load balancer that is translated to multiple IP addresses. When
an outside host accesses one of the mapped IP addresses, it is untranslated to the single load balancer
address. Depending on the URL requested, it redirects traffic to the correct web server. (See
Figure 30-3).
Figure 30-3

Static NAT with One-to-Many for an Inside Load Balancer

Host

Undo Translation
209.165.201.5
10.1.2.27

Outside
Undo Translation
209.165.201.3
10.1.2.27

Undo Translation
209.165.201.4
10.1.2.27

Inside

Web Servers

Step 1

248633

Load Balancer
10.1.2.27

Create a network object for the addresses to which you want to map the load balancer:

Cisco ASA 5500 Series Configuration Guide using the CLI

30-17

Chapter 30

Configuring Network Object NAT

Configuration Examples for Network Object NAT

hostname(config)# object network myPublicIPs
hostname(config-network-object)# range 209.165.201.3 209.265.201.8

Step 2

Create a network object for the load balancer:
hostname(config)# object network myLBHost

Step 3

Define the load balancer address:
hostname(config-network-object)# host 10.1.2.27

Step 4

Configure static NAT for the load balancer:
hostname(config-network-object)# nat (inside,outside) static myPublicIPs

Single Address for FTP, HTTP, and SMTP (Static NAT-with-Port-Translation)
The following static NAT-with-port-translation example provides a single address for remote users to
access FTP, HTTP, and SMTP. These servers are actually different devices on the real network, but for
each server, you can specify static NAT-with-port-translation rules that use the same mapped IP address,
but different ports. (See Figure 30-4.)
Figure 30-4

Static NAT-with-Port-Translation

Host

Undo Translation
209.165.201.3:21
10.1.2.27

Outside

Undo Translation
209.165.201.3:25
10.1.2.29
Undo Translation
209.165.201.3:80
10.1.2.28

Inside

SMTP server
10.1.2.29

HTTP server
10.1.2.28

Step 1

Create a network object for the FTP server address:
hostname(config)# object network FTP_SERVER

Cisco ASA 5500 Series Configuration Guide using the CLI

30-18

130031

FTP server
10.1.2.27

Chapter 30

Configuring Network Object NAT
Configuration Examples for Network Object NAT

Step 2

Define the FTP server address, and configure static NAT with identity port translation for the FTP server:
hostname(config-network-object)# host 10.1.2.27
hostname(config-network-object)# nat (inside,outside) static 209.165.201.3 service tcp ftp
ftp

Step 3

Create a network object for the HTTP server address:
hostname(config)# object network HTTP_SERVER

Step 4

Define the HTTP server address, and configure static NAT with identity port translation for the HTTP
server:
hostname(config-network-object)# host 10.1.2.28
hostname(config-network-object)# nat (inside,outside) static 209.165.201.3 service tcp
http http

Step 5

Create a network object for the SMTP server address:
hostname(config)# object network SMTP_SERVER

Step 6

Define the SMTP server address, and configure static NAT with identity port translation for the SMTP
server:
hostname(config-network-object)# host 10.1.2.29
hostname(config-network-object)# nat (inside,outside) static 209.165.201.3 service tcp
smtp smtp

DNS Server on Mapped Interface, Web Server on Real Interface (Static NAT
with DNS Modification)
For example, a DNS server is accessible from the outside interface. A server, ftp.cisco.com, is on the
inside interface. You configure the ASA to statically translate the ftp.cisco.com real address (10.1.3.14)
to a mapped address (209.165.201.10) that is visible on the outside network. (See Figure 30-5.) In this
case, you want to enable DNS reply modification on this static rule so that inside users who have access
to ftp.cisco.com using the real address receive the real address from the DNS server, and not the mapped
address.

Cisco ASA 5500 Series Configuration Guide using the CLI

30-19

Chapter 30

Configuring Network Object NAT

Configuration Examples for Network Object NAT

When an inside host sends a DNS request for the address of ftp.cisco.com, the DNS server replies with
the mapped address (209.165.201.10). The ASA refers to the static rule for the inside server and
translates the address inside the DNS reply to 10.1.3.14. If you do not enable DNS reply modification,
then the inside host attempts to send traffic to 209.165.201.10 instead of accessing ftp.cisco.com
directly.
Figure 30-5

DNS Reply Modification

DNS Server

1
DNS Query
ftp.cisco.com?

2

Outside

DNS Reply
209.165.201.10

Security
Appliance

3
DNS Reply Modification
209.165.201.10
10.1.3.14
Inside

4
DNS Reply
10.1.3.14

ftp.cisco.com
10.1.3.14
Static Translation
on Outside to:
209.165.201.10
130021

User

5
FTP Request
10.1.3.14

Step 1

Create a network object for the FTP server address:
hostname(config)# object network FTP_SERVER

Step 2

Define the FTP server address, and configure static NAT with DNS modification:
hostname(config-network-object)# host 10.1.3.14
hostname(config-network-object)# nat (inside,outside) static 209.165.201.10 dns

Cisco ASA 5500 Series Configuration Guide using the CLI

30-20

Chapter 30

Configuring Network Object NAT
Configuration Examples for Network Object NAT

DNS Server and Web Server on Mapped Interface, Web Server is Translated
(Static NAT with DNS Modification)
Figure 30-6 shows a web server and DNS server on the outside. The ASA has a static translation for the
outside server. In this case, when an inside user requests the address for ftp.cisco.com from the DNS
server, the DNS server responds with the real address, 209.165.20.10. Because you want inside users to
use the mapped address for ftp.cisco.com (10.1.2.56) you need to configure DNS reply modification for
the static translation.
Figure 30-6

DNS Reply Modification Using Outside NAT

ftp.cisco.com
209.165.201.10
Static Translation on Inside to:
10.1.2.56
DNS Server

7
FTP Request
209.165.201.10

1
DNS Query
ftp.cisco.com?

2

DNS Reply
209.165.201.10

3

Outside

6
Dest Addr. Translation
10.1.2.56
209.165.201.10

Security
Appliance

5

DNS Reply Modification
209.165.201.10
10.1.2.56
Inside

4

FTP Request
10.1.2.56

User
10.1.2.27

Step 1

130022

DNS Reply
10.1.2.56

Create a network object for the FTP server address:
hostname(config)# object network FTP_SERVER

Step 2

Define the FTP server address, and configure static NAT with DNS modification:
hostname(config-network-object)# host 209.165.201.10
hostname(config-network-object)# nat (outside,inside) static 10.1.2.56 dns

Cisco ASA 5500 Series Configuration Guide using the CLI

30-21

Chapter 30

Configuring Network Object NAT

Feature History for Network Object NAT

Feature History for Network Object NAT
Table 30-1 lists each feature change and the platform release in which it was implemented.
Table 30-1

Feature History for Network Object NAT

Feature Name

Platform
Releases

Feature Information

Network Object NAT

8.3(1)

Configures NAT for a network object IP address(es).
We introduced or modified the following commands: nat
(object network configuration mode), show nat, show
xlate, show nat pool.

Identity NAT configurable proxy ARP and route 8.4(2)
lookup

In earlier releases for identity NAT, proxy ARP was
disabled, and a route lookup was always used to determine
the egress interface. You could not configure these settings.
In 8.4(2) and later, the default behavior for identity NAT
was changed to match the behavior of other static NAT
configurations: proxy ARP is enabled, and the NAT
configuration determines the egress interface (if specified)
by default. You can leave these settings as is, or you can
enable or disable them discretely. Note that you can now
also disable proxy ARP for regular static NAT.
When upgrading to 8.4(2) from 8.3(1), 8.3(2), and 8.4(1),
all identity NAT configurations will now include the
no-proxy-arp and route-lookup keywords, to maintain
existing functionality.
We modified the following commands: nat static
[no-proxy-arp] [route-lookup].

PAT pool and round robin address assignment

8.4(2)

You can now specify a pool of PAT addresses instead of a
single address. You can also optionally enable round-robin
assignment of PAT addresses instead of first using all ports
on a PAT address before using the next address in the pool.
These features help prevent a large number of connections
from a single PAT address from appearing to be part of a
DoS attack and makes configuration of large numbers of
PAT addresses easy.
We modifed the following commands: nat dynamic
[pat-pool mapped_object [round-robin]].

Round robin PAT pool allocation uses the same 8.4(3)
IP address for existing hosts

When using a PAT pool with round robin allocation, if a host
has an existing connection, then subsequent connections
from that host will use the same PAT IP address if ports are
available.
We did not modify any commands.
This feature is not available in 8.5(1) or 8.6(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

30-22

Chapter 30

Configuring Network Object NAT
Feature History for Network Object NAT

Table 30-1

Feature History for Network Object NAT (continued)

Feature Name

Platform
Releases

Flat range of PAT ports for a PAT pool

8.4(3)

Feature Information
If available, the real source port number is used for the
mapped port. However, if the real port is not available, by
default the mapped ports are chosen from the same range of
ports as the real port number: 0 to 511, 512 to 1023, and
1024 to 65535. Therefore, ports below 1024 have only a
small PAT pool.
If you have a lot of traffic that uses the lower port ranges,
when using a PAT pool, you can now specify a flat range of
ports to be used instead of the three unequal-sized tiers:
either 1024 to 65535, or 1 to 65535.
We modifed the following commands: nat dynamic
[pat-pool mapped_object [flat [include-reserve]]].
This feature is not available in 8.5(1) or 8.6(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

30-23

Chapter 30

Configuring Network Object NAT

Feature History for Network Object NAT

Table 30-1

Feature History for Network Object NAT (continued)

Feature Name

Platform
Releases

Extended PAT for a PAT pool

8.4(3)

Feature Information
Each PAT IP address allows up to 65535 ports. If 65535
ports do not provide enough translations, you can now
enable extended PAT for a PAT pool. Extended PAT uses
65535 ports per service, as opposed to per IP address, by
including the destination address and port in the translation
information.
We modifed the following commands: nat dynamic
[pat-pool mapped_object [extended]].
This feature is not available in 8.5(1) or 8.6(1).

Automatic NAT rules to translate a VPN peer’s 8.4(3)
local IP address back to the peer’s real IP
address

In rare situations, you might want to use a VPN peer’s real
IP address on the inside network instead of an assigned local
IP address. Normally with VPN, the peer is given an
assigned local IP address to access the inside network.
However, you might want to translate the local IP address
back to the peer’s real public IP address if, for example,
your inside servers and network security is based on the
peer’s real IP address.
You can enable this feature on one interface per tunnel
group. Object NAT rules are dynamically added and deleted
when the VPN session is established or disconnected. You
can view the rules using the show nat command.
Because of routing issues, we do not recommend
using this feature unless you know you need this
feature; contact Cisco TAC to confirm feature
compatibility with your network. See the following
limitations:

Note

•

Only supports Cisco IPsec and AnyConnect Client.

•

Return traffic to the public IP addresses must be
routed back to the ASA so the NAT policy and VPN
policy can be applied.

•

Does not support load-balancing (because of
routing issues).

•

Does not support roaming (public IP changing).

We introduced the following command:
nat-assigned-to-public-ip interface (tunnel-group
general-attributes configuration mode).

Cisco ASA 5500 Series Configuration Guide using the CLI

30-24

CH A P T E R

31

Configuring Twice NAT
Twice NAT lets you identify both the source and destination address in a single rule. This chapter shows
you how to configure twice NAT and includes the following sections:

Note

•

Information About Twice NAT, page 31-1

•

Licensing Requirements for Twice NAT, page 31-2

•

Prerequisites for Twice NAT, page 31-2

•

Guidelines and Limitations, page 31-2

•

Default Settings, page 31-3

•

Configuring Twice NAT, page 31-3

•

Monitoring Twice NAT, page 31-24

•

Configuration Examples for Twice NAT, page 31-24

•

Feature History for Twice NAT, page 31-28

For detailed information about how NAT works, see Chapter 29, “Information About NAT.”

Information About Twice NAT
Twice NAT lets you identify both the source and destination address in a single rule. Specifying both the
source and destination addresses lets you specify that a source address should be translated to A when
going to destination X, but be translated to B when going to destination Y, for example.

Note

For static NAT, the rule is bidirectional, so be aware that “source” and “destination” are used in
commands and descriptions throughout this guide even though a given connection might originate at the
“destination” address. For example, if you configure static NAT with port address translation, and
specify the source address as a Telnet server, and you want all traffic going to that Telnet server to have
the port translated from 2323 to 23, then in the command, you must specify the source ports to be
translated (real: 23, mapped: 2323). You specify the source ports because you specified the Telnet server
address as the source address.
The destination address is optional. If you specify the destination address, you can either map it to itself
(identity NAT), or you can map it to a different address. The destination mapping is always a static
mapping.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-1

Chapter 31

Configuring Twice NAT

Licensing Requirements for Twice NAT

Twice NAT also lets you use service objects for static NAT-with-port-translation; network object NAT
only accepts inline definition.
For detailed information about the differences between twice NAT and network object NAT, see the
“How NAT is Implemented” section on page 29-16.
Twice NAT rules are added to section 1 of the NAT rules table, or if specified, section 3. For more
information about NAT ordering, see the “NAT Rule Order” section on page 29-20.

Licensing Requirements for Twice NAT
Model

License Requirement

All models

Base License.

Prerequisites for Twice NAT
•

For both the real and mapped addresses, configure network objects or network object groups (the
object network or object-group network command). Network object groups are particularly useful
for creating a mapped address pool with discontinuous IP address ranges or multiple hosts or
subnets. To create a network object or group, see the “Configuring Objects and Groups” section on
page 13-1.

•

For static NAT-with-port-translation, configure TCP or UDP service objects (the object service
command). To create a service object, see the “Configuring a Service Object” section on page 13-4.

For specific guidelines for objects and groups, see the configuration section for the NAT type you want
to configure. See also the “Guidelines and Limitations” section.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines
•

Supported in routed and transparent firewall mode.

•

In transparent mode, you must specify the real and mapped interfaces; you cannot use any.

•

In transparent mode, you cannot configure interface PAT, because the transparent mode interfaces
do not have IP addresses. You also cannot use the management IP address as a mapped address.

IPv6 Guidelines

Does not support IPv6.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-2

Chapter 31

Configuring Twice NAT
Default Settings

Additional Guidelines
•

If you change the NAT configuration, and you do not want to wait for existing translations to time
out before the new NAT information is used, you can clear the translation table using the clear xlate
command. However, clearing the translation table disconnects all current connections that use
translations.

If you remove a dynamic NAT or PAT rule, and then add a new rule with mapped addresses
that overlap the addresses in the removed rule, then the new rule will not be used until all
connections associated with the removed rule time out or are cleared using the clear xlate
command. This safeguard ensures that the same address is not assigned to multiple hosts.

Note

•

Objects and object groups used in NAT cannot be undefined; they must include IP addresses.

•

You can use the same objects in multiple rules.

•

The mapped IP address pool cannot include:
– The mapped interface IP address. If you specify any interface for the rule, then all interface IP

addresses are disallowed. For interface PAT (routed mode only), use the interface keyword
instead of the IP address.
– (Transparent mode) The management IP address.
– (Dynamic NAT) The standby interface IP address when VPN is enabled.
– Existing VPN pool addresses.

Default Settings
•

By default, the rule is added to the end of section 1 of the NAT table.

•

(Routed mode) The default real and mapped interface is Any, which applies the rule to all interfaces.

•

(8.3(1), 8.3(2), and 8.4(1)) The default behavior for identity NAT has proxy ARP disabled. You
cannot configure this setting. (8.4(2) and later) The default behavior for identity NAT has proxy
ARP enabled, matching other static NAT rules. You can disable proxy ARP if desired.

•

If you specify an optional interface, then the ASA uses the NAT configuration to determine the
egress interface. (8.3(1) through 8.4(1)) The only exception is for identity NAT, which always uses
a route lookup, regardless of the NAT configuration. (8.4(2) and later) For identity NAT, the default
behavior is to use the NAT configuration, but you have the option to always use a route lookup
instead.

Configuring Twice NAT
This section describes how to configure twice NAT. This section includes the following topics:
•

Configuring Dynamic NAT, page 31-4

•

Configuring Dynamic PAT (Hide), page 31-8

•

Configuring Static NAT or Static NAT-with-Port-Translation, page 31-15

•

Configuring Identity NAT, page 31-20

Cisco ASA 5500 Series Configuration Guide using the CLI

31-3

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Configuring Dynamic NAT
This section describes how to configure twice NAT for dynamic NAT. For more information, see the
“Dynamic NAT” section on page 29-8.

Detailed Steps

Step 1

Command

Purpose

Network object:

Configure the real source addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

You can configure either a network object or a network object
group. For more information, see the “Configuring Objects”
section on page 13-3.

Network object group:

If you want to translate all traffic, you can skip this step and
specify the any keyword instead of creating an object or group.

object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:
hostname(config)# object network MyInsNet
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Step 2

Network object:

Configure the mapped source addresses.

object network obj_name
range ip_address_1 ip_address_2

You can configure either a network object or a network object
group.

Network object group:

For dynamic NAT, you typically configure a larger group of
addresses to be mapped to a smaller group. If a mapped network
object contains both ranges and host IP addresses, then the ranges
are used for dynamic NAT, and then the host IP addresses are used
as a PAT fallback.

object-group network grp_name
{network-object {object net_obj_name |
host ip_address} |
group-object grp_obj_name}

Note

Example:
hostname(config)# object network NAT_POOL
hostname(config-network-object)# range
209.165.201.10 209.165.201.20

Cisco ASA 5500 Series Configuration Guide using the CLI

31-4

The mapped object or group cannot contain a subnet.

See the “Guidelines and Limitations” section on page 31-2 for
information about disallowed mapped IP addresses.

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Step 3

Command

Purpose

(Optional)

Configure the real destination addresses.

Network object:

You can configure either a network object or a network object
group.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Although the main feature of twice NAT is the inclusion of the
destination IP address, the destination address is optional. If you
do specify the destination address, you can configure static
translation for that address or just use identity NAT for it. You
might want to configure twice NAT without a destination address
to take advantage of some of the other qualities of twice NAT,
including the use of network object groups for real addresses, or
manually ordering of rules. For more information, see the “Main
Differences Between Network Object NAT and Twice NAT”
section on page 29-16.

Example:
hostname(config)# object network Server1
hostname(config-network-object)# host
209.165.201.8

Step 4

(Optional)

Configure the mapped destination addresses.

Network object:

The destination translation is always static. For identity NAT, you
can skip this step and simply use the same object or group for both
the real and mapped addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:

If you want to translate the destination address, you can configure
either a network object or a network object group. The static
mapping is typically one-to-one, so the real addresses have the
same quantity as the mapped addresses. You can, however, have
different quantities if desired. For more information, see the
“Static NAT” section on page 29-3.
For static interface NAT with port translation (routed mode only),
you can skip this step and specify the interface keyword instead
of a network object/group for the mapped address. For more
information, see the “Static Interface NAT with Port Translation”
section on page 29-5.

hostname(config)# object network
Server1_mapped
hostname(config-network-object)# host
10.1.1.67

Cisco ASA 5500 Series Configuration Guide using the CLI

31-5

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Step 5

Command

Purpose

(Optional)

Configure service objects for:

object service obj_name
service {tcp | udp} destination
operator port

Example:
hostname(config)# object service REAL_SVC
hostname(config-service-object)# service
tcp destination eq 80
hostname(config)# object service
MAPPED_SVC
hostname(config-service-object)# service
tcp destination eq 8080

Cisco ASA 5500 Series Configuration Guide using the CLI

31-6

•

Destination real port

•

Destination mapped port

Dynamic NAT does not support port translation. However,
because the destination translation is always static, you can
perform port translation for the destination port. A service object
can contain both a source and destination port, but only the
destination port is used in this case. If you specify the source port,
it will be ignored. NAT only supports TCP or UDP. When
translating a port, be sure the protocols in the real and mapped
service objects are identical (both TCP or both UDP). For identity
NAT, you can use the same service object for both the real and
mapped ports. The “not equal” (neq) operator is not supported.

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Step 6

Command

Purpose

nat [(real_ifc,mapped_ifc)]
[line | {after-auto [line]}]
source dynamic {real_obj | any}
{mapped_obj [interface]}
[destination static {mapped_obj |
interface} real_obj]
[service mapped_dest_svc_obj
real_dest_svc_obj] [dns] [inactive]
[description desc]

Configure dynamic NAT. See the following guidelines:
•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Section and Line—(Optional) By default, the NAT rule is
added to the end of section 1 of the NAT table (see the “NAT
Rule Order” section on page 29-20). If you want to add the
rule into section 3 instead (after the network object NAT
rules), then use the after-auto keyword. You can insert a rule
anywhere in the applicable section using the line argument.

•

Source addresses:

Example:
hostname(config)# nat (inside,outside)
source dynamic MyInsNet NAT_POOL
destination static Server1_mapped Server1
service MAPPED_SVC REAL_SVC

– Real—Specify a network object, group, or the any

keyword (see Step 1). Use the any keyword if you want
to translate all traffic from the real interface to the
mapped interface.
– Mapped—Specify a different network object or group

(see Step 2). You can optionally configure the following
fallback method:
Interface PAT fallback—(Routed mode only) The
interface keyword enables interface PAT fallback. After
the mapped IP addresses are used up, then the IP address
of the mapped interface is used. For this option, you must
configure a specific interface for the mapped_ifc.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-7

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Command

Purpose
(Continued)
•

Destination addresses (Optional):
– Mapped—Specify a network object or group, or for static

interface NAT with port translation only, specify the
interface keyword (see Step 4). If you specify interface,
be sure to also configure the service keyword. For this
option, you must configure a specific interface for the
real_ifc. See the “Static Interface NAT with Port
Translation” section on page 29-5 for more information.
– Real—Specify a network object or group (see Step 3).

For identity NAT, simply use the same object or group for
both the real and mapped addresses.
•

Destination port—(Optional) Specify the service keyword
along with the mapped and real service objects (see Step 5).
For identity port translation, simply use the same service
object for both the real and mapped ports.

•

DNS—(Optional; for a source-only rule) The dns keyword
translates DNS replies. Be sure DNS inspection is enabled (it
is enabled by default). You cannot configure the dns keyword
if you configure a destination address. See the “DNS and
NAT” section on page 29-24 for more information.

•

Inactive—(Optional) To make this rule inactive without
having to remove the command, use the inactive keyword. To
reactivate it, reenter the whole command without the inactive
keyword.

•

Description—Optional) Provide a description up to 200
characters using the description keyword.

Configuring Dynamic PAT (Hide)
This section describes how to configure twice NAT for dynamic PAT (hide). For more information, see
the “Dynamic PAT” section on page 29-10.

Guidelines
For a PAT pool:
•

If available, the real source port number is used for the mapped port. However, if the real port is not
available, by default the mapped ports are chosen from the same range of ports as the real port
number: 0 to 511, 512 to 1023, and 1024 to 65535. Therefore, ports below 1024 have only a small
PAT pool that can be used. (8.4(3) and later, not including 8.5(1) or 8.6(1)) If you have a lot of traffic
that uses the lower port ranges, you can now specify a flat range of ports to be used instead of the
three unequal-sized tiers: either 1024 to 65535, or 1 to 65535.

•

(8.4(3) and later, not including 8.5(1) or 8.6(1)) If you use the same PAT pool object in two separate
rules, then be sure to specify the same options for each rule. For example, if one rule specifies
extended PAT and a flat range, then the other rule must also specify extended PAT and a flat range.

For extended PAT for a PAT pool (8.4(3) and later, not including 8.5(1) or 8.6(1)):

Cisco ASA 5500 Series Configuration Guide using the CLI

31-8

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

•

Many application inspections do not support extended PAT. See the “Default Settings” section on
page 42-4 in Chapter 42, “Getting Started with Application Layer Protocol Inspection,” for a
complete list of unsupported inspections.

•

If you enable extended PAT for a dynamic PAT rule, then you cannot also use an address in the PAT
pool as the PAT address in a separate static NAT-with-port-translation rule. For example, if the PAT
pool includes 10.1.1.1, then you cannot create a static NAT-with-port-translation rule using 10.1.1.1
as the PAT address.

•

If you use a PAT pool and specify an interface for fallback, you cannot specify extended PAT.

•

For VoIP deployments that use ICE or TURN, do not use extended PAT. ICE and TURN rely on the
PAT binding to be the same for all destinations.

For round robin for a PAT pool:
•

(8.4(3) and later, not including 8.5(1) or 8.6(1)) If a host has an existing connection, then subsequent
connections from that host will use the same PAT IP address if ports are available. Note: This
“stickiness” does not survive a failover. If the ASA fails over, then subsequent connections from a
host may not use the initial IP address.

•

(8.4(2), 8.5(1), and 8.6(1)) If a host has an existing connection, then subsequent connections from
that host will likely use different PAT addresses for each connection because of the round robin
allocation. In this case, you may have problems when accessing two websites that exchange
information about the host, for example an e-commerce site and a payment site. When these sites
see two different IP addresses for what is supposed to be a single host, the transaction may fail.

•

Round robin, especially when combined with extended PAT, can consume a large amount of
memory. Because NAT pools are created for every mapped protocol/IP address/port range, round
robin results in a large number of concurrent NAT pools, which use memory. Extended PAT results
in an even larger number of concurrent NAT pools.

Detailed Steps

Step 1

Command

Purpose

Network object:

Configure the real source addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

You can configure either a network object or a network object
group. For more information, see the “Configuring Objects”
section on page 13-3.

Network object group:

If you want to translate all traffic, you can skip this step and
specify the any keyword instead of creating an object or group.

object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:
hostname(config)# object network MyInsNet
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Cisco ASA 5500 Series Configuration Guide using the CLI

31-9

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Step 2

Command

Purpose

Network object:

Specify the mapped address(es) (that you want to translate to).
You can configure a single address or, for a PAT pool, multiple
addresses. Configure a network object or network object group. A
network object group can contain objects and/or inline addresses.
Alternatively, you can skip this step if you want to enter a single
IP address as an inline value for the nat command or if you want
to use the interface address by specifying the interface keyword.

object network obj_name
{host ip_address | range ip_address_1
ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
host ip_address} |
group-object grp_obj_name}

For mapped addresses used as a PAT pool, all addresses in the
object or group, including ranges, are used as PAT addresses.
Note

Example:
hostname(config)# object network PAT_POOL1
hostname(config-network-object)# range
10.5.1.80 10.7.1.80

The object or group cannot contain a subnet.

See the “Guidelines and Limitations” section on page 31-2 for
information about disallowed mapped IP addresses.
For more information about configuring a network object or
group, see the “Configuring Objects” section on page 13-3.

hostname(config)# object network PAT_POOL2
hostname(config-network-object)# range
10.9.1.1 10.10.1.1
hostname(config)# object network PAT_IP
hostname(config-network-object)# host
10.5.1.79
hostname(config-network-object)#
object-group network PAT_POOLS
hostname(config-network)# network-object
object PAT_POOL1
hostname(config-network)# network-object
object PAT_POOL2
hostname(config-network)# network-object
object PAT_IP

Step 3

(Optional)

Configure the real destination addresses.

Network object:

You can configure either a network object or a network object
group.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:
hostname(config)# object network Server1
hostname(config-network-object)# host
209.165.201.8

Cisco ASA 5500 Series Configuration Guide using the CLI

31-10

Although the main feature of twice NAT is the inclusion of the
destination IP address, the destination address is optional. If you
do specify the destination address, you can configure static
translation for that address or just use identity NAT for it. You
might want to configure twice NAT without a destination address
to take advantage of some of the other qualities of twice NAT,
including the use of network object groups for real addresses, or
manually ordering of rules. For more information, see the “Main
Differences Between Network Object NAT and Twice NAT”
section on page 29-16.

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Step 4

Command

Purpose

(Optional)

Configure the mapped destination addresses.

Network object:

The destination translation is always static. For identity NAT, you
can skip this step and simply use the same object or group for both
the real and mapped addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:

If you want to translate the destination address, you can configure
either a network object or a network object group. The static
mapping is typically one-to-one, so the real addresses have the
same quantity as the mapped addresses. You can, however, have
different quantities if desired. For more information, see the
“Static NAT” section on page 29-3.
For static interface NAT with port translation (routed mode only),
you can skip this step and specify the interface keyword instead
of a network object/group for the mapped address. For more
information, see the “Static Interface NAT with Port Translation”
section on page 29-5.

hostname(config)# object network
Server1_mapped
hostname(config-network-object)# host
10.1.1.67

Step 5

(Optional)
object service obj_name
service {tcp | udp} destination
operator port

Example:
hostname(config)# object service REAL_SVC
hostname(config-service-object)# service
tcp destination eq 80
hostname(config)# object service
MAPPED_SVC
hostname(config-service-object)# service
tcp destination eq 8080

Configure service objects for:
•

Destination real port

•

Destination mapped port

Dynamic PAT does not support additional port translation.
However, because the destination translation is always static, you
can perform port translation for the destination port. A service
object can contain both a source and destination port, but only the
destination port is used in this case. If you specify the source port,
it will be ignored. NAT only supports TCP or UDP. When
translating a port, be sure the protocols in the real and mapped
service objects are identical (both TCP or both UDP). For identity
NAT, you can use the same service object for both the real and
mapped ports. The “not equal” (neq) operator is not supported.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-11

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Step 6

Command

Purpose

nat [(real_ifc,mapped_ifc)]
[line | {after-auto [line]}]
source dynamic {real-obj | any}
{mapped_obj [interface] | [pat-pool
mapped_obj [round-robin] [extended]
[flat [include-reserve]] [interface] |
interface} [destination static {mapped_obj
| interface} real_obj]
[service mapped_dest_svc_obj
real_dest_svc_obj] [dns] [inactive]
[description desc]

Configures dynamic PAT (hide). See the following guidelines:
•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Section and Line—(Optional) By default, the NAT rule is
added to the end of section 1 of the NAT table (see the “NAT
Rule Order” section on page 29-20). If you want to add the
rule into section 3 instead (after the network object NAT
rules), then use the after-auto keyword. You can insert a rule
anywhere in the applicable section using the line argument.

•

Source addresses:

Example:
hostname(config)# nat (inside,outside)
source dynamic MyInsNet interface
destination static Server1 Server1
description Interface PAT for inside
addresses when going to server 1

– Real—Specify a network object, group, or the any

keyword (see Step 1). Use the any keyword if you want
to translate all traffic from the real interface to the
mapped interface.
– Mapped—Configure one of the following:

- Network object—Specify a network object that contains
a host address (see Step 2).
- pat-pool—Specify the pat-pool keyword and a network
object or group that contains multiple addresses (see
Step 2).
- interface—(Routed mode only) Specify the interface
keyword alone to only use interface PAT. When specified
with a PAT pool or network object, the interface
keyword enables interface PAT fallback. After the PAT IP
addresses are used up, then the IP address of the mapped
interface is used. For this option, you must configure a
specific interface for the mapped_ifc.
(continued)

Cisco ASA 5500 Series Configuration Guide using the CLI

31-12

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Command

Purpose
(continued)
For a PAT pool, you can specify one or more of the
following options:
-- Round robin—The round-robin keyword enables
round-robin address allocation for a PAT pool. Without
round robin, by default all ports for a PAT address will be
allocated before the next PAT address is used. The
round-robin method assigns an address/port from each
PAT address in the pool before returning to use the first
address again, and then the second address, and so on.
-- Extended PAT—(8.4(3) and later, not including 8.5(1)
or 8.6(1)) The extended keyword enables extended PAT.
Extended PAT uses 65535 ports per service, as opposed
to per IP address, by including the destination address
and port in the translation information. Normally, the
destination port and address are not considered when
creating PAT translations, so you are limited to 65535
ports per PAT address. For example, with extended PAT,
you can create a translation of 10.1.1.1:1027 when going
to 192.168.1.7:23 as well as a translation of
10.1.1.1:1027 when going to 192.168.1.7:80.
-- Flat range—(8.4(3) and later, not including 8.5(1) or
8.6(1)) The flat keyword enables use of the entire 1024
to 65535 port range when allocating ports. When
choosing the mapped port number for a translation, the
ASA uses the real source port number if it is available.
However, without this option, if the real port is not
available, by default the mapped ports are chosen from
the same range of ports as the real port number: 1 to 511,
512 to 1023, and 1024 to 65535. To avoid running out of
ports at the low ranges, configure this setting. To use the
entire range of 1 to 65535, also specify the
include-reserve keyword.
(continued)

Cisco ASA 5500 Series Configuration Guide using the CLI

31-13

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Command

Purpose
(continued)
•

Destination addresses (Optional):
– Mapped—Specify a network object or group, or for static

interface NAT with port translation only (routed mode),
specify the interface keyword (see Step 4). If you
specify interface, be sure to also configure the service
keyword. For this option, you must configure a specific
interface for the real_ifc. See the “Static Interface NAT
with Port Translation” section on page 29-5 for more
information.
– Real—Specify a network object or group (see Step 3).

For identity NAT, simply use the same object or group for
both the real and mapped addresses.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-14

•

Destination port—(Optional) Specify the service keyword
along with the real and mapped service objects (see Step 5).
For identity port translation, simply use the same service
object for both the real and mapped ports.

•

DNS—(Optional; for a source-only rule) The dns keyword
translates DNS replies. Be sure DNS inspection is enabled (it
is enabled by default). You cannot configure the dns keyword
if you configure a destination address. See the “DNS and
NAT” section on page 29-24 for more information.

•

Inactive—(Optional) To make this rule inactive without
having to remove the command, use the inactive keyword. To
reactivate it, reenter the whole command without the inactive
keyword.

•

Description—(Optional) Provide a description up to 200
characters using the description keyword.

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Configuring Static NAT or Static NAT-with-Port-Translation
This section describes how to configure a static NAT rule using twice NAT. For more information about
static NAT, see the “Static NAT” section on page 29-3.

Detailed Steps

Step 1

Command

Purpose

Network object:

Configure the real source addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

You can configure either a network object or a network object
group. For more information, see the “Configuring Objects”
section on page 13-3.

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:
hostname(config)# object network MyInsNet
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Step 2

Network object:

Configure the mapped source addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

You can configure either a network object or a network object
group. For static NAT, the mapping is typically one-to-one, so the
real addresses have the same quantity as the mapped addresses.
You can, however, have different quantities if desired. For more
information, see the “Static NAT” section on page 29-3.

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:

For static interface NAT with port translation (routed mode only),
you can skip this step and specify the interface keyword instead
of a network object/group for the mapped address. For more
information, see the “Static Interface NAT with Port Translation”
section on page 29-5.
See the “Guidelines and Limitations” section on page 31-2 for
information about disallowed mapped IP addresses.

hostname(config)# object network
MyInsNet_mapped
hostname(config-network-object)# subnet
192.168.1.0 255.255.255.0

Cisco ASA 5500 Series Configuration Guide using the CLI

31-15

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Step 3

Command

Purpose

(Optional)

Configure the real destination addresses.

Network object:

You can configure either a network object or a network object
group.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Although the main feature of twice NAT is the inclusion of the
destination IP address, the destination address is optional. If you
do specify the destination address, you can configure static
translation for that address or just use identity NAT for it. You
might want to configure twice NAT without a destination address
to take advantage of some of the other qualities of twice NAT,
including the use of network object groups for real addresses, or
manually ordering of rules. For more information, see the “Main
Differences Between Network Object NAT and Twice NAT”
section on page 29-16.

Example:
hostname(config)# object network Server1
hostname(config-network-object)# host
209.165.201.8

Step 4

(Optional)

Configure the mapped destination addresses.

Network object:

The destination translation is always static. For identity NAT, you
can skip this step and simply use the same object or group for both
the real and mapped addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:
hostname(config)# object network
Server1_mapped
hostname(config-network-object)# host
10.1.1.67

Cisco ASA 5500 Series Configuration Guide using the CLI

31-16

If you want to translate the destination address, you can configure
either a network object or a network object group. The static
mapping is typically one-to-one, so the real addresses have the
same quantity as the mapped addresses. You can, however, have
different quantities if desired. For more information, see the
“Static NAT” section on page 29-3.
For static interface NAT with port translation (routed mode only),
you can skip this step and specify the interface keyword instead
of a network object/group for the mapped address. For more
information, see the “Static Interface NAT with Port Translation”
section on page 29-5.

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Step 5

Command

Purpose

(Optional)

Configure service objects for:

object service obj_name
service {tcp | udp} [source operator
port] [destination operator port]

Example:
hostname(config)# object service
REAL_SRC_SVC
hostname(config-service-object)# service
tcp source eq 80
hostname(config)# object service
MAPPED_SRC_SVC
hostname(config-service-object)# service
tcp source eq 8080

•

Source or destination real port

•

Source or destination mapped port

A service object can contain both a source and destination port;
however, you should specify either the source or the destination
port for both service objects. You should only specify both the
source and destination ports if your application uses a fixed
source port (such as some DNS servers); but fixed source ports are
rare. NAT only supports TCP or UDP. When translating a port, be
sure the protocols in the real and mapped service objects are
identical (both TCP or both UDP). For identity NAT, you can use
the same service object for both the real and mapped ports. The
“not equal” (neq) operator is not supported.
For example, if you want to translate the port for the source host,
then configure the source service.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-17

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Step 6

Command

Purpose

nat [(real_ifc,mapped_ifc)]
[line | {after-object [line]}]
source static real_ob
[mapped_obj | interface]
[destination static {mapped_obj |
interface} real_obj]
[service real_src_mapped_dest_svc_obj
mapped_src_real_dest_svc_obj] [dns]
[no-proxy-arp] [inactive]
[description desc]

Configures static NAT. See the following guidelines:
•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Section and Line—(Optional) By default, the NAT rule is
added to the end of section 1 of the NAT table. See the “NAT
Rule Order” section on page 29-20 for more information
about sections. If you want to add the rule into section 3
instead (after the network object NAT rules), then use the
after-auto keyword. You can insert a rule anywhere in the
applicable section using the line argument.

•

Source addresses:

Example:
hostname(config)# nat (inside,dmz) source
static MyInsNet MyInsNet_mapped
destination static Server1 Server1 service
REAL_SRC_SVC MAPPED_SRC_SVC

– Real—Specify a network object or group (see Step 1).
– Mapped—Specify a different network object or group

(see Step 2). For static interface NAT with port
translation only, you can specify the interface keyword
(routed mode only). If you specify interface, be sure to
also configure the service keyword (in this case, the
service objects should include only the source port). For
this option, you must configure a specific interface for
the mapped_ifc. See the “Static Interface NAT with Port
Translation” section on page 29-5 for more information.
•

Destination addresses (Optional):
– Mapped—Specify a network object or group, or for static

interface NAT with port translation only, specify the
interface keyword (see Step 4). If you specify interface,
be sure to also configure the service keyword (in this
case, the service objects should include only the
destination port). For this option, you must configure a
specific interface for the real_ifc.
– Real—Specify a network object or group (see Step 3).

For identity NAT, simply use the same object or group for
both the real and mapped addresses.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-18

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Command

Purpose
(Continued)
•

Ports—(Optional) Specify the service keyword along with
the real and mapped service objects (see Step 5). For source
port translation, the objects must specify the source service.
The order of the service objects in the command for source
port translation is service real_obj mapped_obj. For
destination port translation, the objects must specify the
destination service. The order of the service objects for
destination port translation is service mapped_obj real_obj.
In the rare case where you specify both the source and
destination ports in the object, the first service object contains
the real source port/mapped destination port; the second
service object contains the mapped source port/real
destination port. For identity port translation, simply use the
same service object for both the real and mapped ports
(source and/or destination ports, depending on your
configuration).

•

DNS—(Optional; for a source-only rule) The dns keyword
translates DNS replies. Be sure DNS inspection is enabled (it
is enabled by default). You cannot configure the dns keyword
if you configure a destination address. See the “DNS and
NAT” section on page 29-24 for more information.

•

No Proxy ARP—(Optional) Specify no-proxy-arp to disable
proxy ARP for incoming packets to the mapped IP addresses.
See the “Mapped Addresses and Routing” section on
page 29-22 for more information.

•

Inactive—(Optional) To make this rule inactive without
having to remove the command, use the inactive keyword. To
reactivate it, reenter the whole command without the inactive
keyword.

•

Description—(Optional) Provide a description up to 200
characters using the description keyword.

Examples
The following example shows the use of static interface NAT with port translation. Hosts on the outside
access an FTP server on the inside by connecting to the outside interface IP address with destination port
65000 through 65004. The traffic is untranslated to the internal FTP server at 192.168.10.100:6500
through :65004. Note that you specify the source port range in the service object (and not the destination
port) because you want to translate the source address and port as identified in the command; the
destination port is “any.” Because static NAT is bidirectional, “source” and “destination” refers primarily
to the command keywords; the actual source and destination address and port in a packet depends on

Cisco ASA 5500 Series Configuration Guide using the CLI

31-19

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

which host sent the packet. In this example, connections are originated from outside to inside, so the
“source” address and port of the FTP server is actually the destination address and port in the originating
packet.
hostname(config)# object service FTP_PASV_PORT_RANGE
hostname(config-service-object)# service tcp source range 65000 65004
hostname(config)# object network HOST_FTP_SERVER
hostname(config-network-object)# host 192.168.10.100
hostname(config)# nat (inside,outside) source static HOST_FTP_SERVER interface service
FTP_PASV_PORT_RANGE FTP_PASV_PORT_RANGE

Configuring Identity NAT
This section describes how to configure an identity NAT rule using twice NAT. For more information
about identity NAT, see the “Identity NAT” section on page 29-11.

Detailed Steps

Step 1

Command

Purpose

Network object:

Configure the real source addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

You can configure either a network object or a network object
group. For more information, see the “Configuring Objects”
section on page 13-3.

Network object group:

These are the addresses on which you want to perform identity
NAT. If you want to perform identity NAT for all addresses, you
can skip this step and instead use the keywords any any.

object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:
hostname(config)# object network MyInsNet
hostname(config-network-object)# subnet
10.1.1.0 255.255.255.0

Cisco ASA 5500 Series Configuration Guide using the CLI

31-20

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Step 2

Command

Purpose

(Optional)

Configure the real destination addresses.

Network object:

You can configure either a network object or a network object
group.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Although the main feature of twice NAT is the inclusion of the
destination IP address, the destination address is optional. If you
do specify the destination address, you can configure static
translation for that address or just use identity NAT for it. You
might want to configure twice NAT without a destination address
to take advantage of some of the other qualities of twice NAT,
including the use of network object groups for real addresses, or
manually ordering of rules. For more information, see the “Main
Differences Between Network Object NAT and Twice NAT”
section on page 29-16.

Example:
hostname(config)# object network Server1
hostname(config-network-object)# host
209.165.201.8

Step 3

(Optional)

Configure the mapped destination addresses.

Network object:

The destination translation is always static. For identity NAT, you
can skip this step and simply use the same object or group for both
the real and mapped addresses.

object network obj_name
{host ip_address | subnet
subnet_address netmask | range
ip_address_1 ip_address_2}

Network object group:
object-group network grp_name
{network-object {object net_obj_name |
subnet_address netmask |
host ip_address} |
group-object grp_obj_name}

Example:

If you want to translate the destination address, you can configure
either a network object or a network object group. The static
mapping is typically one-to-one, so the real addresses have the
same quantity as the mapped addresses. You can, however, have
different quantities if desired. For more information, see the
“Static NAT” section on page 29-3.
For static interface NAT with port translation (routed mode only),
you can skip this step and specify the interface keyword instead
of a network object/group for the mapped address. For more
information, see the “Static Interface NAT with Port Translation”
section on page 29-5.

hostname(config)# object network
Server1_mapped
hostname(config-network-object)# host
10.1.1.67

Cisco ASA 5500 Series Configuration Guide using the CLI

31-21

Chapter 31

Configuring Twice NAT

Configuring Twice NAT

Step 4

Command

Purpose

(Optional)

Configure service objects for:

object service obj_name
service {tcp | udp} [source operator
port] [destination operator port]

Example:
hostname(config)# object service
REAL_SRC_SVC
hostname(config-service-object)# service
tcp source eq 80
hostname(config)# object service
MAPPED_SRC_SVC
hostname(config-service-object)# service
tcp source eq 8080

•

Source or destination real port

•

Source or destination mapped port

A service object can contain both a source and destination port;
however, you should specify either the source or the destination
port for both service objects. You should only specify both the
source and destination ports if your application uses a fixed
source port (such as some DNS servers); but fixed source ports are
rare. NAT only supports TCP or UDP. When translating a port, be
sure the protocols in the real and mapped service objects are
identical (both TCP or both UDP). For identity NAT, you can use
the same service object for both the real and mapped ports. The
“not equal” (neq) operator is not supported.
For example, if you want to translate the port for the source host,
then configure the source service.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-22

Chapter 31

Configuring Twice NAT
Configuring Twice NAT

Step 5

Command

Purpose

nat [(real_ifc,mapped_ifc)]
[line | {after-object [line]}]
source static {nw_obj nw_obj | any any}
[destination static {mapped_obj |
interface} real_obj]
[service real_src_mapped_dest_svc_obj
mapped_src_real_dest_svc_obj]
[no-proxy-arp] [route-lookup] [inactive]
[description desc]

Configures identity NAT. See the following guidelines:
•

Interfaces—(Required for transparent mode) Specify the real
and mapped interfaces. Be sure to include the parentheses in
your command. In routed mode, if you do not specify the real
and mapped interfaces, all interfaces are used; you can also
specify the keyword any for one or both of the interfaces.

•

Section and Line—(Optional) By default, the NAT rule is
added to the end of section 1 of the NAT table. See the “NAT
Rule Order” section on page 29-20 for more information
about sections. If you want to add the rule into section 3
instead (after the network object NAT rules), then use the
after-auto keyword. You can insert a rule anywhere in the
applicable section using the line argument.

•

Source addresses—Specify a network object, group, or the
any keyword for both the real and mapped addresses (see
Step 1).

•

Destination addresses (Optional):

Example:
hostname(config)# nat (inside,outside)
source static MyInsNet MyInsNet
destination static Server1 Server1

– Mapped—Specify a network object or group, or for static

interface NAT with port translation only, specify the
interface keyword (routed mode only) (see Step 3). If
you specify interface, be sure to also configure the
service keyword (in this case, the service objects should
include only the destination port). For this option, you
must configure a specific interface for the real_ifc. See
the “Static Interface NAT with Port Translation” section
on page 29-5 for more information.
– Real—Specify a network object or group (see Step 2).

For identity NAT, simply use the same object or group for
both the real and mapped addresses.
•

Port—(Optional) Specify the service keyword along with the
real and mapped service objects (see Step 4). For source port
translation, the objects must specify the source service. The
order of the service objects in the command for source port
translation is service real_obj mapped_obj. For destination
port translation, the objects must specify the destination
service. The order of the service objects for destination port
translation is service mapped_obj real_obj. In the rare case
where you specify both the source and destination ports in the
object, the first service object contains the real source
port/mapped destination port; the second service object
contains the mapped source port/real destination port. For
identity port translation, simply use the same service object
for both the real and mapped ports (source and/or destination
ports, depending on your configuration).

Cisco ASA 5500 Series Configuration Guide using the CLI

31-23

Chapter 31

Configuring Twice NAT

Monitoring Twice NAT

Command

Purpose
(Continued)
•

No Proxy ARP—(Optional) Specify no-proxy-arp to disable
proxy ARP for incoming packets to the mapped IP addresses.
See the “Mapped Addresses and Routing” section on
page 29-22 for more information.

•

Route lookup—(Optional; routed mode only; interface(s)
specified) Specify route-lookup to determine the egress
interface using a route lookup instead of using the interface
specified in the NAT command. See the “Determining the
Egress Interface” section on page 29-24 for more
information.

•

Inactive—(Optional) To make this rule inactive without
having to remove the command, use the inactive keyword. To
reactivate it, reenter the whole command without the inactive
keyword.

•

Description—(Optional) Provide a description up to 200
characters using the description keyword.

Monitoring Twice NAT
To monitor twice NAT, enter one of the following commands:
Command

Purpose

show nat

Shows NAT statistics, including hits for each NAT rule.

show nat pool

Shows NAT pool statistics, including the addresses and ports allocated,
and how many times they were allocated.

show xlate

Shows current NAT session information.

Configuration Examples for Twice NAT
This section includes the following configuration examples:
•

Different Translation Depending on the Destination (Dynamic PAT), page 31-24

•

Different Translation Depending on the Destination Address and Port (Dynamic PAT), page 31-26

Different Translation Depending on the Destination (Dynamic PAT)
Figure 31-1 shows a host on the 10.1.2.0/24 network accessing two different servers. When the host
accesses the server at 209.165.201.11, the real address is translated to 209.165.202.129:port. When the
host accesses the server at 209.165.200.225, the real address is translated to 209.165.202.130:port.

Cisco ASA 5500 Series Configuration Guide using the CLI

31-24

Configuring Twice NAT
Configuration Examples for Twice NAT

Figure 31-1

Twice NAT with Different Destination Addresses

Server 1
209.165.201.11

Server 2
209.165.200.225

209.165.201.0/27

209.165.200.224/27
DMZ

Translation
10.1.2.27
209.165.202.129

Translation
10.1.2.27
209.165.202.130

Inside
10.1.2.0/24
Packet
Dest. Address:
209.165.201.11

Step 1

10.1.2.27

Packet
Dest. Address:
209.165.200.225

130039

Chapter 31

Add a network object for the inside network:
hostname(config)# object network myInsideNetwork
hostname(config-network-object)# subnet 10.1.2.0 255.255.255.0

Step 2

Add a network object for the DMZ network 1:
hostname(config)# object network DMZnetwork1
hostname(config-network-object)# subnet 209.165.201.0 255.255.255.224

Step 3

Add a network object for the PAT address:
hostname(config)# object network PATaddress1
hostname(config-network-object)# host 209.165.202.129

Step 4

Configure the first twice NAT rule:
hostname(config)# nat (inside,dmz) source dynamic myInsideNetwork PATaddress1 destination
static DMZnetwork1 DMZnetwork1

Because you do not want to translate the destination address, you need to configure identity NAT for it
by specifying the same address for the real and mapped destination addresses.
By default, the NAT rule is added to the end of section 1 of the NAT table, See the “Configuring Dynamic
PAT (Hide)” section on page 31-8 for more information about specifying the section and line number for
the NAT rule.
Step 5

Add a network object for the DMZ network 2:
hostname(config)# object network DMZnetwork2
hostname(config-network-object)# subnet 209.165.200.224 255.255.255.224

Step 6

Add a network object for the PAT address:
hostname(config)# object network PATaddress2

Cisco ASA 5500 Series Configuration Guide using the CLI

31-25

Chapter 31

Configuring Twice NAT

Configuration Examples for Twice NAT

hostname(config-network-object)# host 209.165.202.130

Step 7

Configure the second twice NAT rule:
hostname(config)# nat (inside,dmz) source dynamic myInsideNetwork PATaddress2 destination
static DMZnetwork2 DMZnetwork2

Different Translation Depending on the Destination Address and Port (Dynamic
PAT)
Figure 31-2 shows the use of source and destination ports. The host on the 10.1.2.0/24 network accesses
a single host for both web services and Telnet services. When the host accesses the server for Telnet
services, the real address is translated to 209.165.202.129:port. When the host accesses the same server
for web services, the real address is translated to 209.165.202.130:port.
Figure 31-2

Twice NAT with Different Destination Ports

Web and Telnet server:
209.165.201.11

Internet

Translation
10.1.2.27:80
209.165.202.129

Translation
10.1.2.27:23
209.165.202.130

Inside

Web Packet
Dest. Address:
209.165.201.11:80

Step 1

10.1.2.27

Telnet Packet
Dest. Address:
209.165.201.11:23

Add a network object for the inside network:
hostname(config)# object network myInsideNetwork
hostname(config-network-object)# subnet 10.1.2.0 255.255.255.0

Step 2

Add a network object for the Telnet/Web server:
hostname(config)# object network TelnetWebServer
hostname(config-network-object)# host 209.165.201.11

Step 3

Add a network object for the PAT address when using Telnet:
hostname(config)# object network PATaddress1

Cisco ASA 5500 Series Configuration Guide using the CLI

31-26

130040

10.1.2.0/24

Chapter 31

Configuring Twice NAT
Configuration Examples for Twice NAT

hostname(config-network-object)# host 209.165.202.129

Step 4

Add a service object for Telnet:
hostname(config)# object service TelnetObj
hostname(config-network-object)# service tcp destination eq telnet

Step 5

Configure the first twice NAT rule:
hostname(config)# nat (inside,outside) source dynamic myInsideNetwork PATaddress1
destination static TelnetWebServer TelnetWebServer service TelnetObj TelnetObj

Because you do not want to translate the destination address or port, you need to configure identity NAT
for them by specifying the same address for the real and mapped destination addresses, and the same
port for the real and mapped service.
By default, the NAT rule is added to the end of section 1 of the NAT table, See the “Configuring Dynamic
PAT (Hide)” section on page 31-8 for more information about specifying the section and line number for
the NAT rule.
Step 6

Add a network object for the PAT address when using HTTP:
hostname(config)# object network PATaddress2
hostname(config-network-object)# host 209.165.202.130

Step 7

Add a service object for HTTP:
hostname(config)# object service HTTPObj
hostname(config-network-object)# service tcp destination eq http

Step 8

Configure the second twice NAT rule:
hostname(config)# nat (inside,outside) source dynamic myInsideNetwork PATaddress2
destination static TelnetWebServer TelnetWebServer service HTTPObj HTTPObj

Cisco ASA 5500 Series Configuration Guide using the CLI

31-27

Chapter 31

Configuring Twice NAT

Feature History for Twice NAT

Feature History for Twice NAT
Table 31-1 lists each feature change and the platform release in which it was implemented.
Table 31-1

Feature History for Twice NAT

Feature Name

Platform
Releases

Twice NAT

8.3(1)

Feature Information
Twice NAT lets you identify both the source and destination
address in a single rule.
We modified or introduced the following commands: nat,
show nat, show xlate, show nat pool.

Identity NAT configurable proxy ARP and route 8.4(2)
lookup

In earlier releases for identity NAT, proxy ARP was
disabled, and a route lookup was always used to determine
the egress interface. You could not configure these settings.
In 8.4(2) and later, the default behavior for identity NAT
was changed to match the behavior of other static NAT
configurations: proxy ARP is enabled, and the NAT
configuration determines the egress interface (if specified)
by default. You can leave these settings as is, or you can
enable or disable them discretely. Note that you can now
also disable proxy ARP for regular static NAT.
For pre-8.3 configurations, the migration of NAT exempt
rules (the nat 0 access-list command) to 8.4(2) and later
now includes the following keywords to disable proxy ARP
and to use a route lookup: no-proxy-arp and route-lookup.
The unidirectional keyword that was used for migrating to
8.3(2) and 8.4(1) is no longer used for migration. When
upgrading to 8.4(2) from 8.3(1), 8.3(2), and 8.4(1), all
identity NAT configurations will now include the
no-proxy-arp and route-lookup keywords, to maintain
existing functionality. The unidirectional keyword is
removed.
We modified the following commands: nat source static
[no-proxy-arp] [route-lookup].

PAT pool and round robin address assignment

8.4(2)

You can now specify a pool of PAT addresses instead of a
single address. You can also optionally enable round-robin
assignment of PAT addresses instead of first using all ports
on a PAT address before using the next address in the pool.
These features help prevent a large number of connections
from a single PAT address from appearing to be part of a
DoS attack and makes configuration of large numbers of
PAT addresses easy.
We modified the following commands: nat source dynamic
[pat-pool mapped_object [round-robin]].

Cisco ASA 5500 Series Configuration Guide using the CLI

31-28

Chapter 31

Configuring Twice NAT
Feature History for Twice NAT

Table 31-1

Feature History for Twice NAT (continued)

Feature Name

Platform
Releases

Round robin PAT pool allocation uses the same 8.4(3)
IP address for existing hosts

Feature Information
When using a PAT pool with round robin allocation, if a host
has an existing connection, then subsequent connections
from that host will use the same PAT IP address if ports are
available.
We did not modify any commands.
This feature is not available in 8.5(1) or 8.6(1).

Flat range of PAT ports for a PAT pool

8.4(3)

If available, the real source port number is used for the
mapped port. However, if the real port is not available, by
default the mapped ports are chosen from the same range of
ports as the real port number: 0 to 511, 512 to 1023, and
1024 to 65535. Therefore, ports below 1024 have only a
small PAT pool.
If you have a lot of traffic that uses the lower port ranges,
when using a PAT pool, you can now specify a flat range of
ports to be used instead of the three unequal-sized tiers:
either 1024 to 65535, or 1 to 65535.
We modified the following commands: nat source dynamic
[pat-pool mapped_object [flat [include-reserve]]].
This feature is not available in 8.5(1) or 8.6(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

31-29

Chapter 31

Configuring Twice NAT

Feature History for Twice NAT

Table 31-1

Feature History for Twice NAT (continued)

Feature Name

Platform
Releases

Extended PAT for a PAT pool

8.4(3)

Feature Information
Each PAT IP address allows up to 65535 ports. If 65535
ports do not provide enough translations, you can now
enable extended PAT for a PAT pool. Extended PAT uses
65535 ports per service, as opposed to per IP address, by
including the destination address and port in the translation
information.
We modified the following commands: nat source dynamic
[pat-pool mapped_object [extended]].
This feature is not available in 8.5(1) or 8.6(1).

Automatic NAT rules to translate a VPN peer’s 8.4(3)
local IP address back to the peer’s real IP
address

In rare situations, you might want to use a VPN peer’s real
IP address on the inside network instead of an assigned local
IP address. Normally with VPN, the peer is given an
assigned local IP address to access the inside network.
However, you might want to translate the local IP address
back to the peer’s real public IP address if, for example,
your inside servers and network security is based on the
peer’s real IP address.
You can enable this feature on one interface per tunnel
group. Object NAT rules are dynamically added and deleted
when the VPN session is established or disconnected. You
can view the rules using the show nat command.
Because of routing issues, we do not recommend
using this feature unless you know you need this
feature; contact Cisco TAC to confirm feature
compatibility with your network. See the following
limitations:

Note

•

Only supports Cisco IPsec and AnyConnect Client.

•

Return traffic to the public IP addresses must be
routed back to the ASA so the NAT policy and VPN
policy can be applied.

•

Does not support load-balancing (because of
routing issues).

•

Does not support roaming (public IP changing).

We introduced the following command:
nat-assigned-to-public-ip interface (tunnel-group
general-attributes configuration mode).

Cisco ASA 5500 Series Configuration Guide using the CLI

31-30

PA R T

8

Configuring Service Policies Using the
Modular Policy Framework

CH A P T E R

32

Configuring a Service Policy Using the Modular
Policy Framework
Service policies using Modular Policy Framework provide a consistent and flexible way to configure
ASA features. For example, you can use a service policy to create a timeout configuration that is specific
to a particular TCP application, as opposed to one that applies to all TCP applications. A service policy
consists of multiple actionsapplied to an interface or applied globally.
This chapter includes the following sections:
•

Information About Service Policies, page 32-1

•

Licensing Requirements for Service Policies, page 32-6

•

Guidelines and Limitations, page 32-6

•

Default Settings, page 32-7

•

Task Flows for Configuring Service Policies, page 32-9

•

Identifying Traffic (Layer 3/4 Class Maps), page 32-12

•

Defining Actions (Layer 3/4 Policy Map), page 32-15

•

Applying Actions to an Interface (Service Policy), page 32-17

•

Monitoring Modular Policy Framework, page 32-18

•

Configuration Examples for Modular Policy Framework, page 32-18

•

Feature History for Service Policies, page 32-21

Information About Service Policies
This section describes how service policies work and includes the following topics:
•

Supported Features for Through Traffic, page 32-2

•

Supported Features for Management Traffic, page 32-2

•

Feature Directionality, page 32-2

•

Feature Matching Within a Service Policy, page 32-3

•

Order in Which Multiple Feature Actions are Applied, page 32-4

•

Incompatibility of Certain Feature Actions, page 32-5

•

Feature Matching for Multiple Service Policies, page 32-6

Cisco ASA 5500 Series Configuration Guide using the CLI

32-1

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Information About Service Policies

Supported Features for Through Traffic
Table 32-1 lists the features supported by Modular Policy Framework.
Table 32-1

Modular Policy Framework

Feature
Application inspection (multiple types)

See:
•

Chapter 42, “Getting Started with Application Layer
Protocol Inspection.”

•

Chapter 43, “Configuring Inspection of Basic Internet
Protocols.”

•

Chapter 44, “Configuring Inspection for Voice and
Video Protocols.”

•

Chapter 45, “Configuring Inspection of Database and
Directory Protocols.”

•

Chapter 46, “Configuring Inspection for Management
Application Protocols.”

ASA CSC

Chapter 60, “Configuring the ASA CSC Module.”

ASA IPS

Chapter 58, “Configuring the ASA IPS Module.”

ASA CX

Chapter 59, “Configuring the ASA CX Module.”

NetFlow Secure Event Logging filtering Chapter 78, “Configuring NetFlow Secure Event Logging
(NSEL).”
QoS input and output policing

Chapter 54, “Configuring QoS.”

QoS standard priority queue

Chapter 54, “Configuring QoS.”

QoS traffic shaping, hierarchical priority Chapter 54, “Configuring QoS.”
queue
TCP and UDP connection limits and
timeouts, and TCP sequence number
randomization

Chapter 53, “Configuring Connection Settings.”

TCP normalization

Chapter 53, “Configuring Connection Settings.”

TCP state bypass

Chapter 53, “Configuring Connection Settings.”

Supported Features for Management Traffic
Modular Policy Framework supports the following features for management traffic:
•

Application inspection for RADIUS accounting traffic—See Chapter 46, “Configuring Inspection
for Management Application Protocols.”

•

Connection limits—See Chapter 53, “Configuring Connection Settings.”

Feature Directionality
Actions are applied to traffic bidirectionally or unidirectionally depending on the feature. For features
that are applied bidirectionally, 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-2

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Information About Service Policies

Note

When you use a global policy, all features are unidirectional; features that are normally bidirectional
when applied to a single interface only apply to the ingress of each interface when applied globally.
Because the policy is applied to all interfaces, the policy will be applied in both directions so
bidirectionality in this case is redundant.
For features that are applied unidirectionally, for example QoS priority queue, only traffic that enters (or
exits, depending on the feature) the interface to which you apply the policy map is affected. See
Table 32-2 for the directionality of each feature.
Table 32-2

Feature Directionality

Feature

Single Interface Direction Global Direction

Application inspection (multiple types)

Bidirectional

Ingress

ASA CSC

Bidirectional

Ingress

ASA CX

Bidirectional

Ingress

ASA CX authentication proxy

Ingress

Ingress

ASA IPS

Bidirectional

Ingress

NetFlow Secure Event Logging filtering

N/A

Ingress

QoS input policing

Ingress

Ingress

QoS output policing

Egress

Egress

QoS standard priority queue

Egress

Egress

QoS traffic shaping, hierarchical priority
queue

Egress

Egress

TCP and UDP connection limits and timeouts, Bidirectional
and TCP sequence number randomization

Ingress

TCP normalization

Bidirectional

Ingress

TCP state bypass

Bidirectional

Ingress

Feature Matching Within a Service Policy
See the following information for how a packet matches class maps in a policy map for a given interface:
1.

A packet can match only one class map in the policy map for each feature type.

2.

When the packet matches a class map for a feature type, the ASA does not attempt to match it to any
subsequent class maps for that feature type.

3.

If the packet matches a subsequent class map for a different feature type, however, then the ASA
also applies the actions for the subsequent class map, if supported. See the “Incompatibility of
Certain Feature Actions” section on page 32-5 for more information about unsupported
combinations.

Note

Application inspection includes multiple inspection types, and most are mutually exclusive.
For inspections that can be combined, each inspection is considered to be a separate feature.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-3

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Information About Service Policies

For example, if a packet matches a class map for connection limits, and also matches a class map for an
application inspection, then both actions are applied.
If a packet matches a class map for HTTP inspection, but also matches another class map that includes
HTTP inspection, then the second class map actions are not applied.
If a packet matches a class map for HTTP inspection, but also matches another class map that includes
FTP inspection, then the second class map actions are not applied because HTTP and FTP inspections
cannpt be combined.
If a packet matches a class map for HTTP inspection, but also matches another class map that includes
IPv6 inspection, then both actions are applied because the IPv6 inspection can be combined with any
other type of inspection.

Order in Which Multiple Feature Actions are Applied
The order in which different types of actions in a policy map are performed is independent of the order
in which the actions appear in the policy map.

Note

NetFlow Secure Event Logging filtering is order-independent.
Actions are performed in the following order:
1.

QoS input policing

2.

TCP normalization, TCP and UDP connection limits and timeouts, TCP sequence number
randomization, and TCP state bypass.

Note

When a the ASA performs a proxy service (such as AAA or CSC) or it modifies the TCP payload
(such as FTP inspection), the TCP normalizer acts in dual mode, where it is applied before and
after the proxy or payload modifying service.

3.

ASA CSC

4.

Application inspections that can be combined with other inspections:
a. IPv6
b. IP options
c. WAAS

5.

Application inspections that cannot be combined with other inspections. The remaining application
inspections cannot be combined with other inspections. See the “Incompatibility of Certain Feature
Actions” section on page 32-5 for more information.

6.

ASA IPS

7.

ASA CX

8.

QoS output policing

9.

QoS standard priority queue

10. QoS traffic shaping, hierarchical priority queue

Cisco ASA 5500 Series Configuration Guide using the CLI

32-4

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Information About Service Policies

Incompatibility of Certain Feature Actions
Some features are not compatible with each other for the same traffic. The following list may not include
all incompatibilities; for information about compatibility of each feature, see the chapter or section for
your feature:

Note

•

You cannot configure QoS priority queueing and QoS policing for the same set of traffic.

•

Most inspections should not be combined with another inspection, so the ASA only applies one
inspection if you configure multiple inspections for the same traffic. The only exceptions are listed
in the “Order in Which Multiple Feature Actions are Applied” section on page 32-4.

•

You cannot configure traffic to be sent to multiple modules, such as the ASA CX and ASA IPS.

•

HTTP inspection is not compatible with the ASA CX.

The match default-inspection-traffic command, which is used in the default global policy, is a special
CLI shortcut to match the default ports for all inspections. When used in a policy map, this class map
ensures that the correct inspection is applied to each packet, based on the destination port of the traffic.
For example, when UDP traffic for port 69 reaches the ASA, then the ASA applies the TFTP inspection;
when TCP traffic for port 21 arrives, then the ASA applies the FTP inspection. So in this case only, you
can configure multiple inspections for the same class map. Normally, the ASA does not use the port
number to determine which inspection to apply, thus giving you the flexibility to apply inspections to
non-standard ports, for example.
An example of a misconfiguration is if you configure multiple inspections in the same policy map and
do not use the default-inspection-traffic shortcut. In Example 32-1, traffic destined to port 21 is
mistakenly configured for both FTP and HTTP inspection. In Example 32-2, traffic destined to port 80
is mistakenly configured for both FTP and HTTP inspection. In both cases of misconfiguration
examples, only the FTP inspection is applied, because FTP comes before HTTP in the order of
inspections applied.
Example 32-1 Misconfiguration for FTP packets: HTTP Inspection Also Configured
class-map ftp
match port tcp eq 21
class-map http
match port tcp eq 21
policy-map test
class ftp
inspect ftp
class http
inspect http

[it should be 80]

Example 32-2 Misconfiguration for HTTP packets: FTP Inspection Also Configured
class-map ftp
match port tcp eq 80
class-map http
match port tcp eq 80
policy-map test
class http
inspect http
class ftp
inspect ftp

[it should be 21]

Cisco ASA 5500 Series Configuration Guide using the CLI

32-5

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Licensing Requirements for Service Policies

Feature Matching for Multiple Service Policies
For TCP and UDP traffic (and ICMP when you enable stateful ICMP inspection), service policies
operate on traffic flows, and not just individual packets. If traffic is part of an existing connection that
matches a feature in a policy on one interface, that traffic flow cannot also match the same feature in a
policy on another interface; only the first policy is used.
For example, if HTTP traffic matches a policy on the inside interface to inspect HTTP traffic, and you
have a separate policy on the outside interface for HTTP inspection, then that traffic is not also inspected
on the egress of the outside interface. Similarly, the return traffic for that connection will not be
inspected by the ingress policy of the outside interface, nor by the egress policy of the inside interface.
For traffic that is not treated as a flow, for example ICMP when you do not enable stateful ICMP
inspection, returning traffic can match a different policy map on the returning interface. For example, if
you configure IPS on the inside and outside interfaces, but the inside policy uses virtual sensor 1 while
the outside policy uses virtual sensor 2, then a non-stateful Ping will match virtual sensor 1 outbound,
but will match virtual sensor 2 inbound.

Licensing Requirements for Service Policies
Model

License Requirement

All models

Base License.
Specific features may have separate license requirements. See the feature chapter for more information.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6 for the following features:
•

Application inspection for FTP, HTTP, ICMP, SIP, SMTP and IPsec-pass-thru, and IPv6.

•

ASA IPS

•

ASA CX

•

NetFlow Secure Event Logging filtering

•

TCP and UDP connection limits and timeouts, TCP sequence number randomization

•

TCP normalization

•

TCP state bypass

Cisco ASA 5500 Series Configuration Guide using the CLI

32-6

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Default Settings

Class Map Guidelines

The maximum number of class mapsof all types is 255 in single mode or per context in multiple mode.
Class maps include the following types:
•

Layer 3/4 class maps (for through traffic and management traffic).

•

Inspection class maps

•

Regular expression class maps

•

match commands used directly underneath an inspection policy map

This limit also includes default class maps of all types, limiting user-configured class mapsto
approximately 235. See the “Default Class Maps” section on page 32-8.
Policy Map Guidelines

See the following guidelines for using policy maps:
•

You can only assign one policy map per interface. (However you can create up to 64 policy maps in
the configuration.)

•

You can apply the same policy map to multiple interfaces.

•

You can identify up to 63 Layer 3/4 class maps in a Layer 3/4 policy map.

•

For each class map, you can assign multiple actions from one or more feature types, if supported.
See the “Incompatibility of Certain Feature Actions” section on page 32-5.

Service Policy Guidelines
•

Interface service policies take precedence over the global service policy for a given feature. For
example, if you have a global policy with FTP inspection, and an interface policy with TCP
normalization, then both FTP inspection and TCP normalization are applied to the interface.
However, if you have a global policy with FTP inspection, and an interface policy with FTP
inspection, then only the interface policy FTP inspection is applied to that interface.

•

You can only apply one global policy. For example, you cannot create a global policy that includes
feature set 1, and a separate global policy that includes feature set 2. All features must be included
in a single policy.

Default Settings
The following topics describe the default settings for Modular Policy Framework:
•

Default Configuration, page 32-7

•

Default Class Maps, page 32-8

Default Configuration
By default, the configuration includes a policy that matches all default application inspection traffic and
applies certain inspections to the traffic on all interfaces (a global policy). Not all inspections are enabled
by default. You can only apply one global policy, so if you want to alter the global policy, you need to
either edit the default policy or disable it and apply a new one. (An interface policy overrides the global
policy for a particular feature.)
The default policy includes the following application inspections:

Cisco ASA 5500 Series Configuration Guide using the CLI

32-7

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Default Settings

•

DNS inspection for the maximum message length of 512 bytes

•

FTP

•

H323 (H225)

•

H323 (RAS)

•

RSH

•

RTSP

•

ESMTP

•

SQLnet

•

Skinny (SCCP)

•

SunRPC

•

XDMCP

•

SIP

•

NetBios

•

TFTP

•

IP Options

The default policy configuration includes the following commands:
class-map inspection_default
match default-inspection-traffic
policy-map type inspect dns preset_dns_map
parameters
message-length maximum 512
policy-map global_policy
class inspection_default
inspect dns preset_dns_map
inspect ftp
inspect h323 h225
inspect h323 ras
inspect rsh
inspect rtsp
inspect esmtp
inspect sqlnet
inspect skinny
inspect sunrpc
inspect xdmcp
inspect sip
inspect netbios
inspect tftp
inspect ip-options
service-policy global_policy global

Note

See the “Incompatibility of Certain Feature Actions” section on page 32-5 for more information about
the special match default-inspection-traffic command used in the default class map.

Default Class Maps
The configuration includes a default Layer 3/4 class map that the ASA uses in the default global policy
called default-inspection-traffic; it matches the default inspection traffic. This class, which is used in the
default global policy, is a special shortcut to match the default ports for all inspections. When used in a

Cisco ASA 5500 Series Configuration Guide using the CLI

32-8

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Task Flows for Configuring Service Policies

policy, this class ensures that the correct inspection is applied to each packet, based on the destination
port of the traffic. For example, when UDP traffic for port 69 reaches the ASA, then the ASA applies the
TFTP inspection; when TCP traffic for port 21 arrives, then the ASA applies the FTP inspection. So in
this case only, you can configure multiple inspections for the same class map. Normally, the ASA does
not use the port number to determine which inspection to apply, thus giving you the flexibility to apply
inspections to non-standard ports, for example.
class-map inspection_default
match default-inspection-traffic

Another class map that exists in the default configuration is called class-default, and it matches all
traffic. This class map appears at the end of all Layer 3/4 policy maps and essentially tells the ASA to
not perform any actions on all other traffic. You can use the class-default class if desired, rather than
making your own match any class map. In fact, some features are only available for class-default, such
as QoS traffic shaping.
class-map class-default
match any

Task Flows for Configuring Service Policies
This section includes the following topics:
•

Task Flow for Using the Modular Policy Framework, page 32-9

•

Task Flow for Configuring Hierarchical Policy Maps for QoS Traffic Shaping, page 32-11

Task Flow for Using the Modular Policy Framework
To configure Modular Policy Framework, perform the following steps:
Step 1

Identify the traffic—Identify the traffic on which you want to perform Modular Policy Framework
actions by creating Layer 3/4 class maps.
For example, you might want to perform actions on all traffic that passes through the ASA; or you might
only want to perform certain actions on traffic from 10.1.1.0/24 to any destination address.
Layer 3/4 Class Map

241506

Layer 3/4 Class Map

See the “Identifying Traffic (Layer 3/4 Class Maps)” section on page 32-12.
Step 2

Perform additional actions on some inspection traffic—If one of the actions you want to perform is
application inspection, and you want to perform additional actions on some inspection traffic, then create
an inspection policy map. The inspection policy map identifies the traffic and specifies what to do with it.
For example, you might want to drop all HTTP requests with a body length greater than 1000 bytes.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-9

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Task Flows for Configuring Service Policies

Inspection Policy Map Actions

241507

Inspection Class Map/
Match Commands

You can create a self-contained inspection policy map that identifies the traffic directly with match
commands, or you can create an inspection class map for reuse or for more complicated matching. See
the “Defining Actions in an Inspection Policy Map” section on page 33-2 and the “Identifying Traffic in
an Inspection Class Map” section on page 33-6.
Step 3

Create a regular expression—If you want to match text with a regular expression within inspected
packets, you can create a regular expression or a group of regular expressions (a regular expression class
map). Then, when you define the traffic to match for the inspection policy map, you can call on an
existing regular expression.
For example, you might want to drop all HTTP requests with a URL including the text “example.com.”
Inspection Policy Map Actions

241509

Inspection Class Map/
Match Commands

Regular Expression Statement/
Regular Expression Class Map

See the “Creating a Regular Expression” section on page 13-12 and the “Creating a Regular Expression
Class Map” section on page 13-15.
Step 4

Define the actions you want to perform and determine on which interfaces you want to apply the policy
map—Define the actions you want to perform on each Layer 3/4 class map by creating a Layer 3/4 policy
map. Then, determine on which interfaces you want to apply the policy map using a service policy.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-10

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Task Flows for Configuring Service Policies

Layer 3/4 Policy Map
Connection Limits

Connection Limits

Service Policy

Inspection

Inspection

241508

IPS

See the “Defining Actions (Layer 3/4 Policy Map)” section on page 32-15 and the “Applying Actions to
an Interface (Service Policy)” section on page 32-17.

Task Flow for Configuring Hierarchical Policy Maps for QoS Traffic Shaping
If you enable QoS traffic shaping for a class map, then you can optionally enable priority queueing for
a subset of shaped traffic. To do so, you need to create a policy map for the priority queueing, and then
within the traffic shaping policy map, you can call the priority class map. Only the traffic shaping class
map is applied to an interface.
See Chapter 54, “Information About QoS,” for more information about this feature.
Hierarchical policy maps are only supported for traffic shaping and priority queueing.
To implement a hierarchical policy map, perform the following steps:
Step 1

Identify the prioritized traffic according to the “Identifying Traffic (Layer 3/4 Class Maps)” section on
page 32-12.
You can create multiple class maps to be used in the hierarchical policy map.

Step 2

Create a policy map according to the “Defining Actions (Layer 3/4 Policy Map)” section on page 32-15,
and identify the sole action for each class map as priority.

Step 3

Create a separate policy map according to the “Defining Actions (Layer 3/4 Policy Map)” section on
page 32-15, and identify the shape action for the class-default class map.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-11

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Identifying Traffic (Layer 3/4 Class Maps)

Traffic shaping can only be applied the to class-default class map.
Step 4

For the same class map, identify the priority policy map that you created in Step 2 using the
service-policy priority_policy_map command.

Step 5

Apply the shaping policy map to the interface accrding to “Applying Actions to an Interface (Service
Policy)” section on page 32-17.

Identifying Traffic (Layer 3/4 Class Maps)
A Layer 3/4 class map identifies Layer 3 and 4 traffic to which you want to apply actions. You can create
multiple Layer 3/4 class maps for each Layer 3/4 policy map.
This section includes the following topics:
•

Creating a Layer 3/4 Class Map for Through Traffic, page 32-12

•

Creating a Layer 3/4 Class Map for Management Traffic, page 32-14

Creating a Layer 3/4 Class Map for Through Traffic
A Layer 3/4 class map matches traffic based on protocols, ports, IP addresses and other Layer 3 or 4
attributes.

Detailed Steps

Step 1

Command

Purpose

class-map class_map_name

Creates a Layer 3/4 class map, where class_map_name is a string
up to 40 characters in length. The name “class-default” is
reserved. All types of class maps use the same name space, so you
cannot reuse a name already used by another type of class map.
The CLI enters class-map configuration mode.

Example:
hostname(config)# class-map all_udp

Step 2

(Optional)

Adds a description to the class map.

description string

Example:
hostname(config-cmap)# description All UDP
traffic

Step 3

Match traffic using one of the following:

Unless otherwise specified, you can include only one match
command in the class map.

match any

Matches all traffic.

Example:
hostname(config-cmap)# match any

Cisco ASA 5500 Series Configuration Guide using the CLI

32-12

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Identifying Traffic (Layer 3/4 Class Maps)

Command

Purpose

match access-list access_list_name

Matches traffic specified by an extended access list. If the ASA is
operating in transparent firewall mode, you can use an EtherType
access list.

Example:
hostname(config-cmap)# match access-list
udp
match port {tcp | udp} {eq port_num |
range port_num port_num}

Matches TCP or UDP destination ports, either a single port or a
contiguous range of ports.
Tip

Example:
hostname(config-cmap)# match tcp eq 80

For applications that use multiple, non-contiguous ports,
use the match access-list command and define an ACE to
match each port.

match default-inspection-traffic

Matches default traffic for inspection: the default TCP and UDP
ports used by all applications that the ASA can inspect.

Example:

This command, which is used in the default global policy, is a
special CLI shortcut that when used in a policy map, ensures that
the correct inspection is applied to each packet, based on the
destination port of the traffic. For example, when UDP traffic for
port 69 reaches the ASA, then the ASA applies the TFTP
inspection; when TCP traffic for port 21 arrives, then the ASA
applies the FTP inspection. So in this case only, you can configure
multiple inspections for the same class map (with the exception of
WAAS inspection, which can be configured with other
inspections. See the “Incompatibility of Certain Feature Actions”
section on page 32-5 for more information about combining
actions). Normally, the ASA does not use the port number to
determine the inspection applied, thus giving you the flexibility to
apply inspections to non-standard ports, for example.

hostname(config-cmap)# match
default-inspection-traffic

See the “Default Settings” section on page 42-4 for a list of
default ports. Not all applications whose ports are included in the
match default-inspection-traffic command are enabled by
default in the policy map.
You can specify a match access-list command along with the
match default-inspection-traffic command to narrow the
matched traffic. Because the match default-inspection-traffic
command specifies the ports and protocols to match, any ports and
protocols in the access list are ignored.
Tip

match dscp value1 [value2] [...] [value8]

We suggest that you only inspect traffic on ports on which
you expect application traffic; if you inspect all traffic, for
example using match any, the ASA performance can be
impacted.

Matches DSCP value in an IP header, up to eight DSCP values.

Example:
hostname(config-cmap)# match dscp af43 cs1
ef

Cisco ASA 5500 Series Configuration Guide using the CLI

32-13

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Identifying Traffic (Layer 3/4 Class Maps)

Command

Purpose

match precedence value1 [value2] [value3]
[value4]

Matches up to four precedence values, represented by the TOS
byte in the IP header, where value1 through value4 can be 0 to 7,
corresponding to the possible precedences.

Example:
hostname(config-cmap)# match precedence 1
4
match rtp starting_port range

Example:
hostname(config-cmap)# match rtp 4004 100
match tunnel-group name

(Optional)
match flow ip destination-address

Example:
hostname(config-cmap)# match tunnel-group
group1
hostname(config-cmap)# match flow ip
destination-address

Matches RTP traffic, where the starting_port specifies an
even-numbered UDP destination port between 2000 and 65534.
The range specifies the number of additional UDP ports to match
above the starting_port, between 0 and 16383.
Matches VPN tunnel group traffic to which you want to apply
QoS.
You can also specify one other match command to refine the
traffic match. You can specify any of the preceding commands,
except for the match any, match access-list, or match
default-inspection-traffic commands. Or you can also enter the
match flow ip destination-address command to match flows in
the tunnel group going to each IP address.

Examples
The following is an example for the class-map command:
hostname(config)# access-list udp permit udp any any
hostname(config)# access-list tcp permit tcp any any
hostname(config)# access-list host_foo permit ip any 10.1.1.1 255.255.255.255
hostname(config)# class-map all_udp
hostname(config-cmap)# description "This class-map matches all UDP traffic"
hostname(config-cmap)# match access-list udp
hostname(config-cmap)# class-map all_tcp
hostname(config-cmap)# description "This class-map matches all TCP traffic"
hostname(config-cmap)# match access-list tcp
hostname(config-cmap)# class-map all_http
hostname(config-cmap)# description "This class-map matches all HTTP traffic"
hostname(config-cmap)# match port tcp eq http
hostname(config-cmap)# class-map to_server
hostname(config-cmap)# description "This class-map matches all traffic to server 10.1.1.1"
hostname(config-cmap)# match access-list host_foo

Creating a Layer 3/4 Class Map for Management Traffic
For management traffic to the ASA, you might want to perform actions specific to this kind of traffic.
You can specify a management class map that can match an access list or TCP or UDP ports. The types
of actions available for a management class map in the policy map are specialized for management
traffic. See the “Supported Features for Management Traffic” section on page 32-2.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-14

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Defining Actions (Layer 3/4 Policy Map)

Detailed Steps

Step 1

Command

Purpose

class-map type management class_map_name

hostname(config)# class-map type
management all_mgmt

Creates a management class map, where class_map_name is a
string up to 40 characters in length. The name “class-default” is
reserved. All types of class maps use the same name space, so you
cannot reuse a name already used by another type of class map.
The CLI enters class-map configuration mode.

(Optional)

Adds a description to the class map.

Example:

Step 2

description string

Example:
hostname(config-cmap)# description All
management traffic

Step 3

Match traffic using one of the following:

Unless otherwise specified, you can include only one match
command in the class map.

match access-list access_list_name

Matches traffic specified by an extended access list. If the ASA is
operating in transparent firewall mode, you can use an EtherType
access list.

Example:
hostname(config-cmap)# match access-list
udp
match port {tcp | udp} {eq port_num |
range port_num port_num}

Matches TCP or UDP destination ports, either a single port or a
contiguous range of ports.
Tip

Example:
hostname(config-cmap)# match tcp eq 80

For applications that use multiple, non-contiguous ports,
use the match access-list command and define an ACE to
match each port.

Defining Actions (Layer 3/4 Policy Map)
This section describes how to associate actions with Layer 3/4 class maps by creating a Layer 3/4 policy
map.

Restrictions
The maximum number of policy maps is 64, but you can only apply one policy map per interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-15

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Defining Actions (Layer 3/4 Policy Map)

Detailed Steps

Command

Purpose

Step 1

policy-map policy_map_name

Step 2

(Optional)

Adds the policy map. The policy_map_name argument is the
name of the policy map up to 40 characters in length. All types of
policy maps use the same name space, so you cannot reuse a name
Example:
already used by another type of policy map. The CLI enters
hostname(config)# policy-map global_policy
policy-map configuration mode.

class class_map_name

Example:
hostname(config-pmap)# description global
policy map

Specifies a previously configured Layer 3/4 class map, where the
class_map_name is the name of the class map. See the
“Identifying Traffic (Layer 3/4 Class Maps)” section on
page 32-12 to add a class map.
Note

If there is no match default-inspection-traffic command
in a class map, then at most one inspect command is
allowed to be configured under the class.
For QoS, you can configure a hierarchical policy map for
the traffic shaping and priority queue features. See the
“Task Flow for Configuring Hierarchical Policy Maps for
QoS Traffic Shaping” section on page 32-11 for more
information.

Step 3

Specify one or more actions for this class map.

Step 4

Repeat Step 2 and Step 3 for each class map you
want to include in this policy map.

See the “Supported Features for Through Traffic” section on
page 32-2.

Examples
The following is an example of a policy-map command for connection policy. It limits the number of
connections allowed to the web server 10.1.1.1:
hostname(config)# access-list http-server permit tcp any host 10.1.1.1
hostname(config)# class-map http-server
hostname(config-cmap)# match access-list http-server
hostname(config)# policy-map global-policy
hostname(config-pmap)# description This policy map defines a policy concerning connection
to http server.
hostname(config-pmap)# class http-server
hostname(config-pmap-c)# set connection conn-max 256

The following example shows how multi-match works in a policy map:
hostname(config)# class-map inspection_default
hostname(config-cmap)# match default-inspection-traffic
hostname(config)# class-map http_traffic
hostname(config-cmap)# match port tcp eq 80
hostname(config)# policy-map outside_policy
hostname(config-pmap)# class inspection_default
hostname(config-pmap-c)# inspect http http_map
hostname(config-pmap-c)# inspect sip
hostname(config-pmap)# class http_traffic
hostname(config-pmap-c)# set connection timeout idle 0:10:0

Cisco ASA 5500 Series Configuration Guide using the CLI

32-16

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Applying Actions to an Interface (Service Policy)

The following example shows how traffic matches the first available class map, and will not match any
subsequent class maps that specify actions in the same feature domain:
hostname(config)# class-map telnet_traffic
hostname(config-cmap)# match port tcp eq 23
hostname(config)# class-map ftp_traffic
hostname(config-cmap)# match port tcp eq 21
hostname(config)# class-map tcp_traffic
hostname(config-cmap)# match port tcp range 1 65535
hostname(config)# class-map udp_traffic
hostname(config-cmap)# match port udp range 0 65535
hostname(config)# policy-map global_policy
hostname(config-pmap)# class telnet_traffic
hostname(config-pmap-c)# set connection timeout idle 0:0:0
hostname(config-pmap-c)# set connection conn-max 100
hostname(config-pmap)# class ftp_traffic
hostname(config-pmap-c)# set connection timeout idle 0:5:0
hostname(config-pmap-c)# set connection conn-max 50
hostname(config-pmap)# class tcp_traffic
hostname(config-pmap-c)# set connection timeout idle 2:0:0
hostname(config-pmap-c)# set connection conn-max 2000

When a Telnet connection is initiated, it matches class telnet_traffic. Similarly, if an FTP connection is
initiated, it matches class ftp_traffic. For any TCP connection other than Telnet and FTP, it will match
class tcp_traffic. Even though a Telnet or FTP connection can match class tcp_traffic, the ASA does
not make this match because they previously matched other classes.

Applying Actions to an Interface (Service Policy)
To activate the Layer 3/4 policy map, create a service policy that applies it to one or more interfaces or
that applies it globally to all interfaces.

Restrictions
You can only apply one global policy, so if you want to alter the global policy, you need to either edit
the default policy or disable it and apply a new one. By default, the configuration includes a global policy
that matches all default application inspection traffic and applies inspection to the traffic globally. The
default service policy includes the following command:
service-policy global_policy global

Cisco ASA 5500 Series Configuration Guide using the CLI

32-17

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Monitoring Modular Policy Framework

Detailed Steps

Command

Purpose

service-policy policy_map_name interface
interface_name

Creates a service policy by associating a policy map with an interface.

Example:
hostname(config)# service-policy
inbound_policy interface outside
service-policy policy_map_name global

Creates a service policy that applies to all interfaces that do not have a
specific policy.

Example:
hostname(config)# service-policy
inbound_policy global

Examples
For example, the following command enables the inbound_policy policy map on the outside interface:
hostname(config)# service-policy inbound_policy interface outside

The following commands disable the default global policy, and enables a new one called
new_global_policy on all other ASA interfaces:
hostname(config)# no service-policy global_policy global
hostname(config)# service-policy new_global_policy global

Monitoring Modular Policy Framework
To monitor Modular Policy Framework, enter the following command:
Command

Purpose

show service-policy

Displays the service policy statistics.

Configuration Examples for Modular Policy Framework
This section includes several Modular Policy Framework examples and includes the following topics:
•

Applying Inspection and QoS Policing to HTTP Traffic, page 32-19

•

Applying Inspection to HTTP Traffic Globally, page 32-19

•

Applying Inspection and Connection Limits to HTTP Traffic to Specific Servers, page 32-20

•

Applying Inspection to HTTP Traffic with NAT, page 32-21

Cisco ASA 5500 Series Configuration Guide using the CLI

32-18

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Configuration Examples for Modular Policy Framework

Applying Inspection and QoS Policing to HTTP Traffic
In this example (see Figure 32-1), any HTTP connection (TCP traffic on port 80) that enters or exits the
ASA through the outside interface is classified for HTTP inspection. Any HTTP traffic that exits the
outside interface is classified for policing.
HTTP Inspection and QoS Policing

Security
appliance
port 80
A

insp.
police

port 80
insp.

Host A

inside

outside

Host B

143356

Figure 32-1

See the following commands for this example:
hostname(config)# class-map http_traffic
hostname(config-cmap)# match port tcp eq 80
hostname(config)# policy-map http_traffic_policy
hostname(config-pmap)# class http_traffic
hostname(config-pmap-c)# inspect http
hostname(config-pmap-c)# police output 250000
hostname(config)# service-policy http_traffic_policy interface outside

Applying Inspection to HTTP Traffic Globally
In this example (see Figure 32-2), any HTTP connection (TCP traffic on port 80) that enters the ASA
through any interface is classified for HTTP inspection. Because the policy is a global policy, inspection
occurs only as the traffic enters each interface.
Figure 32-2

Global HTTP Inspection

Security
appliance
port 80

A
Host A

inside

port 80 insp.
outside

Host B

143414

insp.

See the following commands for this example:
hostname(config)# class-map http_traffic
hostname(config-cmap)# match port tcp eq 80

Cisco ASA 5500 Series Configuration Guide using the CLI

32-19

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Configuration Examples for Modular Policy Framework

hostname(config)# policy-map http_traffic_policy
hostname(config-pmap)# class http_traffic
hostname(config-pmap-c)# inspect http
hostname(config)# service-policy http_traffic_policy global

Applying Inspection and Connection Limits to HTTP Traffic to Specific Servers
In this example (see Figure 32-3), any HTTP connection destined for Server A (TCP traffic on port 80)
that enters the ASA through the outside interface is classified for HTTP inspection and maximum
connection limits. Connections initiated from Server A to Host A does not match the access list in the
class map, so it is not affected.
Any HTTP connection destined for Server B that enters the ASA through the inside interface is classified
for HTTP inspection. Connections initiated from Server B to Host B does not match the access list in the
class map, so it is not affected.
Figure 32-3

HTTP Inspection and Connection Limits to Specific Servers

Server A
Real Address: 192.168.1.2
Mapped Address: 209.165.201.1

Security
appliance

port 80

insp.
set conns

port 80
insp. inside

Host B
Real Address: 192.168.1.1
Mapped Address: 209.165.201.2:port

outside
Server B
209.165.200.227

143357

Host A
209.165.200.226

See the following commands for this example:
hostname(config)# object network obj-192.168.1.2
hostname(config-network-object)# host 192.168.1.2
hostname(config-network-object)# nat (inside,outside) static 209.165.201.1
hostname(config)# object network obj-192.168.1.0
hostname(config-network-object)# subnet 192.168.1.0 255.255.255.0
hostname(config-network-object)# nat (inside,outside) dynamic 209.165.201.2
hostname(config)# access-list serverA extended permit tcp any host 209.165.201.1 eq 80
hostname(config)# access-list ServerB extended permit tcp any host 209.165.200.227 eq 80
hostname(config)# class-map http_serverA
hostname(config-cmap)# match access-list serverA
hostname(config)# class-map http_serverB
hostname(config-cmap)# match access-list serverB
hostname(config)# policy-map policy_serverA
hostname(config-pmap)# class http_serverA
hostname(config-pmap-c)# inspect http
hostname(config-pmap-c)# set connection conn-max 100
hostname(config)# policy-map policy_serverB
hostname(config-pmap)# class http_serverB
hostname(config-pmap-c)# inspect http

Cisco ASA 5500 Series Configuration Guide using the CLI

32-20

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework
Feature History for Service Policies

hostname(config)# service-policy policy_serverB interface inside
hostname(config)# service-policy policy_serverA interface outside

Applying Inspection to HTTP Traffic with NAT
In this example, the Host on the inside network has two addresses: one is the real IP address 192.168.1.1,
and the other is a mapped IP address used on the outside network, 209.165.200.225. Because the policy
is applied to the inside interface, where the real address is used, then you must use the real IP address in
the access list in the class map. If you applied it to the outside interface, you would use the mapped
address.
Figure 32-4

HTTP Inspection with NAT

port 80
insp. inside

outside

Host
Real IP: 192.168.1.1
Mapped IP: 209.165.200.225

Server
209.165.201.1

143416

Security
appliance

See the following commands for this example:
hostname(config)# static (inside,outside) 209.165.200.225 192.168.1.1
hostname(config)# access-list http_client extended permit tcp host 192.168.1.1 any eq 80
hostname(config)# class-map http_client
hostname(config-cmap)# match access-list http_client
hostname(config)# policy-map http_client
hostname(config-pmap)# class http_client
hostname(config-pmap-c)# inspect http
hostname(config)# service-policy http_client interface inside

Feature History for Service Policies
Table 32-3 lists the release history for this feature.
Table 32-3

Feature History for Service Policies

Feature Name

Releases

Feature Information

Modular Policy Framework

7.0(1)

Modular Policy Framework was introduced.

Management class map for use with RADIUS
accounting traffic

7.2(1)

The management class map was introduced for use with
RADIUS accounting traffic. The following commands were
introduced: class-map type management, and inspect
radius-accounting.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-21

Chapter 32

Configuring a Service Policy Using the Modular Policy Framework

Feature History for Service Policies

Table 32-3

Feature History for Service Policies (continued)

Feature Name

Releases

Feature Information

Inspection policy maps

7.2(1)

The inspection policy map was introduced. The following
command was introduced: class-map type inspect.

Regular expressions and policy maps

7.2(1)

Regular expressions and policy maps were introduced to be
used under inspection policy maps. The following
commands were introduced: class-map type regex, regex,
match regex.

Match any for inspection policy maps

8.0(2)

The match any keyword was introduced for use with
inspection policy maps: traffic can match one or more
criteria to match the class map. Formerly, only match all
was available.

Maximum connections and embryonic
connections for management traffic

8.0(2)

The set connection command is now available for a Layer
3/4 management class map, for to-the-security appliance
management traffic. Only the conn-max and
embryonic-conn-max keywords are available.

Cisco ASA 5500 Series Configuration Guide using the CLI

32-22

CH A P T E R

33

Configuring Special Actions for Application
Inspections (Inspection Policy Map)
Modular Policy Framework lets you configure special actions for many application inspections. When
you enable an inspection engine in the Layer 3/4 policy map, you can also optionally enable actions as
defined in an inspection policy map. When the inspection policy map matches traffic within the Layer
3/4 class map for which you have defined an inspection action, then that subset of traffic will be acted
upon as specified (for example, dropped or rate-limited).
This chapter includes the following sections:
•

Information About Inspection Policy Maps, page 33-1

•

Guidelines and Limitations, page 33-2

•

Default Inspection Policy Maps, page 33-2

•

Defining Actions in an Inspection Policy Map, page 33-2

•

Identifying Traffic in an Inspection Class Map, page 33-6

•

Where to Go Next, page 33-7

Information About Inspection Policy Maps
See the “Configuring Application Layer Protocol Inspection” section on page 42-6 for a list of
applications that support inspection policy maps.
An inspection policy map consists of one or more of the following elements. The exact options available
for an inspection policy map depends on the application.
•

Traffic matching command—You can define a traffic matching command directly in the inspection
policy map to match application traffic to criteria specific to the application, such as a URL string,
for which you then enable actions.
– Some traffic matching commands can specify regular expressions to match text inside a packet.

Be sure to create and test the regular expressions before you configure the policy map, either
singly or grouped together in a regular expression class map.
•

Inspection class map—(Not available for all applications. See the CLI help for a list of supported
applications.) An inspection class map includes traffic matching commands that match application
traffic with criteria specific to the application, such as a URL string. You then identify the class map
in the policy map and enable actions. The difference between creating a class map and defining the
traffic match directly in the inspection policy map is that you can create more complex match criteria
and you can reuse class maps.

Cisco ASA 5500 Series Configuration Guide using the CLI

33-1

Chapter 33

Configuring Special Actions for Application Inspections (Inspection Policy Map)

Guidelines and Limitations

– Some traffic matching commands can specify regular expressions to match text inside a packet.

Be sure to create and test the regular expressions before you configure the policy map, either
singly or grouped together in a regular expression class map.
•

Parameters—Parameters affect the behavior of the inspection engine.

Guidelines and Limitations
•

HTTP inspection policy maps—If you modify an in-use HTTP inspection policy map (policy-map
type inspect http), you must remove and reapply the inspect http map action for the changes to
take effect. For example, if you modify the “http-map” inspection policy map, you must remove and
readd the inspect http http-map command from the layer 3/4 policy:
hostname(config)# policy-map test
hostname(config-pmap)# class httpO
hostname(config-pmap-c)# no inspect http http-map
hostname(config-pmap-c)# inspect http http-map

•

All inspection policy maps—If you want to exchange an in-use inspection policy map for a different
map name, you must remove the inspect protocol map command, and readd it with the new map.
For example:
hostname(config)# policy-map test
hostname(config-pmap)# class sip
hostname(config-pmap-c)# no inspect sip sip-map1
hostname(config-pmap-c)# inspect sip sip-map2

Default Inspection Policy Maps
The default inspection policy map configuration includes the following commands, which sets the
maximum message length for DNS packets to be 512 bytes:
policy-map type inspect dns preset_dns_map
parameters
message-length maximum 512

Note

There are other default inspection policy maps such as policy-map type inspect esmtp
_default_esmtp_map. These default policy maps are created implicitly by the command inspect
protocol. For example, inspect esmtp implicitly uses the policy map “_default_esmtp_map.” All the
default policy maps can be shown by using the show running-config all policy-map command.

Defining Actions in an Inspection Policy Map
When you enable an inspection engine in the Layer 3/4 policy map, you can also optionally enable
actions as defined in an inspection policy map.

Restrictions
You can specify multiple class or match commands in the policy map.

Cisco ASA 5500 Series Configuration Guide using the CLI

33-2

Chapter 33

Configuring Special Actions for Application Inspections (Inspection Policy Map)
Defining Actions in an Inspection Policy Map

If a packet matches multiple different match or class commands, then the order in which the ASA
applies the actions is determined by internal ASA rules, and not by the order they are added to the policy
map. The internal rules are determined by the application type and the logical progression of parsing a
packet, and are not user-configurable. For example for HTTP traffic, parsing a Request Method field
precedes parsing the Header Host Length field; an action for the Request Method field occurs before the
action for the Header Host Length field. For example, the following match commands can be entered in
any order, but the match request method get command is matched first.
match request header host length gt 100
reset
match request method get
log

If an action drops a packet, then no further actions are performed in the inspection policy map. For
example, if the first action is to reset the connection, then it will never match any further match or class
commands. If the first action is to log the packet, then a second action, such as resetting the connection,
can occur. (You can configure both the reset (or drop-connection, and so on.) and the log action for the
same match or class command, in which case the packet is logged before it is reset for a given match.)
If a packet matches multiple match or class commands that are the same, then they are matched in the
order they appear in the policy map. For example, for a packet with the header length of 1001, it will
match the first command below, and be logged, and then will match the second command and be reset.
If you reverse the order of the two match commands, then the packet will be dropped and the connection
reset before it can match the second match command; it will never be logged.
match request header length gt 100
log
match request header length gt 1000
reset

A class map is determined to be the same type as another class map or match command based on the
lowest priority match command in the class map (the priority is based on the internal rules). If a class
map has the same type of lowest priority match command as another class map, then the class maps are
matched according to the order they are added to the policy map. If the lowest priority command for each
class map is different, then the class map with the higher priority match command is matched first. For
example, the following three class maps contain two types of match commands: match request-cmd
(higher priority) and match filename (lower priority). The ftp3 class map includes both commands, but
it is ranked according to the lowest priority command, match filename. The ftp1 class map includes the
highest priority command, so it is matched first, regardless of the order in the policy map. The ftp3 class
map is ranked as being of the same priority as the ftp2 class map, which also contains the match
filename command. They are matched according to the order in the policy map: ftp3 and then ftp2.
class-map type inspect ftp match-all ftp1
match request-cmd get
class-map type inspect ftp match-all ftp2
match filename regex abc
class-map type inspect ftp match-all ftp3
match request-cmd get
match filename regex abc
policy-map type inspect ftp ftp
class ftp3
log
class ftp2
log
class ftp1
log

Cisco ASA 5500 Series Configuration Guide using the CLI

33-3

Chapter 33

Configuring Special Actions for Application Inspections (Inspection Policy Map)

Defining Actions in an Inspection Policy Map

Detailed Steps

Step 1

Command

Purpose

(Optional)

See the “Identifying Traffic in an Inspection Class Map” section
on page 33-6. Alternatively, you can identify the traffic directly
within the policy map.

Create an inspection class map.
Step 2

policy-map type inspect application
policy_map_name

Creates the inspection policy map. See the “Configuring
Application Layer Protocol Inspection” section on page 42-6 for
a list of applications that support inspection policy maps.

Example:

The policy_map_name argument is the name of the policy map up
to 40 characters in length. All types of policy maps use the same
name space, so you cannot reuse a name already used by another
type of policy map. The CLI enters policy-map configuration
mode.

hostname(config)# policy-map type inspect
http http_policy

Step 3

Specify the traffic on which you want to perform actions using one of the following methods:
class class_map_name

Example:
hostname(config-pmap)# class http_traffic
hostname(config-pmap-c)#

Not all applications support inspection class maps.

Specify traffic directly in the policy map using
one of the match commands described for each
application in the inspection chapter.

If you use a match not command, then any traffic that matches
the criterion in the match not command does not have the action
applied.

Example:
hostname(config-pmap)# match req-resp
content-type mismatch
hostname(config-pmap-c)#

Cisco ASA 5500 Series Configuration Guide using the CLI

33-4

Specifies the inspection class map that you created in the
“Identifying Traffic in an Inspection Class Map” section on
page 33-6.

Chapter 33

Configuring Special Actions for Application Inspections (Inspection Policy Map)
Defining Actions in an Inspection Policy Map

Step 4

Command

Purpose

{[drop [send-protocol-error] |
drop-connection [send-protocol-error]|
mask | reset] [log] | rate-limit
message_rate}

Specifies the action you want to perform on the matching traffic.
Not all options are available for each application. Other actions
specific to the application might also be available. See the
appropriate inspection chapter for the exact options available.

Example:
hostname(config-pmap-c)# drop-connection
log

Step 5

parameters

Example:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

•

drop—Drops all packets that match.

•

send-protocol-error—Sends a protocol error message.

•

drop-connection—Drops the packet and closes the
connection.

•

mask—Masks out the matching portion of the packet.

•

reset—Drops the packet, closes the connection, and sends a
TCP reset to the server and/or client.

•

log—Sends a system log message. You can use log alone or
with one of the other keywords.

•

rate-limit message_rate—Limits the rate of messages.

Configures parameters that affect the inspection engine. The CLI
enters parameters configuration mode. For the parameters
available for each application, see the appropriate inspection
chapter.

Examples
The following is an example of an HTTP inspection policy map and the related class maps. This policy
map is activated by the Layer 3/4 policy map, which is enabled by the service policy.
hostname(config)# regex url_example example\.com
hostname(config)# regex url_example2 example2\.com
hostname(config)# class-map type regex match-any URLs
hostname(config-cmap)# match regex url_example
hostname(config-cmap)# match regex url_example2
hostname(config-cmap)#
hostname(config-cmap)#
hostname(config-cmap)#
hostname(config-cmap)#

class-map type inspect http match-all http-traffic
match req-resp content-type mismatch
match request body length gt 1000
match not request uri regex class URLs

hostname(config-cmap)# policy-map type inspect http http-map1
hostname(config-pmap)# class http-traffic
hostname(config-pmap-c)# drop-connection log
hostname(config-pmap-c)# match req-resp content-type mismatch
hostname(config-pmap-c)# reset log
hostname(config-pmap-c)# parameters
hostname(config-pmap-p)# protocol-violation action log
hostname(config-pmap-p)# policy-map test
hostname(config-pmap)# class test (a Layer 3/4 class
hostname(config-pmap-c)# inspect http http-map1

map not shown)

hostname(config-pmap-c)# service-policy test interface outside

Cisco ASA 5500 Series Configuration Guide using the CLI

33-5

Chapter 33

Configuring Special Actions for Application Inspections (Inspection Policy Map)

Identifying Traffic in an Inspection Class Map

Identifying Traffic in an Inspection Class Map
This type of class map allows you to match criteria that is specific to an application. For example, for
DNS traffic, you can match the domain name in a DNS query.
A class map groups multiple traffic matches (in a match-all class map), or lets you match any of a list of
matches (in a match-any class map). The difference between creating a class map and defining the traffic
match directly in the inspection policy map is that the class map lets you group multiple match
commands, and you can reuse class maps. For the traffic that you identify in this class map, you can
specify actions such as dropping, resetting, and/or logging the connection in the inspection policy map.
If you want to perform different actions on different types of traffic, you should identify the traffic
directly in the policy map.

Restrictions
Not all applications support inspection class maps. See the CLI help for class-map type inspect for a
list of supported applications.

Detailed Steps

Step 1

Command

Purpose

(Optional)

See the “Creating a Regular Expression” section on page 13-12
and the “Creating a Regular Expression Class Map” section on
page 13-15.

Create a regular expression.
Step 2

class-map type inspect application
[match-all | match-any] class_map_name

Example:
hostname(config)# class-map type inspect
http http_traffic
hostname(config-cmap)#

Creates an inspection class map, where the application is the
application you want to inspect. For supported applications, see
the CLI help for a list of supported applications or see Chapter 42,
“Getting Started with Application Layer Protocol Inspection.”
The class_map_name argument is the name of the class map up to
40 characters in length.
The match-all keyword is the default, and specifies that traffic
must match all criteria to match the class map.
The match-any keyword specifies that the traffic matches the
class map if it matches at least one of the criteria.
The CLI enters class-map configuration mode, where you can
enter one or more match commands.

Cisco ASA 5500 Series Configuration Guide using the CLI

33-6

Chapter 33

Configuring Special Actions for Application Inspections (Inspection Policy Map)
Where to Go Next

Step 3

Command

Purpose

(Optional)

Adds a description to the class map.

description string

Example:
hostname(config-cmap)# description All UDP
traffic

Step 4

Define the traffic to include in the class by
To specify traffic that should not match the class map, use the
entering one or more match commands available match not command. For example, if the match not command
for your application.
specifies the string “example.com,” then any traffic that includes
“example.com” does not match the class map.
To see the match commands available for each application, see
the appropriate inspection chapter.

Examples
The following example creates an HTTP class map that must match all criteria:
hostname(config-cmap)#
hostname(config-cmap)#
hostname(config-cmap)#
hostname(config-cmap)#

class-map type inspect http match-all http-traffic
match req-resp content-type mismatch
match request body length gt 1000
match not request uri regex class URLs

The following example creates an HTTP class map that can match any of the criteria:
hostname(config-cmap)#
hostname(config-cmap)#
hostname(config-cmap)#
hostname(config-cmap)#

class-map type inspect http match-any monitor-http
match request method get
match request method put
match request method post

Where to Go Next
To use an inspection policy, see Chapter 32, “Configuring a Service Policy Using the Modular Policy
Framework.”

Cisco ASA 5500 Series Configuration Guide using the CLI

33-7

Chapter 33
Where to Go Next

Cisco ASA 5500 Series Configuration Guide using the CLI

33-8

Configuring Special Actions for Application Inspections (Inspection Policy Map)

PA R T

9

Configuring Access Control

CH A P T E R

34

Configuring Access Rules
This chapter describes how to control network access through the ASA using access rules and includes
the following sections:

Note

•

Information About Access Rules, page 34-1

•

Licensing Requirements for Access Rules, page 34-6

•

Prerequisites, page 34-7

•

Guidelines and Limitations, page 34-7

•

Default Settings, page 34-7

•

Configuring Access Rules, page 34-7

•

Monitoring Access Rules, page 34-8

•

Configuration Examples for Permitting or Denying Network Access, page 34-9

•

Feature History for Access Rules, page 34-10

You use access rules to control network access in both routed and transparent firewall modes. In
transparent mode, you can use both access rules (for Layer 3 traffic) and EtherType rules (for Layer 2
traffic).
To access the ASA interface for management access, you do not also need an access rule allowing the
host IP address. You only need to configure management access according to Chapter 37, “Configuring
Management Access.”

Information About Access Rules
You create an access rule by applying an extended or EtherType access list to an interface or globally for
all interfaces.You can use access rules in routed and transparent firewall mode to control IP traffic. An
access rule permits or denies traffic based on the protocol, a source and destination IP address or
network, and optionally the source and destination ports.
For transparent mode only, an EtherType rule controls network access for non-IP traffic. An EtherType
rule permits or denies traffic based on the EtherType.
This section includes the following topics:
•

General Information About Rules, page 34-2

•

Information About Extended Access Rules, page 34-4

Cisco ASA 5500 Series Configuration Guide using the CLI

34-1

Chapter 34

Configuring Access Rules

Information About Access Rules

•

Information About EtherType Rules, page 34-5

General Information About Rules
This section describes information for both access rules and EtherType rules, and it includes the
following topics:
•

Implicit Permits, page 34-2

•

Information About Interface Access Rules and Global Access Rules, page 34-2

•

Using Access Rules and EtherType Rules on the Same Interface, page 34-2

•

Implicit Deny, page 34-3

•

Inbound and Outbound Rules, page 34-3

Implicit Permits
For routed mode, the following types of traffic are allowed through by default:
•

IPv4 traffic from a higher security interface to a lower security interface.

•

IPv6 traffic from a higher security interface to a lower security interface.

For transparent mode, the following types of traffic are allowed through by default:
•

IPv4 traffic from a higher security interface to a lower security interface.

•

IPv6 traffic from a higher security interface to a lower security interface.

•

ARPs in both directions.

Note
•

ARP traffic can be controlled by ARP inspection, but cannot be controlled by an access rule.

BPDUs in both directions.

For other traffic, you need to use either an extended access rule (IPv4), an IPv6 access rule (IPv6), or an
EtherType rule (non-IPv4/IPv6).

Information About Interface Access Rules and Global Access Rules
You can apply an access rule to a specific interface, or you can apply an access rule globally to all
interfaces. You can configure global access rules in conjunction with interface access rules, in which
case, the specific interface access rules are always processed before the general global access rules.

Note

Global access rules apply only to inbound traffic. See the “Inbound and Outbound Rules” section on
page 34-3.

Using Access Rules and EtherType Rules on the Same Interface
You can apply one access rule and one EtherType rule to each direction of an interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

34-2

Chapter 34

Configuring Access Rules
Information About Access Rules

Implicit Deny
Access lists have an implicit deny at the end of the list, so unless you explicitly permit it, traffic cannot
pass. For example, if you want to allow all users to access a network through the ASA except for
particular addresses, then you need to deny the particular addresses and then permit all others.
For EtherType access lists, the implicit deny at the end of the access list does not affect IP traffic or
ARPs; for example, if you allow EtherType 8037, the implicit deny at the end of the access list does not
now block any IP traffic that you previously allowed with an extended access list (or implicitly allowed
from a high security interface to a low security interface). However, if you explicitly deny all traffic with
an EtherType ACE, then IP and ARP traffic is denied.
If you configure a global access rule, then the implicit deny comes after the global rule is processed. See
the following order of operations:
1.

Interface access rule.

2.

Global access rule.

3.

Implicit deny.

Inbound and Outbound Rules
The ASA supports two types of access rules:

Note

•

Inbound—Inbound access rules apply to traffic as it enters an interface. Global access rules are
always inbound.

•

Outbound—Outbound access rules apply to traffic as it exits an interface.

“Inbound” and “outbound” refer to the application of an access list on an interface, either to traffic
entering the ASA on an interface or traffic exiting the ASA on an interface. These terms do not refer to
the movement of traffic from a lower security interface to a higher security interface, commonly known
as inbound, or from a higher to lower interface, commonly known as outbound.
An outbound access list is useful, for example, if you want to allow only certain hosts on the inside
networks to access a web server on the outside network. Rather than creating multiple inbound access
lists to restrict access, you can create a single outbound access list that allows only the specified hosts.
(See Figure 34-1.) The outbound access list prevents any other hosts from reaching the outside network.

Cisco ASA 5500 Series Configuration Guide using the CLI

34-3

Chapter 34

Configuring Access Rules

Information About Access Rules

Figure 34-1

Outbound Access List

Web Server:
209.165.200.225

ASA

Outside
ACL Outbound
Permit HTTP from 10.1.1.14, 10.1.2.67,
and 10.1.3.34 to 209.165.200.225
Deny all others

ACL Inbound
Permit from any to any

10.1.1.14

209.165.201.4
Static NAT

HR
ACL Inbound
Permit from any to any

10.1.2.67
209.165.201.6
Static NAT

Eng
ACL Inbound
Permit from any to any

10.1.3.34
209.165.201.8
Static NAT

333823

Inside

See the following commands for this example:
hostname(config)# access-list OUTSIDE extended permit tcp host 10.1.1.14
host 209.165.200.225 eq www
hostname(config)# access-list OUTSIDE extended permit tcp host 10.1.2.67
host 209.165.200.225 eq www
hostname(config)# access-list OUTSIDE extended permit tcp host 10.1.3.34
host 209.165.200.225 eq www
hostname(config)# access-group OUTSIDE out interface outside

Information About Extended Access Rules
This section describes information about extended access rules and includes the following topics:
•

Access Rules for Returning Traffic, page 34-4

•

Allowing Broadcast and Multicast Traffic through the Transparent Firewall Using Access Rules,
page 34-5

•

Management Access Rules, page 34-5

Access Rules for Returning Traffic
For TCP and UDP connections for both routed and transparent mode, you do not need an access rule to
allow returning traffic because the ASA allows all returning traffic for established, bidirectional
connections.

Cisco ASA 5500 Series Configuration Guide using the CLI

34-4

Chapter 34

Configuring Access Rules
Information About Access Rules

For connectionless protocols such as ICMP, however, the ASA establishes unidirectional sessions, so
you either need access rules to allow ICMP in both directions (by applying access lists to the source and
destination interfaces), or you need to enable the ICMP inspection engine. The ICMP inspection engine
treats ICMP sessions as bidirectional connections. To control ping, specify echo-reply (0) (ASA to host)
or echo (8) (host to ASA).

Allowing Broadcast and Multicast Traffic through the Transparent Firewall Using Access Rules
In routed firewall mode, broadcast and multicast traffic is blocked even if you allow it in an access rule,
including unsupported dynamic routing protocols and DHCP (unless you configure DHCP relay).
Transparent firewall mode can allow any IP traffic through. This feature is especially useful in multiple
context mode, which does not allow dynamic routing, for example.

Note

Because these special types of traffic are connectionless, you need to apply an extended access list to
both interfaces, so returning traffic is allowed through.
Table 34-1 lists common traffic types that you can allow through the transparent firewall.
Table 34-1

Transparent Firewall Special Traffic

Traffic Type

Protocol or Port

Notes

DHCP

UDP ports 67 and 68

If you enable the DHCP server, then the ASA
does not pass DHCP packets.

EIGRP

Protocol 88

—

OSPF

Protocol 89

—

Multicast streams The UDP ports vary depending
on the application.

Multicast streams are always destined to a
Class D address (224.0.0.0 to 239.x.x.x).

RIP (v1 or v2)

—

UDP port 520

Management Access Rules
You can configure access rules that control management traffic destined to the ASA. Access control rules
for to-the-box management traffic (defined by such commands as http, ssh, or telnet) have higher
precedence than an management access rule applied with the control-plane option. Therefore, such
permitted management traffic will be allowed to come in even if explicitly denied by the to-the-box
access list.

Information About EtherType Rules
This section describes EtherType rules and includes the following topics:
•

Supported EtherTypes and Other Traffic, page 34-6

•

Access Rules for Returning Traffic, page 34-6

•

Allowing MPLS, page 34-6

Cisco ASA 5500 Series Configuration Guide using the CLI

34-5

Chapter 34

Configuring Access Rules

Licensing Requirements for Access Rules

Supported EtherTypes and Other Traffic
An EtherType rule controls the following:
•

EtherType identified by a 16-bit hexadecimal number, including common types IPX and MPLS
unicast or multicast.

•

Ethernet V2 frames.

•

BPDUs, which are permitted by default. BPDUs are SNAP-encapsulated, and the ASA is designed
to specifically handle BPDUs.

•

Trunk port (Cisco proprietary) BPDUs. Trunk BPDUs have VLAN information inside the payload,
so the ASA modifies the payload with the outgoing VLAN if you allow BPDUs.

•

IS-IS (supported in Version 8.4(5) only).

The following types of traffic are not supported:
•

802.3-formatted frames—These frames are not handled by the rule because they use a length field
as opposed to a type field.

Access Rules for Returning Traffic
Because EtherTypes are connectionless, you need to apply the rule to both interfaces if you want traffic
to pass in both directions.

Allowing MPLS
If you allow MPLS, ensure that Label Distribution Protocol and Tag Distribution Protocol TCP
connections are established through the ASA by configuring both MPLS routers connected to the ASA
to use the IP address on the ASA interface as the router-id for LDP or TDP sessions. (LDP and TDP
allow MPLS routers to negotiate the labels (addresses) used to forward packets.)
On Cisco IOS routers, enter the appropriate command for your protocol, LDP or TDP. The interface is
the interface connected to the ASA.
hostname(config)# mpls ldp router-id interface force

Or
hostname(config)# tag-switching tdp router-id interface force

Licensing Requirements for Access Rules
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

34-6

Chapter 34

Configuring Access Rules
Prerequisites

Prerequisites
Before you can create an access rule, create the access list. See Chapter 15, “Adding an Extended Access
List,” and Chapter 16, “Adding an EtherType Access List,” for more information.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
IPv6 Guidelines

Supports IPv6.
Per-User Access List Guidelines
•

If there is no per-user access list associated with a packet, the interface access rule is applied.

•

The per-user access list uses the value in the timeout uauth command, but it can be overridden by
the AAA per-user session timeout value.

•

If traffic is denied because of a per-user access list, syslog message 109025 is logged. If traffic is
permitted, no syslog message is generated. The log option in the per-user access list has no effect.

Default Settings
See the “Implicit Permits” section on page 34-2.

Configuring Access Rules
To apply an access rule, perform the following steps.

Cisco ASA 5500 Series Configuration Guide using the CLI

34-7

Chapter 34

Configuring Access Rules

Monitoring Access Rules

Detailed Steps

Command

Purpose

access-group access_list
{{in | out} interface interface_name
[per-user-override | control-plane] |
global}

Binds an access list to an interface or applies it globally.

Example:
hostname(config)# access-group acl_out in
interface outside

Specify the extended, EtherType, or IPv6 access list name. You can
configure one access-group command per access list type per interface.
You cannot reference empty access lists or access lists that contain only a
remark.
For an interface-specific rule:
•

The in keyword applies the access list to inbound traffic. The out
keyword applies the access list to the outbound traffic.

•

Specify the interface name.

•

The per-user-override keyword (for inbound access lists only) allows
dynamic user access lists that are downloaded for user authorization to
override the access list assigned to the interface. For example, if the
interface access list denies all traffic from 10.0.0.0, but the dynamic
access list permits all traffic from 10.0.0.0, then the dynamic access
list overrides the interface access list for that user. See the
“Configuring RADIUS Authorization” section on page 38-14 for more
information about per-user access lists. See also the “Per-User Access
List Guidelines” section on page 34-7.

•

The control-plane keyword specifies if the rule is for to-the-box
traffic.

For a global rule, specify the global keyword to apply the access list to
the inbound direction of all interfaces.

Examples
The following example shows how to use the access-group command:
hostname(config)# access-list acl_out permit tcp any host 209.165.201.3 eq 80
hostname(config)# access-group acl_out in interface outside

The access-list command lets any host access the global address using port 80. The access-group
command specifies that the access-list command applies to traffic entering the outside interface.

Monitoring Access Rules
To monitor network access, enter the following command:
Command

Purpose

show running-config access-group

Displays the current access list bound to the
interfaces.

Cisco ASA 5500 Series Configuration Guide using the CLI

34-8

Chapter 34

Configuring Access Rules
Configuration Examples for Permitting or Denying Network Access

Configuration Examples for Permitting or Denying Network
Access
This section includes typical configuration examples for permitting or denying network access.
The following example illustrates the commands required to enable access to an inside web server with
the IP address 209.165.201.12. (This IP address is the real address, not the visible on the outside
interface after NAT.)
hostname(config)# access-list ACL_OUT extended permit tcp any host 209.165.201.12 eq www
hostname(config)# access-group ACL_OUT in interface outside

The following example allows all hosts to communicate between the inside and hr networks but only
specific hosts to access the outside network:
hostname(config)# access-list ANY extended permit ip any any
hostname(config)# access-list OUT extended permit ip host 209.168.200.3 any
hostname(config)# access-list OUT extended permit ip host 209.168.200.4 any
hostname(config)# access-group ANY in interface inside
hostname(config)# access-group ANY in interface hr
hostname(config)# access-group OUT out interface outside

For example, the following sample access list allows common EtherTypes originating on the inside
interface:
hostname(config)# access-list ETHER ethertype permit ipx
hostname(config)# access-list ETHER ethertype permit mpls-unicast
hostname(config)# access-group ETHER in interface inside

The following example allows some EtherTypes through the ASA, but it denies all others:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list ETHER ethertype permit 0x1234
access-list ETHER ethertype permit mpls-unicast
access-group ETHER in interface inside
access-group ETHER in interface outside

The following example denies traffic with EtherType 0x1256 but allows all others on both interfaces:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list nonIP ethertype deny 1256
access-list nonIP ethertype permit any
access-group ETHER in interface inside
access-group ETHER in interface outside

The following example uses object groups to permit specific traffic on the inside interface:
!
hostname
hostname
hostname
hostname
hostname
hostname

(config)# object-group service myaclog
(config-service)# service-object tcp source range 2000 3000
(config-service)# service-object tcp source range 3000 3010 destinatio$
(config-service)# service-object ipsec
(config-service)# service-object udp destination range 1002 1006
(config-service)# service-object icmp echo

hostname(config)# access-list outsideacl extended permit object-group myaclog interface
inside any

Cisco ASA 5500 Series Configuration Guide using the CLI

34-9

Chapter 34

Configuring Access Rules

Feature History for Access Rules

Feature History for Access Rules
Table 34-2 lists each feature change and the platform release in which it was implemented.
Table 34-2

Feature History for Access Rules

Feature Name
Interface access rules

Platform
Releases
7.0(1)

Feature Information
Controlling network access through the ASA using access
lists.
We introduced the following command: access-group.

Global access rules

8.3(1)

Global access rules were introduced.
We modified the following command: access-group.

Support for Identity Firewall

8.4(2)

You can now use identity firewall users and groups for the
source and destination. You can use an identity firewall
ACL with access rules, AAA rules, and for VPN
authentication.
We modified the following commands: access-list
extended.

EtherType ACL support for IS-IS traffic
(transparent firewall mode)

8.4(5)

In transparent firewall mode, the ASA can now pass IS-IS
traffic using an EtherType ACL.
We modified the following command: access-list ethertype
{permit | deny} is-is.
Not available in Version 8.5(1), 8.6(1), or 9.0(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

34-10

CH A P T E R

35

Configuring AAA Servers and the Local Database
This chapter describes support for authentication, authorization, and accounting (AAA, pronounced
“triple A”), and how to configure AAA servers and the local database.
The chapter includes the following sections:
•

Information About AAA, page 35-1

•

Licensing Requirements for AAA Servers, page 35-10

•

Guidelines and Limitations, page 35-10

•

Configuring AAA, page 35-10

•

Monitoring AAA Servers, page 35-30

•

Additional References, page 35-31

•

Feature History for AAA Servers, page 35-31

Information About AAA
AAA enables the ASA to determine who the user is (authentication), what the user can do
(authorization), and what the user did (accounting).
AAA provides an extra level of protection and control for user access than using access lists alone. For
example, you can create an access list allowing all outside users to access Telnet on a server on the DMZ
network. If you want only some users to access the server and you might not always know IP addresses
of these users, you can enable AAA to allow only authenticated and/or authorized users to connect
through the ASA. (The Telnet server enforces authentication, too; the ASA prevents unauthorized users
from attempting to access the server.)
You can use authentication alone or with authorization and accounting. Authorization always requires a
user to be authenticated first. You can use accounting alone, or with authentication and authorization.
This section includes the following topics:
•

Information About Authentication, page 35-2

•

Information About Authorization, page 35-2

•

Information About Accounting, page 35-3

•

Summary of Server Support, page 35-3

•

RADIUS Server Support, page 35-4

•

TACACS+ Server Support, page 35-5

Cisco ASA 5500 Series Configuration Guide using the CLI

35-1

Chapter 35

Configuring AAA Servers and the Local Database

Information About AAA

•

RSA/SDI Server Support, page 35-5

•

NT Server Support, page 35-6

•

Kerberos Server Support, page 35-6

•

LDAP Server Support, page 35-6

•

Local Database Support, Including as a Falback Method, page 35-8

•

How Fallback Works with Multiple Servers in a Group, page 35-8

•

Using Certificates and User Login Credentials, page 35-9

•

Task Flow for Configuring AAA, page 35-11

Information About Authentication
Authentication controls access by requiring valid user credentials, which are usually a username and
password. You can configure the ASA to authenticate the following items:
•

All administrative connections to the ASA, including the following sessions:
– Telnet
– SSH
– Serial console
– ASDM using HTTPS
– VPN management access

•

The enable command

•

Network access

•

VPN access

Information About Authorization
Authorization controls access per user after users are authenticated. You can configure the ASA to
authorize the following items:
•

Management commands

•

Network access

•

VPN access

Authorization controls the services and commands that are available to each authenticated user. If you
did not enable authorization, authentication alone would provide the same access to services for all
authenticated users.
If you need the control that authorization provides, you can configure a broad authentication rule, and
then have a detailed authorization configuration. For example, you can authenticate inside users who try
to access any server on the outside network and then limit the outside servers that a particular user can
access using authorization.
The ASA caches the first 16 authorization requests per user, so if the user accesses the same services
during the current authentication session, the ASA does not resend the request to the authorization
server.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-2

Chapter 35

Configuring AAA Servers and the Local Database
Information About AAA

Information About Accounting
Accounting tracks traffic that passes through the ASA, enabling you to have a record of user activity. If
you enable authentication for that traffic, you can account for traffic per user. If you do not authenticate
the traffic, you can account for traffic per IP address. Accounting information includes session start and
stop times, username, the number of bytes that pass through the ASA for the session, the service used,
and the duration of each session.

Summary of Server Support
Table 35-1 summarizes the support for each AAA service by each AAA server type, including the local
database. For more information about support for a specific AAA server type, see the topics following
the table.
Table 35-1

Summary of AAA Support

Database Type
AAA Service

Local RADIUS

TACACS+

SDI (RSA) NT

Kerberos

LDAP

HTTP Form

VPN users1

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes2

Firewall sessions

Yes

Yes

Yes

Yes

Yes

Yes

Yes

No

Administrators

Yes

Yes

Yes

Yes3

Yes

Yes

Yes

No

Yes

Yes

No

No

No

No

Yes

No

Yes

No

No

No

No

No

No

Yes

No

No

No

No

No

Yes

No

No

No

No

No

Yes

No

No

No

No

No

Yes

No

No

No

No

No

Authentication of...

Authorization of...

VPN users
Firewall sessions
Administrators

No
Yes

Yes
5

4

Accounting of...

VPN connections

No

Yes

Firewall sessions

No

Yes

Administrators

No

Yes

6

1. For SSL VPN connections, either PAP or MS-CHAPv2 can be used.
2. HTTP Form protocol supports both authentication and single sign-on operations for clientless SSL VPN users sessions only.
3. RSA/SDI is supported for ASDM HTTP administrative access with ASA 5500 software version 8.2(1) or later.
4. For firewall sessions, RADIUS authorization is supported with user-specific access lists only, which are received or specified
in a RADIUS authentication response.
5. Local command authorization is supported by privilege level only.
6. Command accounting is available for TACACS+ only.

Note

In addition to the native protocol authentication listed in Table 35-1, the ASA supports proxying
authentication. For example, the ASA can proxy to an RSA/SDI and/or LDAP server via a RADIUS
server. Authentication via digital certificates and/or digital certificates with the AAA combinations
listed in the table are also supported.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-3

Chapter 35

Configuring AAA Servers and the Local Database

Information About AAA

RADIUS Server Support
The ASA supports the following RFC-compliant RADIUS servers for AAA:
•

Cisco Secure ACS 3.2, 4.0, 4.1, 4.2, and 5.x

•

Cisco Identity Services Engine (ISE)

•

RSA RADIUS in RSA Authentication Manager 5.2, 6.1, and 7.x

•

Microsoft

Authentication Methods
The ASA supports the following authentication methods with RADIUS:

Note

•

PAP—For all connection types.

•

CHAP and MS-CHAPv1—For L2TP-over-IPsec connections.

•

MS-CHAPv2—For L2TP-over-IPsec connections, and for regular IPsec remote access connections
when the password management feature is enabled. You can also use MS-CHAPv2 with clientless
connections.

•

Authentication Proxy modes—Including RADIUS to Active Directory, RADIUS to RSA/SDI,
RADIUS to Token-server, and RSA/SDI to RADIUS connections,

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.

Attribute Support
The ASA supports the following sets of RADIUS attributes:
•

Authentication attributes defined in RFC 2138.

•

Accounting attributes defined in RFC 2139.

•

RADIUS attributes for tunneled protocol support, defined in RFC 2868.

•

Cisco IOS Vendor-Specific Attributes (VSAs), identified by RADIUS vendor ID 9.

•

Cisco VPN-related VSAs, identified by RADIUS vendor ID 3076.

•

Microsoft VSAs, defined in RFC 2548.

•

Cisco VSA (Cisco-Priv-Level), which provides a standard 0-15 numeric ranking of privileges, with
1 being the lowest level and 15 being the highest level. A zero level indicates no privileges. The first
level (login) allows privileged EXEC access for the commands available at this level. The second
level (enable) allows CLI configuration privileges.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-4

Chapter 35

Configuring AAA Servers and the Local Database
Information About AAA

•

A list of attributes is available at the following URL:
http://www.cisco.com/en/US/docs/security/asa/asa84/configuration/guide/ref_extserver.html#wp1
605508

RADIUS Authorization Functions
The ASA can use RADIUS servers for user authorization of VPN remote access and firewall
cut-through-proxy sessions using dynamic access lists or access list names per user. To implement
dynamic access lists, you must configure the RADIUS server to support it. When the user authenticates,
the RADIUS server sends a downloadable access list or access list name to the ASA. Access to a given
service is either permitted or denied by the access list. The ASA deletes the access list when the
authentication session expires.
In addtition to access lists, the ASA supports many other attributes for authorization and setting of
permissions for VPN remote access and firewall cut-through proxy sessions. For a complete list of
authorization attributes, see the following URL:
http://www.cisco.com/en/US/docs/security/asa/asa84/configuration/guide/ref_extserver.html#wp16055
08

TACACS+ Server Support
The ASA supports TACACS+ authentication with ASCII, PAP, CHAP, and MS-CHAPv1.

RSA/SDI Server Support
The RSA SecureID servers are also known as SDI servers.
This section includes the following topics:
•

RSA/SDI Version Support, page 35-5

•

Two-step Authentication Process, page 35-5

•

RSA/SDI Primary and Replica Servers, page 35-6

RSA/SDI Version Support
The ASA supports SDI Versions 5.x, 6.x, and 7.x. SDI uses the concepts of an SDI primary and SDI
replica servers. Each primary and its replicas share a single node secret file. The node secret file has its
name based on the hexadecimal value of the ACE or Server IP address, with .sdi appended.
A version 5.x, 6.x, or 7.x SDI server that you configure on the ASA can be either the primary or any one
of the replicas. See the “RSA/SDI Primary and Replica Servers” section on page 35-6 for information
about how the SDI agent selects servers to authenticate users.

Two-step Authentication Process
SDI Versions 5.x, 6.x, or 7.x use a two-step process to prevent an intruder from capturing information
from an RSA SecurID authentication request and using it to authenticate to another server. The agent
first sends a lock request to the SecurID server before sending the user authentication request. The server

Cisco ASA 5500 Series Configuration Guide using the CLI

35-5

Chapter 35

Configuring AAA Servers and the Local Database

Information About AAA

locks the username, preventing another (replica) server from accepting it. This actions means that the
same user cannot authenticate to two ASAs using the same authentication servers simultaneously. After
a successful username lock, the ASA sends the passcode.

RSA/SDI Primary and Replica Servers
The ASA obtains the server list when the first user authenticates to the configured server, which can be
either a primary or a replica. The ASA then assigns priorities to each of the servers on the list, and
subsequent server selection is derived at random from those assigned priorities. The highest priority
servers have a higher likelihood of being selected.

NT Server Support
The ASA supports Microsoft Windows server operating systems that support NTLM Version 1,
collectively referred to as NT servers.

Note

NT servers have a maximum length of 14 characters for user passwords. Longer passwords are truncated,
which is a limitation of NTLM Version 1.

Kerberos Server Support
The ASA supports 3DES, DES, and RC4 encryption types.

Note

The ASA does not support changing user passwords during tunnel negotiation. To avoid this situation
happening inadvertently, disable password expiration on the Kerberos/Active Directory server for users
connecting to the ASA.
For a simple Kerberos server configuration example, see Example 35-2 on page 35-16.

LDAP Server Support
The ASA supports LDAP. This section includes the following topics:
•

Authentication with LDAP, page 35-6

•

LDAP Server Types, page 35-7

Authentication with LDAP
During authentication, the ASA acts as a client proxy to the LDAP server for the user, and authenticates
to the LDAP server in either plain text or by using the SASL protocol. By default, the ASA passes
authentication parameters, usually a username and password, to the LDAP server in plain text.
The ASA supports the following SASL mechanisms, listed in order of increasing strength:
•

Digest-MD5—The ASA responds to the LDAP server with an MD5 value computed from the
username and password.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-6

Chapter 35

Configuring AAA Servers and the Local Database
Information About AAA

•

Kerberos—The ASA responds to the LDAP server by sending the username and realm using the
GSSAPI Kerberos mechanism.

You can configure the ASA and LDAP server to support 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 mechanism 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 mechanisms.
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. Thus, using LDAP accomplishes authentication and authorization in a single
step.

LDAP Server Types
The ASA supports LDAP version 3 and is compatible with the Sun Microsystems JAVA System
Directory Server (formerly named the Sun ONE Directory Server), the Microsoft Active Directory,
Novell, OpenLDAP, and other LDAPv3 directory servers.
By default, the ASA auto-detects whether it is connected to Microsoft Active Directory, Sun LDAP,
Novell, OpenLDAP, or a generic LDAPv3 directory server. However, if auto-detection 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.
When configuring the server type, note the following 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 ASA uses the Login Distinguished Name (DN) and Login Password to establish a trust
relationship (bind) with an LDAP server. For more information, see the “Binding the ASA to the
LDAP Server” section on page C-4.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-7

Chapter 35

Configuring AAA Servers and the Local Database

Information About AAA

HTTP Forms Authentication for Clientless SSL VPN
The ASA can use the HTTP Form protocol for both authentication and single sign-on (SSO) operations
of Clientless SSL VPN user sessions only. For configuration information, see the “Using Single Sign-on
with Clientless SSL VPN” section on page 74-13.

Local Database Support, Including as a Falback Method
The ASA maintains a local database that you can populate with user profiles.
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.
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.

•

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.

How Fallback Works with Multiple Servers in a Group
If you configure multiple servers in a server group and you enable fallback to the local database for the
server group, fallback occurs when no server in the group responds to the authentication request from
the ASA. To illustrate, consider this scenario:
You configure an LDAP server group with two Active Directory servers, server 1 and server 2, in that
order. When the remote user logs in, the ASA attempts to authenticate to server 1.
If server 1 responds with an authentication failure (such as user not found), the ASA does not attempt to
authenticate to server 2.
If server 1 does not respond within the timeout period (or the number of authentication attempts exceeds
the configured maximum), the ASA tries server 2.
If both servers in the group do not respond, and the ASA is configured to fall back to the local database,
the ASA tries to authenticate to the local database.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-8

Chapter 35

Configuring AAA Servers and the Local Database
Information About AAA

Using Certificates and User Login Credentials
The following section describes the different methods of using certificates and user login credentials
(username and password) for authentication and authorization. These methods apply to IPsec,
AnyConnect, and Clientless SSL VPN.
In all cases, LDAP authorization does not use the password as a credential. RADIUS authorization uses
either a common password for all users or the username as a password.
This section includes the following topics:
•

Using User Login Credentials, page 35-9

•

Using Certificates, page 35-9

Using User Login Credentials
The default method for authentication and authorization uses the user login credentials.
•

Authentication
– Enabled by the authentication server group setting in the tunnel group (also called ASDM

Connection Profile)
– Uses the username and password as credentials
•

Authorization
– Enabled by the authorization server group setting in the tunnel group (also called ASDM

Connection Profile)
– Uses the username as a credential

Using 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.
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

Cisco ASA 5500 Series Configuration Guide using the CLI

35-9

Chapter 35

Configuring AAA Servers and the Local Database

Licensing Requirements for AAA Servers

– 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;ea=anyuser@example.com

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 anyuser@example.com.

Licensing Requirements for AAA Servers
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines

The username command has two versions: one for 8.4(3) and earlier and one for 8.4(4.1) and later. See
the command reference for more information.

Configuring AAA
This section includes the following topics:
•

Configuring AAA Server Groups, page 35-11

•

Configuring Authorization with LDAP for VPN, page 35-16

•

Configuring LDAP Attribute Maps, page 35-18

•

Adding a User Account to the Local Database, page 35-20

Cisco ASA 5500 Series Configuration Guide using the CLI

35-10

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

•

Managing User Passwords, page 35-25

•

.Changing User Passwords, page 35-27

•

Authenticating Users with a Public Key for SSH, page 35-28

•

Differentiating User Roles Using AAA, page 35-28

Task Flow for Configuring AAA
Step 1

Do one or both of the following:
•

Add a AAA server group. See the “Configuring AAA Server Groups” section on page 35-11.

•

Add a user to the local database. See the “Adding a User Account to the Local Database” section on
page 35-20.

Step 2

(Optional) Configure authorization from an LDAP server that is separate and distinct from the
authentication mechanism. See the “Configuring Authorization with LDAP for VPN” section on
page 35-16.

Step 3

For an LDAP server, configure LDAP attribute maps. See the “Configuring LDAP Attribute Maps”
section on page 35-18.

Step 4

For an administrator, specify the password policy attributes for users. See the “Managing User
Passwords” section on page 35-25.

Step 5

(Optional) Users can change their own passwords. See the “.Changing User Passwords” section on
page 35-27.

Step 6

(Optional) Users can authenticate with a public key. See the “Authenticating Users with a Public Key for
SSH” section on page 35-28.

Step 7

(Optional) Distinguish between administrative and remote-access users when they authenticate. See the
“Differentiating User Roles Using AAA” section on page 35-28.

Configuring AAA Server Groups
If you want to use an external AAA server for authentication, authorization, or accounting, you must first
create at least one AAA server group per AAA protocol and add one or more servers to each group. You
identify AAA server groups by name. Each server group is specific to one type of server: Kerberos,
LDAP, NT, RADIUS, SDI, or TACACS+.

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.

•

When a user logs in, the servers are accessed one at a time, starting with the first server 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 AAA servers.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-11

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

Detailed Steps

Step 1

Command

Purpose

aaa-server server_tag protocol {kerberos | ldap |
nt | radius | sdi | tacacs+}

Identifies the server group name and the protocol. For
example, to use RADIUS to authenticate network access
and TACACS+ to authenticate CLI access, you need to
create at least two server groups, one for RADIUS
servers and one for TACACS+ servers.

Example:
hostname(config)# aaa-server servergroup1
protocol ldap
hostname(config-aaa-server-group)#
hostname(config)# aaa-server servergroup1
protocol radius
hostname(config-aaa-server-group)#
interim-accounting-update
hostname(config)# aaa-server servergroup1
protocol radius
hostname(config-aaa-server-group)# ad-agent-mode

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 15 servers in single mode or 4 servers in
multiple mode.
When you enter the aaa-server protocol command, you
enter aaa-server group configuration mode.
The interim-accounting-update option enables
multi-session accounting for clientless SSL and
AnyConnect sessions. If you choose this option, interim
accounting records are sent to the RADIUS server in
addition to the start and stop records.
Tip

Choose this option if users have trouble
completing a VPN connection using clean access
SSO, which might occur when making clientless
or AnyConnect connections directly to the ASA.

The ad-agent-mode option specifies the shared secret
between the ASA and the AD agent, and indicates that a
RADIUS server group includes AD agents that are not
full-function RADIUS servers. Only a RADIUS server
group that has been configured using the ad-agent-mode
option can be associated with user identity. As a result,
the test aaa-server {authentication | authorization}
aaa-server-group command is not available when a
RADIUS server group that is not configured using the
ad-agent-mode option is specified.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-12

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

Step 2

Command

Purpose

merge-dacl {before-avpair | after-avpair}

Merges a downloadable ACL with the ACL received in
the Cisco AV pair from a RADIUS packet. 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.

Example:
hostname(config)# aaa-server servergroup1
protocol radius
hostname(config-aaa-server-group)# merge-dacl
before-avpair

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

max-failed-attempts number

Example:
hostname(config-aaa-server-group)#
max-failed-attempts 2

Specifies the maximum number of requests sent to a
AAA server in the group before trying the next server.
The number argument can range from 1 and 5. The
default is 3.
If you configured a fallback method using the local
database (for management access only; see the
“Configuring Local Command Authorization” section on
page 37-23 and the “Configuring TACACS+ Command
Authorization” section on page 37-29 to configure the
fallback mechanism), and all the servers in the group fail
to respond, then the group is considered to be
unresponsive, and the fallback method is tried. The
server group remains marked as unresponsive for a
period of 10 minutes (by default), so that additional AAA
requests within that period do not attempt to contact the
server group, and the fallback method is used
immediately. To change the unresponsive period from the
default, see the reactivation-mode command in the next
step.
If you do not have a fallback method, the ASA continues
to retry the servers in the group.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-13

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

Step 4

Command

Purpose

reactivation-mode {depletion [deadtime minutes] |
timed}

Specifies the method (reactivation policy) by which
failed servers in a group are reactivated.
The depletion keyword reactivates failed servers only
after all of the servers in the group are inactive.

Example:
hostname(config-aaa-server-group)#
reactivation-mode deadtime 20

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 5

accounting-mode simultaneous

Sends accounting messages to all servers in the group
(RADIUS or TACACS+ only).

Example:

To restore the default of sending messages only to the
active server, enter the accounting-mode single
command.

hostname(config-aaa-server-group)#
accounting-mode simultaneous

Step 6

Identifies the server and the AAA server group to which
it belongs.

aaa-server server_group [interface_name] host
server_ip

Example:
hostname(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 commands in host configuration mode do not apply
to all AAA server types. Table 35-2 lists the available
commands, the server types to which they apply, and
whether or not a new AAA server definition has a default
value for that command. Where a command is applicable
to the specified server type and no default value is
provided (indicated by “—”), use the command to
specify the value.

Table 35-2

Host Mode Commands, Server Types, and Defaults

Command

Applicable AAA Server Types Default Value

accounting-port

RADIUS

1646

acl-netmask-convert

RADIUS

standard

authentication-port

RADIUS

1645

kerberos-realm

Kerberos

—

key

RADIUS

—

TACACS+

—

ldap-attribute-map

LDAP

—

ldap-base-dn

LDAP

—

ldap-login-dn

LDAP

—

Cisco ASA 5500 Series Configuration Guide using the CLI

35-14

Description

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

Table 35-2

Host Mode Commands, Server Types, and Defaults (continued)

Command

Applicable AAA Server Types Default Value

ldap-login-password

LDAP

—

ldap-naming-attribute

LDAP

—

ldap-over-ssl

LDAP

636

ldap-scope

LDAP

—

mschapv2-capable

RADIUS

enabled

Description

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.

nt-auth-domain-controller NT

—

radius-common-pw

RADIUS

—

retry-interval

Kerberos

10 seconds

RADIUS

10 seconds

SDI

10 seconds

sasl-mechanism

LDAP

—

server-port

Kerberos

88

LDAP

389

NT

139

SDI

5500

TACACS+

49

server-type

LDAP

auto-discovery If auto-detection 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

All

10 seconds

Examples
Example 35-1 shows how to add one TACACS+ group with one primary and one backup server, one
RADIUS group with a single server, and an NT domain server.
Example 35-1 Multiple AAA Server Groups and Servers
hostname(config)# aaa-server AuthInbound protocol tacacs+
hostname(config-aaa-server-group)# max-failed-attempts 2
hostname(config-aaa-server-group)# reactivation-mode depletion deadtime 20
hostname(config-aaa-server-group)# exit
hostname(config)# aaa-server AuthInbound (inside) host 10.1.1.1
hostname(config-aaa-server-host)# key TACPlusUauthKey
hostname(config-aaa-server-host)# exit
hostname(config)# aaa-server AuthInbound (inside) host 10.1.1.2
hostname(config-aaa-server-host)# key TACPlusUauthKey2
hostname(config-aaa-server-host)# exit

Cisco ASA 5500 Series Configuration Guide using the CLI

35-15

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

hostname(config)# aaa-server AuthOutbound protocol radius
hostname(config-aaa-server-group)# exit
hostname(config)# aaa-server AuthOutbound (inside) host 10.1.1.3
hostname(config-aaa-server-host)# key RadUauthKey
hostname(config-aaa-server-host)# exit
hostname(config)# aaa-server NTAuth protocol nt
hostname(config-aaa-server-group)# exit
hostname(config)# aaa-server NTAuth (inside) host 10.1.1.4
hostname(config-aaa-server-host)# nt-auth-domain-controller primary1
hostname(config-aaa-server-host)# exit

Example 35-2 shows how to configure a Kerberos AAA server group named watchdogs, add a AAA
server to the group, and define the Kerberos realm for the server. Because Example 35-2 does not define
a retry interval or the port that the Kerberos server listens to, the ASA uses the default values for these
two server-specific parameters. Table 35-2 lists the default values for all AAA server host mode
commands.

Note

Kerberos realm names use numbers and upper-case letters only. Although the ASA accepts lower-case
letters for a realm name, it does not translate lower-case letters to upper-case letters. Be sure to use
upper-case letters only.
Example 35-2 Kerberos Server Group and Server
hostname(config)# aaa-server watchdogs protocol kerberos
hostname(config-aaa-server-group)# aaa-server watchdogs host 192.168.3.4
hostname(config-aaa-server-host)# kerberos-realm EXAMPLE.COM
hostname(config-aaa-server-host)# exit
hostname(config)#

Configuring Authorization with LDAP for VPN
When user LDAP authentication for VPN access has succeeded, the ASA queries the LDAP server which
returns LDAP attributes. These attributes generally include authorization data that applies to the VPN
session. Thus, using LDAP accomplishes authentication and authorization in a single step.
There may be cases, however, where you require authorization from an LDAP directory server that is
separate and distinct from the authentication mechanism. For example, if you use an SDI or certificate
server for authentication, no authorization information is passed back. For user authorizations in this
case, you can query an LDAP directory after successful authentication, accomplishing authentication
and authorization in two steps.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-16

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

To set up VPN user authorization using LDAP, perform the following steps.

Detailed Steps

Step 1

Command

Purpose

aaa-server server_group protocol {kerberos | ldap | nt |
radius | sdi | tacacs+}

Creates a AAA server group.

Example:
hostname(config)# aaa-server servergroup1 protocol
ldap
hostname(config-aaa-server-group)

Step 2

tunnel-group groupname

Creates an IPsec remote access tunnel group named
remotegrp.

Example:
hostname(config)# tunnel-group remotegrp

Step 3

tunnel-group groupname general-attributes

Associates the server group and the tunnel group.

Example:
hostname(config)# tunnel-group remotegrp
general-attributes

Step 4

Assigns a new tunnel group to a previously created
AAA server group for authorization.

authorization-server-group group-tag

Example:
hostname(config-general)# authorization-server-group
ldap_dir_1

Examples
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:
hostname(config)# tunnel-group remote-1 type ipsec-ra
hostname(config)# tunnel-group remote-1 general-attributes
hostname(config-general)# authorization-server-group ldap_dir_1
hostname(config-general)#

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:
hostname(config)# aaa-server ldap_dir_1 protocol ldap
hostname(config-aaa-server-group)# aaa-server ldap_dir_1 host 10.1.1.4
hostname(config-aaa-server-host)# ldap-login-dn obscurepassword
hostname(config-aaa-server-host)# ldap-base-dn starthere
hostname(config-aaa-server-host)# ldap-scope subtree
hostname(config-aaa-server-host)#

Cisco ASA 5500 Series Configuration Guide using the CLI

35-17

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

Configuring LDAP Attribute Maps
The ASA can use an LDAP directory for authenticating VPN remote access users or firewall network
access/cut-thru-proxy sessions and/or for setting policy permissions (also called authorization
attributes), such as ACLs, bookmark lists, DNS or WINS settings, session timers, and so on. That is, you
can set the key attributes that exist in a local group policy externally through an LDAP server.
The authorization process is accomplished by means of LDAP attribute maps (similar to a RADIUS
dictionary that defines vendor-specific attributes), which translate the native LDAP user attributes to
Cisco ASA attribute names. You can then bind these attribute maps to LDAP servers or remove them, as
needed. You can also show or clear attribute maps.

Guidelines
The ldap-attribute-map has a limitation with multi-valued attributes. For example, if a user is a
memberOf of several AD groups and the ldap attribute map matches on more than one of them, the
mapped value is chosen based on the alphabetization of the matched entries.
To use the attribute mapping features correctly, you need to understand Cisco LDAP attribute names and
values, as well as the user-defined attribute names and values. For more information about LDAP
attribute maps, see the “Active Directory/LDAP VPN Remote Access Authorization Examples” section
on page C-16.
The names of frequently mapped Cisco 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’s 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—An access control list or ACL applied 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 ldapattribute map may contain one or many attributes. You can only assign one ldap
attribute to a specific LDAP server.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-18

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

To map LDAP features correctly, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

ldap attribute-map map-name

Creates an unpopulated LDAP attribute map table.

Example:
hostname(config)# ldap attribute-map
att_map_1

Step 2

map-name user-attribute-name
Cisco-attribute-name

Maps the user-defined attribute name department to the Cisco
attribute.

Example:
hostname(config-ldap-attribute-map)#
map-name department IETF-Radius-Class

Step 3

map-value user-attribute-name
Cisco-attribute-name

Maps the user-defined map value department to the user-defined
attribute value and the Cisco attribute value.

Example:
hostname(config-ldap-attribute-map)#
map-value department Engineering group1

Step 4

aaa-server server_group [interface_name]
host server_ip

Identifies the server and the AAA server group to which it
belongs.

Example:
hostname(config)# aaa-server ldap_dir_1
host 10.1.1.4

Step 5

ldap-attribute-map map-name

Binds the attribute map to the LDAP server.

Example:
hostname(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 has three possible values:
•

VPN

•

admin

•

helpdesk

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:
hostname(config)# ldap attribute-map
hostname(config-ldap-attribute-map)#
hostname(config-ldap-attribute-map)#
hostname(config-ldap-attribute-map)#

MGMT
map-name accessType IETF-Radius-Service-Type
map-value accessType VPN 5
map-value accessType admin 6

Cisco ASA 5500 Series Configuration Guide using the CLI

35-19

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

hostname(config-ldap-attribute-map)# map-value accessType helpdesk 7
hostname(config-ldap-attribute-map)# aaa-server LDAP protocol ldap
hostname(config-aaa-server-group)# aaa-server LDAP (inside) host 10.1.254.91
hostname(config-aaa-server-host)# ldap-base-dn CN=Users,DC=cisco,DC=local
hostname(config-aaa-server-host)# ldap-scope subtree
hostname(config-aaa-server-host)# ldap-login-password test
hostname(config-aaa-server-host)# ldap-login-dn
CN=Administrator,CN=Users,DC=cisco,DC=local
hostname(config-aaa-server-host)# server-type auto-detect
hostname(config-aaa-server-host)# ldap-attribute-map MGMT

The following example shows how to display the complete list of Cisco LDAP attribute names:
hostname(config)# ldap attribute-map att_map_1
hostname(config-ldap-attribute-map)# map-name att_map_1?
ldap mode commands/options:
cisco-attribute-names:
Access-Hours
Allow-Network-Extension-Mode
Auth-Service-Type
Authenticated-User-Idle-Timeout
Authorization-Required
Authorization-Type
:
:
X509-Cert-Data
hostname(config-ldap-attribute-map)#

Adding a User Account to the Local Database
This section describes how to manage users in the local database and includes the following topics:

Guidelines
The local database is used for the following features:
•

ASDM per-user access

•

Console authentication

•

Telnet and SSH authentication.

•

enable command authentication
This setting is for CLI-access only and does not affect the ASDM login.

•

Command authorization
If you turn on command authorization using the local database, then the ASA refers to the user
privilege level to determine which commands are available. Otherwise, the privilege level is not
generally used. By default, all commands are either privilege level 0 or level 15.

•

Network access authentication

•

VPN client authentication

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-20

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

Limitations
You cannot use the local database for network access authorization.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-21

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

To add a user to the local database, perform the following steps:

Detailed Steps

Cisco ASA 5500 Series Configuration Guide using the CLI

35-22

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

Step 1

Command

Purpose

username username {nopassword | password
password [mschap]} [privilege priv_level]

Creates the user account. The username username keyword is a
string from 4 to 64 characters long.
Note

Example:
hostname(config)# username exampleuser1
privilege 1

The ASA does not prohibit the creation of usernames that
only differ by case with previously configured usernames.
We do not recommend this practice if VPN users are
authenticated using the local user database. Usernames
such as “User1” and “user1” are still distinct for
authentication purposes, but if a maximum simultaneous
login limit has been configured, these users share the same
session count. This makes it possible for “user1” to log off
“User1” by establishing a tunnel that exceeds the
simultaneous login limit.

The password password argument is a string from 3 to 32
characters long. The mschap keyword specifies that the password
is converted to Unicode and hashed using MD4 after you enter it.
Use this keyword if users are authenticated using MS-CHAPv1 or
MS-CHAPv2. The privilege level argument 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.To limit access to privileged EXEC mode,
either set the privilege level to 0 or 1, or use the
service-type command (see Step 5).

The nopassword keyword creates a user account with no
password.
The encrypted and nt-encrypted keywords are typically for
display only. 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 or nt-encrypted keyword (when you
specify mschap). For example, if you enter the password “test,”
the show running-config output would appear as something
similar to the following:
username user1 password DLaUiAX3l78qgoB5c7iVNw==
nt-encrypted

The only time you would actually enter the encrypted or
nt-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.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-23

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

Step 2

Command

Purpose

aaa authorization exec
authentication-server

(Optional) Enforces user-specific access levels for users who
authenticate for management access (see the aaa authentication
console LOCAL command). This command enables management
authorization for local, RADIUS, LDAP (mapped), and
TACACS+ users.

Example:
hostname(config)# aaa authorization exec
authentication-server

Use the aaa authorization exec LOCAL command to enable
attributes to be taken from the local database. See the “Limiting
User CLI and ASDM Access with Management Authorization”
section on page 37-21 for information about configuring a user on
a AAA server to accommodate management authorization.
Note the following prerequisites for each user type:

Step 3

username username attributes

Example:
hostname(config)# username exampleuser1
attributes

Cisco ASA 5500 Series Configuration Guide using the CLI

35-24

•

Configure local database users at a privilege level from 0 to
15 using the username command. Configure the level of
access using the service-type command.

•

Configure RADIUS users with Cisco VSA
CVPN3000-Privilege-Level with a value between 0 and 15.

•

Configure LDAP users with a privilege level between 0 and
15, and then map the LDAP attribute to Cisco VAS
CVPN3000-Privilege-Level using the ldap map-attributes
command.

•

See the privilege command for information about setting
command privilege levels.

(Optional) Configures username attributes. The username
argument is the username that you created in Step 1.

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

Step 4

Command

Purpose

service-type {admin | nas-prompt |
remote-access}

(Optional) Configures the user level if you configured
management authorization in Step 2. The admin keyword allows
full access to any services specified by the aaa authentication
console LOCAL commands. The admin keyword is the default.

Example:
hostname(config-username)# service-type
admin

The nas-prompt keyword allows access to the CLI when you
configure the aaa authentication {telnet | ssh | serial} console
LOCAL command, but denies ASDM configuration access if you
configure the aaa authentication http console LOCAL
command. ASDM monitoring access is allowed. If you enable
authentication with the aaa authentication enable console
LOCAL command, the user cannot access privileged EXEC mode
using the enable command (or the login command).
The remote-access keyword denies management access. The user
cannot use any services specified by the aaa authentication
console LOCAL commands (excluding the serial keyword; serial
access is allowed).
(Optional) If you are using this username for VPN authentication,
you can configure many VPN attributes for the user. For more
information, see the “Configuring Attributes for Specific Users”
section on page 67-79.

Examples
The following example assigns a privilege level of 15 to the admin user account:
hostname(config)# username admin password password privilege 15

The following example creates a user account with no password:
hostname(config)# username user34 nopassword

The following example enables management authorization, creates a user account with a password,
enters username attributes configuration mode, and specifies the service-type attribute:
hostname(config)# aaa authorization exec authentication-server
hostname(config)# username user1 password gOgeOus
hostname(config)# username user1 attributes
hostname(config-username)# service-type nas-prompt

Managing User Passwords
The ASA enables administrators with the necessary privileges to modify password policy for users in
the current context.
User passwords have the following guidelines:
•

A maximum lifetime of 0 to 65536 days.

•

A minimum length of 3 to 64 characters.

•

A minimum number of changed characters for updates of 0 to 64 characters.

•

They may include lower case characters.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-25

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

•

They may include upper case characters.

•

They may include numbers.

•

They may include special characters.

To specify password policy for users, perform the following steps:

Step 1

Command

Purpose

password-policy lifetime value

Sets the password policy for the current context and
the interval in days after which passwords expire.
Valid values are between 0 and 65536 days. The
default value is 0 days.

Example:
hostname (config)# password-policy lifetime 1000

Step 2

password-policy minimum-changes value

Example:
hostname(config)# password-policy minimum-changes 4

Sets the minimum number of characters that must be
changed between new and old passwords. Valid
values are between 0 and 64 characters. The default
value is 0.
New passwords must include a minimum of 4
character changes from the current password and are
considered changed only if they do not appear
anywhere in the current password.

Step 3

password-policy minimum-length value

Example:

Step 4

hostname(config)# password-policy minimum-length 8

If the minimum length is less than the value of any
of the other minimum values (lowercase, numeric,
special, and uppercase), an error message appears
and the minimum length is not changed.

password-policy minimum-lowercase value

Sets the minimum number of lower case characters
that passwords may have. Valid values are between
0 and 64 characters. The default value is 0, which
means there is no minimum.

Example:
hostname(config)# password-policy minimum-lowercase
6

Step 5

password-policy minimum-numeric value

Example:
hostname(config)# password-policy minimum-numeric 1

Step 6

password-policy minimum-special value

Example:
hostname(config)# password-policy minimum-special 2

Cisco ASA 5500 Series Configuration Guide using the CLI

35-26

Sets the minimum length of passwords. Valid values
are between 3 and 64 characters. The recommended
minimum password length is 8 characters.

Sets the minimum number of numeric characters
that passwords may have. Valid values are between
0 and 64 characters. The default value is 0, which
means there is no minimum.
Sets the minimum number of special characters that
passwords may have. 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.

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

Step 7

Command

Purpose

password-policy minimum-uppercase value

Sets the minimum number of upper case characters
that passwords may have. Valid values are between
0 and 64 characters. The default value is 0, which
means there is no minimum.

Example:
hostname(config)# password-policy minimum-uppercase
3

Step 8

password-policy authenticate enable

(Optional) Determines whether or not users are
allowed to modify their own user account.

Example:

If authentication is enabled, users cannot change
their own password or delete their own account with
the username command or with the clear configure
username command.

hostname(config)# password-policy authenticate
enable

.

Changing User Passwords
The ASA enables administrators with the necessary privileges to modify passwords for users in the
current context. Users must authenticate with their current passwords before they are allowed to change
passwords. However, authentication is not required when an administrator is changing a user password.
To enable users to change their own account passwords, enter the following command:

Command

Purpose

change-password [old-password old-password
[new-password new-password]]

Enables users to change their own account passwords. The
new-password new-password keyword-argument pair
specifies the new password. The old-password old-password
keyword-argument pair specifies the old password, which
reauthenticates the user. If users omit the passwords, the ASA
prompts them for input. When users enter the
change-password command, they are asked to save their
running configuration.

Example:
hostname# change-password old-password
myoldpassword000 new password mynewpassword123

Cisco ASA 5500 Series Configuration Guide using the CLI

35-27

Chapter 35

Configuring AAA Servers and the Local Database

Configuring AAA

Authenticating Users with a Public Key for SSH
Users can authenticate with a public key for SSH. The public key can be hashed or not hashed.
To authenticate with a public key for SSH, enter the following command:
Command

Purpose

username {user} attributes ssh authentication
publickey key [hashed]

Enables public key authentication on a per-user basis. The
value of the key argument can be one of the following:
•

When the key argument is supplied and the hashed tag is
not specified, the value of the key must be a Base 64
encoded public key that is generated by SSH key
generation software that can generate SSH-RSA raw keys
(that is, with no certificates). After you submit the Base
64 encoded public key, that key is then hashed via
SHA-256 and the corresponding 32-byte hash is used for
all further comparisons.

•

When the key argument is supplied and the hashed tag is
specified, the value of the key must have been previously
hashed with SHA-256 and be 32 bytes long, with each
byte separated by a colon (for parsing purposes).

Example:
hostname(config)# username anyuser ssh authentication
publickey key [hashed]

When you save the configuration, the hashed key value is
saved to the configuration and used when the ASA is
rebooted.

Differentiating User Roles Using AAA
The ASA enables you to distinguish between administrative and remote-access users when they
authenticate using RADIUS, LDAP, TACACS+, or the local user database. User role differentiation can
prevent remote access VPN and network access users from establishing an administrative connection to
the ASA.
To differentiate user roles, use the service-type attribute in username configuration mode. For RADIUS
and LDAP (with the ldap-attribute-map command), you can use a Cisco Vendor-Specific Attribute
(VSA), Cisco-Priv-Level, to assign a privilege level to an authenticated user.
This section includes the following topics:
•

Using Local Authentication, page 35-28

•

Using RADIUS Authentication, page 35-29

•

Using LDAP Authentication, page 35-29

•

Using TACACS+ Authentication, page 35-30

Using Local Authentication
Before you configure the service-type attribute and privilege level when using local authentication, you
must create a user, assign a password, and assign a privilege level.
To do so, enter the following command:
hostname(config)# username admin password mysecret123 privilege 15

Cisco ASA 5500 Series Configuration Guide using the CLI

35-28

Chapter 35

Configuring AAA Servers and the Local Database
Configuring AAA

Where mysecret123 is the stored password and 15 is the assigned privilege level, which indicates an
admin user.
The available configuration options for the service-type attribute include the following:
•

admin, in which users are allowed access to the configuration mode. This option also allows a user
to connect via remote access.

•

nas-prompt, in which users are allowed access to the EXEC mode.

•

remote-access, in which users are allowed access to the network.

The following example designates a service-type of admin for a user named admin:
hostname(config)# username admin attributes
hostname(config-username)# service-type admin

The following example designates a service-type of remote-access for a user named ra-user:
hostname(config)# username ra-user attributes
hostname(config-username)# service-type remote-access

Using RADIUS Authentication
The RADIUS IETF service-type attribute, when sent in an access-accept message as the result of a
RADIUS authentication and authorization request, is used to designate which type of service is granted
to the authenticated user. The supported attribute values are the following: administrative(6),
nas-prompt(7), Framed(2), and Login(1). For a list of supported RADIUS IETF VSAs used for
authentication and authorization, see Table C-8 on page C-36.
For more information about using RADIUS authentication, see “Configuring an External RADIUS
Server” section on page C-27. For more information about configuring RADIUS authentication for
Cisco Secure ACS, see the Cisco Secure ACS documentation on Cisco.com.
The RADIUS Cisco VSA privilege-level attribute (Vendor ID 3076, sub-ID 220), when sent in an
access-accept message, is used to designate the level of privilege for the user. For a list of supported
RADIUS VSAs used for authorization, see Table C-7 on page C-28.

Using LDAP Authentication
When users are authenticated through LDAP, the native LDAP attributes and their values can be mapped
to Cisco ASA attributes to provide specific authorization features. For the supported list of LDAP VSAs
used for authorization, see Table C-2 on page C-6.
You can use the LDAP attribute mapping feature for LDAP authorization. For examples of this feature,
see the “Understanding Policy Enforcement of Permissions and Attributes” section on page C-1.
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.
To define an LDAP attribute map, enter the following commands:
hostname(config)# ldap attribute-map admin-control
hostname(config-ldap-attribute-map)# map-name title IETF-RADIUS-Service-Type
hostname(config-ldap-attribute-map)# map-name company Privilege-Level

The following is sample output from the ldap-attribute-map command:
ldap attribute-map admin-control

Cisco ASA 5500 Series Configuration Guide using the CLI

35-29

Chapter 35

Configuring AAA Servers and the Local Database

Monitoring AAA Servers

map-name company Privilege-Level
map-name title IETF-Radius-Service-Type

To apply the LDAP attribute map to the LDAP AAA server, enter the following commands:
hostname(config)# aaa-server ldap-server (dmz1) host 10.20.30.1
hostname(config-aaa-server-host)# ldap-attribute-map admin-control

Note

When an authenticated user tries administrative access to the ASA through ASDM, SSH, or Telnet, but
does not have the appropriate privilege level to do so, the ASA generates syslog message 113021. This
message informs the user that the attempted login failed because of inappropriate administrative
privileges.

Using TACACS+ Authentication
For information about how to configure TACACS+ authentication, see the “RADIUS Accounting
Disconnect Reason Codes” section on page C-37.

Monitoring AAA Servers
To monitor AAA servers,enter one of the following commands:
Command

Purpose

show aaa-server

Shows the configured AAA server statistics.
To clear the AAA server configuration, enter the clear aaa-server
statistics command.

show running-config aaa-server

Shows the AAA server running configuration.
To clear AAA server statistics, enter the clear configure aaa-server
command.

show running-config all ldap attribute-map

Shows all LDAP attribute maps in the running configuration.
To clear all LDAP attribute maps in the running configuration, use the
clear configuration ldap attribute-map command.

show running-config zonelabs-integrity

Shows the Zone Labs Integrity server configuration.
To clear the Zone Labs Integrity server configuration, use the clear
configure zonelabs-integrity command.

show ad-groups name [filter string]

Applies only to AD servers using LDAP, and shows groups that are listed
on an AD server.

show running-config [all] password-policy

Shows the password policy for the current context.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-30

Chapter 35

Configuring AAA Servers and the Local Database
Additional References

Additional References
For additional information related to implementing LDAP mapping, see the “RFCs” section on
page 35-31.

RFCs
RFC

Title

2138

Remote Authentication Dial In User Service (RADIUS)

2139

RADIUS Accounting

2548

Microsoft Vendor-specific RADIUS Attributes

2868

RADIUS Attributes for Tunnel Protocol Support

Feature History for AAA Servers
Table 35-3 lists each feature change and the platform release in which it was implemented.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-31

Chapter 35

Configuring AAA Servers and the Local Database

Feature History for AAA Servers

Table 35-3

Feature History for AAA Servers

Feature Name

Platform
Releases

AAA Servers

7.0(1)

Feature Information
AAA Servers describe support for AAA and how to
configure AAA servers and the local database.
We introduced the following commands:
username, aaa authorization exec authentication-server,
aaa authentication console LOCAL, aaa authorization
exec LOCAL, service-type, ldap attribute-map,
aaa-server protocol, aaa authentication {telnet | ssh |
serial} console LOCAL, aaa authentication http console
LOCAL, aaa authentication enable console LOCAL,
max-failed-attempts, reactivation-mode,
accounting-mode simultaneous, aaa-server host,
authorization-server-group, tunnel-group, tunnel-group
general-attributes, map-name, map-value,
ldap-attribute-map, zonelabs-Integrity server-address,
zonelabs-integrity port, zonelabs-integrity interface,
zonelabs-integrity fail-timeout, zonelabs-integrity
fail-close, zonelabs-integrity fail-open,
zonelabs-integrity ssl-certificate-port,
zonelabs-integrity ssl-client-authentication {enable |
disable}, client-firewall {opt | req} zonelabs-integrity

8.4(3)
Key vendor-specific attributes (VSAs) sent in
RADIUS access request and accounting request
packets from the ASA

Four New VSAs—Tunnel Group Name (146) and Client
Type (150) are sent in RADIUS access request packets from
the ASA. Session Type (151) and Session Subtype (152) are
sent in RADIUS accounting request packets from the ASA.
All four attributes are sent for all accounting request packet
types: Start, Interim-Update, and Stop. The RADIUS server
(for example, ACS and ISE) can then enforce authorization
and policy attributes or use them for accounting and billing
purposes.

Common Criteria certification and FIPS support 8.4(4.1)
for password policy, password change, and SSH
public key authentication

We introduced or modified the following commands:
password-policy lifetime, password-policy minimum
changes, password-policy minimum-length,
password-policy minimum-lowercase, password-policy
minimum-uppercase, password-policy
minimum-numeric, password-policy minimum-special,
password-policy authenticate enable, username,
username attributes, clear configure username,
change-password, clear configure password-policy,
show running-config password-policy, and username.

Cisco ASA 5500 Series Configuration Guide using the CLI

35-32

CH A P T E R

36

Configuring the Identity Firewall
This chapter describes how to configure the ASA for the Identity Firewall. The chapter includes the
following sections:
•

Information About the Identity Firewall, page 1

•

Licensing for the Identity Firewall, page 8

•

Guidelines and Limitations, page 8

•

Prerequisites, page 9

•

Configuring the Identity Firewall, page 10

•

Monitoring the Identity Firewall, page 25

•

Feature History for the Identity Firewall, page 28

Information About the Identity Firewall
This section includes the following topics:
•

Overview of the Identity Firewall, page 1

•

Architecture for Identity Firewall Deployments, page 2

•

Features of the Identity Firewall, page 3

•

Deployment Scenarios, page 4

•

Cut-through Proxy and VPN Authentication, page 7

Overview of the Identity Firewall
In an enterprise, users often need access to one or more server resources. Typically, a firewall is not
aware of the users’ identities and, therefore, cannot apply security policies based on identity. To
configure per-user access policies, you must configure a user authentication proxy, which requires user
interaction (a user name/password query).
The Identity Firewall in the ASA provides more granular access control based on users’ identities. You
can configure access rules and security policies based on user names and user groups name rather than
through source IP addresses. The ASA applies the security policies based on an association of IP
addresses to Windows Active Directory login information and reports events based on the mapped user
names instead of network IP addresses.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-1

Chapter 36

Configuring the Identity Firewall

Information About the Identity Firewall

The Identity Firewall integrates with Microsoft Active Directory in conjunction with an external Active
Directory (AD) Agent that provides the actual identity mapping. The ASA uses Windows Active
Directory as the source to retrieve the current user identity information for specific IP addresses and
allows transparent authentication for Active Directory users.
Identity-based firewall services enhance the existing access control and security policy mechanisms by
allowing users or groups to be specified in place of source IP addresses. Identity-based security policies
can be interleaved without restriction between traditional IP address based rules.
The key benefits of the Identity Firewall include:
•

Decoupling network topology from security policies

•

Simplifying the creation of security policies

•

Providing the ability to easily identify user activities on network resources

•

Simplify user activity monitoring

Architecture for Identity Firewall Deployments
The Identity Firewall integrates with Window Active Directory in conjunction with an external Active
Directory (AD) Agent that provides the actual identity mapping.
The identity firewall consists of three components:
•

ASA

•

Microsoft Active Directory
Though Active Directory is part of the Identity Firewall on the ASA, they are managed by Active
Directory administrators. The reliability and accuracy of the data depends on data in Active
Directory.
Supported versions include Windows Server 2003, Windows Server 2008, and Windows Server
2008 R2 servers.

•

Active Directory (AD) Agent
The AD Agent runs on a Windows server. Supported Windows servers include Windows 2003,
Windows 2008, and Windows 2008 R2.

Note

Windows 2003 R2 is not supported for the AD Agent server.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-2

Chapter 36

Configuring the Identity Firewall
Information About the Identity Firewall

Figure 36-1

Identity Firewall Components

LAN
ASA

Client
NetBIOS Probe

LD
AP

US
DI
RA

mktg.sample.com
10.1.1.2
AD
Agent

WMI

1

AD Agent

xxxxxx

AD Servers

On the ASA: Configure local user groups and 4
Identity Firewall policies.

Client <-> ASA: The client logs onto the
network through Microsoft Active Directory.
The AD Server authenticates users and
generates user logon security logs.
Alternatively, the client can log onto the
network through a cut-through proxy or by
using VPN.

2

ASA <-> AD Server: The ASA sends an
LDAP query for the Active Directory groups
configured on the AD Server.

5

If configured, the ASA probes the NetBIOS of
the client to pass inactive and no-response
users.

The ASA consolidates local and Active
Directory groups and applies access rules and
MPF security policies based on user identity.
3

ASA <-> AD Agent: Depending on the
Identity Firewall configuration, the ASA
downloads the IP-user database or sends a
RADIUS request to the AD Agent querying
the user’s IP address.

ASA <-> Client: Based on the policies
configured on the ASA, it grants or denies
access to the client.

6

The ASA forwards the new mappings learned
from web authentication and VPN sessions to
the AD Agent.

AD Agent <-> AD Server: Periodically or
on-demand, the AD Agent monitors the AD
Server security event log file via WMI for
client login and logoff events.
The AD Agent maintains a cache of user ID
and IP address mappings. and notifies the
ASA of changes.
The AD Agent sends logs to a syslog server.

Features of the Identity Firewall
The Identity Firewall has the following key features.
Flexibility
•

The ASA can retrieve user identity and IP address mappings from the AD Agent by querying the
AD Agent for each new IP address or by maintaining a local copy of the entire user identity and IP
address database.

•

Supports host group, subnet, or IP address for the destination of a user identity policy.

•

Supports a fully qualified domain name (FQDN) for the source and destination of a user identity
policy.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-3

Chapter 36

Configuring the Identity Firewall

Information About the Identity Firewall

•

Supports the combination of 5-tuple policies with ID-based policies. The identity-based feature
works in tandem with existing 5-tuple solution.

•

Supports usage with IPS and Application Inspection policies.

•

Retrieves user identity information from remote access VPN, AnyConnect VPN, L2TP VPN and
cut-through proxy. All retrieved users are populated to all ASA devices connected to the AD Agent.

Scalability
•

Each AD Agent supports 100 ASA devices. Multiple ASA devices are able to communicate with a
single AD Agent to provide scalability in larger network deployments.

•

Supports 30 Active Directory servers provided the IP address is unique among all domains.

•

Each user identity in a domain can have up to 8 IP addresses.

•

Supports up to 64,000 user identity-IP address mappings in active ASA policies for ASA 5500
Series models. This limit controls the maximum users who have policies applied. The total users are
the aggregated users configured on all different contexts.

•

Supports up to 1024 user identity-IP address mappings in active ASA policies for the ASA 5505.

•

Supports up to 256 user groups in active ASA policies.

•

A single rule can contain one or more user groups or users.

•

Supports multiple domains.

Availability
•

The ASA retrieves group information from Active Directory and falls back to web authentication
for IP addresses that the AD Agent cannot map a source IP address to a user identity.

•

The AD Agent continues to function when any of the Active Directory servers or the ASA are not
responding.

•

Supports configuring a primary AD Agent and a secondary AD Agent on the ASA. If the primary
AD Agent stops responding, the ASA can switch to the secondary AD Agent.

•

If the AD Agent is unavailable, the ASA can fall back to existing identity sources such as cut through
proxy and VPN authentication.

•

The AD Agent runs a watchdog process that automatically restarts its services when they are down.

•

Allows a distributed IP address/user mapping database among ASA devices.

Deployment Scenarios
You can deploy the components of the Identity Firewall in the following ways depending on your
environmental requirement.
As shown in Figure 36-2, you can deploy the components of the Identity Firewall to allow for
redundancy. Scenario 1 shows a simple installation without component redundancy.
Scenario 2 also shows a simple installation without redundancy. However, in that deployment scenario,
the Active Directory server and AD Agent are co-located on one Windows server.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-4

Configuring the Identity Firewall
Information About the Identity Firewall

Figure 36-2
Deployment Scenario without Redundancy
No Redundancy
Scenario 1

Scenario 2

AD Agent
AD
Agent
AD
Agent

AD Server
AD Agent

ASA

xxxxxx

AD Server

ASA

As shown in Figure 36-3, you can deploy the Identity Firewall components to support redundancy.
Scenario 1 shows a deployment with multiple Active Directory servers and a single AD Agent installed
on a separate Windows server. Scenario 2 shows a deployment with multiple Active Directory servers
and multiple AD Agents installed on separate Windows servers.
Figure 36-3

Deployment Scenario with Redundant Components

Redundant
Scenario 1
AD Server

Scenario 2

AD Agent

AD
Agent

AD Server

AD
Agent

AD Server

ASA

AD Server

ASA

xxxxxx

AD
Agent

As shown in Figure 36-4, all Identity Firewall components—Active Directory server, the AD Agent, and
the clients—are installed and communicate on the LAN.
Figure 36-4

LAN -based Deployment

LAN
ASA

Client
NetBIOS Probe

RA
DI

LD
AP

US

mktg.sample.com
10.1.1.2
AD
Agent

WMI

AD Servers

AD Agent

xxxxxx

Chapter 36

Cisco ASA 5500 Series Configuration Guide using the CLI

36-5

Chapter 36

Configuring the Identity Firewall

Information About the Identity Firewall

Figure 36-5 shows a WAN-based deployment to support a remote site. The Active Directory server and
the AD Agent are installed on the main site LAN. The clients are located at a remote site and connect to
the Identity Firewall components over a WAN.
Figure 36-5

WAN-based Deployment

Remote Site

Enterprise Main Site
ASA

Client
NetBIOS Probe
Login/Authentication

AP
LD

R
AD
IU
S

WAN

mktg.sample.com
10.1.1.2

AD
Agent

AD Agent

xxxxxx

WMI

AD Servers

Figure 36-6 also shows a WAN-based deployment to support a remote site. The Active Directory server
is installed on the main site LAN. However, the AD Agent is installed and access by the clients at the
remote site. The remote clients connect to the Active Directory servers at the main site over a WAN.
Figure 36-6

WAN-based Deployment with Remote AD Agent

Remote Site

Enterprise Main Site
ASA

Client
RADIUS

WAN
AP
LD

mktg.sample.com
10.1.1.2

AD
Agent

WMI

AD Servers

xxxxxx

Login/Authentication

AD Agent

Figure 36-7 shows an expanded remote site installation. An AD Agent and Active Directory servers are
installed at the remote site. The clients access these components locally when logging into network
resources located at the main site. The remote Active Directory server must synchronize its data with the
central Active Directory servers located at the main site.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-6

Chapter 36

Configuring the Identity Firewall
Information About the Identity Firewall

Figure 36-7

WAN-based Deployment with Remote AD Agent and AD Servers

Remote Site

Enterprise Main Site
ASA

Client
RADIUS

WAN

LDAP

Directory
Sync

AD
Agent

mktg.sample.com
10.1.1.2

WMI
xxxxxx

AD Servers
AD Agent

AD Servers

Cut-through Proxy and VPN Authentication
In an enterprise, some users log onto the network by using other authentication mechanisms, such as
authenticating with a web portal (cut-through proxy) or by using a VPN. For example, users with a
Machintosh and Linux client might log in a web portal (cut-through proxy) or by using a VPN.
Therefore, you must configure the Identity Firewall to allow these types of authentication in connection
with identity-based access policies.
Figure 36-8 shows a deployment to support a cut-through proxy authentication captive portal. Active
Directory servers and the AD Agent are installed on the main site LAN. However, the Identity Firewall
is configured to support authentication of clients that are not part of the Active Directory domain.
Figure 36-8

Deployment Supporting Cut-through Proxy Authentication
Inside Enterprise

Windows Clients
(Domain Members)

ASA

WAN / LAN

R

AD

AP
LD

IU
S

PS

/HTT

HTTP

mktg.sample.com
10.1.1.2

AD
Agent

AD Agent

AD Servers

xxxxxx

WMI

Non-domain Member
Clients

The ASA designates users logging in through a web portal (cut-through proxy) as belonging to the
Active Directory domain with which they authenticated.
The ASA designates users logging in through a VPN as belonging to the LOCAL domain unless the VPN
is authenticated by LDAP with Active Directory, then the Identity Firewall can associate the users with
their Active Directory domain.
The ASA reports users logging in through VPN authentication or a web portal (cut-through proxy) to the
AD Agent, which distributes the user information to all registered ASA devices. Specifically, the user
identity-IP address mappings of authenticated users are forwarded to all ASA contexts that contain the
input interface where packets are received and authenticated.
See Configuring Cut-through Proxy Authentication, page 22.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-7

Chapter 36

Configuring the Identity Firewall

Licensing for the Identity Firewall

Licensing for the Identity Firewall
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
Failover Guidelines

The Identity Firewall supports user identity-IP address mappings and AD Agent status replication from
active to standby when stateful failover is enabled. However, only user identity-IP address mappings,
AD Agent status, and domain status are replicated. User and user group records are not replicated to the
standby ASA.
When failover is configured, the standby ASA must also be configured to connect to the AD Agent
directly to retrieve user groups. The standby ASA does not send NetBIOS packets to clients even when
the NetBIOS probing options are configured for the Identity Firewall.
When a client is determined as inactive by the active ASA, the information is propagated to the standby
ASA. User statistics are not propagated to the standby ASA.
When you have failover configured, you must configure the AD Agent to communicate with both the
active and standby ASA devices. See the Installation and Setup Guide for the Active Directory Agent for
the steps to configure the ASA on the AD Agent server.
IPv6 Guidelines
•

Supports IPv6.
The AD Agent supports endpoints with IPv6 addresses. It can receive IPv6 addresses in log events,
maintain them in its cache, and send them through RADIUS messages.

•

NetBIOS over IPv6 is not supported

•

Cut through proxy over IPv6 is not supported.

Additional Guidelines and Limitations
•

A full URL as a destination address is not supported.

•

For NetBIOS probing to function, the network between the ASA, AD Agent, and clients must
support UDP-encapsulated NetBIOS traffic.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-8

Chapter 36

Configuring the Identity Firewall
Prerequisites

•

MAC address checking by the Identity Firewall does not work when intervening routers are present.
Users logged onto clients that are behind the same router have the same MAC addresses. With this
implementation, all the packets from the same router are able to pass the check, because the ASA is
unable to ascertain to the actual MAC addresses behind the router.

•

The following ASA features do not support using the identity-based object and FQDN:
– route-map
– Crypto map
– WCCP
– NAT
– group-policy (except VPN filter)
– DAP

See Configuring Identity-based Access Rules, page 20.

Prerequisites
Before configuring the Identity Firewall in the ASA, you must meet the prerequisites for the AD Agent
and Microsoft Active Directory.
AD Agent

The AD Agent must be installed on a Windows server that is accessible to the ASA. Additionally, you
must configure the AD Agent to obtain information from the Active Directory servers. Configure the AD
Agent to communicate with the ASA.
Supported Windows servers include Windows 2003, Windows 2008, and Windows 2008 R2.

Note

Windows 2003 R2 is not supported for the AD Agent server.

For the steps to install and configure the AD Agent, see the Installation and Setup Guide for the Active
Directory Agent.
Before configuring the AD Agent in the ASA, obtain the secret key value that the AD Agent and the ASA
use to communicate. This value must match on both the AD Agent and the ASA.
Microsoft Active Directory

Microsoft Active Directory must be installed on a Windows server and accessible by the ASA. Supported
versions include Windows 2003, 2008, and 2008 R2 servers.
Before configuring the Active Directory server on the ASA, create a user account in Active Directory
for the ASA.
Additionally, the ASA sends encrypted log in information to the Active Directory server by using SSL
enabled over LDAP. SSL must be enabled on the Active Directory server. See the documentation for
Microsft Active Diretory for the steps to enable SSL for Active Directory.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-9

Chapter 36

Configuring the Identity Firewall

Configuring the Identity Firewall

Note

Before running the AD Agent Installer, you must install the following patches on every Microsoft Active
Directory server that the AD Agent monitors. These patches are required even when the AD Agent is
installed directly on the domain controller server. See the README First for the Cisco Active Directory
Agent.

Configuring the Identity Firewall
This section contains the following topics:
•

Task Flow for Configuring the Identity Firewall, page 10

•

Configuring the Active Directory Domain, page 11

•

Configuring Active Directory Agents, page 13

•

Configuring Identity Options, page 14

•

Configuring Identity-based Access Rules, page 20

•

Configuring Cut-through Proxy Authentication, page 22

•

Configuring VPN Authentication, page 24

Task Flow for Configuring the Identity Firewall
Prerequisite

Before configuring the Identity Firewall in the ASA, you must meet the prerequisites for the AD Agent
and Microsoft Active Directory. See Prerequisites, page 9 for information.
Task Flow in the ASA

To configure the Identity Firewall, perform the following tasks:
Step 1

Configure the Active Directory domain in the ASA.
See Configuring the Active Directory Domain, page 11.
See also Deployment Scenarios, page 4 for the ways in which you can deploy the Active Directory
servers to meet your environment requirements.

Step 2

Configure the AD Agent in ASA.
See Configuring Active Directory Agents, page 13.
See also Deployment Scenarios, page 4 for the ways in which you can deploy the AD Agents to meet
your environment requirements.

Step 3

Configure Identity Options.
See Configuring Identity Options, page 14.

Step 4

Configure Identity-based Access Rules in the ASA.
After AD domain and AD-Agent are configured, identity-based rules can be specified to enforce
identity-based rules. See Configuring Identity-based Access Rules, page 20.

Step 5

Configure the cut-through proxy.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-10

Chapter 36

Configuring the Identity Firewall
Task Flow for Configuring the Identity Firewall

See Configuring Cut-through Proxy Authentication, page 22.
Step 6

Configure VPN authentication.
See Configuring VPN Authentication, page 24.

Configuring the Active Directory Domain
Active Directory domain configuration on the ASA is required for the ASA to download Active
Directory groups and accept user identities from specific domains when receiving IP-user mapping from
the AD Agent.

Prerequisites
•

Active Directory server IP address

•

Distinguished Name for LDAP base dn

•

Distinguished Name and password for the Active Directory user that the Identity Firewall uses to
connect to the Active Directory domain controller

To configure the Active Directory domain, perform the following steps:
Command

Purpose

Step 1

hostname(config)# aaa-server server-tag protocol
ldap
Example:
hostname(config)# aaa-server adserver protocol ldap

Creates the AAA server group and configures AAA
server parameters for the Active Directory server.

Step 2

hostname(config-aaa-server-group)# aaa-server
server-tag [(interface-name)] host {server-ip |
name} [key] [timeout seconds]
Example:
hostname(config-aaa-server-group)# aaa-server
adserver (mgmt) host 172.168.224.6

For the Active Directory server, configures the AAA
server as part of a AAA server group and the AAA
server parameters that are host-specific.

Step 3

hostname(config-aaa-server-host)# ldap-base-dn
string
Example:
hostname(config-aaa-server-host)# ldap-base-dn
DC=SAMPLE,DC=com

Specifies the location in the LDAP hierarchy where
the server should begin searching when it receives
an authorization request.

Step 4

hostname(config-aaa-server-host)# ldap-scope subtree

Specifies the extent of the search in the LDAP
hierarchy that the server should make when it
receives an authorization request.

Step 5

hostname(config-aaa-server-host)#
ldap-login-password string
Example:
hostname(config-aaa-server-host)#
ldap-login-password obscurepassword

Specifies the login password for the LDAP server.

Specifying the ldap-base-dn command is optional.
If you do not specify this command, the ASA
retrieves the defaultNamingContext from Active
Directory and uses it as the base DN.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-11

Chapter 36

Configuring the Identity Firewall

Task Flow for Configuring the Identity Firewall

Step 6

Command

Purpose

hostname(config-aaa-server-host)# ldap-login-dn
string
Example:
hostname(config-aaa-server-host)#ldap-login-dn
SAMPLE\user1

Specifies the name of the directory object that the
system should bind this as. The ASA identifies itself
for authenticated binding by attaching a Login DN
field to the user authentication request. The Login
DN field describes the authentication characteristics
of the ASA.
Where string is a case-sensitive string of up to 128
characters that specifies the name of the directory
object in the LDAP hierarchy. Spaces are not
permitted in the string, but other special characters
are allowed.
You can specify the traditional or simplified format.
The traditional ldap-login-dn in format includes:
CN=username,OU=Employees,OU=Sample
Users,DC=sample,DC=com is accepted also.

Step 7

hostname(config-aaa-server-host)# server-type
microsoft

Configures the LDAP server model for the
Microsoft Active Directory server.

Step 8

hostname(config-aaa-server-host)# ldap-group-base-dn
string
Example:
hostname(config-aaa-server-host)# ldap-group-base-dn
OU=Sample Groups,DC=SAMPLE,DC=com

Specifies location of the Active Directory groups
configuration in the Active Directory domain
controller. If not specified, the value in ldap-base-dn
is used.
Specifying the ldap-group-base-dn command is
optional.

Step 9

hostname(config-aaa-server-host)# ldap-over-ssl
enable

Allows the ASA to access the Active Directory
domain controller over SSL. To support LDAP over
SSL, Active Directory server needs to be configured
to have this support.
By default, Active Directory does not have SSL
configured. If SSL is not configured on on Active
Directory, you do not need to configure it on the
ASA for the Identity Firewall.

Step 10

hostname(config-aaa-server-host)# server-port
port-number
Examples:
hostname(config-aaa-server-host)# server-port 389
hostname(config-aaa-server-host)# server-port 636

By default, if ldap-over-ssl is not enabled, the
default server-port is 389; if ldap-over-ssl is
enabled, the default server-port is 636.

Step 11

hostname(config-aaa-server-host)#
group-search-timeout seconds
Examples:
hostname(config-aaa-server-host)#
group-search-timeout 300

Sets the amount of time before LDAP queries time
out.

What to Do Next
Configure AD Agents. See Configuring Active Directory Agents, page 13.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-12

Chapter 36

Configuring the Identity Firewall
Task Flow for Configuring the Identity Firewall

Configuring Active Directory Agents
Periodically or on-demand, the AD Agent monitors the Active Directory server security event log file
via WMI for user login and logoff events. The AD Agent maintains a cache of user ID and IP address
mappings. and notifies the ASA of changes.
Configure the primary and secondary AD Agents for the AD Agent Server Group. When the ASA detects
that the primary AD Agent is not responding and a secondary agent is specified, the ASA switches to
secondary AD Agent. The Active Directory server for the AD agent uses RADIUS as the communication
protocol; therefore, you should specify a key attribute for the shared secret between ASA and AD Agent.
Requirement
•

AD agent IP address

•

Shared secret between ASA and AD agent

To configure the AD Agents, perform the following steps:
Command

Purpose

Step 1

hostname(config)# aaa-server server-tag protocol
radius
Example:
hostname(config)# aaa-server adagent protocol radius

Creates the AAA server group and configures AAA
server parameters for the AD Agent.

Step 1

hostname(config)# ad-agent-mode

Enables the AD Agent mode.

Step 2

hostname(config-aaa-server-group)# aaa-server
server-tag [(interface-name)] host {server-ip |
name} [key] [timeout seconds]
Example:
hostname(config-aaa-server-group)# aaa-server
adagent (inside) host 192.168.1.101

For the AD Agent, configures the AAA server as
part of a AAA server group and the AAA server
parameters that are host-specific.

Step 3

hostname(config-aaa-server-host)# key key
Example:
hostname(config-aaa-server-host)# key mysecret

Specifies the server secret value used to authenticate
the ASA to the AD Agent server.

Step 4

hostname(config-aaa-server-host)# user-identity
ad-agent aaa-server aaa_server_group_tag
Examples:
hostname(config-aaa-server-hostkey )# user-identity
ad-agent aaa-server adagent

Defines the server group of the AD Agent.
The first server defined in aaa_server_group_tag
variable is the primary AD Agent and the second
server defined is the secondary AD Agent.
The Identity Firewall supports defining only two
AD-Agent hosts.
When ASA detects the primary AD Agent is down
and a secondary agent is specified, it switches to
secondary AD Agent. The aaa-server for the AD
agent uses RADIUS as the communication protocol,
and should specify key attribute for the shared secret
between ASA and AD Agent.

Step 5

hostname(config-aaa-server-host)# test aaa-server
ad-agent

Tests the communication between the ASA and the
AD Agent server.

What to Do Next
Configure access rules for the Identity Firewall. See Configuring Identity-based Access Rules, page 20.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-13

Chapter 36

Configuring the Identity Firewall

Task Flow for Configuring the Identity Firewall

Configuring Identity Options
Perform this procedure to add or edit the Identity Firewall feature; select the Enable check box to enable
the feature. By default, the Identity Firewall feature is disabled.

Prerequisites
Before configuring the identify options for the Identity Firewall, you must you must meet the
prerequisites for the AD Agent and Microsoft Active Directory. See Prerequisites, page 9 the
requirements for the AD Agent and Microsoft Active Directory installation.
To configure the Identity Options for the Identity Firewall, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

36-14

Chapter 36

Configuring the Identity Firewall
Task Flow for Configuring the Identity Firewall

Command
Step 1

hostname(config)# user-identity enable

Step 2

hostname(config)# user-identity default-domain
domain_NetBIOS_name
Example:
hostname(config)# user-identity default-domain
SAMPLE

Purpose
Enables the Identity Firewall feature.
Specifies the default domain for the Identity
Firewall.
For domain_NetBIOS_name, enter a name up to 32
characters consisting of [a-z], [A-Z], [0-9],
[!@#$%^&()-_=+[]{};,. ] except '.' and ' ' at the first
character. If the domain name contains a space,
enclose the entire name in quotation marks. The
domain name is not case sensitive.
The default domain is used for all users and user
groups when a domain has not been explicitly
configured for those users or groups. When a default
domain is not specified, the default domain for users
and groups is LOCAL. For multiple context modes,
you can set a default domain name for each context,
as well as within the system execution space.
Note

The default domain name you specify must
match the NetBIOS domain name
configured on the Active Directory domain
controller. If the domain name does not
match, the AD Agent will incorrectly
associate the user identity-IP address
mappings with the domain name you enter
when configuring the ASA. To view the
NetBIOS domain name, open the Active
Directory user event security log in any text
editor.

The Identity Firewall uses the LOCAL domain for
all locally defined user groups or locally defined
users. Users logging in through a web portal
(cut-through proxy) are designated as belonging to
the Active Directory domain with which they
authenticated. Users logging in through a VPN are
designated as belonging to the LOCAL domain
unless the VPN is authenticated by LDAP with
Active Directory, then the Identity Firewall can
associate the users with their Active Directory
domain.
Step 3

hostname(config)# user-identity domain
domain_nickname aaa-server aaa_server_group_tag
Example:
hostname(config)# user-identity domain SAMPLE
aaa-server ds

Associates the LDAP parameters defined for the
AAA server for importing user group queries with
the domain name.
For domain_nickname, enter a name up to 32
characters consisting of [a-z], [A-Z], [0-9],
[!@#$%^&()-_=+[]{};,. ] except '.' and ' ' at the first
character. If the domain name contains a space, you
must enclose that space character in quotation
marks. The domain name is not case sensitive.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-15

Chapter 36

Configuring the Identity Firewall

Task Flow for Configuring the Identity Firewall

Step 4

Command

Purpose

hostname(config)# user-identity logout-probe netbios
local-system probe-time minutes minutes
retry-interval seconds seconds retry-count times
[user-not-needed|match-any|exact-match]
Example:
hostname(config)# user-identity logout-probe netbios
local-system probe-time minutes 10 retry-interval
seconds 10 retry-count 2 user-not-needed

Enables NetBIOS probing. Enabling this option
configures how often the ASA probes the user client
IP address to determine whether the client is still
active. By default, NetBIOS probing is disabled.
To minimize the NetBIOS packets, the ASA only
sends a NetBIOS probe to a client when the user has
been idle for more than the specified number of
minutes.
Set the NetBIOS probe timer from1 to 65535
minutes and the retry interval from 1 to 256 retries.
Specify the number of times to retry the probe:
•

match-any—As long as the NetBIOS response
from the client contains the user name of the
user assigned to the IP address, the user identity
is be considered valid. Specifying this option
requires that the client enabled the Messenger
service and configured a WINS server.

•

exact-match—The user name of the user
assigned to the IP address must be the only one
in the NetBIOS response. Otherwise, the user
identity of that IP address is considered invalid.
Specifying this option requires that the client
enabled the Messenger service and configured a
WINS server.

•

user-not-needed—As long as the ASA received
a NetBIOS response from the client the user
identity is considered valid.

The Identity Firewall only performs NetBIOS
probing for those users identities that are in the
active state and exist in at least one security policy.
The ASA does not perform NetBIOS probing for
clients where the users logged in through
cut-through proxy or by using VPN.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-16

Chapter 36

Configuring the Identity Firewall
Task Flow for Configuring the Identity Firewall

Step 5

Command

Purpose

hostname(config)# user-identity inactive-user-timer
minutes minutes
Example:
hostname(config)# user-identity inactive-user-timer
minutes 120

Specifies the amount of time before a user is
considered idle, meaning the ASA has not received
traffic from the user's IP address for specified
amount of time.
When the timer expires, the user's IP address is
marked as inactive and removed from the local
cached user identity-IP address mappings database
and the ASA no longer notifies the AD Agent about
that IP address removal. Existing traffic is still
allowed to pass. When this command is specified,
the ASA runs an inactive timer even when the
NetBIOS Logout Probe is configured.
By default, the idle timeout is set to 60 minutes.
Note

Step 6

hostname(config)# user-identity
poll-import-user-group-timer hours hours
Example:
hostname(config)# user-identity
poll-import-user-group-timer hours 1

The Idle Timeout option does not apply to
VPN or cut through proxy users.

Specifies the amount of time before the ASA queries
the Active Directory server for user group
information.
If a user is added to or deleted from to an Active
Directory group, the ASA received the updated user
group after import group timer runs.
By default, the poll-import-user-group-timer is 8
hours.
To immediately update user group information,
enter the following command:
user-identity update import-user
See the CLI configuration guide

Step 7

hostname(config)# user-identity action
netbios-response-fail remove-user-ip

Specifies the action when a client does not respond
to a NetBIOS probe. For example, the network
connection might be blocked to that client or the
client is not active.
When the user-identity action remove-user-ip is
configured, the ASA removed the user identity-IP
address mapping for that client.
By default, this command is disabled.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-17

Chapter 36

Configuring the Identity Firewall

Task Flow for Configuring the Identity Firewall

Step 8

Command

Purpose

hostname(config)# user-identity action
domain-controller-down domain_nickname
disable-user-identity-rule
Example:
hostname(config)# user-identity action
domain-controller-down SAMPLE
disable-user-identity-rule

Specifies the action when the domain is down
because Active Directory domain controller is not
responding.
When the domain is down and the
disable-user-identity-rule keyword is configured,
the ASA disables the user identity-IP address
mappings for that domain. Additionally, the status of
all user IP addresses in that domain are marked as
disabled in the output displayed by the show
user-identity user command.
By default, this command is disabled.

Step 9

hostname(config)# user-identity user-not-found
enable

Enables user-not-found tracking. Only the last 1024
IP addresses tracked.
By default, this command is disabled.

Step 10

hostname(config)# user-identity action ad-agent-down
disable-user-identity-rule

Specifies the action when the AD Agent is not
responding.
When the AD Agent is down and the user-identity
action ad-agent-down is configured, the ASA
disables the user identity rules associated with the
users in that domain. Additionally, the status of all
user IP addresses in that domain are marked as
disabled in the output displayed by the show
user-identity user command.
By default, this command is disabled.

Step 11

hostname(config)# user-identity action
mac-address-mismatch remove-user-ip

Specifies the action when a user's MAC address is
found to be inconsistent with the ASA device IP
address currently mapped to that MAC address.
When the user-identity action
mac-address-mismatch command is configured,
the ASA removes the user identity-IP address
mapping for that client.
By default, the ASA uses the remove-user-ip
keyword when this command is specified.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-18

Chapter 36

Configuring the Identity Firewall
Task Flow for Configuring the Identity Firewall

Step 12

Command

Purpose

hostname(config)# user-identity ad-agent
active-user-database {on-demand|full-download}
Example:
hostname(config)# user-identity ad-agent
active-user-database full-download

Defines how the ASA retrieves the user identity-IP
address mapping information from the AD Agent:
•

full-download—Specifies that the ASA send a
request to the AD Agent to download the entire
IP-user mapping table when the ASA starts and
then to receive incremental IP-user mapping
when users log in and log out.

•

on-demand—Specifies that the ASA retrieve
the user mapping information of an IP address
from the AD Agent when the ASA receives a
packet that requires a new connection and the
user of its source IP address is not in the
user-identity database.

By default, the ASA 5505, uses the on-demand
option. The other ASA platforms use the
full-download option.
Full downloads are event driven, meaning that
subsequent requests to download the database, send
just the updates to the user identity-IP address
mapping database.
When the ASA registers a change request with the
AD Agent, the AD Agent sends a new event to the
ASA.
Step 13

hostname(config)# user-identity ad-agent hello-timer
seconds seconds retry-times number
Example:
hostname(config)# user-identity ad-agent hello-timer
seconds 20 retry-times 3

Defines the hello timer between the ASA and the AD
Agent.
The hello timer between the ASA and the AD Agent
defines how frequently the ASA exchanges hello
packets. The ASA uses the hello packet to obtain
ASA replication status (in-sync or out-of-sync) and
domain status (up or down). If the ASA does not
receive a response from the AD Agent, it resends a
hello packet after the specified interval.
By default, the hello timer is set to 30 seconds and 5
retries.

Step 14

hostname(config)# user-identity ad-agent aaa-server
aaa_server_group_tag
Example:
hostname(config)# user-identity ad-agent aaa-server
adagent

Defines the server group of the AD Agent.
For aaa_server_group_tag, enter the value defined
by the aaa-server command.

What to Do Next
Configure the Active Directory domain and server groups. See Configuring the Active Directory
Domain, page 11.
Configure AD Agents. See Configuring Active Directory Agents, page 13.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-19

Chapter 36

Configuring the Identity Firewall

Task Flow for Configuring the Identity Firewall

Configuring Identity-based Access Rules
An access rule permits or denies traffic based on the protocol, a source and destination IP address or
network, and the source and destination ports. For information about access rules, see in Chapter 34,
“Configuring Access Rules.”
The Identity Firewall feature adds the ability to permit or deny traffic based on a users’ identities or
based on a user group. You configure access rules and security policies based on user names and user
groups name in addition to source IP addresses. The ASA applies the security policies based on an
association of IP addresses to Windows Active Directory login information and reports events based on
the mapped user names instead of network IP addresses.
Users can be local, remote (via VPN), wired or wireless. Server resources can include server IP address,
server DNS name, or domain.
Identity-based access rules follow the same general format that standard IP-address-based rules follow:
action, protocol, source, destination, and optional source service when the protocol for the rule is TCP
or UDP. In addition, they include specifying user and user group objects before traditional
IP-address-based objects—any, network object/network group, interface, host, IP address, and network
mask.
You can create access rules that solely contain identity-based objects (users and user groups) or combine
identity-based objects with traditional IP-address-based objects. You can create an access rule that
includes a source user or source user group from a qualifying IP-address-based source. For example, you
could create and access rule for sample_user1 11.0.0.0 255.0.0.0, meaning the user could have any IP
address on subnet 11.0.0.0/8.
You can create an access rule with FQDN in the source and the destination.
The destination portion of an identity-based access rule follows the same format and guidelines as
traditional IP-address-based access rules.

Guidelines and Limitations
•

Supports up to 64,000 user identity-IP address mappings in active ASA policies for ASA 5500
Series models.
This limit controls the maximum users who have policies applied. The total users are the aggregated
users configured on all different contexts.

•

Supports up to 1024 user identity-IP address mappings in active ASA policies for the ASA 5505.
This limit controls the maximum users who have policies applied. The total users are the aggregated
users configured on all different contexts.

•

Supports up to 256 user groups in active ASA security policies.

•

A single rule can contain one or more user groups or users.

Prerequisites
After AD domain and AD-Agent are configured, Identity-based rules can be specified to enforce
identity-based rules.
To configure identity-based access rules, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

36-20

Chapter 36

Configuring the Identity Firewall
Task Flow for Configuring the Identity Firewall

Command

Purpose

Step 1

hostname(config)# object-group user user_group_name
Examples:
hostname(config)# object-group user users1

Defines object groups that you can use to control
access with the Identity Firewall. You can use the
object group as part of an access group or service
policy.

Step 2

hostname(config-user-object-group)# user
domain_NetBIOS_name\user_name
Examples:
hostname(config-user-object-group)# user
SAMPLE\users1

Specifies the user to add to the access rule.
The user_name can contain any character including
[a-z], [A-Z], [0-9], [!@#$%^&()-_{}. ]. If
domain_NetBIOS_name\user_name contains a
space, you must enclose the domain name and user
name in quotation marks.
The user_name can be part of the LOCAL domain or
a user imported by the ASA from Active Directory
domain.
If the domain_NetBIOS_name is associated with a
AAA server, the user_name must be the Active
Directory sAMAccountName, which is unique,
instead of the common name (cn), which might not
be unique.
Thedomain_NetBIOS_name can be LOCAL or the
actual domain name as specified in user-identity
domain domain_NetBIOS_name aaa-server
aaa_server_group_tag command.

Step 3

hostname(config-user-object-group)# user-group
domain__NetBIOS_name\\user_group_name
Examples:
hostname(config-user-object-group)# user-group
SAMPLE\\group.marketing

Specifies a user group to add to the access rule.
The group_name can contain any character
including [a-z], [A-Z], [0-9], [!@#$%^&()-_{}. ]. If
domain_NetBIOS_name\group_name contains a
space, you must enclose the domain name and user
name in quotation marks.
Specifying the domain_NetBIOS_name for
user-group has the same requirements as specifying
it for user.
The ASA imports the nested user groups from in
Active Directory when the access rule is used in an
access group or service policy.

Step 4

hostname(config-user-object-group)# exit

Exit from the configure user object group mode to
the global configuration mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-21

Chapter 36

Configuring the Identity Firewall

Task Flow for Configuring the Identity Firewall

Step 5

Step 6

Command

Purpose

hostname(config)# access-list access_list_name {deny
| permit} protocol [{user-group
[domain_name\\]user_group_name | user
{[domain_name\\]user_name | any | none} |
object-group-user object_group_user_name}] {any |
host sip | sip smask | interface name | object
src_object_name | object-group
network_object_group_name> [eq port | …]
{object-group-user dst_object_group_name | object
dst_object_name host dst_host_name | ip_address}
[object-group service_object_name | eq port | …]

Creates an access control entry that controls access
using user identity or group identity.
You can specify [domain_nickname>\]user_name
and [domain_nickname>\]user_group_name
directly without specifying them in an object-group
first.
See the access-list extended command in the Cisco
ASA 5500 Series Command Reference for a
complete description of the command syntax.

Examples:
hostname(config)# access-list identity-list1 permit
ip user SAMPLE\user1 any any
hostname(config)# access-list aclname extended
permit ip user-group SAMPLE\\group.marketing any any
hostname(config)# access-list aclname extended
permit ip object-group-user asausers any any

The keywords user-group any and user-group
none can be specified to support cut-through proxy
authentication. See Configuring Cut-through Proxy
Authentication, page 22.

hostname(config)# access-group access-list global
Examples:
hostname(config)# access-group aclname global

Applies a single set of global rules to all interfaces
with the single command.

Configuring Cut-through Proxy Authentication
In an enterprise, some users log onto the network by using other authentication mechanisms, such as
authenticating with a web portal (cut-through proxy) or by using a VPN. For example, users with a
Machintosh and Linux client might log in a web portal (cut-through proxy) or by using a VPN.
Therefore, you must configure the Identity Firewall to allow these types of authentication in connection
with identity-based access policies.
The ASA designates users logging in through a web portal (cut-through proxy) as belonging to the
Active Directory domain with which they authenticated. The ASA designates users logging in through
a VPN as belonging to the LOCAL domain unless the VPN is authenticated by LDAP with Active
Directory, then the Identity Firewall can associate the users with their Active Directory domain. The
ASA reports users logging in through VPN authentication or a web portal (cut-through proxy) to the AD
Agent, which distributes the user information to all registered ASA devices.
Users can log in by using HTTP/HTTPS, FTP, Telnet, or SSH. When users log in with these
authentication methods, the following guidelines apply:
•

For HTTP/HTTPS traffic, an authentication window appears for unauthenticated users.

•

For Telnet and FTP traffic, users must log in through the cut-through proxy and again to Telnet and
FTP server.

•

A user can specify an Active Directory domain while providing login credentials (in the format
domain\username). The ASA automatically selects the associated AAA server group for the
specified domain.

•

If a user specifies an Active Directory domain while providing login credentials (in the format
domain\username), the ASA parses the domain and uses it to select an authentication server from
the AAA servers configured for the Identity Firewall. Only the username is passed to the AAA
server.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-22

Chapter 36

Configuring the Identity Firewall
Task Flow for Configuring the Identity Firewall

•

If the backslash (\) delimiter is not found in the log in credentials, the ASA does not parse a domain
and authentication is conducted with the AAA server that corresponds to default domain configured
for the Identity Firewall.

•

If a default domain or a server group is not configured for that default domain, the ASA rejects the
authentication.

•

If the domain is not specified, the ASA selects the AAA server group for the default domain that is
configured for the Identity Firewall.

Detailed Steps
To configure the cut-through proxy for the Identity Firewall, perform the following steps:
Command

Purpose

Step 1

hostname(config)# access-list access_list_name
extended permit tcp any user_ip_address
255.255.255.255 eq http
hostname(config)# access-list access_list_name
extended permit tcp any user_ip_address
255.255.255.255 eq https
Examples:
hostname(config)# access-list listenerAuth extended
permit tcp any any

Creates an access list that permits traffic from the
users client that uses the HTTP or HTTPS protocol.

Step 2

hostname(config)# aaa authentication listener http
inside port port
Examples:
hostname(config)# aaa authentication listener http
inside port 8888

Enables HTTP(S) listening ports to authenticate the
user.

Step 3

hostname(config)# access-list access_list_name {deny
| permit} protocol [{user-group
[domain_name\\]user_group_name | user
{[domain_name\\]user_name | any | none} |
object-group-user object_group_user_name}] {any |
host sip | sip smask | interface name | object
src_object_name | object-group
network_object_group_name> [eq port | …]
{object-group-user dst_object_group_name | object
dst_object_name host dst_host_name | ip_address}
[object-group service_object_name | eq port | …]
Examples:
hostname(config)# access-list 100 ex deny ip user
CISCO\abc any any
hostname(config)# access-list 100 ex permit ip user
NONE any any

Creates an access control entry that controls access
using user identity or group identity.

Step 4

hostname(config)# aaa authenticate match
access_list_name inside user-identity
Examples:
aaa authenticate match listenerAuth inside
user-identity

See the access-list extended command in the Cisco
ASA 5500 Series Command Reference for a
complete description of the command syntax.
The keywords user-group any and user-group
none can be specified to support cut-through proxy
authentication.
•

any—The access list matches any IP addresses
that has already been associated with any users.

•

none—The access list matches any IP addresses
that has not been associated with any IP address.

Enables authentication for connections through the
ASA and matches it to the Identity Firewall feature.

Examples
Example 1

This example shows a typical cut-through proxy configuration to allow a user to log in through the ASA.
In this example, the following conditions apply:

Cisco ASA 5500 Series Configuration Guide using the CLI

36-23

Chapter 36

Configuring the Identity Firewall

Task Flow for Configuring the Identity Firewall

•

The ASA IP address is 172.1.1.118.

•

The Active Directory domain controller has the IP address 71.1.2.93.

•

The end user client has the IP address 172.1.1.118 and uses HTTPS to log in through a web portal.

•

The user is authenticated by the Active Directory domain controller via LDAP.

•

The ASA uses the inside interface to connect to the Active Directory domain controller on the
corporate network.

hostname(config)# access-list AUTH extended permit tcp any 172.1.1.118 255.255.255.255 eq http
hostname(config)# access-list AUTH extended permit tcp any 172.1.1.118 255.255.255.255 eq https
hostname(config)# aaa-server LDAP protocol ldap
hostname(config-aaa-server-group)# aaa-server LDAP (inside) host 171.1.2.93
hostname(config-aaa-server-host)# ldap-base-dn DC=cisco,DC=com
hostname(config-aaa-server-host)# ldap-group-base-dn DC=cisco,DC=com
hostname(config-aaa-server-host)# ldap-scope subtree
hostname(config-aaa-server-host)# ldap-login-dn cn=kao,OU=Employees,OU=Cisco Users,DC=cisco,DC=com
hostname(config-aaa-server-host)# ldap-login-password *****
hostname(config-aaa-server-host)# ldap-over-ssl enable
hostname(config-aaa-server-host)# server-type microsoft
hostname(config-aaa-server-host)# aaa authentication match AUTH inside LDAP
hostname(config)#
hostname(config)# http server enable
hostname(config)# http 0.0.0.0 0.0.0.0 inside
hostname(config)#
hostname(config)# auth-prompt prompt Enter Your Authentication
hostname(config)# auth-prompt accept You are Good
hostname(config)# auth-prompt reject Goodbye

Example 2
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

access-list listenerAuth extended permit tcp any any
aaa authentication match listenerAuth inside ldap
aaa authentication listener http inside port 8888
access-list 100 ex permit ip user SAMPLE\user1 any any
access-list 100 ex deny ip user SAMPLE\user2 any any
access-list 100 ex permit ip user NONE any any
access-list 100 ex deny any any
access-group 100 in interface inside
aaa authenticate match 200 inside user-identity

In this example, the following guidelines apply:
•

In access-list commands, “permit user NONE” rules should be written before the “access-list 100
ex deny any any” to allow unauthenticated incoming users trigger AAA Cut-Through Proxy.

•

In auth access-list command, “permit user NONE” rules guarantee only unauthenticated trigger
Cut-Through Proxy. Ideally they should be the last lines.

Configuring VPN Authentication
In an enterprise, some traffic might need to bypass the Identity Firewall.
The ASA reports users logging in through VPN authentication or a web portal (cut-through proxy) to the
AD Agent, which distributes the user information to all registered ASA devices. Specifically, the IP-user
mapping of authenticated users is forwarded to all ASA contexts that contain the input interface where
HTTP/HTTPS packets are received and authenticated. The ASA designates users logging in through a
VPN as belonging the LOCAL domain.
There are two different ways to apply IDFW rules on VPN users.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-24

Chapter 36

Configuring the Identity Firewall
Monitoring the Identity Firewall

•

Apply VPN-Filter with bypassing access-list check disabled

•

Apply VPN-Filter with bypassing access-list check enabled

Configuration Example -- VPN with IDFW Rule -1
By default, “sysopt connection permit-vpn" is enabled and VPN traffic is exempted from access-list
check. In order to apply regular interface based ACL rules for VPN traffic, VPN traffic access-list
bypassing needs to be disabled.
In the this example, if the user logs in from outside interface, the IDFW rules will control what network
resource he can access. All VPN users are be stored under domain LOCAL. Therefore, it is only
meaningful to apply the rules over LOCAL users or object-group containing LOCAL users.
! Apply VPN-Filter with bypassing access-list check disabled
no sysopt connection permit-vpn
access-list v1 extended deny ip user LOCAL\idfw any 10.0.0.0 255.255.255.0
access-list v1 extended permit ip user LOCAL\idfw any 20.0.0.0 255.255.255.0
access-group v1 in interface outside
>> Control VPN user based on regular IDFW ACLs

Configuration ExampleVPN with IDFW Rule -2
By default, "sysopt connection permit-vpn" is enabled, with VPN traffic access bypassing enabled.
VPN-filter can be used to apply the IDFW rules on the VPN traffic. VPN-filter with IDFW rules can be
defined in CLI username and group-policy.
In the example, when user idfw logs in, he is able to access to network resources in 10.0.00/24 subnet.
However, when user user1 loggs in, his access to network resources in 10.0.00/24 subnet will be denied.
Note that all VPN users will be stored under domain LOCAL. Therefore, it is only meaningful to apply
the rules over LOCAL users or object-group containing LOCAL users.
Note: IDFW rules can only be aplpied to vpn-filter under group-policy and are not available in all the
other group-policy features.
! Apply VPN-Filter with bypassing access-list check enabled
sysopt connection permit-vpn
access-list v1 extended permit ip user LOCAL\idfw any 10.0.0.0 255.255.255.0
access-list v2 extended deny ip user LOCAL\user1 any 10.0.0.0 255.255.255.0
username user1 password QkBIIYVi6IFLEsYv encrypted privilege 0 username user1 attributes
vpn-group-policy group1 vpn-filter value v2
>> Per user VPN-filter control
username idfw password eEm2dmjMaopcGozT encrypted
username idfw attributes
vpn-group-policy testgroup vpn-filter value v1
sysopt connection permit-vpn
access-list v1 extended permit ip user LOCAL\idfw any 10.0.0.0 255.255.255.0 access-list
v1 extended deny ip user LOCAL\user1 any 10.0.0.0 255.255.255.0 group-policy group1
internal
group-policy group1 attributes
>> Per group VPN-filter control
vpn-filter value v1
vpn-tunnel-protocol ikev1 l2tp-ipsec ssl-client ssl-clientless

Monitoring the Identity Firewall
This section contains the following topics:
•

Monitoring AD Agents, page 26

•

Monitoring Groups, page 26

Cisco ASA 5500 Series Configuration Guide using the CLI

36-25

Chapter 36

Configuring the Identity Firewall

Monitoring the Identity Firewall

•

Monitoring Memory Usage for the Identity Firewall, page 26

•

Monitoring Users for the Identity Firewall, page 27

Monitoring AD Agents
You can monitor the AD Agent component of the Identity Firewall.
Use the following options of the show user-identity command to obtain troubleshooting information for
the AD Agent:
•

show user-identity ad-agent

•

show user-identity ad-agent statistics

These commands display the following information about the primary and secondary AD Agents:
•

Status of the AD Agents

•

Status of the domains

•

Statistics for the AD Agents

Monitoring Groups
You can monitor the user groups configured for the Identity Firewall.
Use the show user-identity group command to obtain troubleshooting information for the user groups
configured for the Identity Firewall:
displays the list of user groups in the following format:
domain\group_name

Monitoring Memory Usage for the Identity Firewall
You can monitor the memory usage that the Identity Firewall consumes on the ASA.
Use the show user-identity memory command to obtain troubleshooting information for the Identity
Firewall:
The command displays the memory usage in bytes of various modules in the Identity Firewall:
•

Users

•

Groups

•

User Stats

•

LDAP
The ASA sends an LDAP query for the Active Directory groups configured on the Active Directory
server. The Active Directory server authenticates users and generates user logon security logs.

•

AD Agent

•

Miscellaneous

•

Total Memory Usage

Cisco ASA 5500 Series Configuration Guide using the CLI

36-26

Chapter 36

Configuring the Identity Firewall
Monitoring the Identity Firewall

Note

How you configure the Identity Firewall to retrieve user information from the AD Agent impacts the
amount of memory used by the feature. You specify whether the ASA uses on demand retrieval or full
download retrieval. Selecting On Demand has the benefit of using less memory as only users of
received packets are queried and stored. See Configuring Identity Options, page 14 for a description of
these options.

Monitoring Users for the Identity Firewall
You can display information about all users contained in the IP-user mapping database used by the
Identity Firewall.
Use the following options of the show user-identity command to obtain troubleshooting information for
the AD Agent:
•

show user-identity user all list

•

show user-identity user active user domain\user-name list detail

These commands display the following information for users:
domain\user_name

Active Connections

Minutes Idle

The default domain name can be the real domain name, a special reserved word, or LOCAL. The Identity
Firewall uses the LOCAL domain name for all locally defined user groups or locally defined users (users
who log in and authenticate by using a VPN or web portal). When default domain is not specified, the
default domain is LOCAL.
The idle time is stored on a per user basis instead of per the IP address of a user.

Note

The first three tabs in the
If the commands user-identity action domain-controller-down domain_name
disable-user-identity-rule is configured and the specified domain is down, or if user-identity action
ad-agent-down disable-user-identity-rule is configured and AD Agent is down, all the logged on users
have the status disabled.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-27

Chapter 36

Configuring the Identity Firewall

Feature History for the Identity Firewall

Feature History for the Identity Firewall
Table 36-1 lists the release history for this feature.
\

Table 36-1

Feature History for the Identity Firewall

Feature Name

Releases

Feature Information

Identity Firewall

8.4(2)

The Identity Firewall feature was introduced.
We introduced or modified the following commands:
user-identity enable, user-identity default-domain,
user-identity domain, user-identity logout-probe,
user-identity inactive-user-timer, user-identity
poll-import-user-group-timer, user-identity action
netbios-response-fail, user-identity user-not-found,
user-identity action ad-agent-down, user-identity action
mac-address-mismatch, user-identity action
domain-controller-down, user-identity ad-agent
active-user-database, user-identity ad-agent hello-timer,
user-identity ad-agent aaa-server, user-identity update
import-user, user-identity static user, dns
domain-lookup, dns poll-timer, dns expire-entry-timer,
object-group user, show user-identity, show dns, clear
configure user-identity, clear dns, debug user-identity.

Cisco ASA 5500 Series Configuration Guide using the CLI

36-28

CH A P T E R

37

Configuring Management Access
This chapter describes how to access the ASA for system management through Telnet, SSH, and HTTPS
(using ASDM), how to authenticate and authorize users, how to create login banners, and how to
customize CLI parameters.
This chapter includes the following sections:

Note

•

Configuring ASA Access for ASDM, Telnet, or SSH, page 37-1

•

Configuring CLI Parameters, page 37-6

•

Configuring ICMP Access, page 37-10

•

Configuring Management Access Over a VPN Tunnel, page 37-12

•

Configuring AAA for System Administrators, page 37-13

•

Feature History for Management Access, page 37-33

To access the ASA interface for management access, you do not also need an access list allowing the
host IP address. You only need to configure management access according to the sections in this chapter.

Configuring ASA Access for ASDM, Telnet, or SSH
This section describes how to allow clients to access the ASA using ASDM, Telnet, or SSH and includes
the following topics:
•

Licensing Requirements for ASA Access for ASDM, Telnet, or SSH, page 37-2

•

Guidelines and Limitations, page 37-2

•

Configuring Telnet Access, page 37-3

•

Using a Telnet Client, page 37-4

•

Configuring SSH Access, page 37-4

•

Using an SSH Client, page 37-5

•

Configuring HTTPS Access for ASDM, page 37-6

Cisco ASA 5500 Series Configuration Guide using the CLI

37-1

Chapter 37

Configuring Management Access

Configuring ASA Access for ASDM, Telnet, or SSH

Licensing Requirements for ASA Access for ASDM, Telnet, or SSH
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines
•

You cannot use Telnet to the lowest security interface unless you use Telnet inside a VPN tunnel.

•

Management access to an interface other than the one from which you entered the ASA is not
supported. For example, if your management host is located on the outside interface, you can only
initiate a management connection directly to the outside interface. The only exception to this rule is
through a VPN connection. See the “Configuring Management Access Over a VPN Tunnel” section
on page 37-12.

•

The ASA allows:
– A maximum of 5 concurrent Telnet connections per context, if available, with a maximum of

100 connections divided among all contexts.
– A maximum of 5 concurrent SSH connections per context, if available, with a maximum of 100

connections divided among all contexts.
– A maximum of 5 concurrent ASDM instances per context, if available, with a maximum of 32

ASDM instances among all contexts.
•

The ASA supports the SSH remote shell functionality provided in SSH Versions 1 and 2 and
supports DES and 3DES ciphers.

•

XML management over SSL and SSH is not supported.

•

(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.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-2

Chapter 37

Configuring Management Access
Configuring ASA Access for ASDM, Telnet, or SSH

Configuring Telnet Access
To identify the client IP addresses allowed to connect to the ASA using Telnet, perform the following
steps.

Detailed Steps

Step 1

Command

Purpose

telnet source_IP_address mask
source_interface

For each address or subnet, identifies the IP addresses from
which the ASA accepts connections.
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.

Example:
hostname(config)# telnet 192.168.1.2
255.255.255.255 inside

Step 2

telnet timeout minutes

Sets the duration for how long a Telnet session can be idle
before the ASA disconnects the session.

Example:

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.

hostname(config)# telnet timeout 30

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:
hostname(config)# telnet 192.168.1.2 255.255.255.255 inside

The following example shows how to allow all users on the 192.168.3.0 network to access the ASA on
the inside interface:
hostname(config)# telnet 192.168.3.0 255.255.255.0 inside

Cisco ASA 5500 Series Configuration Guide using the CLI

37-3

Chapter 37

Configuring Management Access

Configuring ASA Access for ASDM, Telnet, or SSH

Using a Telnet Client
To gain access to the ASA CLI using Telnet, enter the login password set by the password command. If
you configure Telnet authentication (see the “Configuring Authentication for CLI and ASDM Access”
section on page 37-19), then enter the username and password defined by the AAA server or local
database.

Configuring SSH Access
To identify the client IP addresses and define a user allowed to connect to the ASA using SSH, perform
the following steps.

Detailed Steps

Step 1

Command

Purpose

crypto key generate rsa modulus
modulus_size

Generates an RSA key pair, which is required for SSH.

Example:

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.

hostname(config)# crypto key generate rsa
modulus 1024

Step 2

write memory

Saves the RSA keys to persistent flash memory.

Example:
hostname(config)# write memory

Step 3

aaa authentication ssh console LOCAL

Enables local authentication for SSH access. You can
alternatively configure authentication using a AAA server. See
the “Configuring Authentication for CLI and ASDM Access”
section on page 37-19 for more information.

Step 4

username username password password

Creates a user in the local database that can be used for SSH
access.

Step 5

ssh source_IP_address mask
source_interface

For each address or subnet, identifies the IP addresses from
which the ASA accepts connections, and the interface on which
you can SSH. Unlike Telnet, you can SSH on the lowest
security level interface.

Example:
hostname(config)# ssh 192.168.3.0
255.255.255.0 inside

Step 6

(Optional)
ssh timeout minutes

Example:
hostname(config)# ssh timeout 30

Cisco ASA 5500 Series Configuration Guide using the CLI

37-4

Sets the duration for how long an SSH session can be idle
before the ASA disconnects the session.
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.

Chapter 37

Configuring Management Access
Configuring ASA Access for ASDM, Telnet, or SSH

Step 7

Command

Purpose

(Optional)

Limits access to SSH version 1 or 2. By default, SSH allows
both versions 1 and 2.

ssh version version_number

Example:
hostname(config)# ssh version 2

Step 8

ssh key-exchange {dh-group1 | dhgroup14}

Example:
hostname(config)# ssh key-exchange
dh-group14

Specifies that either the Diffie-Hellman Group 1 or
Diffie-Hellman Group 14 follows and should be used for key
exchange. Diffie-Hellman Group 1 is the default if no value is
specified.

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:
hostname(config)# crypto key generate rsa modulus 1024
hostname(config)# write memory
hostname(config)# aaa authentication ssh console LOCAL
WARNING: local database is empty! Use 'username' command to define local users.
hostname(config)# username exampleuser1 password examplepassword1
hostname(config)# ssh 192.168.1.2 255.255.255.255 inside
hostname(config)# ssh timeout 30

The following example shows how to allow all users on the 192.168.3.0 network to access the ASA on
the inside interface:
hostname(config)# ssh 192.168.3.0 255.255.255.0 inside

Using an SSH Client
In the SSH client on your management host, enter the username and password that you configured in the
“Configuring SSH Access” section on page 37-4. When starting an SSH session, a dot (.) displays on the
ASA console before the following SSH user authentication prompt appears:
hostname(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.

Note

If more than one SSH configuration session exists and the configuration operation is carried through any
file operations (such as copy, tftp, config net, context mode config file), even if it is a single CLI, it will
be blocked with the response "Command Ignored, configuration in progress...". If the CLI is directly
entered through a command prompt, it is not blocked.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-5

Chapter 37

Configuring Management Access

Configuring CLI Parameters

Configuring HTTPS Access for ASDM
To use ASDM, you need to enable the HTTPS server, and allow HTTPS connections to the ASA. HTTPS
access is enabled as part of the factory default configuration or when you use the setup command. This
section describes how to manually configure ASDM access.
To configure HTTPS access for ASDM, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

http source_IP_address mask
source_interface

For each address or subnet, identifies the IP addresses from
which the ASA accepts HTTPS connections.

Example:
hostname(config)# http 192.168.1.2
255.255.255.255 inside

Step 2

http server enable [port]

Enables the HTTPS server.

Example:

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:

hostname(config)# http server enable 443

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:
hostname(config)# http server enable
hostname(config)# http 192.168.1.2 255.255.255.255 inside

The following example shows how to allow all users on the 192.168.3.0 network to access ASDM on the
inside interface:
hostname(config)# http 192.168.3.0 255.255.255.0 inside

Configuring CLI Parameters
This section includes the following topics:
•

Licensing Requirements for CLI Parameters, page 37-7

•

Guidelines and Limitations, page 37-7

•

Configuring a Login Banner, page 37-7

•

Customizing a CLI Prompt, page 37-8

•

Changing the Console Timeout, page 37-9

Cisco ASA 5500 Series Configuration Guide using the CLI

37-6

Chapter 37

Configuring Management Access
Configuring CLI Parameters

Licensing Requirements for CLI Parameters
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.

Configuring a Login Banner
You can configure a message to display when a user connects to the ASA, before a user logs in, or before
a user enters privileged EXEC mode.

Restrictions
After a banner is added, Telnet or SSH sessions to 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).

•

From a security perspective, it is important that your banner discourage unauthorized access. Do not
use the words “welcome” or “please,” as they appear to invite intruders in. The following banner
sets the correct tone for unauthorized access:

Guidelines

You have logged in to a secure device. If you are not authorized to access this
device, log out immediately or risk possible criminal consequences.

•

See RFC 2196 for guidelines about banner messages.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-7

Chapter 37

Configuring Management Access

Configuring CLI Parameters

To configure a login banner, perform the following steps:

Detailed Steps

Command

Purpose

banner {exec | login | motd} text

Adds 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). 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.

Example:
hostname(config)# banner motd Welcome to
$(hostname).

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 example shows how to add a message-of-the-day banner:
hostname(config)# banner motd Welcome to $(hostname).
hostname(config)# banner motd Contact me at admin@example.com for any
hostname(config)# banner motd issues.

Customizing a CLI Prompt
The CLI Prompt pane lets you customize the prompt used during CLI sessions. By default, the prompt
shows the hostname of the ASA. In multiple context mode, the prompt also displays the context name.
You can display the following items in the CLI prompt:
context

(Multiple mode only) Displays the name of the current context.

domain

Displays the domain name.

hostname

Displays the hostname.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-8

Chapter 37

Configuring Management Access
Configuring CLI Parameters

priority

Displays the failover priority as pri (primary) or sec (secondary).

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 nonactive 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.

Detailed Steps
To customize the CLI prompt, enter the following command:
Command

Purpose

prompt {[hostname] [context] [domain]
[slot] [state] [priority]}

Customizes the CLI prompt.

Example:
hostname(config)# firewall transparent

Changing the Console Timeout
The console timeout sets how long a connection can remain in privileged EXEC mode or configuration
mode; when the timeout is reached, the session drops into user EXEC mode. By default, the session does
not time out. This setting does not affect how long you can remain connected to the console port, which
never times out.
To change the console timeout, enter the following command:
Command

Purpose

console timeout number

Specifies the idle time in minutes (0 through 60) after which the privileged
session ends. The default timeout is 0, which means the session does not
time out.

Example:
hostname(config)# console timeout 0

Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-9

Chapter 37

Configuring Management Access

Configuring ICMP Access

Configuring ICMP Access
By default, you can send ICMP packets to any ASA interface using either IPv4 or IPv6. This section tells
how to limit ICMP management access to the ASA. You can protect the ASA from attacks by limiting
the addresses of hosts and networks that are allowed to have ICMP access to the ASA.

Note

For allowing ICMP traffic through the ASA, see Chapter 34, “Configuring Access Rules.”
This section includes the following topics:
•

Information About ICMP Access, page 37-10

•

Licensing Requirements for ICMP Access, page 37-10

•

Guidelines and Limitations, page 37-10

•

Default Settings, page 37-11

•

Configuring ICMP Access, page 37-11

Information About ICMP Access
ICMP in IPv6 functions the same as ICMP in IPv4. ICMPv6 generates error messages, such as ICMP
destination unreachable messages and informational messages like ICMP echo request and reply
messages. Additionally ICMP packets in IPv6 are used in the IPv6 neighbor discovery process and path
MTU discovery.
We recommend that you always grant permission for the ICMP unreachable message type (type 3).
Denying ICMP unreachable messages disables ICMP path MTU discovery, which can halt IPsec and
PPTP traffic. See RFC 1195 and RFC 1435 for details about path MTU discovery.
If you configure ICMP rules, then the ASA uses a first match to the ICMP traffic followed by an implicit
deny all entry. That is, if the first matched entry is a permit entry, the ICMP packet continues to be
processed. If the first matched entry is a deny entry or an entry is not matched, the ASA discards the
ICMP packet and generates a syslog message. An exception is when an ICMP rule is not configured; in
that case, a permit statement is assumed.

Licensing Requirements for ICMP Access
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-10

Chapter 37

Configuring Management Access
Configuring ICMP Access

Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6.
Additional Guidelines
•

The ASA does not respond to ICMP echo requests directed to a broadcast address.

•

The ASA only responds to ICMP traffic sent to the interface that traffic comes in on; you cannot
send ICMP traffic through an interface to a far interface.

Default Settings
By default, you can send ICMP packets to any ASA interface using either IPv4 or IPv6.

Configuring ICMP Access
To configure ICMP access rules, enter one of the following commands:

Detailed Steps

Command

Purpose

(For IPv4)

Creates an IPv4 ICMP access rule. If you do not specify an icmp_type, all
types are identified. You can enter the number or the name. To control ping,
specify echo-reply (0) (ASA-to-host) or echo (8) (host-to-ASA). See the
“ICMP Types” section on page B-15 for a list of ICMP types.

icmp {permit | deny} {host ip_address |
ip_address mask | any} [icmp_type]
interface_name

Example:
hostname(config)# icmp deny host 10.1.1.15
inside

(For IPv6)
ipv6 icmp {permit | deny}
{ipv6-prefix/prefix-length | any | host
ipv6-address} [icmp-type] interface_name

Creates an IPv6 ICMP access rule. If you do not specify an icmp_type, all
types are identified. You can enter the number or the name. To control ping,
specify echo-reply (0) (ASA-to-host) or echo (8) (host-to-ASA). See
the“ICMP Types” section on page B-15 for a list of ICMP types.

Example:
hostname(config)# icmp permit host
fe80::20d:88ff:feee:6a82 outside

Examples
The following example shows how to allow all hosts except the one at 10.1.1.15 to use ICMP to the inside
interface:
hostname(config)# icmp deny host 10.1.1.15 inside
hostname(config)# icmp permit any inside

Cisco ASA 5500 Series Configuration Guide using the CLI

37-11

Chapter 37

Configuring Management Access

Configuring Management Access Over a VPN Tunnel

The following example shows how to allow the host at 10.1.1.15 to use only ping to the inside interface,
enter the following command:
hostname(config)# icmp permit host 10.1.1.15 inside

The following example shows how to deny all ping requests and permit all packet-too-big messages (to
support path MTU discovery) at the outside interface:
hostname(config)# ipv6 icmp deny any echo-reply outside
hostname(config)# ipv6 icmp permit any packet-too-big outside

The following example shows how to permit host 2000:0:0:4::2 or hosts on prefix 2001::/64 to ping the
outside interface:
hostname(config)# ipv6 icmp permit host 2000:0:0:4::2 echo-reply outside
hostname(config)# ipv6 icmp permit 2001::/64 echo-reply outside
hostname(config)# ipv6 icmp permit any packet-too-big outside

Configuring Management Access Over a VPN Tunnel
If your VPN tunnel terminates on one interface, but you want to manage the ASA by accessing a different
interface, you can identify that interface as a management-access interface. For example, if you enter the
ASA from the outside interface, this feature lets you connect to the inside interface using ASDM, SSH,
Telnet, or SNMP; or you can ping the inside interface when entering from the outside interface.
Management access is available via the following VPN tunnel types: IPsec clients, IPsec site-to-site, and
the AnyConnect SSL VPN client.
This section includes the following topics:
•

Licensing Requirements for a Management Interface, page 37-12

•

Guidelines and Limitations, page 37-12

•

Configuring a Management Interface, page 37-13

Licensing Requirements for a Management Interface
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single mode.
Firewall Mode Guidelines

Supported in routed mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-12

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

IPv6 Guidelines

Supports IPv6.
Additional Guidelines

You can define only one management access interface.

Configuring a Management Interface
To configure the management interface, enter the following command:
Command

Purpose

management access management_interface

The management_interface specifies the name of the management
interface that you want to access when entering the ASA from another
interface.

Example:
hostname(config)# management access inside

Configuring AAA for System Administrators
This section describes how to enable authentication and command authorization for system
administrators. Before you configure AAA for system administrators, first configure the local database
or AAA server according to procedures listed in Chapter 35, “Configuring AAA Servers and the Local
Database.”
This section includes the following topics:
•

Information About AAA for System Administrators, page 37-14

•

Licensing Requirements for AAA for System Administrators, page 37-17

•

Prerequisites, page 37-17

•

Guidelines and Limitations, page 37-18

•

Default Settings, page 37-18

•

Configuring Authentication for CLI and ASDM Access, page 37-19

•

Configuring Authentication to Access Privileged EXEC Mode (the enable Command), page 37-19

•

Limiting User CLI and ASDM Access with Management Authorization, page 37-21

•

Configuring Command Authorization, page 37-22

•

Configuring Management Access Accounting, page 37-30

•

Viewing the Currently Logged-In User, page 37-30

•

Recovering from a Lockout, page 37-31

•

Setting a Management Session Quota, page 37-32

Cisco ASA 5500 Series Configuration Guide using the CLI

37-13

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

Information About AAA for System Administrators
This section describes AAA for system administrators and includes the following topics:
•

Information About Management Authentication, page 37-14

•

Information About Command Authorization, page 37-14

Information About Management Authentication
This section describes authentication for management access and includes the following topics:
•

Comparing CLI Access with and without Authentication, page 37-14

•

Comparing ASDM Access with and without Authentication, page 37-14

Comparing CLI Access with and without Authentication
How you log into the ASA depends on whether or not you enable authentication:
•

If you do not enable any authentication for Telnet, you do not enter a username; you enter the login
password (set with the password command). For SSH, you enter the username and the login
password. You access user EXEC mode.

•

If you enable Telnet or SSH authentication according to this section, you enter the username and
password as defined on the AAA server or local user database. You access user EXEC mode.

To enter privileged EXEC mode after logging in, enter the enable command. How enable works depends
on whether you enable authentication:
•

If you do not configure enable authentication, enter the system enable password when you enter the
enable command (set by the enable password command). However, if you do not use enable
authentication, after you enter the enable command, you are no longer logged in as a particular user.
To maintain your username, use enable authentication.

•

If you configure enable authentication (see the Configuring Authentication to Access Privileged
EXEC Mode (the enable Command), page 37-19), the ASA prompts you for your username and
password again. This feature is particularly useful when you perform command authorization, in
which usernames are important in determining the commands that a user can enter.

For enable authentication using the local database, you can use the login command instead of the enable
command. login maintains the username but requires no configuration to turn on authentication. See the
“Authenticating Users with the login Command” section on page 37-20 for more information.

Comparing ASDM Access with and without Authentication
By default, you can log into ASDM with a blank username and the enable password set by the enable
password command. Note that if you enter a username and password at the login screen (instead of
leaving the username blank), ASDM checks the local database for a match.
If you configure HTTP authentication, you can no longer use ASDM with a blank username and the
enable password.

Information About Command Authorization
This section describes command authorization and includes the following topics:
•

Supported Command Authorization Methods, page 37-15

Cisco ASA 5500 Series Configuration Guide using the CLI

37-14

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

•

About Preserving User Credentials, page 37-15

•

Security Contexts and Command Authorization, page 37-16

Supported Command Authorization Methods
You can use one of two command authorization methods:
•

Note

•

Local privilege levels—Configure the command privilege levels on the ASA. When a local,
RADIUS, or LDAP (if you map LDAP attributes to RADIUS attributes) user authenticates for CLI
access, the ASA places that user in the privilege level that is defined by the local database, RADIUS,
or LDAP server. The user can access commands at the assigned privilege level and below. Note that
all users access user EXEC mode when they first log in (commands at level 0 or 1). The user needs
to authenticate 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).

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 (see the
“Configuring Local Command Authorization” section on page 37-23). (See the command
reference for more information about the enable command.)
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.

About Preserving User Credentials
When a user logs into the ASA, that user is required to provide a username and password for
authentication. The ASA retains these session credentials in case further authentication is needed later
in the session.
When the following configurations are in place, a user needs only to authenticate with the local server
for login. Subsequent serial authorization uses the saved credentials. The user is also prompted for the
privilege level 15 password. When exiting privileged mode, the user is authenticated again. User
credentials are not retained in privileged mode.
•

The local server is configured to authenticate user access.

•

Privilege level 15 command access is configured to require a password.

•

The user account is configured for serial-only authorization (no access to console or ASDM).

•

The user account is configured for privilege level 15 command access.

The following table shows how credentials are used in this case by the ASA.

Credentials required

Username and
Password
Authentication

Serial
Authorization

Privileged Mode Privileged
Command
Mode Exit
Authorization
Authorization

Username

Yes

No

No

Yes

Cisco ASA 5500 Series Configuration Guide using the CLI

37-15

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

Credentials required

Username and
Password
Authentication

Serial
Authorization

Privileged Mode Privileged
Command
Mode Exit
Authorization
Authorization

Password

Yes

No

No

Yes

Privileged Mode
Password

No

No

Yes

No

Security Contexts and Command Authorization
The following are important points to consider when implementing command authorization with
multiple security contexts:
•

AAA settings are discrete per context, not shared among contexts.
When configuring command authorization, you must configure each security context separately.
This configuration provides you the opportunity to enforce different command authorizations for
different security contexts.
When switching between security contexts, administrators should be aware that the commands
permitted for the username specified when they login may be different in the new context session or
that command authorization may not be configured at all in the new context. Failure to understand
that command authorizations may differ between security contexts could confuse an administrator.
This behavior is further complicated by the next point.

•

New context sessions started with the changeto command always use the default enable_15
username as the administrator identity, regardless of which username was used in the previous
context session. This behavior can lead to confusion if command authorization is not configured for
the enable_15 user or if authorizations are different for the enable_15 user than for the user in the
previous context session.
This behavior also affects command accounting, which is useful only if you can accurately associate
each command that is issued with a particular administrator. Because all administrators with
permission to use the changeto command can use the enable_15 username in other contexts,
command accounting records may not readily identify who was logged in as the enable_15
username. If you use different accounting servers for each context, tracking who was using the
enable_15 username requires correlating the data from several servers.
When configuring command authorization, consider the following:
•

An administrator with permission to use the changeto command effectively has permission to
use all commands permitted to the enable_15 user in each of the other contexts.

•

If you intend to authorize commands differently per context, ensure that in each context the
enable_15 username is denied use of commands that are also denied to administrators who are
permitted use of the changeto command.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-16

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

Licensing Requirements for AAA for System Administrators
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Prerequisites
Depending on the feature, you can use the following:
•

AAA server—See the “Configuring AAA Server Groups” section on page 35-11.

•

Local Database—See the “Adding a User Account to the Local Database” section on page 35-20.

Prerequisites for Management Authentication

Before the ASA can authenticate a Telnet, SSH, or HTTP user, you must identify the IP addresses that
are allowed to communicate with the ASA. For more information, see the “Configuring ASA Access for
ASDM, Telnet, or SSH” section on page 37-1.
Prerequisites for Local Command Authorization
•

Configure enable authentication. (See the “Configuring Authentication for CLI and ASDM Access”
section on page 37-19.) enable authentication is essential for maintaining the username after the
user accesses the enable command.
Alternatively, you can use the login command (which is the same as the enable command with
authentication; for the local database only), which requires no configuration. We do not recommend
this option because it is not as secure as enable authentication.
You can also use CLI authentication, but it is not required.

•

See the following prerequisites for each user type:
– Local database users—Configure each user in the local database at a privilege level from 0 to 15.
– RADIUS users—Configure the user with Cisco VSA CVPN3000-Privilege-Level with a value

between 0 and 15.
– LDAP users—Configure the user with a privilege level between 0 and 15, and then map the

LDAP attribute to Cisco VSA CVPN3000-Privilege-Level according to the “Configuring LDAP
Attribute Maps” section on page 35-18.
Prerequisites for TACACS+ Command Authorization
•

Configure CLI authentication (see the “Configuring Authentication for CLI and ASDM Access”
section on page 37-19).

•

Configure enable authentication (see the “Configuring Authentication to Access Privileged EXEC
Mode (the enable Command)” section on page 37-19).

Prerequisites for Managament Accounting
•

Configure CLI authentication (see the “Configuring Authentication for CLI and ASDM Access”
section on page 37-19).

Cisco ASA 5500 Series Configuration Guide using the CLI

37-17

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

•

Configure enable authentication (see the “Configuring Authentication to Access Privileged EXEC
Mode (the enable Command)” section on page 37-19).

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6.

Default Settings
By default, the following commands are assigned to privilege level 0. All other commands are assigned
to privilege level 15.
•

show checksum

•

show curpriv

•

enable

•

help

•

show history

•

login

•

logout

•

pager

•

show pager

•

clear pager

•

quit

•

show version

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 will not be able to enter configuration mode.
To view all privilege levels, see the “Viewing Local Command Privilege Levels” section on page 37-26.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-18

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

Configuring Authentication for CLI and ASDM Access
To configure management authentication, enter the following command:
Command

Purpose

aaa authentication {telnet | ssh | http |
serial} console {LOCAL |
server_group [LOCAL]}

Authenticates users for management access. The telnet keyword controls
Telnet access.
The ssh keyword controls SSH access. The SSH default usernames asa and
pix are no longer supported.

Example:
hostname(config)# aaa authentication
telnet console LOCAL

The http keyword controls ASDM access.
The serial keyword controls console port access.
HTTP management authentication does not support the SDI protocol for a
AAA server group.
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 (LOCAL
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.

Configuring Authentication to Access Privileged EXEC Mode (the enable
Command)
You can configure the ASA to authenticate users with a AAA server or the local database when they enter
the enable command. Alternatively, users are automatically authenticated with the local database when
they enter the login command, which also accesses privileged EXEC mode depending on the user level
in the local database.
This section includes the following topics:
•

Configuring Authentication for the enable Command, page 37-20

•

Authenticating Users with the login Command, page 37-20

Cisco ASA 5500 Series Configuration Guide using the CLI

37-19

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

Configuring Authentication for the enable Command
You can configure the ASA to authenticate users when they enter the enable command. See the
“Comparing CLI Access with and without Authentication” section on page 37-14 for more information.
To authenticate users who enter the enable command, enter the following command.
Command

Purpose

aaa authentication enable console {LOCAL |
server_group [LOCAL]}

Authenticates users who enter the enable command. The user is prompted
for the username and password.

Example:
hostname(config)# aaa authentication
enable console LOCAL

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 (LOCAL
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 of 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.

Authenticating Users with the login Command
From user EXEC mode, you can log in as any username in the local database using the login command.
This feature allows users to 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. See the “Configuring Local Command Authorization” section
on page 37-23 for more information.

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 use a AAA server for
authentication, 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.
To log in as a user from the local database, enter the following command:

Command

Purpose

login

Logs in as a user from the local database. 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.

Example:
hostname# login

Cisco ASA 5500 Series Configuration Guide using the CLI

37-20

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

Limiting User CLI and ASDM Access with Management Authorization
If you configure CLI or enable authentication, you can limit a local user, RADIUS, TACACS+, or LDAP
user (if you map LDAP attributes to RADIUS attributes) from accessing the CLI, ASDM, or the enable
command.

Note

Serial access is not included in management authorization, so if you configure the aaa authentication
serial consolecommand, then any user who authenticates can access the console port.
To limit user CLI and ASDM access, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

aaa authorization exec
authentication-server

Enables management authorization for local, RADIUS, LDAP
(mapped), and TACACS+ users. Also enables support of
administrative user privilege levels from RADIUS, which can be
used in conjunction with local command privilege levels for
command authorization. See the “Configuring Local Command
Authorization” section on page 37-23 for more information. Use
the aaa authorization exec LOCAL command to enable
attributes to be taken from the local database.

Example:
hostname(config)# aaa authorization exec
authentication-server

Cisco ASA 5500 Series Configuration Guide using the CLI

37-21

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

Command
Step 2

Purpose

To configure the user for management authorization, see the following requirements for each AAA server type or
local user:
•

RADIUS or LDAP (mapped) users—Use the IETF RADIUS numeric Service-Type attribute, which maps to one
of the following values:
– Service-Type 6 (Administrative)—Allows full access to any services specified by the aaa authentication

console commands.
– Service-Type 7 (NAS prompt)—Allows access to the CLI when you configure the aaa authentication

{telnet | ssh} console command, but denies ASDM configuration access if you configure the aaa
authentication http console command. ASDM monitoring access is allowed. If you configure enable
authentication with the aaa authentication enable console command, the user cannot access privileged
EXEC mode using the enable command.
– Service-Type 5 (Outbound)—Denies management access. The user cannot use any services specified by the

aaa authentication console commands (excluding the serial keyword; serial access is allowed). Remote
access (IPsec and SSL) users can still authenticate and terminate their remote access sessions.
Configure Cisco VSA CVPN3000-Privilege-Level with a value between 0 and 15. and then map the LDAP
attributes to Cisco VAS CVPN3000-Privilege-Level using the ldap map-attributes command. For more
information, see the “Configuring LDAP Attribute Maps” section on page 35-18.
•

TACACS+ users—Authorization is requested with “service=shell,” and the server responds with PASS or FAIL.
– PASS, privilege level 1—Allows access to ASDM, with limited read-only access to the configuration and

monitoring sections, and access for show commands that are privilege level 1 only.
– PASS, privilege level 2 and higher—Allows access to the CLI when you configure the aaa authentication

{telnet | ssh} console command, but denies ASDM configuration access if you configure the aaa
authentication http console command. ASDM monitoring access is allowed. If you configure enable
authentication with the aaa authentication enable console command, the user cannot access privileged
EXEC mode using the enable command. You are not allowed to access privileged EXEC mode using the
enable command if your enable privilege level is set to 14 or less.
– FAIL—Denies management access. You cannot use any services specified by the aaa authentication

console commands (excluding the serial keyword; serial access is allowed).
•

Local users—Sets the service-type command. By default, the service-type is admin, which allows full access
to any services specified by the aaa authentication console command. Uses the username command to
configure local database users at a privilege level from 0 to 15. For more information, see the “Adding a User
Account to the Local Database” section on page 35-20.

Configuring Command Authorization
If you want to control access to commands, the ASA lets you configure command authorization, where
you can determine which commands that are available to a user. By default when you log in, you can
access user EXEC mode, which offers only minimal commands. When you enter the enable command
(or the login command when you use the local database), you can access privileged EXEC mode and
advanced commands, including configuration commands.
You can use one of two command authorization methods:
•

Local privilege levels

•

TACACS+ server privilege levels

Cisco ASA 5500 Series Configuration Guide using the CLI

37-22

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

For more information about command authorization, see the “Information About Command
Authorization” section on page 37-14.
This section includes the following topics:
•

Configuring Local Command Authorization, page 37-23

•

Viewing Local Command Privilege Levels, page 37-26

•

Configuring Commands on the TACACS+ Server, page 37-26

•

Configuring TACACS+ Command Authorization, page 37-29

Configuring Local Command Authorization
Local command authorization lets you assign commands to one of 16 privilege levels (0 to 15). By
default, each command is assigned either to privilege level 0 or 15. You can define each user to be at a
specific privilege level, and each user can enter any command at the assigned privilege level or below.
The ASA supports user privilege levels defined in the local database, a RADIUS server, or an LDAP
server (if you map LDAP attributes to RADIUS attributes. See the “Configuring LDAP Attribute Maps”
section on page 35-18.)

Cisco ASA 5500 Series Configuration Guide using the CLI

37-23

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

To configure local command authorization, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

privilege [show | clear | cmd] level level
[mode {enable | cmd}] command command

Assigns a command to a privilege level.
Repeat this command for each command that you want to
reassign.

Example:
hostname(config)# privilege show level 5
command filter

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.
•

Step 2

aaa authorization exec
authentication-server

Example:
hostname(config)# aaa authorization exec
authentication-server

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.

Supports administrative user privilege levels from RADIUS.
Enforces user-specific access levels for users who authenticate for
management access (see the aaa authentication console LOCAL
command).
Without this command, the ASA only supports privilege levels for
local database users and defaults all other types of users to level
15.
This command also enables management authorization for local,
RADIUS, LDAP (mapped), and TACACS+ users.
Use the aaa authorization exec LOCAL command to enable
attributes to be taken from the local database. See the “Limiting
User CLI and ASDM Access with Management Authorization”
section on page 37-21 for information about configuring a user on
a AAA server to accommodate management authorization.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-24

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

Step 3

Command

Purpose

aaa authorization command LOCAL

Enables the use of local command privilege levels, which can be
checked with the privilege level of users in the local database,
RADIUS server, or LDAP server (with mapped attributes).

Example:
hostname(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:
hostname(config)# privilege show level 5 command filter
hostname(config)# privilege clear level 10 command filter
hostname(config)# privilege cmd level 10 command filter

Alternatively, the following example shows how to set all filter commands to the same level:
hostname(config)# privilege level 5 command filter

The show privilege command separates the forms in the display.
The following example shows the use of the mode keyword. The enable command must be entered from
user EXEC mode, while the enable password command, which is accessible in configuration mode,
requires the highest privilege level:
hostname(config)# privilege cmd level 0 mode enable command enable
hostname(config)# privilege cmd level 15 mode cmd command enable
hostname(config)# privilege show level 15 mode cmd command enable

The following example shows an additional command, the configure command, which uses the mode
keyword:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

Note

privilege
privilege
privilege
privilege

show level 5 mode cmd command configure
clear level 15 mode cmd command configure
cmd level 15 mode cmd command configure
cmd level 15 mode enable command configure

This last line is for the configure terminal command.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-25

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

Viewing Local Command Privilege Levels
The following commandslet you view privilege levels for commands.
Command

Purpose

show running-config all privilege all

Shows all commands.

show running-config privilege level level

Shows commands for a specific level. The level is an integer between 0
and 15.

show running-config privilege command
command

Shows the level of a specific command.

Examples
For the show running-config all privilege all command, the ASA displays the current assignment of
each CLI command to a privilege level. The following is sample output from this command:
hostname(config)# show running-config all privilege all
privilege show level 15 command aaa
privilege clear level 15 command aaa
privilege configure level 15 command aaa
privilege show level 15 command aaa-server
privilege clear level 15 command aaa-server
privilege configure level 15 command aaa-server
privilege show level 15 command access-group
privilege clear level 15 command access-group
privilege configure level 15 command access-group
privilege show level 15 command access-list
privilege clear level 15 command access-list
privilege configure level 15 command access-list
privilege show level 15 command activation-key
privilege configure level 15 command activation-key
....

The following example displays the command assignments for privilege level 10:
hostname(config)# show running-config privilege level 10
privilege show level 10 command aaa

The following example displays the command assignments for the access-list command:
hostname(config)# show running-config privilege command access-list
privilege show level 15 command access-list
privilege clear level 15 command access-list
privilege configure level 15 command access-list

Configuring Commands on the TACACS+ Server
You can configure commands on a Cisco Secure Access Control Server (ACS) TACACS+ server as a
shared profile component, for a group, or for individual users. For third-party TACACS+ servers, see
your server documentation for more information about command authorization support.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-26

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

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, and 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 ?, which shows CLI usage (see Figure 37-1).

Figure 37-1

•

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 Figure 37-2).

Figure 37-2

•

Permitting All Related Commands

Permitting Single Word Commands

To disallow some arguments, enter the arguments preceded by deny.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-27

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

For example, to allow enable, but not enable password, enter enable in the commands field, and
deny password in the arguments field. Be sure to check the Permit Unmatched Args check box so
that enable alone is still allowed (see Figure 37-3).
Figure 37-3

•

Disallowing Arguments

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+ server, and not the expanded command show logging message. You can configure
multiple spellings of the same argument to anticipate abbreviations (see Figure 37-4).

Figure 37-4

•

Specifying Abbreviations

We recommend that you allow the following basic commands for all users:
– show checksum
– show curpriv
– enable
– help
– show history

Cisco ASA 5500 Series Configuration Guide using the CLI

37-28

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

– login
– logout
– pager
– show pager
– clear pager
– quit
– show version

Configuring TACACS+ Command Authorization
If you enable TACACS+ command authorization, and a user enters a command at the CLI, the ASA
sends the command and username to the TACACS+ server to determine if the command is authorized.
Before you enable TACACS+ command authorization, be sure that you are logged into the ASA as a user
that is defined on the TACACS+ server, and that you have the necessary command authorization to
continue configuring the ASA. For example, you should log in as an admin user with all commands
authorized. Otherwise, you could become unintentionally locked out.
Do not save your configuration until you are sure that it works the way you want. If you get locked out
because of a mistake, you can usually recover access by restarting the ASA. If you still get locked out,
see the “Recovering from a Lockout” section on page 37-31.
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. In this case, you need to configure local users and
command privilege levels according to procedures listed in the “Configuring Command Authorization”
section on page 37-22.
To configure TACACS+ command authorization, enter the following command:

Detailed Steps

Command

Purpose

aaa authorization command
tacacs+_server_group [LOCAL]

Performs command authorization using a TACACS+ server.

Example:
hostname(config)# aaa authorization
command group_1 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 which method is being used. Be sure to configure users in
the local database (see the “Adding a User Account to the Local Database”
section on page 35-20) and command privilege levels (see the
“Configuring Local Command Authorization” section on page 37-23).

Cisco ASA 5500 Series Configuration Guide using the CLI

37-29

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

Configuring Management Access Accounting
You can send accounting messages to the TACACS+ accounting server when you enter any command
other than show commands at the CLI. You can configure accounting when users log in, when they enter
the enable command, or when they issue commands.
For command accounting, you can only use TACACS+ servers.
To configure management access and enable command accounting, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

aaa accounting {serial | telnet | ssh |
enable} console server-tag

Enables support for AAA accounting for administrative access.
Valid server group protocols are RADIUS and TACACS+.

Example:
hostname(config)# aaa accounting telnet
console group_1

Step 2

aaa accounting command [privilege level]
server-tag

Enables command accounting. Only TACACS+ servers support
command accounting.

Example:

Where privilege level is the minimum privilege level and
server-tag is the name of the TACACS+ server group to which
the ASA should send command accounting messages.

hostname(config)# aaa accounting command
privilege 15 group_1

Viewing the Currently Logged-In User
To view the current logged-in user, enter the following command:
hostname# show curpriv

The following is sample output from the show curpriv command:
hostname# show curpriv
Username: admin
Current privilege level: 15
Current Mode/s: P_PRIV

Table 37-1 describes the show curpriv command output.
Table 37-1

show curpriv Command Output Description

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).

Cisco ASA 5500 Series Configuration Guide using the CLI

37-30

Chapter 37

Configuring Management Access
Configuring AAA for System Administrators

Table 37-1

show curpriv Command Output Description (continued)

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.
Current Mode/s

The available access modes are the following:
•

P_UNPR—User EXEC mode (levels 0 and 1)

•

P_PRIV—Privileged EXEC mode (levels 2 to 15)

•

P_CONF—Configuration mode

Recovering from a Lockout
In some circumstances, when you turn on command authorization or CLI authentication, you can be
locked out of the ASA CLI. You can usually recover access by restarting the ASA. However, if you
already saved your configuration, you might be locked out. Table 37-2 lists the common lockout
conditions and how you might recover from them.
Table 37-2

CLI Authentication and Command Authorization Lockout Scenarios

Feature

Lockout Condition Description

Local CLI
authentication

No users in the
local database

If you have no users in Log in and reset the
the local database, you passwords and aaa
cannot log in, and you commands.
cannot add any users.

TACACS+
command
authorization

Server down or
unreachable and
you do not have
the fallback
method
configured

If the server is
unreachable, then you
cannot log in or enter
any commands.

TACACS+ CLI
authentication
RADIUS CLI
authentication

Workaround: Single Mode

1.

Log in and reset the
passwords and AAA
commands.

2.

Configure the local
database as a fallback
method so you do not
get locked out when the
server is down.

Workaround: Multiple Mode
Session into the ASA from
the switch. From the system
execution space, you can
change to the context and
add a user.
1.

If the server is
unreachable because the
network configuration
is incorrect on the ASA,
session into the ASA
from the switch. From
the system execution
space, you can change
to the context and
reconfigure your
network settings.

2.

Configure the local
database as a fallback
method so you do not
get locked out when the
server is down.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-31

Chapter 37

Configuring Management Access

Configuring AAA for System Administrators

Table 37-2

CLI Authentication and Command Authorization Lockout Scenarios (continued)

Feature

Lockout Condition Description

TACACS+
command
authorization

You are logged in
as a user without
enough privileges
or as a user that
does not exist

Local command
authorization

You are logged in You enable command Log in and reset the
as a user without authorization, but then passwords and aaa
commands.
enough privileges find that the user
cannot enter any more
commands.

You enable command
authorization, but then
find that the user
cannot enter any more
commands.

Workaround: Single Mode

Workaround: Multiple Mode

Fix the TACACS+ server
user account.

Session into the ASA from
the switch. From the system
execution space, you can
change to the context and
complete the configuration
changes. You can also
disable command
authorization until you fix
the TACACS+
configuration.

If you do not have access to
the TACACS+ server and
you need to configure the
ASA immediately, then log
into the maintenance
partition and reset the
passwords and aaa
commands.

Session into the ASA from
the switch. From the system
execution space, you can
change to the context and
change the user level.

Setting a Management Session Quota
An administrator can establish a maximum number of simultaneous management sessions. If the
maximum is reached, no additional sessions are allowed and a syslog message is generated. To prevent
a system lockout, the management session quota mechanism cannot block a console session.
To set a management session maximum, enter the following command:
Command

Purpose

quota management-session number

Sets the maximum number of simultaneous ASDM, SSH, and
Telnet sessions that are allowed on the ASA. The no form of
this command sets the quota value to 0, which means that
there is no session limit.

Example:
hostname(config)# quota management-session 1000

Cisco ASA 5500 Series Configuration Guide using the CLI

37-32

Chapter 37

Configuring Management Access
Feature History for Management Access

Feature History for Management Access
Table 37-3 lists each feature change and the platform release in which it was implemented.
Table 37-3

Feature History for Management Access

Feature Name

Platform
Releases

Feature Information

Management Access

7.0(1)

We introduced this feature.
We introduced the following commands:
show running-config all privilege all, show
running-config privilege level, show running-config
privilege command, telnet, telnet timeout, ssh, ssh
timeout, , http, http server enable, asdm image disk,
banner, console timeout, icmp, ipv6 icmp, management
access, aaa authentication console, aaa authentication
enable console, aaa authentication telnet | ssh console,
service-type, login, privilege, aaa authentication exec
authentication-server, aaa authentication command
LOCAL,aaa accounting serial | telnet | ssh | enable
console, show curpriv, aaa accounting command
privilege

Increased SSH security; the SSH default
username is no longer supported.

8.4(2)

Common Criteria certification and FIPS support 8.4(4.1)
for maximum number of management sessions
allowed and Diffie-Hellman Key Exchange
Group 14 support for SSH.

Starting in 8.4(2), 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 (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.
The maximum number of simultaneous ASDM, SSH, and
Telnet sessions allowed was added. Support for
Diffie-Hellman Key Exchange Group 14 for SSH was
added.
We introduced or modified the following commands: quota
management-session, show running-config quota
management-session, show quota management-session,
ssh.

Cisco ASA 5500 Series Configuration Guide using the CLI

37-33

Chapter 37
Feature History for Management Access

Cisco ASA 5500 Series Configuration Guide using the CLI

37-34

Configuring Management Access

CH A P T E R

38

Configuring AAA Rules for Network Access
This chapter describes how to enable AAA (pronounced “triple A”) for network access.
For information about AAA for management access, see the “Configuring AAA for System
Administrators” section on page 37-13.
This chapter includes the following sections:
•

AAA Performance, page 38-1

•

Licensing Requirements for AAA Rules, page 38-1

•

Guidelines and Limitations, page 38-2

•

Configuring Authentication for Network Access, page 38-2

•

Configuring Authorization for Network Access, page 38-11

•

Configuring Accounting for Network Access, page 38-18

•

Using MAC Addresses to Exempt Traffic from Authentication and Authorization, page 38-20

•

Feature History for AAA Rules, page 38-21

AAA Performance
The ASA uses “cut-through proxy” to significantly improve performance compared to a traditional
proxy server. The performance of a traditional proxy server suffers because it analyzes every packet at
the application layer of the OSI model. The ASA cut-through proxy challenges a user initially at the
application layer and then authenticates with standard AAA servers or the local database. After the ASA
authenticates the user, it shifts the session flow, and all traffic flows directly and quickly between the
source and destination while maintaining session state information.

Licensing Requirements for AAA Rules
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

38-1

Chapter 38

Configuring AAA Rules for Network Access

Guidelines and Limitations

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Supports IPv6.

Configuring Authentication for Network Access
This section includes the following topics:
•

Information About Authentication, page 38-2

•

Configuring Network Access Authentication, page 38-4

•

Enabling Secure Authentication of Web Clients, page 38-6

•

Authenticating Directly with the ASA, page 38-7

Information About Authentication
The ASA lets you configure network access authentication using AAA servers. This section includes the
following topics:
•

One-Time Authentication, page 38-2

•

Applications Required to Receive an Authentication Challenge, page 38-2

•

ASA Authentication Prompts, page 38-3

•

Static PAT and HTTP, page 38-4

One-Time Authentication
A user at a given IP address only needs to authenticate one time for all rules and types, until the
authentication session expires. (See the timeout uauth command in the command reference for timeout
values.) For example, if you configure the ASA to authenticate Telnet and FTP, and a user first
successfully authenticates for Telnet, then as long as the authentication session exists, the user does not
also have to authenticate for FTP.

Applications Required to Receive an Authentication Challenge
Although you can configure the ASA to require authentication for network access to any protocol or
service, users can authenticate directly with HTTP, HTTPS, Telnet, or FTP only. A user must first
authenticate with one of these services before the ASA allows other traffic requiring authentication.
The authentication ports that the ASA supports for AAA are fixed as follows:

Cisco ASA 5500 Series Configuration Guide using the CLI

38-2

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authentication for Network Access

•

Port 21 for FTP

•

Port 23 for Telnet

•

Port 80 for HTTP

•

Port 443 for HTTPS

ASA Authentication Prompts
For Telnet and FTP, the ASA generates an authentication prompt.
For HTTP, the ASA uses basic HTTP authentication by default, and provides an authentication prompt.
You can optionally configure the ASA to redirect users to an internal web page where they can enter their
username and password (configured with the aaa authentication listener command).
For HTTPS, the ASA generates a custom login screen. You can optionally configure the ASA to redirect
users to an internal web page where they can enter their username and password (configured with the
aaa authentication listener command).
Redirection is an improvement over the basic method because it provides an improved user experience
when authenticating, and an identical user experience for HTTP and HTTPS in both Easy VPN and
firewall modes. It also supports authenticating directly with the ASA.
You might want to continue to use basic HTTP authentication for the following reasons:
•

You do not want the ASA to open listening ports.

•

You use NAT on a router and you do not want to create a translation rule for the web page served by
the ASA.

•

Basic HTTP authentication might work better with your network.

For example non-browser applications, as when a URL is embedded in e-mail, might be more compatible
with basic authentication.
After you authenticate correctly, the ASA redirects you to your original destination. If the destination
server also has its own authentication, the user enters another username and password. If you use basic
HTTP authentication and need to enter another username and password for the destination server, then
you need to configure the virtual http command.

Note

If you use HTTP authentication, by default the username and password are sent from the client to the
ASA in clear text; in addition, the username and password are sent on to the destination web server as
well. See the “Enabling Secure Authentication of Web Clients” section on page 38-6 for information to
secure your credentials.
For FTP, a user has the option of entering the ASA username followed by an at sign (@) and then the
FTP username (name1@name2). For the password, the user enters the ASA password followed by an at
sign (@) and then the FTP password (password1@password2). For example, enter the following text:
name> name1@name2
password> password1@password2

This feature is useful when you have cascaded firewalls that require multiple logins. You can separate
several names and passwords by multiple at signs (@).

Cisco ASA 5500 Series Configuration Guide using the CLI

38-3

Chapter 38

Configuring AAA Rules for Network Access

Configuring Authentication for Network Access

Static PAT and HTTP
For HTTP authentication, the ASA checks real ports when static PAT is configured. If it detects traffic
destined for real port 80, regardless of the mapped port, the ASA intercepts the HTTP connection and
enforces authentication.
For example, assume that outside TCP port 889 is translated to port 80 and that any relevant access lists
permit the traffic:
object network obj-192.168.123.10-01
host 192.168.123.10
nat (inside,outside) static 10.48.66.155 service tcp 80 889

Then when users try to access 10.48.66.155 on port 889, the ASA intercepts the traffic and enforces
HTTP authentication. Users see the HTTP authentication page in their web browsers before the ASA
allows HTTP connection to complete.
If the local port is different than port 80, as in the following example:
object network obj-192.168.123.10-02
host 192.168.123.10
nat (inside,outside) static 10.48.66.155 service tcp 111 889

Then users do not see the authentication page. Instead, the ASA sends an error message to the web
browser indicating that the user must be authenticated before using the requested service.

Configuring Network Access Authentication
To configure network access authentication, perform the following steps:

Step 1

Command

Purpose

aaa-server

Identifies your AAA servers. If you have already
identified them, continue to the next step. For more
information about identifying AAA servers, see the
“Configuring AAA Server Groups” section on
page 35-11.

Example:
hostname(config)# aaa-server AuthOutbound protocol
tacacs+

Step 2

access-list

Example:
hostname(config)# access-list MAIL_AUTH extended
permit tcp any any eq smtp

Cisco ASA 5500 Series Configuration Guide using the CLI

38-4

Creates an access list that identifies the source
addresses and destination addresses of traffic you
want to authenticate. For details, see Chapter 15,
“Adding an Extended Access List.”
The permit ACEs mark matching traffic for
authentication, while deny entries exclude matching
traffic from authentication. Be sure to include the
destination ports for either HTTP, HTTPS, Telnet, or
FTP in the access list, because the user must
authenticate with one of these services before other
services are allowed through the ASA.

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authentication for Network Access

Step 3

Command

Purpose

aaa authentication match acl_name interface_name
server_group

Configures authentication.

Example:
hostname(config)# aaa authentication match MAIL_AUTH
inside AuthOutbound

The acl_name argument is the name of the access
list that you created in Step 2. The interface_name
argument is the name of the interface specified with
the nameif command. The server_group argument is
the AAA server group that you created in Step 1.
Note

Step 4

You can alternatively use the aaa
authentication include command (which
identifies traffic within the command).
However, you cannot use both methods in
the same configuration. See the command
reference for more information.

(Optional) Enables the redirection method of
authentication for HTTP or HTTPS connections.

aaa authentication listener http[s] interface_name
[port portnum] redirect

The interface_name argument is the interface on
which you want to enable listening ports. The port
portnum argument specifies the port number on
which the ASA listens; the defaults are 80 (HTTP)
and 443 (HTTPS).

Example:
hostname(config)# aaa authentication listener http
inside redirect

You can use any port number and retain the same
functionality, but be sure your direct authentication
users know the port number; redirected traffic is sent
to the correct port number automatically, but direct
authenticators must specify the port number
manually.
Enter this command separately for HTTP and for
HTTPS.
Step 5

aaa local authentication attempts max-fail number

Example:
hostname(config)# aaa local authentication attempts
max-fail 7

(Optional) Uses the local database for network
access authentication and limits the number of
consecutive failed login attempts that the ASA
allows any given user account (with the exception of
users with a privilege level of 15. This feature does
not affect level 15 users). The number argument
value is between 1 and 16.
Tip

To clear the lockout status of a specific user
or all users, use the clear aaa local user
lockout command.

Examples
The following example authenticates all inside HTTP traffic and SMTP traffic:
hostname(config)# aaa-server AuthOutbound protocol tacacs+
hostname(config-aaa-server-group)# exit
hostname(config)# aaa-server AuthOutbound (inside) host 10.1.1.1
hostname(config-aaa-server-host)# key TACPlusUauthKey
hostname(config-aaa-server-host)# exit
hostname(config)# access-list MAIL_AUTH extended permit tcp any any eq smtp
hostname(config)# access-list MAIL_AUTH extended permit tcp any any eq www
hostname(config)# aaa authentication match MAIL_AUTH inside AuthOutbound

Cisco ASA 5500 Series Configuration Guide using the CLI

38-5

Chapter 38

Configuring AAA Rules for Network Access

Configuring Authentication for Network Access

hostname(config)# aaa authentication listener http inside redirect

The following example authenticates Telnet traffic from the outside interface to a particular server
(209.165.201.5):
hostname(config)# aaa-server AuthInbound protocol tacacs+
hostname(config-aaa-server-group)# exit
hostname(config)# aaa-server AuthInbound (inside) host 10.1.1.1
hostname(config-aaa-server-host)# key TACPlusUauthKey
hostname(config-aaa-server-host)# exit
hostname(config)# access-list TELNET_AUTH extended permit tcp any host 209.165.201.5 eq
telnet
hostname(config)# aaa authentication match TELNET_AUTH outside AuthInbound

For more information about authentication, see the “Information About Authentication” section on
page 38-2.

Enabling Secure Authentication of Web Clients
If you use HTTP authentication, by default the username and password are sent from the client to the
ASA in clear text; in addition, the username and password are sent to the destination web server as well.
The ASA provides the following methods for securing HTTP authentication:
•

Enable the redirection method of authentication for HTTP—Use the aaa authentication listener
command with the redirect keyword. This method prevents the authentication credentials from
continuing to the destination server. See the “ASA Authentication Prompts” section on page 38-3
for more information about the redirection method compared to the basic method.

•

Enable virtual HTTP—Use the virtual http command to authenticateseparately with the ASA and
with the HTTP server. Even if the HTTP server does not need a second authentication, this command
achieves the effect of stripping the basic authentication credentials from the HTTP GET request. See
the “Authenticating HTTP(S) Connections with a Virtual Server” section on page 38-8 for more
information.
Enable the exchange of usernames and passwords between a web client and the ASA with
HTTPS—Use the aaa authentication secure-http-client command to enable the exchange of
usernames and passwords between a web client and the ASA with HTTPS. This is the only method
that protects credentials between the client and the ASA, as well as between the ASA and the
destination server. You can use this method alone, or in conjunction with either of the other methods
so you can maximize your security.
After enabling this feature, when a user requires authentication when using HTTP, the ASA redirects
the HTTP user to an HTTPS prompt. After you authenticate correctly, the ASA redirects you to the
original HTTP URL.
Secured, web-client authentication has the following limitations:
– A maximum of 16 concurrent HTTPS authentication sessions are allowed. If all 16 HTTPS

authentication processes are running, a new connection requiring authentication will not
succeed.
– When uauth timeout 0 is configured (the uauth timeout is set to 0),HTTPS authentication

might not work. If a browser initiates multiple TCP connections to load a web page after HTTPS
authentication, the first connection is let through, but the subsequent connections trigger
authentication. As a result, users are continuously presented with an authentication page, even
if the correct username and password are entered each time. To work around this, set the uauth

Cisco ASA 5500 Series Configuration Guide using the CLI

38-6

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authentication for Network Access

timeout to 1 second with the timeout uauth 0:0:1 command. However, this workaround opens
a 1-second window of opportunity that might allow unauthenticated users to go through the
firewall if they are coming from the same source IP address.
Because HTTPS authentication occurs on the SSL port 443, users must not configure an access-list
command statement to block traffic from the HTTP client to the HTTP server on port 443. Furthermore,
if static PAT is configured for web traffic on port 80, it must also be configured for the SSL port.
– In the following example, the first set of commands configures static PAT for web traffic, and

the second set of commands must be added to support the HTTPS authentication configuration:
object network obj-10.130.16.10-01
host 10.130.16.10
nat (inside,outside) static 10.132.16.200 service tcp 80 80
object network obj-10.130.16.10-02
host 10.130.16.10
nat (inside,outside) static 10.132.16.200 service tcp 443 443

Authenticating Directly with the ASA
If you do not want to allow HTTP, HTTPS, Telnet, or FTP through the ASA but want to authenticate
other types of traffic, you can authenticate with the ASA directly using HTTP, HTTPS, or Telnet.
This section includes the following topics:
•

Authenticating HTTP(S) Connections with a Virtual Server, page 38-8

•

Authenticating Telnet Connections with a Virtual Server, page 38-9

Cisco ASA 5500 Series Configuration Guide using the CLI

38-7

Chapter 38

Configuring AAA Rules for Network Access

Configuring Authentication for Network Access

Authenticating HTTP(S) Connections with a Virtual Server
If you enabled the redirection method of HTTP and HTTPS authentication in the “Configuring Network
Access Authentication” section on page 38-4, then you have also automatically enabled direct
authentication.
When you use HTTP authentication on the ASA (see the“Configuring Network Access Authentication”
section on page 38-4), the ASA uses basic HTTP authentication by default.
To continue to use basic HTTP authentication, and to enable direct authentication for HTTP and HTTPS,
enter the following command:
Command

Purpose

aaa authentication listener http[s] interface_name
[port portnum] redirect

(Optional) Enables the redirection method of authentication
for HTTP or HTTPS connections.

Example:
hostname(config)# aaa authentication listener http
inside redirect

The interface_name argument is the interface on which you
want to enable listening ports. The port portnum argument
specifies the port number on which the ASA listens; the
defaults are 80 (HTTP) and 443 (HTTPS).
You can use any port number and retain the same functionality,
but be sure your direct authentication users know the port
number; redirected traffic is sent to the correct port number
automatically, but direct authenticators must specify the port
number manually.
Enter this command separately for HTTP and for HTTPS.

If the destination HTTP server requires authentication in addition to the ASA, then to authenticate
separately with the ASA (via a AAA server) and with the HTTP server, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

38-8

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authentication for Network Access

Command

Purpose

virtual http

Redirects all HTTP connections that require AAA
authentication to the virtual HTTP server on the ASA. The
ASA prompts for the AAA server username and password.
After the AAA server authenticates the user, the ASA redirects
the HTTP connection back to the original server, but it does
not include the AAA server username and password. Because
the username and password are not included in the HTTP
packet, the HTTP server prompts the user separately for the
HTTP server username and password.

Example:
hostname(config)# virtual http

For inbound users (from lower security to higher security),
you must also include the virtual HTTP address as a
destination interface in the access list applied to the source
interface. In addition, you must add a static NAT command for
the virtual HTTP IP address, even if NAT is not required. An
identity NAT command is typically used (where you translate
the address to itself).
For outbound users, there is an explicit permit for traffic, but
if you apply an access list to an inside interface, be sure to
allow access to the virtual HTTP address. A static statement is
not required.
Note

Do not set the timeout uauth command duration to 0
seconds when using the virtual http command,
because this setting prevents HTTP connections to the
actual web server.

You can authenticate directly with the ASA at the following
URLs when you enable AAA for the interface:
http://interface_ip[:port]/netaccess/connstatus.html
https://interface_ip[:port]/netaccess/connstatus.html

Without virtual HTTP, the same username and password that
you used to authenticate with the ASA are sent to the HTTP
server; you are not prompted separately for the HTTP server
username and password. Assuming the username and
password are not the same for the AAA and HTTP servers,
then the HTTP authentication fails.

Authenticating Telnet Connections with a Virtual Server
Although you can configure network access authentication for any protocol or service (see the aaa
authentication match or aaa authentication include command), you can authenticate directly with
HTTP, Telnet, or FTP only. A user must first authenticate with one of these services before other traffic
that requires authentication is allowed through. If you do not want to allow HTTP, Telnet, or FTP traffic
through the ASA, but want to authenticate other types of traffic, you can configure virtual Telnet; the
user Telnets to a given IP address configured on the ASA, and the ASA issues a Telnet prompt.
To configure a virtual Telnet server, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

38-9

Chapter 38

Configuring AAA Rules for Network Access

Configuring Authentication for Network Access

Command

Purpose

virtual telnet ip_address

Configures a virtual Telnet server.

Example:

The ip_address argument sets the IP address for the virtual
Telnet server. Make sure this address is an unused address that
is routed to the ASA.

hostname(config)# virtual telnet 209.165.202.129

You must configure authentication for Telnet access to the
virtual Telnet address as well as the other services that you
want to authenticate using the authentication match or aaa
authentication include command.
When an unauthenticated user connects to the virtual Telnet IP
address, the user is challenged for a username and password,
and then authenticated by the AAA server. Once authenticated,
the user sees the message “Authentication Successful.” Then,
the user can successfully access other services that require
authentication.
For inbound users (from lower security to higher security),
you must also include the virtual Telnet address as a
destination interface in the access list applied to the source
interface. In addition, you must add a static NAT command for
the virtual Telnet IP address, even if NAT is not required. An
identity NAT command is typically used (where you translate
the address to itself).
For outbound users, there is an explicit permit for traffic, but
if you apply an access list to an inside interface, be sure to
allow access to the virtual Telnet address. A static statement is
not required.
To log out from the ASA, reconnect to the virtual Telnet IP
address; you are then prompted to log out.

Examples
The following example shows how to enable virtual Telnet together with AAA authentication for other
services:
hostname(config)# virtual telnet 209.165.202.129
hostname(config)# access-list ACL-IN extended permit tcp any host 209.165.200.225 eq smtp
hostname(config)# access-list ACL-IN remark This is the SMTP server on the inside
hostname(config)# access-list ACL-IN extended permit tcp any host 209.165.202.129 eq
telnet
hostname(config)# access-list ACL-IN remark This is the virtual Telnet address
hostname(config)# access-group ACL-IN in interface outside
hostname(config)# network object obj-209.165.202.129-01
hostname(config-network-object)# host 209.165.202.129
hostname(config-network-object)# nat (inside,outside) static 209.165.202.129
hostname(config)# access-list AUTH extended permit tcp any host 209.165.200.225 eq smtp
hostname(config)# access-list AUTH remark This is the SMTP server on the inside
hostname(config)# access-list AUTH extended permit tcp any host 209.165.202.129 eq telnet
hostname(config)# access-list AUTH remark This is the virtual Telnet address
hostname(config)# aaa authentication match AUTH outside tacacs+

Cisco ASA 5500 Series Configuration Guide using the CLI

38-10

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authorization for Network Access

Configuring Authorization for Network Access
After a user authenticates for a given connection, the ASA can use authorization to further control traffic
from the user.
This section includes the following topics:
•

Configuring TACACS+ Authorization, page 38-11

•

Configuring RADIUS Authorization, page 38-14

Configuring TACACS+ Authorization
You can configure the ASA to perform network access authorization with TACACS+. You identify the
traffic to be authorized by specifying access lists that authorization rules must match. Alternatively, you
can identify the traffic directly in authorization rules themselves.

Tip

Using access lists to identify traffic to be authorized can greatly reduced the number of authorization
commands that you must enter. This is because each authorization rule that you enter can specify only
one source and destination subnet and service, whereas an access list can include many entries.
Authentication and authorization statements are independent; however, any unauthenticated traffic
matched by an authorization rule will be denied. For authorization to succeed:
1.

A user must first authenticate with the ASA.
Because a user at a given IP address only needs to authenticate one time for all rules and types, if
the authentication session has not expired, authorization can occur even if the traffic is not matched
by an authentication rule.

2.

After a user authenticates, the ASA checks the authorization rules for matching traffic.

3.

If the traffic matches the authorization rule, the ASA sends the username to the TACACS+ server.

4.

The TACACS+ server responds to the ASA with a permit or a deny for that traffic, based on the user
profile.

5.

The ASA enforces the authorization rule in the response.

See the documentation for your TACACS+ server for information about configuring network access
authorizations for a user.
To configure TACACS+ authorization, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

38-11

Chapter 38

Configuring AAA Rules for Network Access

Configuring Authorization for Network Access

Step 1

Command

Purpose

aaa-server

Identifies your AAA servers. If you have already
identified them, continue to the next step. For more
information about identifying AAA servers, see the
“Configuring AAA Server Groups” section on
page 35-11.

Example:
hostname(config)# aaa-server AuthOutbound protocol
tacacs+

Step 2

access-list

Example:
hostname(config)# access-list MAIL_AUTH extended
permit tcp any any eq smtp

Step 3

aaa authentication match acl_name interface_name
server_group

Example:
hostname(config)# aaa authentication match MAIL_AUTH
inside AuthOutbound

Creates an access list that identifies the source
addresses and destination addresses of traffic you
want to authenticate. For details, see Chapter 15,
“Adding an Extended Access List.”
The permit ACEs mark matching traffic for
authentication, while deny entries exclude matching
traffic from authentication. Be sure to include the
destination ports for either HTTP, HTTPS, Telnet, or
FTP in the access list, because the user must
authenticate with one of these services before other
services are allowed through the ASA.
Configures authentication. The acl_name argument
is the name of the access list that you created in Step
2., The interface_name argument is the name of the
interface specified with the nameif command, and
the server_group argument is the AAA server group
that you created in Step 1.
Note

Step 4

aaa authentication listener http[s] interface_name
[port portnum] redirect

Example:
hostname(config)# aaa authentication listener http
inside redirect

You can alternatively use the aaa
authentication include command (which
identifies traffic within the command).
However, you cannot use both methods in
the same configuration. See the command
reference for more information.

(Optional) Enables the redirection method of
authentication for HTTP or HTTPS connections.
The interface_name argument is the interface on
which you want to enable listening ports. The port
portnum argument specifies the port number on
which the ASA listens; the defaults are 80 (HTTP)
and 443 (HTTPS).
You can use any port number and retain the same
functionality, but be sure your direct authentication
users know the port number; redirected traffic is sent
to the correct port number automatically, but direct
authenticators must specify the port number
manually.
Enter this command separately for HTTP and for
HTTPS.

Cisco ASA 5500 Series Configuration Guide using the CLI

38-12

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authorization for Network Access

Step 5

Command

Purpose

aaa local authentication attempts max-fail number

(Optional) Uses the local database for network
access authentication and limits the number of
consecutive failed login attempts that the ASA
allows any given user account (with the exception of
users with a privilege level of 15. This feature does
not affect level 15 users). The number argument
value is between 1 and 16.

Example:
hostname(config)# aaa local authentication attempts
max-fail 7

Tip

Step 6

Create an access list that identifies the source
addresses and destination addresses of traffic that
you want to authorize. For instructions, see
Chapter 15, “Adding an Extended Access List.”

access-list

Example:
hostname(config)# access-list TELNET_AUTH extended
permit tcp any any eq telnet

The permit ACEs mark matching traffic for
authorization, while deny entries exclude matching
traffic from authorization. The access list that you
use for authorization matching should include rules
that are equal to or a subset of the rules in the access
list used for authentication matching.
Note

Step 7

To clear the lockout status of a specific user
or all users, use the clear aaa local user
lockout command.

If you have configured authentication and
want to authorize all the traffic being
authenticated, you can use the same access
list that you created for use with the aaa
authentication match command.

Enables authorization.

aaa authorization match acl_name interface_name
server_group

The acl_name argument is the name of the access
list you created in Step 6, the interface_name
argument is the name of the interface as specified
with the nameif command or by default, and the
server_group argument is the AAA server group that
you created when you enabled authentication.

Example:
hostname(config)# aaa authentication match
TELNET_AUTH inside AuthOutbound

Note

Alternatively, you can use the aaa
authorization include command (which
identifies traffic within the command) but
you cannot use both methods in the same
configuration. See the command reference
for more information.

Examples
The following example authenticates and authorizes inside Telnet traffic. Telnet traffic to servers other
than 209.165.201.5 can be authenticated alone, but traffic to 209.165.201.5 requires authorization.
hostname(config)# access-list TELNET_AUTH
hostname(config)# access-list SERVER_AUTH
telnet
hostname(config)# aaa-server AuthOutbound
hostname(config-aaa-server-group)# exit
hostname(config)# aaa-server AuthOutbound

extended permit tcp any any eq telnet
extended permit tcp any host 209.165.201.5 eq
protocol tacacs+
(inside) host 10.1.1.1

Cisco ASA 5500 Series Configuration Guide using the CLI

38-13

Chapter 38

Configuring AAA Rules for Network Access

Configuring Authorization for Network Access

hostname(config-aaa-server-host)# key TACPlusUauthKey
hostname(config-aaa-server-host)# exit
hostname(config)# aaa authentication match TELNET_AUTH inside AuthOutbound
hostname(config)# aaa authorization match SERVER_AUTH inside AuthOutbound

Configuring RADIUS Authorization
When authentication succeeds, the RADIUS protocol returns user authorizations in the access-accept
message sent by a RADIUS server. For more information about configuring authentication, see the
“Configuring Network Access Authentication” section on page 38-4.
When you configure the ASA to authenticate users for network access, you are also implicitly enabling
RADIUS authorizations; therefore, this section contains no information about configuring RADIUS
authorization on the ASA. It does provide information about how the ASA handles access list
information received from RADIUS servers.
You can configure a RADIUS server to download an access list to the ASA or an access list name at the
time of authentication. The user is authorized to do only what is permitted in the user-specific access list.

Note

If you have used the access-group command to apply access lists to interfaces, be aware of the following
effects of the per-user-override keyword on authorization by user-specific access lists:
•

Without the per-user-override keyword, traffic for a user session must be permitted by both the
interface access list and the user-specific access list.

•

With the per-user-override keyword, the user-specific access list determines what is permitted.

For more information, see the access-group command entry in the command reference.

This section includes the following topics:
•

Configuring a RADIUS Server to Send Downloadable Access Control Lists, page 38-14

•

Configuring a RADIUS Server to Download Per-User Access Control List Names, page 38-18

Configuring a RADIUS Server to Send Downloadable Access Control Lists
This section describes how to configure Cisco Secure ACS or a third-party RADIUS server and includes
the following topics:
•

About the Downloadable Access List Feature and Cisco Secure ACS, page 38-14

•

Configuring Cisco Secure ACS for Downloadable Access Lists, page 38-16

•

Configuring Any RADIUS Server for Downloadable Access Lists, page 38-17

•

Converting Wildcard Netmask Expressions in Downloadable Access Lists, page 38-18

About the Downloadable Access List Feature and Cisco Secure ACS
Downloadable access lists is the most scalable means of using Cisco Secure ACS to provide the
appropriate access lists for each user. It provides the following capabilities:
•

Unlimited access list size—Downloadable access lists are sent using as many RADIUS packets as
required to transport the full access list from Cisco Secure ACS to the ASA.

Cisco ASA 5500 Series Configuration Guide using the CLI

38-14

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authorization for Network Access

•

Simplified and centralized management of access lists—Downloadable access lists enable you to
write a set of access lists once and apply it to many user or group profiles and distribute it to many
ASAs.

This approach is most useful when you have very large access list sets that you want to apply to more
than one Cisco Secure ACS user or group; however, its ability to simplify Cisco Secure ACS user and
group management makes it useful for access lists of any size.
The ASA receives downloadable access lists from Cisco Secure ACS using the following process:
1.

The ASA sends a RADIUS authentication request packet for the user session.

2.

If Cisco Secure ACS successfully authenticates the user, Cisco Secure ACS returns a RADIUS
access-accept message that includes the internal name of the applicable downloadable access list.
The Cisco IOS cisco-av-pair RADIUS VSA (vendor 9, attribute 1) includes the following
attribute-value pair to identify the downloadable access list set:
ACS:CiscoSecure-Defined-ACL=acl-set-name

where acl-set-name is the internal name of the downloadable access list, which is a combination of
the name assigned to the access list by the Cisco Secure ACS administrator and the date and time
that the access list was last modified.
3.

The ASA examines the name of the downloadable access list and determines if it has previously
received the named downloadable access list.
– If the ASA has previously received the named downloadable access list, communication with

Cisco Secure ACS is complete and the ASA applies the access list to the user session. Because
the name of the downloadable access list includes the date and time that it was last modified,
matching the name sent by Cisco Secure ACS to the name of an access list previously
downloaded means that the ASA has the most recent version of the downloadable access list.
– If the ASA has not previously received the named downloadable access list, it may have an

out-of-date version of the access list or it may not have downloaded any version of the access
list. In either case, the ASA issues a RADIUS authentication request using the downloadable
access list name as the username in the RADIUS request and a null password attribute. In a
cisco-av-pair RADIUS VSA, the request also includes the following attribute-value pairs:
AAA:service=ip-admission
AAA:event=acl-download

In addition, the ASA signs the request with the Message-Authenticator attribute (IETF RADIUS
attribute 80).
4.

After receipt of a RADIUS authentication request that has a username attribute that includes the
name of a downloadable access list, Cisco Secure ACS authenticates the request by checking the
Message-Authenticator attribute. If the Message-Authenticator attribute is missing or incorrect,
Cisco Secure ACS ignores the request. The presence of the Message-Authenticator attribute
prevents malicious use of a downloadable access list name to gain unauthorized network access. The
Message-Authenticator attribute and its use are defined in RFC 2869, RADIUS Extensions,
available at http://www.ietf.org.

5.

If the access list required is less than approximately 4 KB in length, Cisco Secure ACS responds
with an access-accept message that includes the access list. The largest access list that can fit in a
single access-accept message is slightly less than 4 KB, because part of the message must be other
required attributes.
Cisco Secure ACS sends the downloadable access list in a cisco-av-pair RADIUS VSA. The access
list is formatted as a series of attribute-value pairs that each include an ACE and are numbered
serially:
ip:inacl#1=ACE-1

Cisco ASA 5500 Series Configuration Guide using the CLI

38-15

Chapter 38

Configuring AAA Rules for Network Access

Configuring Authorization for Network Access

ip:inacl#2=ACE-2
.
.
.
ip:inacl#n=ACE-n

The following example is of an attribute-value pair:
ip:inacl#1=permit tcp 10.1.0.0 255.0.0.0 10.0.0.0 255.0.0.0

6.

If the access list required is more than approximately 4 KB in length, Cisco Secure ACS responds
with an access-challenge message that includes a portion of the access list, formatted as described
previously, and a State attribute (IETF RADIUS attribute 24), which includes control data used by
Cisco Secure ACS to track the progress of the download. Cisco Secure ACS fits as many complete
attribute-value pairs into the cisco-av-pair RADIUS VSA as it can without exceeding the maximum
RADIUS message size.
The ASA stores the portion of the access list received and responds with another access-request
message that includes the same attributes as the first request for the downloadable access list, plus
a copy of the State attribute received in the access-challenge message.
This process repeats until Cisco Secure ACS sends the last of the access list in an access-accept
message.

Configuring Cisco Secure ACS for Downloadable Access Lists
You can configure downloadable access lists on Cisco Secure ACS as a shared profile component and
then assign the access list to a group or to an individual user.
The access list definition consists of one or more ASA commands that are similar to the extended
access-list command (see command reference), except without the following prefix:
access-list acl_name extended

The following example is a downloadable access list definition on Cisco Secure ACS version 3.3:
+--------------------------------------------+
| Shared profile Components
|
|
|
|
Downloadable IP ACLs Content
|
|
|
| Name:
acs_ten_acl
|
|
|
|
ACL Definitions
|
|
|
| permit tcp any host 10.0.0.254
|
| permit udp any host 10.0.0.254
|
| permit icmp any host 10.0.0.254
|
| permit tcp any host 10.0.0.253
|
| permit udp any host 10.0.0.253
|
| permit icmp any host 10.0.0.253
|
| permit tcp any host 10.0.0.252
|
| permit udp any host 10.0.0.252
|
| permit icmp any host 10.0.0.252
|
| permit ip any any
|
+--------------------------------------------+

For more information about creating downloadable access lists and associating them with users, see the
user guide for your version of Cisco Secure ACS.
On the ASA, the downloaded access list has the following name:
#ACSACL#-ip-acl_name-number

Cisco ASA 5500 Series Configuration Guide using the CLI

38-16

Chapter 38

Configuring AAA Rules for Network Access
Configuring Authorization for Network Access

The acl_name argument is the name that is defined on Cisco Secure ACS (acs_ten_acl in the preceding
example), and number is a unique version ID generated by Cisco Secure ACS.
The downloaded access list on the ASA consists of the following lines:
access-list
access-list
access-list
access-list
access-list
access-list
access-list
access-list
access-list
access-list

#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7
#ACSACL#-ip-asa-acs_ten_acl-3b5385f7

permit
permit
permit
permit
permit
permit
permit
permit
permit
permit

tcp any host 10.0.0.254
udp any host 10.0.0.254
icmp any host 10.0.0.254
tcp any host 10.0.0.253
udp any host 10.0.0.253
icmp any host 10.0.0.253
tcp any host 10.0.0.252
udp any host 10.0.0.252
icmp any host 10.0.0.252
ip any any

Configuring Any RADIUS Server for Downloadable Access Lists
You can configure any RADIUS server that supports Cisco IOS RADIUS VSAs to send user-specific
access lists to the ASA in a Cisco IOS RADIUS cisco-av-pair VSA (vendor 9, attribute 1).
In the cisco-av-pair VSA, configure one or more ACEs that are similar to the access-list extended
command (see command reference), except that you replace the following command prefix:
access-list acl_name extended

with the following text:
ip:inacl#nnn=

The nnn argument is a number in the range from 0 to 999999999 that identifies the order of the command
statement to be configured on the ASA. If this parameter is omitted, the sequence value is 0, and the
order of the ACEs inside the cisco-av-pair RADIUS VSA is used.
The following example is an access list definition as it should be configured for a cisco-av-pair VSA on
a RADIUS server:
ip:inacl#1=permit tcp 10.1.0.0 255.0.0.0 10.0.0.0 255.0.0.0
ip:inacl#99=deny tcp any any
ip:inacl#2=permit udp 10.1.0.0 255.0.0.0 10.0.0.0 255.0.0.0
ip:inacl#100=deny udp any any
ip:inacl#3=permit icmp 10.1.0.0 255.0.0.0 10.0.0.0 255.0.0.0

For information about making unique per user the access lists that are sent in the cisco-av-pair attribute,
see the documentation for your RADIUS server.
On the ASA, the downloaded access list name has the following format:
AAA-user-username

The username argument is the name of the user that is being authenticated.
The downloaded access list on the ASA consists of the following lines. Notice the order based on the
numbers identified on the RADIUS server.
access-list
access-list
access-list
access-list
access-list

AAA-user-bcham34-79AD4A08
AAA-user-bcham34-79AD4A08
AAA-user-bcham34-79AD4A08
AAA-user-bcham34-79AD4A08
AAA-user-bcham34-79AD4A08

permit tcp 10.1.0.0 255.0.0.0 10.0.0.0 255.0.0.0
permit udp 10.1.0.0 255.0.0.0 10.0.0.0 255.0.0.0
permit icmp 10.1.0.0 255.0.0.0 10.0.0.0 255.0.0.0
deny tcp any any
deny udp any any

Cisco ASA 5500 Series Configuration Guide using the CLI

38-17

Chapter 38

Configuring AAA Rules for Network Access

Configuring Accounting for Network Access

Downloaded access lists have two spaces between the word “access-list” and the name. These spaces
serve to differentiate a downloaded access list from a local access list. In this example, “79AD4A08” is
a hash value generated by the ASA to help determine when access list definitions have changed on the
RADIUS server.

Converting Wildcard Netmask Expressions in Downloadable Access Lists
If a RADIUS server provides downloadable access lists to Cisco VPN 3000 series concentrators as well
as to the ASA, you may need the ASA to convert wildcard netmask expressions to standard netmask
expressions. This is because Cisco VPN 3000 series concentrators support wildcard netmask
expressions, but the ASA only supports standard netmask expressions. Configuring the ASA to convert
wildcard netmask expressions helps minimize the effects of these differences on how you configure
downloadable access lists on your RADIUS servers. Translation of wildcard netmask expressions means
that downloadable access lists written for Cisco VPN 3000 series concentrators can be used by the ASA
without altering the configuration of the downloadable access lists on the RADIUS server.
You configure access list netmask conversion on a per-server basis using the acl-netmask-convert
command, available in the aaa-server configuration mode. For more information about configuring a
RADIUS server, see the “Configuring AAA Server Groups” section on page 35-11. For more
information about the acl-netmask-convert command, see the command reference.

Configuring a RADIUS Server to Download Per-User Access Control List Names
To download a name for an access list that you already created on the ASA from the RADIUS server
when a user authenticates, configure the IETF RADIUS filter-id attribute (attribute number 11) as
follows:
filter-id=acl_name

Note

In Cisco Secure ACS, the values for filter-id attributes are specified in boxes in the HTML interface,
omitting filter-id= and entering only acl_name.
For information about making the filter-id attribute value unique per user, see the documentation for your
RADIUS server.
To create an access list on the ASA, see Chapter 15, “Adding an Extended Access List.”

Configuring Accounting for Network Access
The ASA can send accounting information to a RADIUS or TACACS+ server about any TCP or UDP
traffic that passes through the ASA. If that traffic is also authenticated, then the AAA server can maintain
accounting information by username. If the traffic is not authenticated, the AAA server can maintain
accounting information by IP address. Accounting information includes session start and stop times,
username, the number of bytes that pass through the ASA for the session, the service used, and the
duration of each session.
To configure accounting, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

38-18

Chapter 38

Configuring AAA Rules for Network Access
Configuring Accounting for Network Access

Step 1

Command

Purpose

access-list

If you want the ASA to provide accounting data per
user, you must enable authentication. For more
information, see the “Configuring Network Access
Authentication” section on page 38-4. If you want
the ASA to provide accounting data per IP address,
enabling authentication is not necessary.

Example:
hostname(config)# access-list TELNET_AUTH extended
permit tcp any any eq telnet

Creates an access list that identifies the source
addresses and destination addresses of traffic for
which you want accounting data. For instructions,
see Chapter 15, “Adding an Extended Access List.”
The permit ACEs mark matching traffic for
accounting, while deny entries exclude matching
traffic from accounting.
Note

Step 2

aaa accounting match acl_name interface_name
server_group

If you have configured authentication and
want accounting data for all the traffic being
authenticated, you can use the same access
list that you created for use with the aaa
authentication match command.

Enables accounting.
The acl_name argument is the access list name set in
the access-list command.

Example:
hostname(config)# aaa accounting match SERVER_AUTH
inside AuthOutbound

The interface_name argument is the interface name
set in the nameif command.
The server_group argument is the server group
name set in the aaa-server command.
Note

Alternatively, you can use the aaa
accounting include command (which
identifies traffic within the command), but
you cannot use both methods in the same
configuration. See the command reference
for more information.

Examples
The following example authenticates, authorizes, and accounts for inside Telnet traffic. Telnet traffic to
servers other than 209.165.201.5 can be authenticated alone, but traffic to 209.165.201.5 requires
authorization and accounting.
hostname(config)# aaa-server AuthOutbound protocol tacacs+
hostname(config-aaa-server-group)# exit
hostname(config)# aaa-server AuthOutbound (inside) host 10.1.1.1
hostname(config-aaa-server-host)# key TACPlusUauthKey
hostname(config-aaa-server-host)# exit
hostname(config)# access-list TELNET_AUTH extended permit tcp any any eq telnet
hostname(config)# access-list SERVER_AUTH extended permit tcp any host 209.165.201.5 eq
telnet
hostname(config)# aaa authentication match TELNET_AUTH inside AuthOutbound
hostname(config)# aaa authorization match SERVER_AUTH inside AuthOutbound
hostname(config)# aaa accounting match SERVER_AUTH inside AuthOutbound

Cisco ASA 5500 Series Configuration Guide using the CLI

38-19

Chapter 38

Configuring AAA Rules for Network Access

Using MAC Addresses to Exempt Traffic from Authentication and Authorization

Using MAC Addresses to Exempt Traffic from Authentication
and Authorization
The ASA can exempt from authentication and authorization any traffic from specific MAC addresses.
For example, if the ASA authenticates TCP traffic originating on a particular network, but you want to
allow unauthenticated TCP connections from a specific server, you would use a MAC exempt rule to
exempt from authentication and authorization any traffic from the server specified by the rule.
This feature is particularly useful to exempt devices such as IP phones that cannot respond to
authentication prompts.
To use MAC addresses to exempt traffic from authentication and authorization, perform the following
steps:

Step 1

Command

Purpose

mac-list id {deny | permit} mac macmask

Configures a MAC list.

Example:
hostname(config)# mac-list abc permit 00a0.c95d.0282
ffff.ffff.ffff

The id argument is the hexadecimal number that you
assign to the MAC list. To group a set of MAC
addresses, enter the mac-list command as many
times as needed with the same ID value. Because you
can only use one MAC list for AAA exemption, be
sure that your MAC list includes all the MAC
addresses that you want to exempt. You can create
multiple MAC lists, but you can only use one at a
time.
The order of entries matters, because the packet uses
the first entry it matches, instead of a best match
scenario. If you have a permit entry, and you want to
deny an address that is allowed by the permit entry,
be sure to enter the deny entry before the permit
entry.
The mac argument specifies the source MAC address
in 12-digit hexadecimal form; that is,
nnnn.nnnn.nnnn.
The macmask argument specifies the portion of the
MAC address that should be used for matching. For
example, ffff.ffff.ffff matches the MAC address
exactly. ffff.ffff.0000 matches only the first 8 digits.

Step 2

aaa mac-exempt match id

Exempts traffic for the MAC addresses specified in a
particular MAC list.

Example:

The id argument is the string identifying the MAC
list that includes the MAC addresses whose traffic is
to be exempt from authentication and authorization.

hostname(config)# aaa mac-exempt match 1

You can only enter one instance of the aaa
mac-exempt match command.

Cisco ASA 5500 Series Configuration Guide using the CLI

38-20

Chapter 38

Configuring AAA Rules for Network Access
Feature History for AAA Rules

Examples
The following example bypasses authentication for a single MAC address:
hostname(config)# mac-list abc permit 00a0.c95d.0282 ffff.ffff.ffff
hostname(config)# aaa mac-exempt match abc

The following example bypasses authentication for all Cisco IP Phones, which have the hardware ID
0003.E3:
hostname(config)# mac-list acd permit 0003.E300.0000 FFFF.FF00.0000
hostname(config)# aaa mac-exempt match acd

The following example bypasses authentication for a a group of MAC addresses except for
00a0.c95d.02b2. Enter the deny statement before the permit statement, because 00a0.c95d.02b2
matches the permit statement as well, and if it is first, the deny statement will never be matched.
hostname(config)# mac-list 1 deny 00a0.c95d.0282 ffff.ffff.ffff
hostname(config)# mac-list 1 permit 00a0.c95d.0000 ffff.ffff.0000
hostname(config)# aaa mac-exempt match 1

Feature History for AAA Rules
Table 38-1 lists each feature change and the platform release in which it was implemented.
Table 38-1

Feature History for AAA Rules

Feature Name

Platform
Releases

AAA Rules

7.0(1)

Feature Information
AAA Rules describe how to enable AAA for network
access.
We introduced the following commands:
aaa authentication match, aaa authentication include |
exclude, aaa authentication listener http[s], aaa local
authentication attempts max-fail, virtual http, virtual
telnet, aaa authentication secure-http-client, aaa
authorization match, aaa accounting match, aaa
mac-exempt match.

Cisco ASA 5500 Series Configuration Guide using the CLI

38-21

Chapter 38
Feature History for AAA Rules

Cisco ASA 5500 Series Configuration Guide using the CLI

38-22

Configuring AAA Rules for Network Access

C H A P T E R

39

Configuring Filtering Services
This chapter describes how to use filtering services to provide greater control over traffic passing
through the ASA and includes the following sections:
•

Information About Web Traffic Filtering, page 39-1

•

Configuring ActiveX Filtering, page 39-2

•

Configuring Java Applet Filtering, page 39-4

•

Filtering URLs and FTP Requests with an External Server, page 39-6

•

Monitoring Filtering Statistics, page 39-15

Information About Web Traffic Filtering
You can use web traffic filtering in two distinct ways:
•

Filtering ActiveX objects or Java applets

•

Filtering with an external filtering server

Instead of blocking access altogether, you can remove specific undesirable objects from web traffic, such
as ActiveX objects or Java applets, that may pose a security threat in certain situations.
You can use web traffic filtering to direct specific traffic to an external filtering server, such an Secure
Computing SmartFilter (formerly N2H2) or the Websense filtering server. You can enable long URL,
HTTPS, and FTP filtering using either Websense or Secure Computing SmartFilter for web traffic
filtering. Filtering servers can block traffic to specific sites or types of sites, as specified by the security
policy.

Note

URL caching will only work if the version of the URL server software from the URL server vendor
supports it.
Because web traffic filtering is CPU-intensive, using an external filtering server ensures that the
throughput of other traffic is not affected. However, depending on the speed of your network and the
capacity of your web traffic filtering server, the time required for the initial connection may be
noticeably slower when filtering traffic with an external filtering server.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-1

Chapter 39

Configuring Filtering Services

Configuring ActiveX Filtering

Configuring ActiveX Filtering
This section includes the following topics:
•

Information About ActiveX Filtering, page 39-2

•

Licensing Requirements for ActiveX Filtering, page 39-2

•

Guidelines and Limitations for ActiveX Filtering, page 39-3

•

Configuring ActiveX Filtering, page 39-3

•

Configuration Examples for ActiveX Filtering, page 39-3

•

Feature History for ActiveX Filtering, page 39-4

Information About ActiveX Filtering
ActiveX objects may pose security risks because they can contain code intended to attack hosts and
servers on a protected network. You can disable ActiveX objects with ActiveX filtering.
ActiveX controls, formerly known as OLE or OCX controls, are components that you can insert in a web
page or another application. These controls include custom forms, calendars, or any of the extensive
third-party forms for gathering or displaying information. As a technology, ActiveX creates many
potential problems for network clients including causing workstations to fail, introducing network
security problems, or being used to attack servers.
The filter activex command blocks the HTML object commands by commenting them out within the
HTML web page. ActiveX filtering of HTML files is performed by selectively replacing the 
and , and  and  tags with comments. Filtering of nested
tags is supported by converting top-level tags to comments.

Caution

The filter activex command also blocks any Java applets, image files, or multimedia objects that are
embedded in object tags.
If the  or  HTML tags split across network packets or if the code in the tags is longer
than the number of bytes in the MTU, the ASA cannot block the tag.
ActiveX blocking does not occur when users access an IP address referenced by the alias command or
for clientless SSL VPN traffic.

Licensing Requirements for ActiveX Filtering
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-2

Chapter 39

Configuring Filtering Services
Licensing Requirements for ActiveX Filtering

Guidelines and Limitations for ActiveX Filtering
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Does not support IPv6.

Configuring ActiveX Filtering
To remove ActiveX objects in HTTP traffic that is passing through the ASA, enter the following
command:
Command

Purpose

filter activex port[-port] local_ip
local_mask foreign_ip foreign_mask

Removes ActiveX objects. To use this command, replace port[-port] with
the TCP port to which filtering is applied. Typically, this is port 80, but
other values are accepted. The http or url literal can be used for port 80.
You can specify a range of ports by using a hyphen between the starting
port number and the ending port number. The local IP address and mask
identify one or more internal hosts that are the source of the traffic to be
filtered. The foreign address and mask specify the external destination of
the traffic to be filtered.

Example:
hostname# filter activex 80 0 0 0 0

Configuration Examples for ActiveX Filtering
You can set either address to 0.0.0.0 (or in shortened form, 0) to specify all hosts. You can use 0.0.0.0
for either mask (or in shortened form, 0) to specify all masks. This command specifies that the ActiveX
object blocking applies to HTTP traffic on port 80 from any local host and for connections to any foreign
host.
The following example shows how to configure ActiveX filtering to block all outbound connections:
hostname(config)# filter activex 80 0 0 0 0

The following example shows how to remove ActiveX filtering:
hostname(config)# no filter activex 80 0 0 0 0

Cisco ASA 5500 Series Configuration Guide using the CLI

39-3

Chapter 39

Configuring Filtering Services

Configuring Java Applet Filtering

Feature History for ActiveX Filtering
Table 39-1 lists the release history for ActiveX Filtering. ASDM is backwards-compatible with multiple
platform releases, so the specific ASDM release in which support was added is not listed.
Table 39-1

Feature History for ActiveX Filtering

Feature Name

Platform
Releases

ActiveX filtering

7.0(1)

Feature Information
Filters specific undesirable objects from HTTP traffic, such as ActiveX
objects, which may pose a security threat in certain situations.

Configuring Java Applet Filtering
This section includes the following topics:
•

Information About Java Applet Filtering, page 39-4

•

Licensing Requirements for Java Applet Filtering, page 39-4

•

Guidelines and Limitations for Java Applet Filtering, page 39-5

•

Configuring Java Applet Filtering, page 39-5

•

Configuration Examples for Java Applet Filtering, page 39-5

•

Feature History for Java Applet Filtering, page 39-6

Information About Java Applet Filtering
Java applets may pose security risks because they can contain code intended to attack hosts and servers
on a protected network. You can remove Java applets with the filter java command.

Note

Use the filter activex command to remove Java applets that are embedded in  tags.
The filter java command filters out Java applets that return to the ASA from an outbound connection.
You still receive the HTML page, but the web page source for the applet is commented out so that the
applet cannot execute. The filter java command does not filter clientless SSL VPN traffic.

Licensing Requirements for Java Applet Filtering
The following table shows the licensing requirements for Java applet filtering:
Table 39-2

Licensing Requirements

Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-4

Chapter 39

Configuring Filtering Services
Configuring Java Applet Filtering

Guidelines and Limitations for Java Applet Filtering
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines
Does not support IPv6.

Configuring Java Applet Filtering
To apply filtering to remove Java applets from HTTP traffic passing through the ASA, enter the
following command:
Command

Purpose

filter java port[-port] local_ip
local_mask foreign_ip foreign_mask

Removes Java applets in HTTP traffic passing through the ASA.

Example:
hostname# filter java 80 0 0 0 0

To use this command, replace port[-port] with the TCP port to which
filtering is applied. Typically, this is port 80, but other values are accepted.
The http or url literal can be used for port 80. You can specify a range of
ports by using a hyphen between the starting port number and the ending
port number.
The local IP address and mask identify one or more internal hosts that are
the source of the traffic to be filtered. The foreign address and mask specify
the external destination of the traffic to be filtered.
You can set either address to 0.0.0.0 (or in shortened form, 0) to specify all
hosts. You can use 0.0.0.0 for either mask (or in shortened form, 0) to
specify all hosts.
You can set either address to 0.0.0.0 (or in shortened form, 0) to specify all
hosts. You can use 0.0.0.0 for either mask (or in shortened form, 0) to
specify all hosts.

Configuration Examples for Java Applet Filtering
The following example specifies that Java applets are blocked on all outbound connections:
hostname(config)# filter java 80 0 0 0 0

This command specifies that the Java applet blocking applies to web traffic on port 80 from any local
host and for connections to any foreign host.
The following example blocks downloading of Java applets to a host on a protected network:
hostname(config)# filter java http 192.168.3.3 255.255.255.255 0 0

This command prevents host 192.168.3.3 from downloading Java applets.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-5

Chapter 39

Configuring Filtering Services

Filtering URLs and FTP Requests with an External Server

The following example removes the configuration for downloading Java applets to a host on a protected
network:
hostname(config)# no filter java http 192.168.3.3 255.255.255.255 0 0

This command allows host 192.168.3.3 to download Java applets.

Feature History for Java Applet Filtering
Table 39-1 lists the release history for Java applet filtering. ASDM is backwards-compatible with
multiple platform releases, so the specific ASDM release in which support was added is not listed.
Table 39-3

Feature History for Java Applet Filtering

Feature Name

Platform
Releases

Java applet filtering

7.0(1)

Feature Information
Filters specific undesirable objects from HTTP traffic, such as Java
applets, which may pose a security threat in certain situations.

Filtering URLs and FTP Requests with an External Server
This section describes how to filter URLs and FTP requests with an external server and includes the
following topics:
•

Information About URL Filtering, page 39-6

•

Licensing Requirements for URL Filtering, page 39-7

•

Guidelines and Limitations for URL Filtering, page 39-7

•

Identifying the Filtering Server, page 39-8

•

Configuring Additional URL Filtering Settings, page 39-10

•

Feature History for URL Filtering, page 39-17

Information About URL Filtering
You can apply filtering to connection requests originating from a more secure network to a less secure
network. Although you can use ACLs to prevent outbound access to specific content servers, managing
usage this way is difficult because of the size and dynamic nature of the Internet. You can simplify
configuration and improve ASA performance by using a separate server running one of the following
Internet filtering products:
•

Websense Enterprise for filtering HTTP, HTTPS, and FTP.

•

McAfee SmartFilter (formerly N2H2) for filtering HTTP, HTTPS, FTP, and long URL filtering.
In long URLs, the URL in the Referer field might contain a “host:” text string, which could cause
the HTTP GET header to be incorrectly parsed as containing the HTTP Host parameter. The ASA,
however, correctly parses the Referer field even when it contains a “host:” text string and forwards
the header to the McAfee SmartFilter server with the correct Referer URL.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-6

Chapter 39

Configuring Filtering Services
Filtering URLs and FTP Requests with an External Server

Note

URL caching will only work if the version of the URL server software from the URL server vendor
supports it.
Although ASA performance is less affected when using an external server, you might notice longer
access times to websites or FTP servers when the filtering server is remote from the ASA.
When filtering is enabled and a request for content is directed through the ASA, the request is sent to
the content server and to the filtering server at the same time. If the filtering server allows the connection,
the ASA forwards the response from the content server to the originating client. If the filtering server
denies the connection, the ASA drops the response and sends a message or return code indicating that
the connection was not successful.
If user authentication is enabled on the ASA, then the ASA also sends the username to the filtering
server. The filtering server can use user-specific filtering settings or provide enhanced reporting about
usage.

Licensing Requirements for URL Filtering
The following table shows the licensing requirements for URL filtering:
Table 39-4

Licensing Requirements

Model

License Requirement

All models

Base License.

Guidelines and Limitations for URL Filtering
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

Does not support IPv6.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-7

Chapter 39

Configuring Filtering Services

Filtering URLs and FTP Requests with an External Server

Identifying the Filtering Server
You can identify up to four filtering servers per context. The ASA uses the servers in order until a server
responds. In single mode, a maximum of 16 of the same type of filtering servers are allowed. You can
only configure a single type of server (Websense or Secure Computing SmartFilter) in your configuration.

Note

You must add the filtering server before you can configure filtering for HTTP or HTTPS with the filter
command. If you remove the filtering servers from the configuration, then all filter commands are also
removed.
To specify the external filtering server, enter the following command:

Command
Choose from the following options:

Cisco ASA 5500 Series Configuration Guide using the CLI

39-8

Purpose

Chapter 39

Configuring Filtering Services
Filtering URLs and FTP Requests with an External Server

Command

Purpose

For Websense:

Identifies the address of the filtering server. if_name
is the name of the ASA interface connected to the
filtering server (the default is inside). For the vendor
{secure-computing | n2h2} option, use
secure-computing as the vendor string; however,
n2h2 is acceptable for backward compatibility. When
the configuration entries are generated,
secure-computing is saved as the vendor string. The
host local_ip option is the IP address of the URL
filtering server. The port number option is the Secure
Computing SmartFilter server port number of the
filtering server; the ASA also listens for UDP replies
on this port.

hostname(config)# url-server (if_name) host local_ip
[timeout seconds] [protocol TCP | UDP
version [1|4] [connections num_conns]]

Example:
hostname(config)# url-server (perimeter) host
10.0.1.1 protocol TCP version 4

Note

The default port is 4005, which is used by the
Secure Computing SmartFilter server to
communicate to the ASA via TCP or UDP.
For information about changing the default
port, see the Filtering by N2H2
Administrator's Guide.

The timeout seconds option is the number of seconds
that the ASA should keep trying to connect to the
filtering server. The connections number option is
the number of tries to make a connection between the
host and server.
The example identifies a Websense filtering server
with the IP address 10.0.1.1 on a perimeter interface
of the ASA.Version 4, which is enabled in this
example, is recommended by Websense because it
supports caching.
For Secure Computing SmartFilter (formerly N2H2):

The example identifies redundant Secure Computing
SmartFilter servers that are both on a perimeter
interface of the ASA.

hostname(config)# url-server (if_name) vendor
{secure-computing | n2h2} host
local_ip [port number] [timeout seconds] [protocol
{TCP [connections number]} | UDP]

Example:
hostname(config)# url-server (perimeter) vendor n2h2
host 10.0.1.1
hostname(config)# url-server (perimeter) vendor n2h2
host 10.0.1.2

Cisco ASA 5500 Series Configuration Guide using the CLI

39-9

Chapter 39

Configuring Filtering Services

Filtering URLs and FTP Requests with an External Server

Configuring Additional URL Filtering Settings
After you have accessed a website, the filtering server can allow the ASA to cache the server address for
a certain period of time, as long as each website hosted at the address is in a category that is permitted
at all times. When you access the server again, or if another user accesses the server, the ASA does not
need to consult the filtering server again to obtain the server address.

Note

Requests for cached IP addresses are not passed to the filtering server and are not logged.
As a result, this activity does not appear in any reports.

This section describes how to configure additional URL filtering settings and includes the following
topics:
•

Buffering the Content Server Response, page 39-10

•

Caching Server Addresses, page 39-11

•

Filtering HTTP URLs, page 39-11

•

Filtering HTTPS URLs, page 39-13

•

Filtering FTP Requests, page 39-14

Buffering the Content Server Response
When you issue a request to connect to a content server, the ASA sends the request to the content server
and to the filtering server at the same time. If the filtering server does not respond before the content
server, the server response is dropped. This behavior delays the web server response for the web client,
because the web client must reissue the request.
By enabling the HTTP response buffer, replies from web content servers are buffered, and the responses
are forwarded to the requesting client if the filtering server allows the connection. This behavior prevents
the delay that might otherwise occur.
To configure buffering for responses to HTTP or FTP requests, enter the following command:

Step 1

Command

Purpose

url-block block block-buffer-limit

Enables buffering of responses for HTTP or FTP requests that are
pending a response from the filtering server.

Example:

Replaces block-buffer with the maximum number of HTTP
responses that can be buffered while awaiting responses from the
URL server.

hostname# url-block 3000

Note

Step 2

url-block mempool-size memory-pool-size

Configures the maximum memory available for buffering pending
URLs (and for buffering long URLs).

Example:

Replaces memory-pool-size with a value from 2 to 10240 for a
maximum memory allocation of 2 KB to 10 MB.

hostname# url-block mempool-size 5000

Cisco ASA 5500 Series Configuration Guide using the CLI

39-10

Buffering of URLs longer than 3072 bytes is not
supported.

Chapter 39

Configuring Filtering Services
Filtering URLs and FTP Requests with an External Server

Caching Server Addresses
After you access a website, the filtering server can allow the ASA to cache the server address for a
certain period of time, as long as each website hosted at the address is in a category that is permitted at
all times. When you access the server again, or if another user accesses the server, the ASA does not
need to consult the filtering server again.

Note

Requests for cached IP addresses are not passed to the filtering server and are not logged. As a result,
this activity does not appear in any reports. You can accumulate Websense run logs before using the
url-cache command.
To improve throughput, enter the following command:

Command

Purpose

url-cache dst | src_dst size

Replaces size with a value for the cache size within the range from 1 to 128
(KB).

Example:

Uses the dst keyword to cache entries based on the URL destination
address. Choose this option if all users share the same URL filtering policy
on the Websense server.

hostname## url-cache src_dst 100

Uses the src_dst keyword to cache entries based on both the source address
initiating the URL request as well as the URL destination address. Choose
this option if users do not share the same URL filtering policy on the
Websense server.

Filtering HTTP URLs
This section describes how to configure HTTP filtering with an external filtering server and includes the
following topics:
•

Enabling HTTP Filtering, page 39-12

•

Enabling Filtering of Long HTTP URLs, page 39-12

•

Truncating Long HTTP URLs, page 39-13

•

Exempting Traffic from Filtering, page 39-13

Cisco ASA 5500 Series Configuration Guide using the CLI

39-11

Chapter 39

Configuring Filtering Services

Filtering URLs and FTP Requests with an External Server

Enabling HTTP Filtering
You must identify and enable the URL filtering server before enabling HTTP filtering. When the filtering
server approves an HTTP connection request, the ASA allows the reply from the web server to reach the
originating client. If the filtering server denies the request, the ASA redirects you to a block page,
indicating that access was denied.
To enable HTTP filtering, enter the following command:
Command

Purpose

filter url [http | port[-port] local_ip
local_mask foreign_ip foreign_mask]
[allow] [proxy-block]

Replaces port[-port] with one or more port numbers if a different port than
the default port for HTTP (80) is used.
Replaces local_ip and local_mask with the IP address and subnet mask of
a user or subnetwork making requests.

Example:
hostname# filter url http 80 allow
proxy-block

Replaces foreign_ip and foreign_mask with the IP address and subnet mask
of a server or subnetwork responding to requests.
The allow option causes the ASA to forward HTTP traffic without filtering
when the primary filtering server is unavailable. Use the proxy-block
command to drop all requests to proxy servers.

Enabling Filtering of Long HTTP URLs
By default, the ASA considers an HTTP URL to be a long URL if it is greater than 1159 characters. You
can increase the maximum length allowed.
To configure the maximum size of a single URL, enter the following command:
Command

Purpose

url-block url-size long-url-size

Replaces the long-url-size with the maximum size in KB for each long
URL being buffered. For Websense servers, this is a value from 2 to 4 for
a maximum URL size from 2 KB to 4 KB; for Secure Computing
SmartFilter servers, this is a value between 2 and 3 for a maximum URL
size from 2 KB to 3 KB. The default value is 2.

Example:
hostname# url-block url-size 3

Cisco ASA 5500 Series Configuration Guide using the CLI

39-12

Chapter 39

Configuring Filtering Services
Filtering URLs and FTP Requests with an External Server

Truncating Long HTTP URLs
By default, if a URL exceeds the maximum permitted size, then it is dropped. To avoid this occurrence,
truncate a long URL by entering the following command:
Command

Purpose

filter url [longurl-truncate |
longurl-deny | cgi-truncate]

The longurl-truncate option causes the ASA to send only the hostname or
IP address portion of the URL for evaluation to the filtering server when
the URL is longer than the maximum length permitted. Use the
longurl-deny option to deny outbound URL traffic if the URL is longer
than the maximum permitted.

Example:
hostname# filter url longurl-truncate

Use the cgi-truncate option to truncate CGI URLs to include only the CGI
script location and the script name without any parameters. Many long
HTTP requests are CGI requests. If the parameters list is very long, waiting
and sending the complete CGI request, including the parameter list, can use
up memory resources and affect ASA performance.

Exempting Traffic from Filtering
To exempt traffic from filtering, enter following command:
Command

Purpose

filter url except source_ip source_mask
dest_ip dest_mask

Exempts specific traffic from filtering.
The example shows how to cause all HTTP requests to be forwarded to the
filtering server, except for those from 10.0.2.54.

Example:
hostname(config)# filter url http 0 0 0 0
hostname(config)# filter url except
10.0.2.54 255.255.255.255 0 0

Filtering HTTPS URLs
You must identify and enable the URL filtering server before enabling HTTPS filtering.

Note

Websense and Secure Computing Smartfilter currently support HTTPS; older versions of the Secure
Computing SmartFilter (formerly N2H2) do not support HTTPS filtering.
Because HTTPS content is encrypted, the ASA sends the URL lookup without directory and filename
information. When the filtering server approves an HTTPS connection request, the ASA allows the
completion of SSL connection negotiation and allows the reply from the web server to reach the
originating client. If the filtering server denies the request, the ASA prevents the completion of SSL
connection negotiation. The browser displays an error message, such as “The Page or the content cannot
be displayed.”

Note

The ASA does not provide an authentication prompt for HTTPS, so you must authenticate with the ASA
using HTTP or FTP before accessing HTTPS servers.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-13

Chapter 39

Configuring Filtering Services

Filtering URLs and FTP Requests with an External Server

To enable HTTPS filtering, enter the following command:
Command

Purpose

filter https port[-port] localIP
local_mask foreign_IP foreign_mask [allow]

Enables HTTPS filtering.
Replaces port[-port] with a range of port numbers if a different port than
the default port for HTTPS (443) is used.

Example:
hostname# filter https 443 0 0 0 0 0 0 0 0
allow

Replaces local_ip and local_mask with the IP address and subnet mask of
a user or subnetwork making requests.
Replaces foreign_ip and foreign_mask with the IP address and subnet mask
of a server or subnetwork responding to requests.
The allow option causes the ASA to forward HTTPS traffic without
filtering when the primary filtering server is unavailable.

Filtering FTP Requests
You must identify and enable the URL filtering server before enabling FTP filtering.

Note

Websense and Secure Computing Smartfilter currently support FTP; older versions of Secure Computing
SmartFilter (formerly known as N2H2) did not support FTP filtering.
When the filtering server approves an FTP connection request, the ASA allows the successful FTP return
code to reach the originating client. For example, a successful return code is “250: CWD command
successful.” If the filtering server denies the request, the FTP return code is changed to show that the
connection was denied. For example, the ASA changes code 250 to “550 Requested file is prohibited by
URL filtering policy.”
To enable FTP filtering, enter the following command:

Command

Purpose

filter ftp port[-port] localIP local_mask
foreign_IP foreign_mask [allow]
[interact-block]

Enables FTP filtering.

Example:
hostname# filter ftp 21 0 0 0 0 0 0 0 0
allow

Replaces port[-port] with a range of port numbers if a different port than
the default port for FTP (21) is used.
Replaces local_ip and local_mask with the IP address and subnet mask of
a user or subnetwork making requests.
Replaces foreign_ip and foreign_mask with the IP address and subnet mask
of a server or subnetwork responding to requests.
The allow option causes the ASA to forward HTTPS traffic without
filtering when the primary filtering server is unavailable.
Use the interact-block option to prevent interactive FTP sessions that do
not provide the entire directory path. An interactive FTP client allows you
to change directories without typing the entire path. For example, you
might enter cd ./files instead of cd /public/files.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-14

Chapter 39

Configuring Filtering Services
Monitoring Filtering Statistics

Monitoring Filtering Statistics
To monitor filtering statistics, enter one of the following commands:
Command

Purpose

show url-server

Shows information about the URL filtering server.

show url-server statistics

Shows URL filtering statistics.

show url-block

Shows the number of packets held in the url-block buffer and the number (if any)
dropped because of exceeding the buffer limit or retransmission.

show url-block block statistics

Shows the URL block statistics.

show url-cache stats

Shows the URL cache statistics.

show perfmon

Shows URL filtering performance statistics, along with other performance
statistics.

show filter

Shows the filtering configuration.

Examples
The following is sample output from the show url-server command:
hostname# show url-server
url-server (outside) vendor n2h2 host 128.107.254.202 port 4005 timeout 5 protocol TCP

The following is sample output from the show url-server statistics command:
hostname# show url-server statistics
Global Statistics:
-------------------URLs total/allowed/denied
URLs allowed by cache/server
URLs denied by cache/server
HTTPSs total/allowed/denied
HTTPSs allowed by cache/server
HTTPSs denied by cache/server
FTPs total/allowed/denied
FTPs allowed by cache/server
FTPs denied by cache/server
Requests dropped
Server timeouts/retries
Processed rate average 60s/300s
Denied rate average 60s/300s
Dropped rate average 60s/300s

13/3/10
0/3
0/10
138/137/1
0/137
0/1
0/0/0
0/0
0/0
0
0/0
0/0 requests/second
0/0 requests/second
0/0 requests/second

Server Statistics:
-------------------10.125.76.20
Vendor
Port
Requests total/allowed/denied
Server timeouts/retries
Responses received
Response time average 60s/300s

UP
websense
15868
151/140/11
0/0
151
0/0

URL Packets Sent and Received Stats:
-----------------------------------Message
Sent
Received

Cisco ASA 5500 Series Configuration Guide using the CLI

39-15

Chapter 39

Configuring Filtering Services

Monitoring Filtering Statistics

STATUS_REQUEST
LOOKUP_REQUEST
LOG_REQUEST

1609
1526
0

Errors:
------RFC noncompliant GET method
URL buffer update failure

1601
1526
NA

0
0

The following is sample output from the show url-block command:
hostname# show url-block
url-block url-mempool 128
url-block url-size 4
url-block block 128

The following is sample output from the show url-block block statistics command:
hostname# show url-block block statistics
URL Pending Packet Buffer Stats with max block 128
----------------------------------------------------Cumulative number of packets held:
896
Maximum number of packets held (per URL):
3
Current number of packets held (global):
38
Packets dropped due to
exceeding url-block buffer limit:
7546
HTTP server retransmission:
10
Number of packets released back to client:
0

The following is sample output from the show url-cache stats command:
hostname# show url-cache stats
URL Filter Cache Stats
---------------------Size :
128KB
Entries :
1724
In Use :
456
Lookups :
45
Hits :
8
This shows how the cache is used.

The following is sample output from the show perfmon command:
hostname# show perfmon
PERFMON STATS:
Current
Xlates
0/s
Connections
0/s
TCP Conns
0/s
UDP Conns
0/s
URL Access
0/s
URL Server Req
0/s
TCP Fixup
0/s
TCPIntercept
0/s
HTTP Fixup
0/s
FTP Fixup
0/s
AAA Authen
0/s
AAA Author
0/s
AAA Account
0/s

Average
0/s
2/s
2/s
0/s
2/s
3/s
0/s
0/s
3/s
0/s
0/s
0/s
0/s

The following is sample output from the show filter command:
hostname# show filter
filter url http 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0

Cisco ASA 5500 Series Configuration Guide using the CLI

39-16

Chapter 39

Configuring Filtering Services
Monitoring Filtering Statistics

Feature History for URL Filtering
Table 39-5 lists the release history for URL filtering. ASDM is backwards-compatible with multiple
platform releases, so the specific ASDM release in which support was added is not listed.
Table 39-5

Feature History for URL Filtering

Feature Name

Platform
Releases

Feature Information

URL filtering

7.0(1)

Filters URLs based on an established set of filtering criteria.

Cisco ASA 5500 Series Configuration Guide using the CLI

39-17

Chapter 39
Monitoring Filtering Statistics

Cisco ASA 5500 Series Configuration Guide using the CLI

39-18

Configuring Filtering Services

C H A P T E R

40

Configuring Web Cache Services Using WCCP
This chapter describes how to configure web caching services using WCCP, and includes the following
sections:
•

Information About WCCP, page 40-1

•

Guidelines and Limitations, page 40-1

•

Licensing Requirements for WCCP, page 40-2

•

Enabling WCCP Redirection, page 40-3

•

WCCP Monitoring Commands, page 40-4

•

Feature History for WCCP, page 40-4

Information About WCCP
The purpose of web caching is to reduce latency and network traffic. Previously-accessed web pages are
stored in a cache buffer, so if users need the page again, they can retrieve it from the cache instead of the
web server.
WCCP specifies interactions between the ASA and external web caches. The feature transparently
redirects selected types of traffic to a group of web cache engines to optimize resource usage and lower
response times. The ASA only supports WCCP Version 2.
Using an ASA as an intermediary eliminates the need for a separate router to do the WCCP redirection,
because the ASA redirects requests to cache engines. When the ASA determines that a packet needs
redirection, it skips TCP state tracking, TCP sequence number randomization, and NAT on these traffic
flows.

Guidelines and Limitations
The following WCCPv2 features are supported for the ASA:
•

Redirection of multiple TCP and UDP port-destined traffic.

•

Authentication for cache engines in a service group.

•

Multiple cache engines in a service group.

•

GRE encapsulation.

The following WCCPv2 features are not supported for the ASA:

Cisco ASA 5500 Series Configuration Guide using the CLI

40-1

Chapter 40

Configuring Web Cache Services Using WCCP

Licensing Requirements for WCCP

•

Multiple routers in a service group.

•

Multicast WCCP.

•

The Layer 2 redirect method.

•

WCCP source address spoofing.

•

WAAS devices.

WCCP Interaction With Other Features

In the ASA implementation of WCCP, the protocol interacts with other configurable features according
to the following:
•

Cut-through proxy will not work in combination with WCCP.

•

An ingress access list entry always takes higher priority over WCCP. For example, if an access list
does not permit a client to communicate with a server, then traffic is not redirected to a cache engine.
Both ingress interface access lists and egress interface access lists are applied.

•

TCP intercept, authorization, URL filtering, inspect engines, and IPS features are not applied to a
redirected flow of traffic.

•

When a cache engine cannot service a request and a packet is returned, or when a cache miss
happens on a cache engine and it requests data from a web server, then the contents of the traffic
flow is subject to all the other configured features of the ASA.

•

If you have two WCCP services and they use two different redirection ACLs that overlap and match
the same packets (with a deny or a permit action), the packets behave according to the first
service-group found and installed rules. The packets are not passed thorugh all service-groups.

Failover Guidelines

Supports Active/Active and Active/Standby failover. WCCP redirect tables are not replicated to standby
units. After a failover, packets are not redirected until the tables are rebuilt. Sessions redirected before
failover are probably reset by the web server.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
Context Mode Guidelines

Supported in single mode and multiple context mode.
Additional Guidelines

The ASA selects the highest IP address configured on any interface as the WCCP router ID. This address
is used to establish a GRE tunnel with the cache engine.

Licensing Requirements for WCCP
Table 40-1 shows the licensing requirements for WCCP.
Table 40-1

Licensing Requirements

Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

40-2

Chapter 40

Configuring Web Cache Services Using WCCP
Enabling WCCP Redirection

Enabling WCCP Redirection
Note

The ASA selects the highest IP address configured on any interface as the WCCP router ID. This address
is used to establish a GRE tunnel with the cache engine.
WCCP redirection is supported only on the ingress of an interface. The only topology that the ASA
supports is when client and cache engine are behind the same interface of the ASA and the cache engine
can directly communicate with the client, without going through the ASA.
The following configuration tasks assume you have already installed and configured the cache engines
that you want to include in your network.
To configure WCCP redirection, perform the following steps:

Step 1

Command

Purpose

wccp {web-cache | service_number}
[redirect-list access_list] [group-list
access_list] [password password]

Enables a WCCP service group and identifies the service to be
redirected. (Optional) Also defines which cache engines can
participate in the service group, and what traffic should be
redirected to the cache engine.

Example:

The standard service is web-cache, which intercepts TCP port 80
(HTTP) traffic and redirects that traffic to the cache engines, but
you can identify a service number (if desired) between 0 and 254.
For example, to transparently redirect native FTP traffic to a
cache engine, use WCCP service 60. You can enter this command
multiple times for each service group that you want to enable.

hostname (config)# wccp web-cache

The redirect-list access_list argument controls traffic that is
redirected to this service group.
The group-list access_list argument determines which web cache
IP addresses are allowed to participate in the service group.
The password password argument specifies MD5 authentication
for messages that are received from the service group. Messages
that are not accepted by the authentication are discarded.
Step 2

wccp interface interface_name {web-cache |
service_number} redirect in

Example:
hostname (config)# wccp interface inside
web-cache redirect in

Identifies an interface and enables WCCP redirection on the
interface.
The standard service is web-cache, which intercepts TCP port 80
(HTTP) traffic and redirects that traffic to the cache engines, but
you can identify a service number (if desired) between 0 and 254.
For example, to transparently redirect native FTP traffic to a
cache engine, use WCCP service 60. You can enter this command
multiple times for each service group that you want to enable.

Examples
For example, to enable the standard web-cache service and redirect HTTP traffic that enters the inside
interface to a web cache, enter the following commands:
hostname (config)# wccp web-cache
hostname (config)# wccp interface inside web-cache redirect in

Cisco ASA 5500 Series Configuration Guide using the CLI

40-3

Chapter 40

Configuring Web Cache Services Using WCCP

WCCP Monitoring Commands

WCCP Monitoring Commands
To monitor WCCP, enter one of the following commands:
Command

Purpose

show running-config wccp

Shows the current WCCP configuration.

show running-config wccp interface

Shows the current WCCP interfaces status.

Feature History for WCCP
Table 40-2 lists the release history for this feature.
Table 40-2

Feature History for WCCP

Feature Name

Releases

Feature Information

WCCP

7.2(1)

WCCP specifies interactions between the ASA and external web caches.
We introduced the following commands:
wccp and wccp interface

Cisco ASA 5500 Series Configuration Guide using the CLI

40-4

CH A P T E R

41

Configuring Digital Certificates
This chapter describes how to configure digital certificates and includes the following sections:
•

Information About Digital Certificates, page 41-1

•

Licensing Requirements for Digital Certificates, page 41-7

•

Prerequisites for Local Certificates, page 41-7

•

Guidelines and Limitations, page 41-8

•

Configuring Digital Certificates, page 41-9

•

Monitoring Digital Certificates, page 41-41

•

Feature History for Certificate Management, page 41-43

Information About Digital Certificates
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.
This section includes the following topics:
•

Public Key Cryptography, page 41-2

•

Certificate Scalability, page 41-2

•

Key Pairs, page 41-2

•

Trustpoints, page 41-3

•

Revocation Checking, page 41-4

•

The Local CA, page 41-6

Cisco ASA 5500 Series Configuration Guide using the CLI

41-1

Chapter 41

Configuring Digital Certificates

Information About Digital Certificates

Public Key Cryptography
Digital signatures, enabled by public key cryptography, provide a way to authenticate devices and users.
In public key cryptography, such as the RSA encryption system, each user has a key pair containing both
a public and a private key. The keys act as complements, and anything encrypted with one of the keys
can be decrypted with the other.
In simple terms, a signature is formed when data is encrypted with a private key. The signature is
attached to the data and sent to the receiver. The receiver applies the public key of the sender to the data.
If the signature sent with the data matches the result of applying the public key to the data, the validity
of the message is established.
This process relies on the receiver having a copy of the public key of the sender and a high degree of
certainty that this key belongs to the sender, not to someone pretending to be the sender.
Obtaining the public key of a sender is normally handled externally or through an operation performed
at installation. For example, most web browsers are configured with the root certificates of several CAs
by default. For VPN, the IKE protocol, a component of IPsec, can use digital signatures to authenticate
peer devices before setting up security associations.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-2

Chapter 41

Configuring Digital Certificates
Information About Digital Certificates

•

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.

•

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.

Note

If an 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.

Proxy for SCEP Requests
The ASA can proxy SCEP requests between AnyConnect and a third-party CA. The CA only needs to
be accessible to the ASA if it is acting as the proxy. For the ASA to provide this service, the user must
authenticate using any of the methods supported by AAA before the ASA sends an enrollment request.
You can also use host scan and dynamic access policies to enforce rules of eligibility to enroll.
The ASA supports this feature only with an AnyConnect SSL or IKEv2 VPN session. It supports all
SCEP-compliant CAs, including IOS CS, Windows Server 2003 CA, and Windows Server 2008 CA.
Clientless (browser-based) access does not support SCEP proxy, although
WebLaunch—clientless-initiated AnyConnect—does support it.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-3

Chapter 41

Configuring Digital Certificates

Information About Digital Certificates

The ASA does not support polling for certificates.
The ASA supports load balancing for this feature.

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.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-4

Chapter 41

Configuring Digital Certificates
Information About Digital Certificates

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.

The ASA uses these two factors in the following ways:
•

If the NextUpdate field is not required, the ASA marks CRLs as stale after the length of time defined
by the cache-time command.

•

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:

Note

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.

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

Cisco ASA 5500 Series Configuration Guide using the CLI

41-5

Chapter 41

Configuring Digital Certificates

Information About Digital Certificates

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.

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.

Storage for Local CA Files
The ASA accesses and implements user information, issued certificates, and revocation lists using a
local CA database. This database resides in local flash memory by default, or can be configured to reside
on an external file system that is mounted and accessible to the ASA.
No limits exist on the number of users that can be stored in the local CA user database; however, if flash
memory storage issues arise, syslogs are generated to alert the administrator to take action, and the local
CA could be disabled until the storage issues are resolved. Flash memory can store a database with 3500
users or less; however, a database of more than 3500 users requires external storage.

The Local CA Server
After you configure a local CA server on the ASA, users can enroll for a certificate by logging into a
website and entering a username and a one-time password that is provided by the local CA administrator
to validate their eligibility for enrollment.
As shown in Figure 41-1, the local CA server resides on the ASA and handles enrollment requests from
website users and CRL inquiries coming from other certificate validating devices and ASAs. Local CA
database and configuration files are maintained either on the ASA flash memory (default storage) or on
a separate storage device.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-6

Chapter 41

Configuring Digital Certificates
Licensing Requirements for Digital Certificates

Figure 41-1

The Local CA

ASDM and CLI
configuration and
management

User Enrollment Webpage
for PKCS12 Users Certificate
Enrollment and Retrieval

Local Database in flash memory
or Mounted external file system
(CIFS or FTP)

HTTP CRL retrieval

191783

Security Device
with Local CA
Configured

Licensing Requirements for Digital Certificates
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Prerequisites for Local Certificates
Local certificates have the following prerequisites:
•

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. For
information about configuring the hostname and domain name, see the “Configuring the Hostname,
Domain Name, and Passwords” section on page 10-1.

•

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.

Prerequisites for SCEP Proxy Support
Configuring the ASA as a proxy to submit requests for third-party certificates has the following
requirements:
•

AnyConnect Secure Mobility Client 3.0 or later must be running at the endpoint.

•

The authentication method, configured in the connection profile for your group policy, must be set
to use both AAA and certificate authentication.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-7

Chapter 41

Configuring Digital Certificates

Guidelines and Limitations

•

An SSL port must be open for IKEv2 VPN connections.

•

The CA must be in auto-grant mode.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
•

Supported in single and multiple context mode for a local CA.

•

Supported in single context mode only for third-party CAs.

Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Failover Guidelines
•

Does not support replicating sessions in Stateful Failover.

•

Does not support Active/Active or Active/Standby failover.

IPv6 Guidelines

Supports IPv6.
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.

•

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-8

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Configuring Digital Certificates
This section describes how to configure local CA certificates. Make sure that you follow the sequence
of tasks listed to correctly configure this type of digital certificate. This section includes the following
topics:
•

Configuring Key Pairs, page 41-9

•

Removing Key Pairs, page 41-10

•

Configuring Trustpoints, page 41-10

•

Configuring CRLs for a Trustpoint, page 41-13

•

Exporting a Trustpoint Configuration, page 41-15

•

Importing a Trustpoint Configuration, page 41-16

•

Configuring CA Certificate Map Rules, page 41-17

•

Obtaining Certificates Manually, page 41-18

•

Obtaining Certificates Automatically with SCEP, page 41-20

•

Configuring Proxy Support for SCEP Requests, page 41-21

•

Enabling the Local CA Server, page 41-22

•

Configuring the Local CA Server, page 41-23

•

Customizing the Local CA Server, page 41-25

•

Debugging the Local CA Server, page 41-26

•

Disabling the Local CA Server, page 41-26

•

Deleting the Local CA Server, page 41-26

•

Configuring Local CA Certificate Characteristics, page 41-27

Configuring Key Pairs
To generate key pairs, perform the following steps:

Step 1

Command

Purpose

crypto key generate rsa

Generates one, general-purpose RSA key pair. The
default key modulus is 1024. To specify other
modulus sizes, use the modulus keyword.

Example:

Step 2

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.

hostname/contexta(config)# crypto key generate rsa

Note

crypto key generate rsa label key-pair-label

(Optional) Assigns a label to each key pair. 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:
hostname/contexta(config)# crypto key generate rsa
label exchange

Cisco ASA 5500 Series Configuration Guide using the CLI

41-9

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Step 3

Command

Purpose

show crypto key name of key

Verifies key pairs that you have generated.

Example:
hostname/contexta(config)# show crypto key
examplekey

Step 4

Saves the key pair that you have generated.

write memory

Example:
hostname(config)# write memory

Removing Key Pairs
To remove key pairs, perform the following steps:
Command

Purpose

crypto key zeroize rsa

Removes key pairs.

Example:
hostname(config)# crypto key zeroize rsa

Examples
The following example shows how to remove key pairs:
hostname(config)# crypto key zeroize rsa
WARNING: All RSA keys will be removed.
WARNING: All device certs issued using these keys will also be removed.
Do you really want to remove these keys? [yes/no] y

Configuring Trustpoints
To configure a trustpoint, perform the following steps:

Step 1

Command

Purpose

crypto ca trustpoint trustpoint-name

Creates a trustpoint that corresponds to the CA from
which the ASA needs to receive a certificate. Enters
the crypto ca trustpoint configuration mode, which
controls CA-specific trustpoint parameters that you
may configure starting in Step 3.

Example:
hostname/contexta(config)# crypto ca trustpoint Main

Step 2

Choose one of the following options:

Cisco ASA 5500 Series Configuration Guide using the CLI

41-10

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Command

Purpose

enrollment url url

Requests automatic enrollment using SCEP with the
specified trustpoint and configures the enrollment
URL.

Example:
hostname/contexta(config-ca-trustpoint)# enrollment
url http://10.29.67.142:80/certsrv/mscep/mscep.dll

Requests manual enrollment with the specified
trustpoint by pasting the certificate received from the
CA into the terminal.

enrollment terminal

Example:
hostname/contexta(config-ca-trustpoint)# enrollment
terminal

Step 3

Specifies the available CRL configuration options.

revocation-check crl none
revocation-check crl
revocation-check none

Note

Example:
hostname/contexta(config-ca-trustpoint)#
revocation-check crl none
hostname/contexta(config-ca-trustpoint)#
revocation-check crl
hostname/contexta(config-ca-trustpoint)#
revocation-check none

Step 4

To enable either required or optional CRL
checking, make sure that you configure the
trustpoint for CRL management after
obtaining certificates.

Enters crl configuration mode.

crl configure

Example:
hostname/contexta(config-ca-trustpoint)# crl
configure

Step 5

During enrollment, asks the CA to include the
specified e-mail address in the Subject Alternative
Name extension of the certificate.

email address

Example:
hostname/contexta(config-ca-trustpoint)# email
example.com

Step 6

(Optional) Specifies a retry period in minutes, and
applies only to SCEP enrollment.

enrollment retry period

Example:
hostname/contexta(config-ca-trustpoint)# enrollment
retry period 5

Step 7

(Optional) Specifies a maximum number of
permitted retries, and applies only to SCEP
enrollment.

enrollment retry count

Example:
hostname/contexta(config-ca-trustpoint)# enrollment
retry period 2

Step 8

fqdn fqdn

Example:

During enrollment, asks the CA to include the
specified fully qualified domain name in the Subject
Alternative Name extension of the certificate.

hostname/contexta(config-ca-trustpoint)# fqdn
example.com

Cisco ASA 5500 Series Configuration Guide using the CLI

41-11

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Step 9

Command

Purpose

ip-address ip-address

During enrollment, asks the CA to include the IP
address of the ASA in the certificate.

Example:
hostname/contexta(config-ca-trustpoint)# ip-address
10.10.100.1

Step 10

keypair name

Specifies the key pair whose public key is to be
certified.

Example:
hostname/contexta(config-ca-trustpoint)# keypair
exchange

Step 11

match certificate map-name override ocsp

Configures OCSP URL overrides and trustpoints to
use for validating OCSP responder certificates.

Example:
hostname/contexta(config-ca-trustpoint)# match
certificate examplemap override ocsp

Step 12

ocsp disable-nonce

Example:

Disables the nonce extension on an OCSP request.
The nonce extension cryptographically binds
requests with responses to avoid replay attacks.

hostname/contexta(config-ca-trustpoint)# ocsp
disable-nonce

Step 13

ocsp url

Example:
hostname/contexta(config-ca-trustpoint)# ocsp url

Step 14

password string

Example:
hostname/contexta(config-ca-trustpoint)# password
mypassword

Step 15

revocation check

Configures 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.
Specifies a challenge phrase that is registered with
the CA during enrollment. The CA usually uses this
phrase to authenticate a subsequent revocation
request.
Sets one or more methods for revocation checking:
CRL, OCSP, and none.

Example:
hostname/contexta(config-ca-trustpoint)# revocation
check

Step 16

subject-name X.500 name

Example:
hostname/contexta(config-ca-trustpoint)# myname
X.500 examplename

Cisco ASA 5500 Series Configuration Guide using the CLI

41-12

During enrollment, asks 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.”).

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Step 17

Command

Purpose

serial-number

During enrollment, asks the CA to include the ASA
serial number in the certificate.

Example:
hostname/contexta(config-ca-trustpoint)# serial
number JMX1213L2A7

Step 18

write memory

Saves the running configuration.

Example:
hostname/contexta(config)# write memory

Configuring CRLs for a Trustpoint
To use mandatory or optional CRL checking during certificate authentication, you must configure CRLs
for each trustpoint. To configure CRLs for a trustpoint, perform the following steps:

Step 1

Command

Purpose

crypto ca trustpoint trustpoint-name

Enters crypto ca trustpoint configuration mode for
the trustpoint whose CRL configuration you want to
modify.

Example:

Step 2

Note

crl configure

Enters crl configuration mode for the current
trustpoint.

Example:

Tip

hostname (config-ca-trustpoint)# crl configure

Step 3

Make sure that you have enabled CRLs
before entering this command. In addition,
the CRL must be available for authentication
to succeed.

hostname (config)# crypto ca trustpoint Main

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.

Do one of the following:
policy cdp

Example:
hostname (config-ca-crl)# policy cdp

Configures retrieval policy. CRLs are retrieved only
from the CRL distribution points specified in
authenticated certificates.
Note

SCEP retrieval is not supported by
distribution points specified in certificates.

To continue, go to Step 5.
policy static

Configures retrieval policy. CRLs are retrieved only
from URLs that you configure.

Example:

To continue, go to Step 4.

hostname (config-ca-crl)# policy static

Cisco ASA 5500 Series Configuration Guide using the CLI

41-13

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Command

Purpose

policy both

Configures retrieval policy. CRLs are retrieved from
CRL distribution points specified in authenticated
certificates and from URLs that you configure.

Example:
Step 4

hostname (config-ca-crl)# policy both

To continue, go to Step 4.

url n url

If you used the keywords static or both 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 is the rank assigned
to the URL. To remove a URL, use the no url n
command.

Example:
hostname (config-ca-crl)# url 2
http://www.example.com

Step 5

protocol http | ldap | scep

Configures the retrieval method. Specifies HTTP,
LDAP, or SCEP as the CRL retrieval method.

Example:
hostname (config-ca-crl)# protocol http

Step 6

cache-time refresh-time

Example:
hostname (config-ca-crl)# cache-time 420

Step 7

Configures how long the ASA caches CRLs for the
current trustpoint. refresh-time is the number of
minutes that the ASA waits before considering a
CRL stale.

Do one of the following:
enforcenextupdate

Requires the NextUpdate field in CRLs. This is the
default setting.

Example:
hostname (config-ca-crl)# enforcenextupdate
no enforcenextupdate

Allows the NextUpdate field to be absent in CRLs.

Example:
hostname (config-ca-crl)# no enforcenextupdate

Step 8

ldap-defaults server

Example:
hostname (config-ca-crl)# ldap-defaults ldap1

Identifies 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.
Note

Step 9

ldap-dn admin-DN password

Example:
hostname (config-ca-crl)# ldap-dn
cn=admin,ou=devtest,o=engineering c00lRunZ

Cisco ASA 5500 Series Configuration Guide using the CLI

41-14

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.

Allows CRL retrieval if the LDAP server requires
credentials.

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Step 10

Command

Purpose

crypto ca crl request trustpoint

Retrieves the current CRL from the CA represented
by the specified trustpoint and tests the CRL
configuration for the current trustpoint.

Example:
hostname (config-ca-crl)# crypto ca crl request Main

Step 11

Saves the running configuration.

write memory

Example:
hostname (config)# write memory

Exporting a Trustpoint Configuration
To export a trustpoint configuration, enter the following command:
Command

Purpose

crypto ca export trustpoint

Exports a trustpoint configuration with all associated keys and
certificates in PKCS12 format. 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.

Example:
hostname(config)# crypto ca export Main

Examples
The following example exports PKCS12 data for the trustpoint Main with the passphrase Wh0zits:
hostname (config)# crypto ca export Main pkcs12 Wh0zits
Exported pkcs12 follows:
[ PKCS12 data omitted ]
---End - This line not part of the pkcs12---

Cisco ASA 5500 Series Configuration Guide using the CLI

41-15

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Importing a Trustpoint Configuration
To import a trustpoint configuration, enter the following command:
Command

Purpose

crypto ca import trustpoint pkcs12

Imports keypairs and issued certificates that are associated with a
trustpoint configuration. 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.

Example:
hostname(config)# crypto ca import Main
pkcs12

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.

Examples
The following example manually imports PKCS12 data to the trustpoint Main with the passphrase
Wh0zits:
hostname (config)# crypto ca import Main pkcs12 Wh0zits
Enter the base 64 encoded pkcs12.
End with a blank line or the word "quit" on a line by itself:
[ PKCS12 data omitted ]
quit
INFO: Import PKCS12 operation completed successfully

The following example manually imports a certificate for the trustpoint Main:
hostname (config)# crypto ca import Main certificate
% The fully-qualified domain name in the certificate will be:
securityappliance.example.com
Enter the base 64 encoded certificate.
End with a blank line or the word “quit” on a line by itself
[ certificate data omitted ]
quit
INFO: Certificate successfully imported

Cisco ASA 5500 Series Configuration Guide using the CLI

41-16

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Configuring CA Certificate Map Rules
You can configure rules based on the Issuer and Subject fields of a certificate. Using the rules you create,
you can map IPsec peer certificates to tunnel groups with the tunnel-group-map command. The ASA
supports one CA certificate map, which can include many rules.
To configure a CA certificate map rule, perform the following steps:

Step 1

Command

Purpose

crypto ca certificate map sequence-number

Enters CA certificate map configuration mode for the
rule you want to configure and specifies the rule
index number.

Example:
hostname(config)# crypto ca certificate map 1

Step 2

issuer-name DN-string

Example:
hostname(config-ca-cert-map)# issuer-name
cn=asa.example.com

Step 3

subject-name attr tag eq | co | ne | nc string

Example:
hostname(config-ca-cert-map)# subject-name attr cn
eq mycert

Step 4

write memory

Specifies the distinguished name of all issued
certificates. which is also the subject-name DN of the
self-signed CA certificate. 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.
Specifies tests that the ASA can apply to values
found in the Subject field of certificates. 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.

Saves the running configuration.

Example:
hostname (config)# write memory

Cisco ASA 5500 Series Configuration Guide using the CLI

41-17

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Obtaining Certificates Manually
To obtain certificates manually, perform the following steps:

Step 1

Command

Purpose

crypto ca authenticate trustpoint

Imports the CA certificate for the configured
trustpoint.

Example:

Note

hostname(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+JbRTANBgkqhkiG
9w0BAQUFADCB
[ 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. For more information, see the
“Configuring Trustpoints” section on page 41-10.

This step assumes that you have already
obtained a base-64 encoded CA certificate
from the CA represented by the trustpoint.

INFO: Certificate has the following attributes:
Fingerprint:
24b81433 409b3fd5 e5431699 8d490d34
Do you accept this certificate? [yes/no]: y
Trustpoint CA certificate accepted.
% Certificate successfully imported

Step 2

crypto ca enroll trustpoint

Example:
hostname(config)# crypto ca enroll Main
% Start certificate enrollment ..
% The fully-qualified domain name in the certificate
will be: securityappliance.example.com
% Include the device serial number in the subject
name? [yes/no]: n
Display Certificate Request to terminal? [yes/no]: y
Certificate Request follows:
MIIBoDCCAQkCAQAwIzEhMB8GCSqGSIb3DQEJAhYSRmVyYWxQaXgu
Y2lzY28uY29t
[ certificate request data omitted ]
jF4waw68eOxQxVmdgMWeQ+RbIOYmvt8g6hnBTrd0GdqjjVLt
---End - This line not part of the certificate
request--Redisplay enrollment request? [yes/no]: n

Cisco ASA 5500 Series Configuration Guide using the CLI

41-18

Enrolls the ASA with the trustpoint. 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.

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Step 3

Command

Purpose

crypto ca import trustpoint certificate

Imports each certificate you receive from the CA.
Requests that you paste the certificate to the terminal
in base-64 format.

Example:
hostname (config)# crypto ca import Main certificate
% The fully-qualified domain name in the certificate
will be: securityappliance.example.com
Enter the base 64 encoded certificate.
End with a blank line or the word “quit” on a line
by itself
[ certificate data omitted ]
quit
INFO: Certificate successfully imported

Step 4

Verifies 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:
hostname(config)# show crypto ca server certificate
Main

Step 5

write memory

Saves the running configuration.

Example:

Repeat these steps for each trustpoint that you
configure for manual enrollment.

hostname(config)# write memory

Cisco ASA 5500 Series Configuration Guide using the CLI

41-19

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Obtaining Certificates Automatically with SCEP
To obtain certificates automatically using SCEP, perform the following steps:

Step 1

Command

Purpose

crypto ca authenticate trustpoint

Obtains the CA certificate for the configured
trustpoint.

Example:

Note

hostname/contexta(config)# crypto ca authenticate
Main

This step assumes that you have already
obtained a base-64 encoded CA certificate
from the CA represented by the trustpoint.

When you configure the trustpoint, use of the
enrollment url command determines whether or not
you must obtain certificates automatically via SCEP.
For more information, see the “Configuring
Trustpoints” section on page 41-10.
Step 2

crypto ca enroll trustpoint

Example:
hostname/contexta(config)# crypto ca enroll Main

Enrolls the ASA with the trustpoint. 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.
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

Cisco ASA 5500 Series Configuration Guide using the CLI

41-20

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.

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Step 3

Command

Purpose

show crypto ca server certificate

Verifies that the enrollment process was successful by
displaying certificate details issued for the ASA and
the CA certificate for the trustpoint.

Example:
hostname/contexta(config)# show crypto ca server
certificate Main

Step 4

write memory

Saves the running configuration.

Example:
hostname/contexta(config)# write memory

Configuring Proxy Support for SCEP Requests
To configure the ASA to authenticate remote access endpoints using third-party CAs, perform the
following steps:

Step 1

Command

Purpose

crypto ikev2 enable outside client-services port
portnumber

Enables client services.
Note

Example:
hostname(config-tunnel-ipsec)# crypto ikev2 enable
outside client-services

Step 2

Needed only if you support IKEv2.

Enter this command in tunnel-group ipsec-attributes
configuration mode.
The default port number is 443.

scep-enrollment enable

Enables SCEP enrollment for the tunnel group.

Example:

Enter this command in tunnel-group
general-attributes configuration mode.

hostname(config-tunnel-general)# scep-enrollment
enable
INFO: 'authentication aaa certificate' must be
configured to complete setup of this option.

Step 3

scep-forwarding-url value URL

Enrolls the SCEP CA for the group policy.

Example:

Enter this command once per group policy to support
a third-party digital certificate. Enter the command in
group-policy general-attributes configuration mode.

hostname(config-group-policy)# scep-forwarding-url
value http://ca.example.com:80/

Step 4

URL is the SCEP URL on the CA.

secondary-pre-fill-username clientless hide
use-common-password password

Supplies a common, secondary password when a
certificate is unavailable for WebLaunch support of
the SCEP proxy.

Example:

You must use the hide keyword to support the SCEP
proxy.

hostname(config)# tunnel-group remotegrp
webvpn-attributes
hostname(config-tunnel-webvpn)#
secondary-pre-fill-username clientless hide
use-common-password secret

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-21

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Step 5

Command

Purpose

secondary-pre-fill-username ssl-client hide
use-common-password password

Hides the secondary prefill username for
AnyConnect VPN sessions.

Example:

Despite the ssl-client keyword inherited from earlier
releases, use this command to support AnyConnect
sessions that use either IKEv2 or SSL.

hostname(config-tunnel-webvpn)#
secondary-pre-fill-username ssl-client hide
use-common-password secret

Step 6

secondary-username-from-certificate {use-entire-name
| use-script | {primary_attr [secondary-attr]}}
[no-certificate-fallback cisco-secure-desktop
machine-unique-id]

You must use the hide keyword to support the SCEP
proxy.
Supplies the username when a certificate is
unavailable.

Example:
hostname(config-tunnel-webvpn)#
secondary-username-from-certificate CN
no-certificate-fallback cisco-secure-desktop
machine-unique-id

Enabling the Local CA Server
Before enabling the local CA server, you must first create a passphrase of at least seven characters to
encode and archive a PKCS12 file that includes the local CA certificate and keypair to be generated. The
passphrase unlocks the PKCS12 archive if the CA certificate or keypair is lost.
To enable the local CA server, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

no shutdown

Example:
hostname (config-ca-server)# no shutdown

Enables the local CA server. Generates the local CA
server certificate, keypair and necessary database
files, and archives the local CA server certificate and
keypair to storage in a PKCS12 file. Requires an 8-65
alphanumeric character password. After initial
startup, you can disable the local CA without being
prompted for the passphrase.
Note

Examples
The following example enables the local CA server:
hostname (config)# crypto ca server

Cisco ASA 5500 Series Configuration Guide using the CLI

41-22

After you enable the local CA server, save the
configuration to make sure that the local CA
certificate and keypair are not lost after a
reboot occurs.

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

hostname (config-ca-server)# no shutdown
% Some server settings cannot be changed after CA certificate generation.
% Please enter a passphrase to protect the private key
% or type Return to exit
Password: caserver
Re-enter password: caserver
Keypair generation process begin. Please wait...

The following is sample output that shows local CA server configuration and status:
Certificate Server LOCAL-CA-SERVER:
Status: enabled
State: enabled
Server's configuration is locked (enter “shutdown” to unlock it)
Issuer name: CN=wz5520-1-16
CA certificate fingerprint/thumbprint: (MD5)
76dd1439 ac94fdbc 74a0a89f cb815acc
CA certificate fingerprint/thumbprint: (SHA1)
58754ffd 9f19f9fd b13b4b02 15b3e4be b70b5a83
Last certificate issued serial number: 0x6
CA certificate expiration timer: 14:25:11 UTC Jan 16 2008
CRL NextUpdate timer: 16:09:55 UTC Jan 24 2007
Current primary storage dir: flash:

Configuring the Local CA Server
To configure the local CA server, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode.
Generates the local CA.

Example:
hostname (config)# crypto ca server

Step 2

smtp from-address e-mail_address

Example:
hostname (config-ca-server) # smtp from-address
SecurityAdmin@hostcorp.com

Specifies 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 OTPs for an
enrollment invitation to users.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-23

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Step 3

Command

Purpose

subject-name-default dn

(Optional) Specifies the subject-name DN that is
appended to each username on issued certificates.

Example:

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.

hostname (config-ca-server)# subject-name-default
cn=engineer, o=asc systems, c=”US”

Note

Step 4

no shutdown

Example:
hostname (config-ca-server)# no shutdown

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.

Creates the self-signed certificate and associates it
with the local CA on the ASA. 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.

Examples
The following example shows how to configure and enable the local CA server using the predefined
default values for all required parameters:
hostname
hostname
hostname
hostname

(config)# crypto ca server
(config-ca-server) # smtp from-address SecurityAdmin@hostcorp.com
(config-ca-server)# subject-name-default cn=engineer, o=asc Systems, c=US
(config-ca-server)# no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

41-24

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Customizing the Local CA Server
To configure a customized local CA server, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

Specifies parameters that do not have default values.

issuer-name DN-string

Example:
hostname (config-ca-server)# issuer-name
cn=xx5520,cn=30.132.0.25,ou=DevTest,ou=QA,o=ASC
Systems

Step 3

Customizes the text that appears in the subject field
of all e-mail messages sent from the local CA server

smtp subject subject-line

Example:
hostname (config-ca-server) # smtp subject Priority
E-Mail: Enclosed Confidential Information is
Required for Enrollment

Step 4

smtp from-address e-mail_address

Example:

Specifies 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.

hostname (config-ca-server) # smtp from-address
SecurityAdmin@hostcorp.com

Step 5

subject-name-default dn

Example:
hostname (config-ca-server) # subject-name default
cn=engineer, o=ASC Systems, c=US

Specifies an optional subject-name DN to be
appended to a username on issued certificates. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-25

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Debugging the Local CA Server
To debug the newly configured local CA server, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

Displays debugging messages when you configure
and enable the local CA server. Performs level 1
debugging functions; levels 1-255 are available.

debug crypto ca server

Example:
hostname (config-ca-server)# debug crypto ca server

Note

Debugging commands might slow down
traffic on busy networks. Levels 5 and higher
are reserved for raw data dumps and should
be avoided during normal debugging because
of excessive output.

Disabling the Local CA Server
To disable the local CA server, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

Disables the local CA server. Disables website
enrollment and allows you to modify the local CA
server configuration. Stores the current configuration
and associated files. After initial startup, you can
reenable the local CA without being prompted for the
passphrase.

shutdown

Example:
hostname (config-ca-server)# shutdown
INFO: Local CA Server has been shutdown.

Deleting the Local CA Server
To delete an existing local CA server (either enabled or disabled), enter one of the following commands:
Command

Purpose

Do one of the following:

Cisco ASA 5500 Series Configuration Guide using the CLI

41-26

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Command

Purpose

no crypto ca server

Removes an existing local CA server (either enabled or
disabled).

Example:

Note

Deleting the local CA server removes the
configuration from the ASA. After the configuration
has been deleted, it is unrecoverable.

hostname (config)# no crypto ca server
clear configure crypto ca server

Example:
hostname (config)# clear config crypto ca server

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.*).

Configuring Local CA Certificate Characteristics
You can configure the following characteristics of local CA certificates:
•

The name of the certificate issuer as it appears on all user certificates.

•

The lifetime of the local CA certificates (server and user) and the CRL.

•

The length of the public and private keypairs associated with local CA and user certificates.

This section includes the following topics:
•

Configuring the Issuer Name, page 41-28

•

Configuring the CA Certificate Lifetime, page 41-28

•

Configuring the User Certificate Lifetime, page 41-29

•

Configuring the CRL Lifetime, page 41-30

•

Configuring the Server Keysize, page 41-30

•

Setting Up External Local CA File Storage, page 41-31

•

Downloading CRLs, page 41-33

•

Storing CRLs, page 41-34

•

Setting Up Enrollment Parameters, page 41-35

•

Adding and Enrolling Users, page 41-36

•

Renewing Users, page 41-38

•

Restoring Users, page 41-39

•

Removing Users, page 41-39

•

Revoking Certificates, page 41-40

•

Maintaining the Local CA Certificate Database, page 41-40

•

Rolling Over Local CA Certificates, page 41-40

•

Archiving the Local CA Server Certificate and Keypair, page 41-41

Cisco ASA 5500 Series Configuration Guide using the CLI

41-27

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Configuring the Issuer Name
To configure the certificate issuer name, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

issuer-name DN-string

Example:
hostname (config-ca-server)# issuer-name
CN=xx5520,CN=30.132.0.25,ou=DevTest,ou=QA,O=ABC
Systems

Specifies the local CA certificate subject name. The
configured certificate issuer name is both the subject
name and issuer name of the self-signed local CA
certificate, as well as the issuer name in all issued
client certificates and in the issued CRL. The default
issuer name in the local CA is in the format,
hostname.domainname.
Note

You cannot change the issuer name value after
the local CA is first enabled.

Configuring the CA Certificate Lifetime
To configure the local CA server certificate lifetime, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Cisco ASA 5500 Series Configuration Guide using the CLI

41-28

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Step 2

Command

Purpose

lifetime ca-certificate time

Determines the expiration date included in the
certificate. The default lifetime of a local CA
certificate is three years.

Example:

Step 3

hostname (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.

no lifetime ca-certificate

(Optional) Resets the local CA certificate lifetime to
the default value of three years.

Example:

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 preexpiration syslog message is generated:

hostname (config-ca-server)# no lifetime
ca-certificate

%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.

Configuring the User Certificate Lifetime
To configure the user certificate lifetime, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

lifetime certificate time

Sets the length of time that you want user certificates
to remain valid.

Example:

Note

hostname (config-ca-server)# lifetime certificate
60

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-29

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Configuring the CRL Lifetime
To configure the CRL lifetime, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

lifetime crl time

Sets the length of time that you want the CRL to
remain valid.

Example:

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.

hostname (config-ca-server)# lifetime crl 10

Step 3

crypto ca server crl issue

Example:
hostname(config)# crypto ca server crl issue
A new CRL has been issued.

Forces the issuance of a CRL at any time, which
immediately updates and regenerates a current CRL
to overwrite the existing CRL.
Note

Do not use this command unless the CRL file
has been removed in error or has been
corrupted and must be regenerated.

Configuring the Server Keysize
To configure the server keysize, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

keysize server

Example:
hostname (config-ca-server)# keysize server 2048

Specifies the size of the public and private keys
generated at user-certificate enrollment. The keypair
size options are 512, 768, 1024, 2048 bits, and the
default value is 1024 bits.
Note

Cisco ASA 5500 Series Configuration Guide using the CLI

41-30

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.

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Examples
The following is sample output that shows two user certificates in the database.
Username: emily1
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: fred1
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 --->

Setting Up External Local CA File Storage
You can store the local CA server configuration, users, issued certificates, and CRLs in the local CA
server database either in flash memory or in an external local CA file system. To configure external local
CA file storage, perform the following steps:

Step 1

Command

Purpose

mount name type

Accesses configuration mode for the specific file
system type.

Example:
hostname (config)# mount mydata type cifs

Step 2

Mounts a CIFS file system.

mount name type cifs

Note

Example:

Only the user who mounts a file system can
unmount it with the no mount command.

hostname (config-mount-cifs)# mount mydata type cifs
server 99.1.1.99 share myshare
domain example.com
username user6
password ********
status enable

Cisco ASA 5500 Series Configuration Guide using the CLI

41-31

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Step 3

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 4

database path mount-name directory-path

Example:
hostname (config-ca-server)# database path
mydata:newuser

Specifies the location of mydata, the premounted
CIFS file system to be used for the local CA server
database. 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

Step 5

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.

Saves the running configuration.

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.

Example:
hostname (config)# write memory

For flash memory storage, user information is saved
automatically to the default location for the start-up
configuration.

Examples
The following example shows the list of local CA files that appear in flash memory or in external storage:
hostname (config-ca-server)# dir LOCAL* //
Directory of disk0:/LOCAL*

75

-rwx

32

13:07:49 Jan 20 2007

LOCAL-CA-SERVER.ser

77

-rwx

229

13:07:49 Jan 20 2007

LOCAL-CA-SERVER.cdb

69

-rwx

0

01:09:28 Jan 20 2007

LOCAL-CA-SERVER.udb

81

-rwx

232

19:09:10 Jan 20 2007

LOCAL-CA-SERVER.crl

72

-rwx

1603

01:09:28 Jan 20 2007

LOCAL-CA-SERVER.p12

127119360 bytes total (79693824 bytes free)

Cisco ASA 5500 Series Configuration Guide using the CLI

41-32

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Downloading CRLs
To make the CRL available for HTTP download on a given interface or port, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

publish-crl interface interface port portnumber

Example:
hostname (config-ca-server)# publish-crl outside 70

Opens 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. The interface and optional port selections
are as follows:
•

inside—Name of interface/GigabitEthernet0/1

•

management—Name of interface/
Management0/0

•

outside—Name of interface/GigabitEthernet0/0

•

Port numbers can range from 1-65535. TCP port
80 is the HTTP default port number.

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://.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-33

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Storing CRLs
To establish a specific location for the automatically generated CRL of the local CA, perform the
following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

cdp-url url

Example:
hostname(config-ca-server)# cdp-url
http://172.16.1.1/pathname/myca.crl

Specifies 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.
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 the “Downloading CRLs”
section on page 41-33 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 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-34

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Setting Up Enrollment Parameters
To set up enrollment parameters, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

otp expiration timeout

Example:
hostname(config-ca-server)# otp expiration 24

Step 3

Specifies the number of hours that an issued OTP for
the local CA enrollment page is valid. The default
expiration time is 72 hours.
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.

Specifies the number of hours an already-enrolled
user can retrieve a PKCS12 enrollment file.This time
period begins when the user is successfully enrolled.
Example:
The default retrieval period is 24 hours. Valid values
hostname(config-ca-server)# enrollment-retrieval 120
for the retrieval period range from 1 to 720 hours. The
enrollment retrieval period is independent of the OTP
expiration period.
enrollment-retrieval timeout

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-35

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Adding and Enrolling Users
To add a user who is eligible for enrollment in the local CA database, perform the following steps:

Step 1

Command

Purpose

crypto ca server user-db add username [dn dn] [email
emailaddress]

Adds a new user to the local CA database. Options
are as follows:
•

username—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.

•

dn—The distinguished name, a global,
authoritative name of an entry in the OSI
Directory (X.500) (for example,
cn=user1@example.com, cn=Engineer,
o=Example Company, c=US).

•

e-mail-address—The e-mail address of the new
user to which OTPs and notices are to be sent.

Example:
hostname (config-ca-server)# crypto ca server
user-db add user1 dn user1@example.com, Engineer,
Example Company, US, email user1@example.com

Step 2

crypto ca server user-db allow user

Provides user privileges to a newly added user.

Example:
hostname (config-ca-server)# crypto ca server
user-db allow user6

Step 3

crypto ca server user-db email-otp username

Example:
hostname (config-ca-server)# crypto ca server
user-db email-otp exampleuser1

Cisco ASA 5500 Series Configuration Guide using the CLI

41-36

Notifies a user in the local CA database to enroll and
download a user certificate, which automatically
e-mails the OTP to that user.
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.

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Step 4

Command

Purpose

crypto ca server user-db show-otp

Shows the issued OTP.

Example:
hostname (config-ca-server)# crypto ca server
user-db show-otp

Step 5

otp expiration timeout

Example:
hostname (config-ca-server)# otp expiration 24

Sets the enrollment time limit in hours. The default
expiration time is 72 hours. The otp expiration
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.
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-37

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Renewing Users
To specify the timing of renewal notices, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local CA server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

renewal-reminder time

Example:
hostname (config-ca-server)# renewal-reminder 7

Specifies the number of days (1-90) before the local
CA certificate expires that an initial reminder to
reenroll is sent to certificate owners. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-38

Chapter 41

Configuring Digital Certificates
Configuring Digital Certificates

Restoring Users
To restore a user and a previously revoked certificate that was issued by the local CA server, perform the
following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

crypto ca server unrevoke cert-serial-no

Restores a user and unrevokes a previously revoked
certificate that was issued by the local CA server.

Example:

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.

hostname (config)# crypto ca server unrevoke
782ea09f

Removing Users
To delete a user from the user database by username, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

crypto ca server user-db remove username

Example:

Removes a user from the user database and allows
revocation of any valid certificates that were issued to
that user.

hostname (config)# crypto ca server user-db remove
user1

Cisco ASA 5500 Series Configuration Guide using the CLI

41-39

Chapter 41

Configuring Digital Certificates

Configuring Digital Certificates

Revoking Certificates
To revoke a user certificate, perform the following steps:

Step 1

Command

Purpose

crypto ca server

Enters local ca server configuration mode. Allows
you to configure and manage a local CA.

Example:
hostname (config)# crypto ca server

Step 2

crypto ca server revoke cert-serial-no

Example:
hostname (config-ca-server)# crypto ca server revoke
782ea09f

Enters the certificate serial number in hexadecimal
format. 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.

Maintaining the Local CA Certificate Database
To maintain the local CA certificate database, make sure that you save the certificate database file,
LOCAL-CA-SERVER.cdb, with the write memory command each time that a change to the database
occurs. The local CA certificate database includes the following files:
•

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.

Rolling Over Local CA Certificates
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.

Examples
The following example shows a base 64 encoded local CA certificate:
MIIXlwIBAzCCF1EGCSqGSIb3DQEHAaCCF0IEghc+MIIXOjCCFzYGCSqGSIb3DQEHBqCCFycwghcjAgEAMIIXHAYJKo
ZIhvcNAQcBMBsGCiqGSIb3DQEMAQMwDQQIjph4SxJoyTgCAQGAghbw3v4bFy+GGG2dJnB4OLphsUM+IG3SDOiDwZG9
n1SvtMieoxd7Hxknxbum06JDrujWKtHBIqkrm+td34qlNE1iGeP2YC94/NQ2z+4kS+uZzwcRhl1KEZTS1E4L0fSaC3
uMTxJq2NUHYWmoc8pi4CIeLj3h7VVMy6qbx2AC8I+q57+QG5vG5l5Hi5imwtYfaWwPEdPQxaWZPrzoG1J8BFqdPa1j
BGhAzzuSmElm3j/2dQ3Atro1G9nIsRHgV39fcBgwz4fEabHG7/Vanb+fj81d5nlOiJjDYYbP86tvbZ2yOVZR6aKFVI
0b2AfCr6PbwfC9U8Z/aF3BCyM2sN2xPJrXva94CaYrqyotZdAkSYA5KWScyEcgdqmuBeGDKOncTknfgy0XM+fG5rb3
qAXy1GkjyFI5Bm9Do6RUROoG1DSrQrKeq/hj….

Cisco ASA 5500 Series Configuration Guide using the CLI

41-40

Chapter 41

Configuring Digital Certificates
Monitoring Digital Certificates

END OF CERTIFICATE

Archiving the Local CA Server Certificate and Keypair
To archive the local CA server certificate and keypair, enter the following command:
Command

Purpose

copy

Copies the local CA server certificate and keypair and all files
from the ASA using either FTP or TFTP.

Example:

Note

hostname# copy LOCAL-CA-SERVER_0001.pl2
tftp://10.1.1.22/user6/

Make sure that you back up all local CA files as often
as possible.

Monitoring Digital Certificates
To display certificate configuration and database information, enter one or more of the following
commands:
Command

Purpose

show crypto ca server

Shows local CA configuration and status.

show crypto ca server cert-db

Shows user certificates issued by the local CA.

show crypto ca server certificate

Shows local CA certificates on the console in base 64 format and the rollover
certificate when available, including the rollover certificate thumbprint for
verification of the new certificate during import onto other devices.

show crypto ca server crl

Shows CRLs.

show crypto ca server user-db

Shows users and their status, which can be used with the following qualifiers
to reduce the number of displayed records:
•

allowed. Shows only users currently allowed to enroll.

•

enrolled. Shows only users that are enrolled and hold a valid certificate

•

expired. Shows only users holding expired certificates.

•

on-hold. Lists only users without a certificate and not currently allowed
to enroll.

show crypto ca server user-db allowed

Shows users who are eligible to enroll.

show crypto ca server user-db enrolled

Shows enrolled users with valid certificates.

show crypto ca server user-db expired

Shows users with expired certificates.

show crypto ca server user-db on-hold

Shows users without certificates who are not allowed to enroll.

show crypto key name of key

Shows key pairs that you have generated.

show running-config

Shows local CA certificate map rules.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-41

Chapter 41

Configuring Digital Certificates

Monitoring Digital Certificates

Examples
The following example shows an RSA general-purpose key:
hostname/contexta(config)# show crypto key mypubkey
Key pair was generated at: 16:39:47 central Feb 10 2010
Key name: 
Usage: General Purpose Key
Modulus Size (bits): 1024
Key Data:
30819f30 0d06092a 864886f7 0d010101 05000381 8d003081
0781848f 78bccac2 4a1b5b8d 2f3e30b4 4cae9f86 f4485207
9eeb0f5d 45fd1811 3b4aafce 292b3b64 b4124a6f 7a777b08
5508e9e5 2c271245 7fd1c0c3 3aaf1e04 c7c4efa4 600f4c4a
e08407dd 45d9e36e 8cc0bfef 14f9e6ac eca141e4 276d7358
Key pair was generated at: 16:34:54 central Feb 10 2010

89028181
159108c9
75b88df1
6afe56ad
f7f50d13

00ea51b7
f5e49103
8092a9f8
c1d2c01c
79020301 0001

The following example shows the local CA CRL:
hostname (config)# show crypto ca
Certificate Revocation List:
Issuer: cn=xx5520-1-3-2007-1
This Update: 13:32:53 UTC Jan
Next Update: 13:32:53 UTC Feb
Number of CRL entries: 2
CRL size: 270 bytes
Revoked Certificates:
Serial Number: 0x6f
Revocation Date: 12:30:01 UTC
Serial Number: 0x47
Revocation Date: 13:32:48 UTC

server crl

4 2010
3 2010

Jan 4 2010
Jan 4 2010

The following example shows one user on-hold:
hostname (config)# show crypto ca server user-db on-hold
username: wilma101
email:

dn:

allowed: 
notified: 0
hostname (config)#

The following example shows output of the show running-config command, in which local CA
certificate map rules appear:
crypto ca certificate map 1
issuer-name co asc
subject-name attr ou eq Engineering

Cisco ASA 5500 Series Configuration Guide using the CLI

41-42

Chapter 41

Configuring Digital Certificates
Feature History for Certificate Management

Feature History for Certificate Management
Table 41-1 lists each feature change and the platform release in which it was implemented.
Table 41-1

Feature History for Certificate Management

Feature Name

Platform
Releases

Certificate management

7.0(1)

Digital certificates (including CA certificates, identity
certificates, and code signer 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.

Certificate management

7.2(1

We introduced the following commands:

Feature Information

issuer-name DN-string, revocation-check crl none,
revocation-check crl, revocation-check none
We deprecated the following commands: crl {required |
optional | nocheck}.

Cisco ASA 5500 Series Configuration Guide using the CLI

41-43

Chapter 41

Configuring Digital Certificates

Feature History for Certificate Management

Table 41-1

Feature History for Certificate Management (continued)

Feature Name

Platform
Releases

Feature Information

Certificate management

8.0(2)

We introduced the following commands:
cdp-url, crypto ca server, crypto ca server crl issue,
crypto ca server revoke cert-serial-no, crypto ca server
unrevoke cert-serial-no, crypto ca server user-db add
user [dn dn] [email e-mail-address], crypto ca server
user-db allow {username | all-unenrolled |
all-certholders} [display-otp] [email-otp] [replace-otp],
crypto ca server user-db email-otp {username |
all-unenrolled | all-certholders}, crypto ca server
user-db remove username, crypto ca server user-db
show-otp {username | all-certholders | all-unenrolled},
crypto ca server user-db write, [no] database path
mount-name directory-path, debug crypto ca server
[level], lifetime {ca-certificate | certificate | crl} time, no
shutdown, otp expiration timeout, renewal-reminder
time, show crypto ca server, show crypto ca server
cert-db [user username | allowed | enrolled | expired |
on-hold] [serial certificate-serial-number], show crypto
ca server certificate, show crypto ca server crl, show
crypto ca server user-db [expired | allowed | on-hold |
enrolled], show crypto key name of key, show
running-config, shutdown.

SCEP proxy

8.4(1)

We introduced this feature, which provides secure
deployment of device certificates from third-party CAs.
We introduced the following commands:
crypto ikev2 enable outside client-services port
portnumber, scep-enrollment enable,
scep-forwarding-url value URL,
secondary-pre-fill-username clientless hide
use-common-password password,
secondary-pre-fill-username ssl-client hide
use-common-password password,
secondary-username-from-certificate {use-entire-name
| use-script | {primary_attr [secondary-attr]}}
[no-certificate-fallback cisco-secure-desktop
machine-unique-id].

Cisco ASA 5500 Series Configuration Guide using the CLI

41-44

PA R T

10

Configuring Application Inspection

CH A P T E R

42

Getting Started with Application Layer Protocol
Inspection
This chapter describes how to configure application layer protocol inspection. Inspection engines are
required for services that embed IP addressing information in the user data packet or that open secondary
channels on dynamically assigned ports. These protocols require the ASA to do a deep packet inspection
instead of passing the packet through the fast path (see the “Stateful Inspection Overview” section on
page 1-27 for more information about the fast path). As a result, inspection engines can affect overall
throughput. Several common inspection engines are enabled on the ASA by default, but you might need
to enable others depending on your network.
This chapter includes the following sections:
•

Information about Application Layer Protocol Inspection, page 42-1

•

Guidelines and Limitations, page 42-3

•

Default Settings, page 42-4

•

Configuring Application Layer Protocol Inspection, page 42-6

Information about Application Layer Protocol Inspection
This section includes the following topics:
•

How Inspection Engines Work, page 42-1

•

When to Use Application Protocol Inspection, page 42-2

How Inspection Engines Work
As illustrated in Figure 42-1, the ASA uses three databases for its basic operation:
•

Access lists—Used for authentication and authorization of connections based on specific networks,
hosts, and services (TCP/UDP port numbers).

•

Inspections—Contains a static, predefined set of application-level inspection functions.

•

Connections (XLATE and CONN tables)—Maintains state and other information about each
established connection. This information is used by the Adaptive Security Algorithm and
cut-through proxy to efficiently forward traffic within established sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

42-1

Chapter 42

Getting Started with Application Layer Protocol Inspection

Information about Application Layer Protocol Inspection

Figure 42-1

How Inspection Engines Work

ACL

2

Client

ASA

6

7

5

3

XLATE
CONN

Server

4

Inspection

132875

1

In Figure 42-1, operations are numbered in the order they occur, and are described as follows:
1.

A TCP SYN packet arrives at the ASA to establish a new connection.

2.

The ASA checks the access list database to determine if the connection is permitted.

3.

The ASA creates a new entry in the connection database (XLATE and CONN tables).

4.

The ASA checks the Inspections database to determine if the connection requires application-level
inspection.

5.

After the application inspection engine completes any required operations for the packet, the ASA
forwards the packet to the destination system.

6.

The destination system responds to the initial request.

7.

The ASA receives the reply packet, looks up the connection in the connection database, and
forwards the packet because it belongs to an established session.

The default configuration of the ASA includes a set of application inspection entries that associate
supported protocols with specific TCP or UDP port numbers and that identify any special handling
required.

When to Use Application Protocol Inspection
When a user establishes a connection, the ASA checks the packet against access lists, creates an address
translation, and creates an entry for the session in the fast path, so that further packets can bypass
time-consuming checks. However, the fast path relies on predictable port numbers and does not perform
address translations inside a packet.
Many protocols open secondary TCP or UDP ports. The initial session on a well-known port is used to
negotiate dynamically assigned port numbers.
Other applications embed an IP address in the packet that needs to match the source address that is
normally translated when it goes through the ASA.
If you use applications like these, then you need to enable application inspection.

Cisco ASA 5500 Series Configuration Guide using the CLI

42-2

Chapter 42

Getting Started with Application Layer Protocol Inspection
Guidelines and Limitations

When you enable application inspection for a service that embeds IP addresses, the ASA translates
embedded addresses and updates any checksum or other fields that are affected by the translation.
When you enable application inspection for a service that uses dynamically assigned ports, the ASA
monitors sessions to identify the dynamic port assignments, and permits data exchange on these ports
for the duration of the specific session.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Failover Guidelines

State information for multimedia sessions that require inspection are not passed over the state link for
stateful failover. The exception is GTP, which is replicated over the state link.
IPv6 Guidelines

Supports IPv6 for the following inspections:
•

FTP

•

HTTP

•

ICMP

•

SIP

•

SMTP

•

IPsec pass-through

Additional Guidelines and Limitations

Some inspection engines do not support PAT, NAT, outside NAT, or NAT between same security
interfaces. See “Default Settings” for more information about NAT support.
For all the application inspections, the adaptive security appliance limits the number of simultaneous,
active data connections to 200 connections. For example, if an FTP client opens multiple secondary
connections, the FTP inspection engine allows only 200 active connections and the 201 connection is
dropped and the adaptive security appliance generates a system error message.
Inspected protocols are subject to advanced TCP-state tracking, and 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.
Inspection Reset Behavior

When you configure an inspection engine to use a reset action and a packet triggers a reset, the ASA
sends a TCP reset under the following conditions:
•

The ASA sends a TCP reset to the inside host when the service resetoutbound command is enabled.
(The service resetoutbound command is disabled by default.)

Cisco ASA 5500 Series Configuration Guide using the CLI

42-3

Chapter 42

Getting Started with Application Layer Protocol Inspection

Default Settings

•

The ASA sends a TCP reset to the outside host when the service resetinbound command is enabled.
(The service resetinbound command is disabled by default.)

For more information, see the service command in the ASA command reference.
This behavior ensures that a reset action will reset the connections on the ASA and on inside servers;
therefore countering denial of service attacks. For outside hosts, the ASA does not send a reset by
default and information is not revealed through a TCP reset.

Default Settings
By default, the configuration includes a policy that matches all default application inspection traffic and
applies inspection to the traffic on all interfaces (a global policy). Default application inspection traffic
includes traffic to the default ports for each protocol. You can only apply one global policy, so if you
want to alter the global policy, for example, to apply inspection to non-standard ports, or to add
inspections that are not enabled by default, you need to either edit the default policy or disable it and
apply a new one.
Table 42-1 lists all inspections supported, the default ports used in the default class map, and the
inspection engines that are on by default, shown in bold. This table also notes any NAT limitations.
Table 42-1

Supported Application Inspection Engines

Application1

Default Port NAT Limitations

Standards2

Comments

CTIQBE

TCP/2748

No extended PAT.

—

—

DCERPC

TCP/135

—

—

—

DNS over UDP

UDP/53

No NAT support is available for RFC 1123
name resolution through
WINS.

No PTR records are changed.

FTP

TCP/21

—

RFC 959

—

GTP

UDP/3386
UDP/2123

No extended PAT.

—

Requires a special license.

No NAT on same security
H.323 H.225 and TCP/1720
RAS
UDP/1718 interfaces.
UDP (RAS) No static PAT.
1718-1719
No extended PAT.

ITU-T H.323,
H.245, H225.0,
Q.931, Q.932

—

HTTP

TCP/80

—

RFC 2616

Beware of MTU limitations stripping
ActiveX and Java. If the MTU is too
small to allow the Java or ActiveX tag to
be included in one packet, stripping
may not occur.

ICMP

—

—

—

All ICMP traffic is matched in the
default class map.

ICMP ERROR

—

—

—

All ICMP traffic is matched in the
default class map.

ILS (LDAP)

TCP/389

No extended PAT.

—

—

Instant
Messaging (IM)

Varies by
client

No extended PAT.

RFC 3860

—

Cisco ASA 5500 Series Configuration Guide using the CLI

42-4

Chapter 42

Getting Started with Application Layer Protocol Inspection
Default Settings

Table 42-1

Supported Application Inspection Engines (continued)

Application1

Default Port NAT Limitations

Standards2

Comments

IP Options

—

—

RFC 791, RFC
2113

All IP Options traffic is matched in the
default class map.

MGCP

UDP/2427,
2727

No extended PAT.

RFC 2705bis-05

—

MMP

TCP 5443

No extended PAT.

—

—

NetBIOS Name
Server over IP

UDP/137,
No extended PAT.
138 (Source
ports)

—

NetBIOS is supported by performing
NAT of the packets for NBNS UDP port
137 and NBDS UDP port 138.

PPTP

TCP/1723

—

RFC 2637

—

RADIUS
Accounting

1646

—

RFC 2865

—

RSH

TCP/514

No PAT

Berkeley UNIX

—

RTSP

TCP/554

No extended PAT.

RFC 2326, 2327, No handling for HTTP cloaking.
1889

No outside NAT.
SIP

TCP/5060
UDP/5060

No outside NAT.

RFC 2543

—

—

Does not handle TFTP uploaded Cisco
IP Phone configurations under certain
circumstances.

—

No NAT on same security
interfaces.
No extended PAT.

SKINNY
(SCCP)

TCP/2000

No outside NAT.
No NAT on same security
interfaces.
No extended PAT.

SMTP and
ESMTP

TCP/25

—

RFC 821, 1123

SNMP

UDP/161,
162

No NAT or PAT.

RFC 1155, 1157, v.2 RFC 1902-1908; v.3 RFC
1212, 1213, 1215 2570-2580.

SQL*Net

TCP/1521

No extended PAT.

—

v.1 and v.2.

Sun RPC over
UDP and TCP

UDP/111

No extended PAT.

—

The default rule includes UDP port 111;
if you want to enable Sun RPC
inspection for TCP port 111, you need
to create a new rule that matches TCP
port 111 and performs Sun RPC
inspection.

TFTP

UDP/69

—

RFC 1350

Payload IP addresses are not translated.

WAAS

—

No extended PAT.

—

—

XDCMP

UDP/177

No extended PAT.

—

—

1. Inspection engines that are enabled by default for the default port are in bold.
2. The ASA is in compliance with these standards, but it does not enforce compliance on packets being inspected. For example, FTP commands are supposed
to be in a particular order, but the ASA does not enforce the order.

The default policy configuration includes the following commands:

Cisco ASA 5500 Series Configuration Guide using the CLI

42-5

Chapter 42

Getting Started with Application Layer Protocol Inspection

Configuring Application Layer Protocol Inspection

class-map inspection_default
match default-inspection-traffic
policy-map type inspect dns preset_dns_map
parameters
message-length maximum 512
policy-map global_policy
class inspection_default
inspect dns preset_dns_map
inspect ftp
inspect h323 h225
inspect h323 ras
inspect rsh
inspect rtsp
inspect esmtp
inspect sqlnet
inspect skinny
inspect sunrpc
inspect xdmcp
inspect sip
inspect netbios
inspect tftp
service-policy global_policy global

Configuring Application Layer Protocol Inspection
This feature uses Modular Policy Framework to create a service policy. Service policies provide a
consistent and flexible way to configure ASA features. For example, you can use a service policy to
create a timeout configuration that is specific to a particular TCP application, as opposed to one that
applies to all TCP applications. See Chapter 32, “Configuring a Service Policy Using the Modular Policy
Framework,” for more information. For some applications, you can perform special actions when you
enable inspection. See Chapter 32, “Configuring a Service Policy Using the Modular Policy
Framework,” for more information.
Inspection is enabled by default for some applications. See the “Default Settings” section for more
information. Use this section to modify your inspection policy.

Detailed Steps
Step 1

To identify the traffic to which you want to apply inspections, add either a Layer 3/4 class map for
through traffic or a Layer 3/4 class map for management traffic. See the “Creating a Layer 3/4 Class Map
for Through Traffic” section on page 32-12 and “Creating a Layer 3/4 Class Map for Management
Traffic” section on page 32-14 for detailed information. The management Layer 3/4 class map can be
used only with the RADIUS accounting inspection.
The default Layer 3/4 class map for through traffic is called “inspection_default.” It matches traffic using
a special match command, match default-inspection-traffic, to match the default ports for each
application protocol. This traffic class (along with match any, which is not typically used for inspection)
matches both IPv4 and IPv6 traffic for inspections that support IPv6. See the “Guidelines and
Limitations” section on page 42-3 for a list of IPv6-enabled inspections.
You can specify a match access-list command along with the match default-inspection-traffic
command to narrow the matched traffic to specific IP addresses. Because the match
default-inspection-traffic command specifies the ports to match, any ports in the access list are ignored.

Cisco ASA 5500 Series Configuration Guide using the CLI

42-6

Chapter 42

Getting Started with Application Layer Protocol Inspection
Configuring Application Layer Protocol Inspection

Tip

We suggest that you only inspect traffic on ports on which you expect application traffic; if you
inspect all traffic, for example using match any, the ASA performance can be impacted.

If you want to match non-standard ports, then create a new class map for the non-standard ports. See the
“Default Settings” section on page 42-4 for the standard ports for each inspection engine. You can
combine multiple class maps in the same policy if desired, so you can create one class map to match
certain traffic, and another to match different traffic. However, if traffic matches a class map that
contains an inspection command, and then matches another class map that also has an inspection
command, only the first matching class is used. For example, SNMP matches the inspection_default
class. To enable SNMP inspection, enable SNMP inspection for the default class in Step 5. Do not add
another class that matches SNMP.
For example, to limit inspection to traffic from 10.1.1.0 to 192.168.1.0 using the default class map, enter
the following commands:
hostname(config)# access-list inspect extended permit ip 10.1.1.0 255.255.255.0
192.168.1.0 255.255.255.0
hostname(config)# class-map inspection_default
hostname(config-cmap)# match access-list inspect

View the entire class map using the following command:
hostname(config-cmap)# show running-config class-map inspection_default
!
class-map inspection_default
match default-inspection-traffic
match access-list inspect
!

To inspect FTP traffic on port 21 as well as 1056 (a non-standard port), create an access list that specifies
the ports, and assign it to a new class map:
hostname(config)# access-list ftp_inspect extended permit tcp any any eq 21
hostname(config)# access-list ftp_inspect extended permit tcp any any eq 1056
hostname(config)# class-map new_inspection
hostname(config-cmap)# match access-list ftp_inspect

Step 2

(Optional) Some inspection engines let you control additional parameters when you apply the inspection
to the traffic. See the following sections to configure an inspection policy map for your application:
•

DCERPC—See the “Configuring a DCERPC Inspection Policy Map for Additional Inspection
Control” section on page 46-2

•

DNS—See the “Configuring a DNS Inspection Policy Map for Additional Inspection Control”
section on page 43-7

•

ESMTP—See the “Configuring an ESMTP Inspection Policy Map for Additional Inspection
Control” section on page 43-32

•

FTP—See the “Configuring an FTP Inspection Policy Map for Additional Inspection Control”
section on page 43-12.

•

GTP—See the “Configuring a GTP Inspection Policy Map for Additional Inspection Control”
section on page 46-4.

•

H323—See the “Configuring an H.323 Inspection Policy Map for Additional Inspection Control”
section on page 44-6

•

HTTP—See the “Configuring an HTTP Inspection Policy Map for Additional Inspection Control”
section on page 43-17.

Cisco ASA 5500 Series Configuration Guide using the CLI

42-7

Chapter 42

Getting Started with Application Layer Protocol Inspection

Configuring Application Layer Protocol Inspection

Step 3

•

Instant Messaging—See the “Configuring an Instant Messaging Inspection Policy Map for
Additional Inspection Control” section on page 43-21

•

IP Options—See the “Configuring an IP Options Inspection Policy Map for Additional Inspection
Control” section on page 43-25

•

MGCP—See the “Configuring an MGCP Inspection Policy Map for Additional Inspection Control”
section on page 44-13.

•

NetBIOS—See the “Configuring a NetBIOS Inspection Policy Map for Additional Inspection
Control” section on page 43-29

•

RADIUS Accounting—See the “Configuring a RADIUS Inspection Policy Map for Additional
Inspection Control” section on page 46-10

•

RTSP—See the “Configuring an RTSP Inspection Policy Map for Additional Inspection Control”
section on page 44-16

•

SIP—See the “Configuring a SIP Inspection Policy Map for Additional Inspection Control” section
on page 44-20

•

Skinny—See the “Configuring a Skinny (SCCP) Inspection Policy Map for Additional Inspection
Control” section on page 44-26

•

SNMP—See the “Configuring an SNMP Inspection Policy Map for Additional Inspection Control”
section on page 46-11.

To add or edit a Layer 3/4 policy map that sets the actions to take with the class map traffic, enter the
following command:
hostname(config)# policy-map name
hostname(config-pmap)#

The default policy map is called “global_policy.” This policy map includes the default inspections listed
in the “Default Settings” section on page 42-4. If you want to modify the default policy (for example, to
add or delete an inspection, or to identify an additional class map for your actions), then enter
global_policy as the name.
Step 4

To identify the class map from Step 1 to which you want to assign an action, enter the following
command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

If you are editing the default policy map, it includes the inspection_default class map. You can edit the
actions for this class by entering inspection_default as the name. To add an additional class map to this
policy map, identify a different name. You can combine multiple class maps in the same policy if desired,
so you can create one class map to match certain traffic, and another to match different traffic. However,
if traffic matches a class map that contains an inspection command, and then matches another class map
that also has an inspection command, only the first matching class is used. For example, SNMP matches
the inspection_default class map.To enable SNMP inspection, enable SNMP inspection for the default
class in Step 5. Do not add another class that matches SNMP.
Step 5

Enable application inspection by entering the following command:
hostname(config-pmap-c)# inspect protocol

The protocol is one of the following values:

Cisco ASA 5500 Series Configuration Guide using the CLI

42-8

Chapter 42

Getting Started with Application Layer Protocol Inspection
Configuring Application Layer Protocol Inspection

Table 42-2

Protocol Keywords

Keywords

Notes

ctiqbe

—

dcerpc [map_name]

If you added a DCERPC inspection policy map according to
“Configuring a DCERPC Inspection Policy Map for
Additional Inspection Control” section on page 46-2,
identify the map name in this command.

dns [map_name]
[dynamic-filter-snoop]

If you added a DNS inspection policy map according to
“Configuring a DNS Inspection Policy Map for Additional
Inspection Control” section on page 43-7, identify the map
name in this command. The default DNS inspection policy
map name is “preset_dns_map.” The default inspection
policy map sets the maximum DNS packet length to 512
bytes.
To enable DNS snooping for the Botnet Traffic Filter, enter
the dynamic-filter-snoop keyword. See the “Enabling DNS
Snooping” section on page 55-10 for more information.

esmtp [map_name]

If you added an ESMTP inspection policy map according to
“Configuring an ESMTP Inspection Policy Map for
Additional Inspection Control” section on page 43-32,
identify the map name in this command.

ftp [strict [map_name]]

Use the strict keyword to increase the security of protected
networks by preventing web browsers from sending
embedded commands in FTP requests. See the “Using the
strict Option” section on page 43-11 for more information.
If you added an FTP inspection policy map according to
“Configuring an FTP Inspection Policy Map for Additional
Inspection Control” section on page 43-12, identify the map
name in this command.

gtp [map_name]

If you added a GTP inspection policy map according to the
“Configuring a GTP Inspection Policy Map for Additional
Inspection Control” section on page 46-4, identify the map
name in this command.

h323 h225 [map_name]

If you added an H323 inspection policy map according to
“Configuring an H.323 Inspection Policy Map for
Additional Inspection Control” section on page 44-6,
identify the map name in this command.

h323 ras [map_name]

If you added an H323 inspection policy map according to
“Configuring an H.323 Inspection Policy Map for
Additional Inspection Control” section on page 44-6,
identify the map name in this command.

http [map_name]

If you added an HTTP inspection policy map according to
the “Configuring an HTTP Inspection Policy Map for
Additional Inspection Control” section on page 43-17,
identify the map name in this command.

icmp

—

Cisco ASA 5500 Series Configuration Guide using the CLI

42-9

Chapter 42

Getting Started with Application Layer Protocol Inspection

Configuring Application Layer Protocol Inspection

Table 42-2

Protocol Keywords

Keywords

Notes

icmp error

—

ils

—

im [map_name]

If you added an Instant Messaging inspection policy map
according to “Configuring an Instant Messaging Inspection
Policy Map for Additional Inspection Control” section on
page 43-21, identify the map name in this command.

ip-options [map_name]

If you added an IP Options inspection policy map according
to “Configuring an IP Options Inspection Policy Map for
Additional Inspection Control” section on page 43-25,
identify the map name in this command.

mgcp [map_name]

If you added an MGCP inspection policy map according to
“Configuring an MGCP Inspection Policy Map for
Additional Inspection Control” section on page 44-13,
identify the map name in this command.

netbios [map_name]

If you added a NetBIOS inspection policy map according to
“Configuring a NetBIOS Inspection Policy Map for
Additional Inspection Control” section on page 43-29,
identify the map name in this command.

pptp

—

radius-accounting [map_name]

The radius-accounting keyword is only available for a
management class map. See the “Creating a Layer 3/4 Class
Map for Management Traffic” section on page 32-14 for
more information about creating a management class map.
If you added a RADIUS accounting inspection policy map
according to “Configuring a RADIUS Inspection Policy
Map for Additional Inspection Control” section on
page 46-10, identify the map name in this command.

rsh

—

rtsp [map_name]

If you added a RTSP inspection policy map according to
“Configuring an RTSP Inspection Policy Map for Additional
Inspection Control” section on page 44-16, identify the map
name in this command.

sip [map_name]

If you added a SIP inspection policy map according to
“Configuring a SIP Inspection Policy Map for Additional
Inspection Control” section on page 44-20, identify the map
name in this command.

skinny [map_name]

If you added a Skinny inspection policy map according to
“Configuring a Skinny (SCCP) Inspection Policy Map for
Additional Inspection Control” section on page 44-26,
identify the map name in this command.

snmp [map_name]

If you added an SNMP inspection policy map according to
“Configuring an SNMP Inspection Policy Map for
Additional Inspection Control” section on page 46-11,
identify the map name in this command.

Cisco ASA 5500 Series Configuration Guide using the CLI

42-10

Chapter 42

Getting Started with Application Layer Protocol Inspection
Configuring Application Layer Protocol Inspection

Table 42-2

Step 6

Protocol Keywords

Keywords

Notes

sqlnet

—

sunrpc

The default class map includes UDP port 111; if you want to
enable Sun RPC inspection for TCP port 111, you need to
create a new class map that matches TCP port 111, add the
class to the policy, and then apply the inspect sunrpc
command to that class.

tftp

—

waas

—

xdmcp

—

To activate the policy map on one or more interfaces, enter the following command:
hostname(config)# service-policy policymap_name {global | interface interface_name}

Where global applies the policy map to all interfaces, and interface applies the policy to one interface.
By default, the default policy map, “global_policy,” is applied globally. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

42-11

Chapter 42
Configuring Application Layer Protocol Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

42-12

Getting Started with Application Layer Protocol Inspection

CH A P T E R

43

Configuring Inspection of Basic Internet
Protocols
This chapter describes how to configure application layer protocol inspection. Inspection engines are
required for services that embed IP addressing information in the user data packet or that open secondary
channels on dynamically assigned ports. These protocols require the ASA to do a deep packet inspection
instead of passing the packet through the fast path. As a result, inspection engines can affect overall
throughput.
Several common inspection engines are enabled on the ASA by default, but you might need to enable
others depending on your network.
This chapter includes the following sections:
•

DNS Inspection, page 43-1

•

FTP Inspection, page 43-11

•

HTTP Inspection, page 43-16

•

ICMP Inspection, page 43-20

•

ICMP Error Inspection, page 43-21

•

Instant Messaging Inspection, page 43-21

•

IP Options Inspection, page 43-24

•

IPsec Pass Through Inspection, page 43-26

•

IPv6 Inspection, page 43-27

•

NetBIOS Inspection, page 43-28

•

PPTP Inspection, page 43-30

•

SMTP and Extended SMTP Inspection, page 43-31

•

TFTP Inspection, page 43-34

DNS Inspection
This section describes DNS application inspection. This section includes the following topics:
•

How DNS Application Inspection Works, page 43-2

•

How DNS Rewrite Works, page 43-2

•

Configuring DNS Rewrite, page 43-3

Cisco ASA 5500 Series Configuration Guide using the CLI

43-1

Chapter 43

Configuring Inspection of Basic Internet Protocols

DNS Inspection

•

Configuring a DNS Inspection Policy Map for Additional Inspection Control, page 43-7

•

Verifying and Monitoring DNS Inspection, page 43-10

How DNS Application Inspection Works
The ASA tears down the DNS session associated with a DNS query as soon as the DNS reply is
forwarded by the ASA. The ASA also monitors the message exchange to ensure that the ID of the DNS
reply matches the ID of the DNS query.
When DNS inspection is enabled, which is the default, the ASA performs the following additional tasks:
•

Translates the DNS record based on the configuration completed using the alias, static and nat
commands (DNS Rewrite). Translation only applies to the A-record in the DNS reply; therefore,
DNS Rewrite does not affect reverse lookups, which request the PTR record.

Note

DNS Rewrite is not applicable for PAT because multiple PAT rules are applicable for each
A-record and the PAT rule to use is ambiguous.

•

Enforces the maximum DNS message length (the default is 512 bytes and the maximum length is
65535 bytes). The ASA performs reassembly as needed to verify that the packet length is less than
the maximum length configured. The ASA drops the packet if it exceeds the maximum length.

Note

If you enter the inspect dns command without the maximum-length option, DNS packet size
is not checked

•

Enforces a domain-name length of 255 bytes and a label length of 63 bytes.

•

Verifies the integrity of the domain-name referred to by the pointer if compression pointers are
encountered in the DNS message.

•

Checks to see if a compression pointer loop exists.

A single connection is created for multiple DNS sessions, as long as they are between the same two
hosts, and the sessions have the same 5-tuple (source/destination IP address, source/destination port, and
protocol). DNS identification is tracked by app_id, and the idle timer for each app_id runs
independently.
Because the app_id expires independently, a legitimate DNS response can only pass through the ASA
within a limited period of time and there is no resource build-up. However, if you enter the show conn
command, you will see the idle timer of a DNS connection being reset by a new DNS session. This is
due to the nature of the shared DNS connection and is by design.

How DNS Rewrite Works
When DNS inspection is enabled, DNS rewrite provides full support for NAT of DNS messages
originating from any interface.
If a client on an inside network requests DNS resolution of an inside address from a DNS server on an
outside interface, the DNS A-record is translated correctly. If the DNS inspection engine is disabled, the
A-record is not translated.
As long as DNS inspection remains enabled, you can configure DNS rewrite using the alias, static, or
nat commands.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-2

Chapter 43

Configuring Inspection of Basic Internet Protocols
DNS Inspection

For details about the configuration required see the “Configuring DNS Rewrite” section on page 43-3.
DNS Rewrite performs two functions:
•

Translating a public address (the routable or “mapped” address) in a DNS reply to a private address
(the “real” address) when the DNS client is on a private interface.

•

Translating a private address to a public address when the DNS client is on the public interface.

In Figure 43-1, the DNS server resides on the external (ISP) network The real address of the server
(192.168.100.1) has been mapped using the static command to the ISP-assigned address
(209.165.200.5). When a web client on the inside interface attempts to access the web server with the
URL http://server.example.com, the host running the web client sends a DNS request to the DNS server
to resolve the IP address of the web server. The ASA translates the non-routable source address in the
IP header and forwards the request to the ISP network on its outside interface. When the DNS reply is
returned, the ASA applies address translation not only to the destination address, but also to the
embedded IP address of the web server, which is contained in the A-record in the DNS reply. As a result,
the web client on the inside network gets the correct address for connecting to the web server on the
inside network.
For configuration instructions for scenarios similar to this one, see the “Configuring DNS Rewrite with
Two NAT Zones” section on page 43-4.
Figure 43-1

Translating the Address in a DNS Reply (DNS Rewrite)

DNS server
server.example.com IN A 209.165.200.5
Web server
server.example.com
192.168.100.1

ISP Internet

132406

Security appliance
192.168.100.1IN A 209.165.200.5

Web client
http://server.example.com
192.168.100.2

DNS rewrite also works if the client making the DNS request is on a DMZ network and the DNS server
is on an inside interface. For an illustration and configuration instructions for this scenario, see the
“Overview of DNS Rewrite with Three NAT Zones” section on page 43-4.

Configuring DNS Rewrite
You configure DNS rewrite using the NAT configuration.
This section includes the following topics:
•

Configuring DNS Rewrite with Two NAT Zones, page 43-4

•

Overview of DNS Rewrite with Three NAT Zones, page 43-4

•

Configuring DNS Rewrite with Three NAT Zones, page 43-6

Cisco ASA 5500 Series Configuration Guide using the CLI

43-3

Chapter 43

Configuring Inspection of Basic Internet Protocols

DNS Inspection

Configuring DNS Rewrite with Two NAT Zones
To implement a DNS Rewrite scenario similar to the one shown in Figure 43-1, perform the following
steps:
Step 1

Create a static translation for the web server using the dns option. See Chapter 30, “Configuring
Network Object NAT.”

Step 2

Create an access list that permits traffic to the port that the web server listens to for HTTP requests.
hostname(config)# access-list acl-name extended permit tcp any host mapped-address eq port

where the arguments are as follows:
acl-name—The name you give the access list.
mapped-address—The translated IP address of the web server.
port—The TCP port that the web server listens to for HTTP requests.
Step 3

Apply the access list created in Step 2 to the mapped interface. To do so, use the access-group command,
as follows:
hostname(config)# access-group acl-name in interface mapped_ifc

Step 4

If DNS inspection is disabled or if you want to change the maximum DNS packet length, configure DNS
inspection. DNS application inspection is enabled by default with a maximum DNS packet length of 512
bytes. For configuration instructions, see the “Configuring a DNS Inspection Policy Map for Additional
Inspection Control” section on page 43-7.

Step 5

On the public DNS server, add an A-record for the web server, such as:
domain-qualified-hostname. IN A mapped-address

where domain-qualified-hostname is the hostname with a domain suffix, as in server.example.com. The
period after the hostname is important. mapped-address is the translated IP address of the web server.

The following example configures the ASA for the scenario shown in Figure 43-1. It assumes DNS
inspection is already enabled.
hostname(config)# object network obj-192.168.100.1-01
hostname(config-network-object)# host 192.168.100.1
hostname(config-network-object)# nat (inside,outside) static 209.165.200.225 dns
hostname(config)# access-list 101 permit tcp any host 209.165.200.225 eq www
hostname(config)# access-group 101 in interface outside

This configuration requires the following A-record on the DNS server:
server.example.com. IN A 209.165.200.225

Overview of DNS Rewrite with Three NAT Zones
Figure 43-2 provides a more complex scenario to illustrate how DNS inspection allows NAT to operate
transparently with a DNS server with minimal configuration. For configuration instructions for scenarios
like this one, see the “Configuring DNS Rewrite with Three NAT Zones” section on page 43-6.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-4

Configuring Inspection of Basic Internet Protocols
DNS Inspection

Figure 43-2

DNS Rewrite with Three NAT Zones

DNS server
erver.example.com IN A 209.165.200.5

Outside
Security
Web server
appliance
192.168.100.10
DMZ
192.168.100.1

99.99.99.2
Inside

10.10.10.1

132407

Chapter 43

Web client
10.10.10.25

In Figure 43-2, a web server, server.example.com, has the real address 192.168.100.10 on the DMZ
interface of the ASA. A web client with the IP address 10.10.10.25 is on the inside interface and a public
DNS server is on the outside interface. The site NAT policies are as follows:
•

The outside DNS server holds the authoritative address record for server.example.com.

•

Hosts on the outside network can contact the web server with the domain name server.example.com
through the outside DNS server or with the IP address 209.165.200.5.

•

Clients on the inside network can access the web server with the domain name server.example.com
through the outside DNS server or with the IP address 192.168.100.10.

When a host or client on any interface accesses the DMZ web server, it queries the public DNS server
for the A-record of server.example.com. The DNS server returns the A-record showing that
server.example.com binds to address 209.165.200.5.
When a web client on the outside network attempts to access http://server.example.com, the sequence of
events is as follows:
1.

The host running the web client sends the DNS server a request for the IP address of
server.example.com.

2.

The DNS server responds with the IP address 209.165.200.225 in the reply.

3.

The web client sends its HTTP request to 209.165.200.225.

4.

The packet from the outside host reaches the ASA at the outside interface.

5.

The static rule translates the address 209.165.200.225 to 192.168.100.10 and the ASA directs the
packet to the web server on the DMZ.

When a web client on the inside network attempts to access http://server.example.com, the sequence of
events is as follows:
1.

The host running the web client sends the DNS server a request for the IP address of
server.example.com.

2.

The DNS server responds with the IP address 209.165.200.225 in the reply.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-5

Chapter 43

Configuring Inspection of Basic Internet Protocols

DNS Inspection

3.

The ASA receives the DNS reply and submits it to the DNS application inspection engine.

4.

The DNS application inspection engine does the following:
a. Searches for any NAT rule to undo the translation of the embedded A-record address

“[outside]:209.165.200.5”. In this example, it finds the following static configuration:
object network obj-192.168.100.10-01
host 192.168.100.10
nat (dmz,outside) static 209.165.200.5 dns

b. Uses the static rule to rewrite the A-record as follows because the dns option is included:
[outside]:209.165.200.225 --> [dmz]:192.168.100.10

Note

If the dns option were not included with the nat command, DNS Rewrite would not be
performed and other processing for the packet continues.

c. Searches for any NAT to translate the web server address, [dmz]:192.168.100.10, when

communicating with the inside web client.
No NAT rule is applicable, so application inspection completes.
If a NAT rule (nat or static) were applicable, the dns option must also be specified. If the dns
option were not specified, the A-record rewrite in step b would be reverted and other processing
for the packet continues.
5.

The ASA sends the HTTP request to server.example.com on the DMZ interface.

Configuring DNS Rewrite with Three NAT Zones
To enable the NAT policies for the scenario in Figure 43-2, perform the following steps:
Step 1

Create a static translation for the web server on the DMZ network using the dns option. See Chapter 30,
“Configuring Network Object NAT.”

Step 2

Create an access list that permits traffic to the port that the web server listens to for HTTP requests.
hostname(config)# access-list acl-name extended permit tcp any host mapped-address eq port

where the arguments are as follows:
acl-name—The name you give the access list.
mapped-address—The translated IP address of the web server.
port—The TCP port that the web server listens to for HTTP requests.
Step 3

Apply the access list created in Step 2 to the outside interface. To do so, use the access-group command,
as follows:
hostname(config)# access-group acl-name in interface outside

Step 4

If DNS inspection is disabled or if you want to change the maximum DNS packet length, configure DNS
inspection. DNS application inspection is enabled by default with a maximum DNS packet length of 512
bytes. For configuration instructions, see the “Configuring a DNS Inspection Policy Map for Additional
Inspection Control” section on page 43-7.

Step 5

On the public DNS server, add an A-record for the web server, such as:
domain-qualified-hostname. IN A mapped-address

Cisco ASA 5500 Series Configuration Guide using the CLI

43-6

Chapter 43

Configuring Inspection of Basic Internet Protocols
DNS Inspection

where domain-qualified-hostname is the hostname with a domain suffix, as in server.example.com. The
period after the hostname is important. mapped-address is the translated IP address of the web server.

The following example configures the ASA for the scenario shown in Figure 43-2. It assumes DNS
inspection is already enabled.
hostname(config)# object network obj-192.168.100.10-01
hostname(config-network-object)# host 192.168.100.10
hostname(config-network-object)# nat (dmz,outside) static 209.165.200.225 dns
hostname(config)# access-list 101 permit tcp any host 209.165.200.225 eq www
hostname(config)# access-group 101 in interface outside

This configuration requires the following A-record on the DNS server:
server.example.com. IN A 209.165.200.225

Configuring a DNS Inspection Policy Map for Additional Inspection Control
DNS application inspection supports DNS message controls that provide protection against DNS
spoofing and cache poisoning. User configurable rules allow filtering based on DNS header, domain
name, resource record type and class. Zone transfer can be restricted between servers with this function,
for example.
The Recursion Desired and Recursion Available flags in the DNS header can be masked to protect a
public server from attack if that server only supports a particular internal zone. In addition, DNS
randomization can be enabled avoid spoofing and cache poisoning of servers that either do not support
randomization, or utilize a weak pseudo random number generator. Limiting the domain names that can
be queried also restricts the domain names which can be queried, which protects the public server
further.
A configurable DNS mismatch alert can be used as notification if an excessive number of mismatching
DNS responses are received, which could indicate a cache poisoning attack. In addition, a configurable
check to enforce a Transaction Signature be attached to all DNS messages is also supported.
To specify actions when a message violates a parameter, create a DNS inspection policy map. You can
then apply the inspection policy map when you enable DNS inspection.
To create a DNS inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Creating a Regular Expression” section on page 13-12. See the types of text you can match in the match
commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.

Step 3

(Optional) Create a DNS inspection class map by performing the following steps.
A class map groups multiple traffic matches. Traffic must match all of the match commands to match
the class map. You can alternatively identify match commands directly in the policy map. The difference
between creating a class map and defining the traffic match directly in the inspection policy map is that
the class map lets you create more complex match criteria, and you can reuse class maps.
To specify traffic that should not match the class map, use the match not command. For example, if the
match not command specifies the string “example.com,” then any traffic that includes “example.com”
does not match the class map.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-7

Chapter 43

Configuring Inspection of Basic Internet Protocols

DNS Inspection

For the traffic that you identify in this class map, you can specify actions such as drop, drop-connection,
reset, mask, set the rate limit, and/or log the connection in the inspection policy map.
If you want to perform different actions for each match command, you should identify the traffic directly
in the policy map.
a.

Create the class map by entering the following command:
hostname(config)# class-map type inspect dns [match-all | match-any] class_map_name
hostname(config-cmap)#

Where class_map_name is the name of the class map. The match-all keyword is the default, and
specifies that traffic must match all criteria to match the class map. The match-any keyword
specifies that the traffic matches the class map if it matches at least one of the criteria. The CLI
enters class-map configuration mode, where you can enter one or more match commands.
b.

(Optional) To add a description to the class map, enter the following command:
hostname(config-cmap)# description string

c.

(Optional) To match a specific flag that is set in the DNS header, enter the following command:
hostname(config-cmap)# match [not] header-flag [eq] {f_well_known | f_value}

Where the f_well_known argument is the DNS flag bit. The f_value argument is the 16-bit value in
hex. The eq keyword specifies an exact match.
d.

(Optional) To match a DNS type, including Query type and RR type, enter the following command:
hostname(config-cmap)# match [not] dns-type {eq t_well_known | t_val} {range t_val1
t_val2}

Where the t_well_known argument is the DNS flag bit. The t_val arguments are arbitrary values in
the DNS type field (0-65535). The range keyword specifies a range and the eq keyword specifies
an exact match.
e.

(Optional) To match a DNS class, enter the following command:
hostname(config-cmap)# match [not] dns-class {eq c_well_known | c_val} {range c_val1
c_val2}

Where the c_well_known argument is the DNS class. The c_val arguments are arbitrary values in
the DNS class field. The range keyword specifies a range and the eq keyword specifies an exact
match.
f.

(Optional) To match a DNS question or resource record, enter the following command:
hostname(config-cmap)# match {question | {resource-record answer | authority | any}}

Where the question keyword specifies the question portion of a DNS message. The
resource-record keyword specifies the resource record portion of a DNS message. The answer
keyword specifies the Answer RR section. The authority keyword specifies the Authority RR
section. The additional keyword specifies the Additional RR section.
g.

(Optional) To match a DNS message domain name list, enter the following command:
hostname(config-cmap)# match [not] domain-name {regex regex_id | regex class class_id]

The regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
Step 4

Create a DNS inspection policy map, enter the following command:
hostname(config)# policy-map type inspect dns policy_map_name
hostname(config-pmap)#

Cisco ASA 5500 Series Configuration Guide using the CLI

43-8

Chapter 43

Configuring Inspection of Basic Internet Protocols
DNS Inspection

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 5

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 6

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the DNS class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 7

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To randomize the DNS identifier for a DNS query, enter the following command:
hostname(config-pmap-p)# id-randomization

c.

To enable logging for excessive DNS ID mismatches, enter the following command:
hostname(config-pmap-p)# id-mismatch [count number duration seconds] action log

Where the count string argument specifies the maximum number of mismatch instances before a
system message log is sent. The duration seconds specifies the period, in seconds, to monitor.
d.

To require a TSIG resource record to be present, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

43-9

Chapter 43

Configuring Inspection of Basic Internet Protocols

DNS Inspection

hostname(config-pmap-p)# tsig enforced action {drop [log] | [log}

Where the count string argument specifies the maximum number of mismatch instances before a
system message log is sent. The duration seconds specifies the period, in seconds, to monitor.

The following example shows a how to define a DNS inspection policy map.
hostname(config)# regex domain_example “example\.com”
hostname(config)# regex domain_foo “foo\.com”
hostname(config)# ! define the domain names that the server serves
hostname(config)# class-map type inspect regex match-any my_domains
hostname(config-cmap)# match regex domain_example
hostname(config-cmap)# match regex domain_foo
hostname(config)# ! Define a DNS map for query only
hostname(config)# class-map type inspect dns match-all pub_server_map
hostname(config-cmap)# match not header-flag QR
hostname(config-cmap)# match question
hostname(config-cmap)# match not domain-name regex class my_domains
hostname(config)# policy-map type inspect dns serv_prot
hostname(config-pmap)# class pub_server_map
hostname(config-pmap-c)# drop log
hostname(config-pmap-c)# match header-flag RD
hostname(config-pmap-c)# mask log
hostname(config)# class-map dns_serv_map
hostname(config-cmap)# match default-inspection-traffic
hostname(config)# policy-map pub_policy
hostname(config-pmap)# class dns_serv_map
hostname(config-pmap-c)# inspect dns serv_prot
hostname(config)# service-policy pub_policy interface dmz

Verifying and Monitoring DNS Inspection
To view information about the current DNS connections, enter the following command:
hostname# show conn

For connections using a DNS server, the source port of the connection may be replaced by the IP address
of DNS server in the show conn command output.
A single connection is created for multiple DNS sessions, as long as they are between the same two
hosts, and the sessions have the same 5-tuple (source/destination IP address, source/destination port, and
protocol). DNS identification is tracked by app_id, and the idle timer for each app_id runs independently.
Because the app_id expires independently, a legitimate DNS response can only pass through the security
appliance within a limited period of time and there is no resource build-up. However, when you enter the
show conn command, you see the idle timer of a DNS connection being reset by a new DNS session.
This is due to the nature of the shared DNS connection and is by design.
To display the statistics for DNS application inspection, enter the show service-policy command. The
following is sample output from the show service-policy command:
hostname# show service-policy
Interface outside:

Cisco ASA 5500 Series Configuration Guide using the CLI

43-10

Chapter 43

Configuring Inspection of Basic Internet Protocols
FTP Inspection

Service-policy: sample_policy
Class-map: dns_port
Inspect: dns maximum-length 1500, packet 0, drop 0, reset-drop 0

FTP Inspection
This section describes the FTP inspection engine. This section includes the following topics:
•

FTP Inspection Overview, page 43-11

•

Using the strict Option, page 43-11

•

Configuring an FTP Inspection Policy Map for Additional Inspection Control, page 43-12

•

Verifying and Monitoring FTP Inspection, page 43-16

FTP Inspection Overview
The FTP application inspection inspects the FTP sessions and performs four tasks:
•

Prepares dynamic secondary data connection

•

Tracks the FTP command-response sequence

•

Generates an audit trail

•

Translates the embedded IP address

FTP application inspection prepares secondary channels for FTP data transfer. Ports for these channels
are negotiated through PORT or PASV commands. The channels are allocated in response to a file
upload, a file download, or a directory listing event.

Note

If you disable FTP inspection engines with the no inspect ftp command, outbound users can start
connections only in passive mode, and all inbound FTP is disabled.

Using the strict Option
Using the strict option with the inspect ftp command increases the security of protected networks by
preventing web browsers from sending embedded commands in FTP requests.

Note

To specify FTP commands that are not permitted to pass through the ASA, create an FTP map according
to the “Configuring an FTP Inspection Policy Map for Additional Inspection Control” section on
page 43-12.
After you enable the strict option on an interface, FTP inspection enforces the following behavior:
•

An FTP command must be acknowledged before the ASA allows a new command.

•

The ASA drops connections that send embedded commands.

•

The 227 and PORT commands are checked to ensure they do not appear in an error string.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-11

Chapter 43

Configuring Inspection of Basic Internet Protocols

FTP Inspection

Caution

Using the strict option may cause the failure of FTP clients that are not strictly compliant with FTP
RFCs.
If the strict option is enabled, each FTP command and response sequence is tracked for the following
anomalous activity:
•

Truncated command—Number of commas in the PORT and PASV reply command is checked to see
if it is five. If it is not five, then the PORT command is assumed to be truncated and the TCP
connection is closed.

•

Incorrect command—Checks the FTP command to see if it ends with  characters, as
required by the RFC. If it does not, the connection is closed.

•

Size of RETR and STOR commands—These are checked against a fixed constant. If the size is
greater, then an error message is logged and the connection is closed.

•

Command spoofing—The PORT command should always be sent from the client. The TCP
connection is denied if a PORT command is sent from the server.

•

Reply spoofing—PASV reply command (227) should always be sent from the server. The TCP
connection is denied if a PASV reply command is sent from the client. This prevents the security
hole when the user executes “227 xxxxx a1, a2, a3, a4, p1, p2.”

•

TCP stream editing—The ASA closes the connection if it detects TCP stream editing.

•

Invalid port negotiation—The negotiated dynamic port value is checked to see if it is less than 1024.
As port numbers in the range from 1 to 1024 are reserved for well-known connections, if the
negotiated port falls in this range, then the TCP connection is freed.

•

Command pipelining—The number of characters present after the port numbers in the PORT and
PASV reply command is cross checked with a constant value of 8. If it is more than 8, then the TCP
connection is closed.

•

The ASA replaces the FTP server response to the SYST command with a series of Xs. to prevent the
server from revealing its system type to FTP clients. To override this default behavior, use the no
mask-syst-reply command in the FTP map.

Configuring an FTP Inspection Policy Map for Additional Inspection Control
FTP command filtering and security checks are provided using strict FTP inspection for improved
security and control. Protocol conformance includes packet length checks, delimiters and packet format
checks, command terminator checks, and command validation.
Blocking FTP based on user values is also supported so that it is possible for FTP sites to post files for
download, but restrict access to certain users. You can block FTP connections based on file type, server
name, and other attributes. System message logs are generated if an FTP connection is denied after
inspection.
If you want FTP inspection to allow FTP servers to reveal their system type to FTP clients, and limit the
allowed FTP commands, then create and configure an FTP map. You can then apply the FTP map when
you enable FTP inspection.
To create an FTP map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Creating a Regular Expression” section on page 13-12. See the types of text you can match in the match
commands described in Step 3.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-12

Chapter 43

Configuring Inspection of Basic Internet Protocols
FTP Inspection

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.

Step 3

(Optional) Create an FTP inspection class map by performing the following steps.
A class map groups multiple traffic matches. Traffic must match all of the match commands to match
the class map. You can alternatively identify match commands directly in the policy map. The difference
between creating a class map and defining the traffic match directly in the inspection policy map is that
the class map lets you create more complex match criteria, and you can reuse class maps.
To specify traffic that should not match the class map, use the match not command. For example, if the
match not command specifies the string “example.com,” then any traffic that includes “example.com”
does not match the class map.
For the traffic that you identify in this class map, you can specify actions such as drop, drop-connection,
reset, mask, set the rate limit, and/or log the connection in the inspection policy map.
If you want to perform different actions for each match command, you should identify the traffic directly
in the policy map.
a.

Create the class map by entering the following command:
hostname(config)# class-map type inspect ftp [match-all | match-any] class_map_name
hostname(config-cmap)#

Where class_map_name is the name of the class map. The match-all keyword is the default, and
specifies that traffic must match all criteria to match the class map. The match-any keyword
specifies that the traffic matches the class map if it matches at least one of the criteria. The CLI
enters class-map configuration mode, where you can enter one or more match commands.
b.

(Optional) To add a description to the class map, enter the following command:
hostname(config-cmap)# description string

c.

(Optional) To match a filename for FTP transfer, enter the following command:
hostname(config-cmap)# match [not] filename regex [regex_name |
class regex_class_name]

Where the regex_name is the regular expression you created in Step 1. The class regex_class_name
is the regular expression class map you created in Step 2.
d.

(Optional) To match a file type for FTP transfer, enter the following command:
hostname(config-cmap)# match [not] filetype regex [regex_name |
class regex_class_name]

Where the regex_name is the regular expression you created in Step 1. The class regex_class_name
is the regular expression class map you created in Step 2.
e.

(Optional) To disallow specific FTP commands, use the following command:
hostname(config-cmap)# match [not] request-command ftp_command [ftp_command...]

Where ftp_command with one or more FTP commands that you want to restrict. See Table 43-1 for
a list of the FTP commands that you can restrict.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-13

Chapter 43

Configuring Inspection of Basic Internet Protocols

FTP Inspection

.

Table 43-1

FTP Map request-command deny Options

request-command deny Option

Purpose

appe

Disallows the command that appends to a file.

cdup

Disallows the command that changes to the parent directory of the
current working directory.

dele

Disallows the command that deletes a file on the server.

get

Disallows the client command for retrieving a file from the server.

help

Disallows the command that provides help information.

mkd

Disallows the command that makes a directory on the server.

put

Disallows the client command for sending a file to the server.

rmd

Disallows the command that deletes a directory on the server.

rnfr

Disallows the command that specifies rename-from filename.

rnto

Disallows the command that specifies rename-to filename.

site

Disallows the command that are specific to the server system.
Usually used for remote administration.

stou

Disallows the command that stores a file using a unique file name.

f.

(Optional) To match an FTP server, enter the following command:
hostname(config-cmap)# match [not] server regex [regex_name | class regex_class_name]

Where the regex_name is the regular expression you created in Step 1. The class regex_class_name
is the regular expression class map you created in Step 2.
g.

(Optional) To match an FTP username, enter the following command:
hostname(config-cmap)# match [not] username regex [regex_name |
class regex_class_name]

Where the regex_name is the regular expression you created in Step 1. The class regex_class_name
is the regular expression class map you created in Step 2.
h.

(Optional) To match active FTP traffic commands PORT and EPRT, enter the following command:
hostname(config-cmap)# match [not] active-ftp

i.

(Optional) To match passive FTP traffic commands PASV and EPSV, enter the following command:
hostname(config-cmap)# match [not] passive-ftp

Step 4

Create an FTP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect ftp policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 5

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 6

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:

Cisco ASA 5500 Series Configuration Guide using the CLI

43-14

Chapter 43

Configuring Inspection of Basic Internet Protocols
FTP Inspection

•

Specify the FTP class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 7

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To mask the greeting banner from the FTP server, enter the following command:
hostname(config-pmap-p)# mask-banner

c.

To mask the reply to syst command, enter the following command:
hostname(config-pmap-p)# mask-syst-reply

Before submitting a username and password, all FTP users are presented with a greeting banner. By
default, this banner includes version information useful to hackers trying to identify weaknesses in a
system. The following example shows how to mask this banner:
hostname(config)# policy-map type inspect ftp mymap
hostname(config-pmap)# parameters
hostname(config-pmap-p)# mask-banner
hostname(config)# class-map match-all ftp-traffic
hostname(config-cmap)# match port tcp eq ftp
hostname(config)# policy-map ftp-policy

Cisco ASA 5500 Series Configuration Guide using the CLI

43-15

Chapter 43

Configuring Inspection of Basic Internet Protocols

HTTP Inspection

hostname(config-pmap)# class ftp-traffic
hostname(config-pmap-c)# inspect ftp strict mymap
hostname(config)# service-policy ftp-policy interface inside

Verifying and Monitoring FTP Inspection
FTP application inspection generates the following log messages:
•

An Audit record 303002 is generated for each file that is retrieved or uploaded.

•

The FTP command is checked to see if it is RETR or STOR and the retrieve and store commands
are logged.

•

The username is obtained by looking up a table providing the IP address.

•

The username, source IP address, destination IP address, NAT address, and the file operation are
logged.

•

Audit record 201005 is generated if the secondary dynamic channel preparation failed due to
memory shortage.

In conjunction with NAT, the FTP application inspection translates the IP address within the application
payload. This is described in detail in RFC 959.

HTTP Inspection
This section describes the HTTP inspection engine. This section includes the following topics:
•

HTTP Inspection Overview, page 43-16

•

Configuring an HTTP Inspection Policy Map for Additional Inspection Control, page 43-17

HTTP Inspection Overview
Use the HTTP inspection engine to protect against specific attacks and other threats that are associated
with HTTP traffic. HTTP inspection performs several functions:
•

Enhanced HTTP inspection

•

URL screening through N2H2 or Websense
See Information About URL Filtering, page 39-6 for information.

•

Java and ActiveX filtering

The latter two features are configured in conjunction with the filter command. For more information
about filtering, see Chapter 39, “Configuring Filtering Services.”
The enhanced HTTP inspection feature, which is also known as an application firewall and is available
when you configure an HTTP map (see “Configuring an HTTP Inspection Policy Map for Additional
Inspection Control”), can help prevent attackers from using HTTP messages for circumventing network
security policy. It verifies the following for all HTTP messages:
•

Conformance to RFC 2616

•

Use of RFC-defined methods only.

•

Compliance with the additional criteria.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-16

Chapter 43

Configuring Inspection of Basic Internet Protocols
HTTP Inspection

Configuring an HTTP Inspection Policy Map for Additional Inspection Control
To specify actions when a message violates a parameter, create an HTTP inspection policy map. You can
then apply the inspection policy map when you enable HTTP inspection.

Note

When you enable HTTP inspection with an inspection policy map, strict HTTP inspection with the action
reset and log is enabled by default. You can change the actions performed in response to inspection
failure, but you cannot disable strict inspection as long as the inspection policy map remains enabled.
To create an HTTP inspection policy map, perform the following steps:

Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Creating a Regular Expression” section on page 13-12. See the types of text you can match in the match
commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.

Step 3

(Optional) Create an HTTP inspection class map by performing the following steps.
A class map groups multiple traffic matches. Traffic must match all of the match commands to match
the class map. You can alternatively identify match commands directly in the policy map. The difference
between creating a class map and defining the traffic match directly in the inspection policy map is that
the class map lets you create more complex match criteria, and you can reuse class maps.
To specify traffic that should not match the class map, use the match not command. For example, if the
match not command specifies the string “example.com,” then any traffic that includes “example.com”
does not match the class map.
For the traffic that you identify in this class map, you can specify actions such as drop, drop-connection,
reset, mask, set the rate limit, and/or log the connection in the inspection policy map.
If you want to perform different actions for each match command, you should identify the traffic directly
in the policy map.
a.

Create the class map by entering the following command:
hostname(config)# class-map type inspect http [match-all | match-any] class_map_name
hostname(config-cmap)#

Where class_map_name is the name of the class map. The match-all keyword is the default, and
specifies that traffic must match all criteria to match the class map. The match-any keyword
specifies that the traffic matches the class map if it matches at least one of the criteria. The CLI
enters class-map configuration mode, where you can enter one or more match commands.
b.

(Optional) To add a description to the class map, enter the following command:
hostname(config-cmap)# description string

c.

(Optional) To match traffic with a content-type field in the HTTP response that does not match the
accept field in the corresponding HTTP request message, enter the following command:
hostname(config-cmap)# match [not] req-resp content-type mismatch

d.

(Optional) To match text found in the HTTP request message arguments, enter the following
command:
hostname(config-cmap)# match [not] request args regex [regex_name | class
regex_class_name]

Cisco ASA 5500 Series Configuration Guide using the CLI

43-17

Chapter 43

Configuring Inspection of Basic Internet Protocols

HTTP Inspection

Where the regex_name is the regular expression you created in Step 1. The class regex_class_name
is the regular expression class map you created in Step 2.
e.

(Optional) To match text found in the HTTP request message body or to match traffic that exceeds
the maximum HTTP request message body length, enter the following command:
hostname(config-cmap)# match [not] request body {regex [regex_name | class
regex_class_name] | length gt max_bytes}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2. The length gt
max_bytes is the maximum message body length in bytes.
f.

(Optional) To match text found in the HTTP request message header, or to restrict the count or length
of the header, enter the following command:
hostname(config-cmap)# match [not] request header {[field]
[regex [regex_name | class regex_class_name]] |
[length gt max_length_bytes | count gt max_count_bytes]}

Where the field is the predefined message header keyword. The regex regex_name argument is the
regular expression you created in Step 1. The class regex_class_name is the regular expression class
map you created in Step 2. The length gt max_bytes is the maximum message body length in bytes.
The count gt max_count is the maximum number of header fields.
g.

(Optional) To match text found in the HTTP request message method, enter the following command:
hostname(config-cmap)# match [not] request method {[method] |
[regex [regex_name | class regex_class_name]]

Where the method is the predefined message method keyword. The regex regex_name argument is
the regular expression you created in Step 1. The class regex_class_name is the regular expression
class map you created in Step 2.
h.

(Optional) To match text found in the HTTP request message URI, enter the following command:
hostname(config-cmap)# match [not] request uri {regex [regex_name | class
regex_class_name] | length gt max_bytes}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2. The length gt
max_bytes is the maximum message body length in bytes.
i.

Optional) To match text found in the HTTP response message body, or to comment out Java applet
and Active X object tags in order to filter them, enter the following command:
hostname(config-cmap)# match [not] response body {[active-x] | [java-applet] |
[regex [regex_name | class regex_class_name]] | length gt max_bytes}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2. The length gt
max_bytes is the maximum message body length in bytes.
j.

(Optional) To match text found in the HTTP response message header, or to restrict the count or
length of the header, enter the following command:
hostname(config-cmap)# match [not] response header {[field]
[regex [regex_name | class regex_class_name]] |
[length gt max_length_bytes | count gt max_count]}

Cisco ASA 5500 Series Configuration Guide using the CLI

43-18

Chapter 43

Configuring Inspection of Basic Internet Protocols
HTTP Inspection

Where the field is the predefined message header keyword. The regex regex_name argument is the
regular expression you created in Step 1. The class regex_class_name is the regular expression class
map you created in Step 2. The length gt max_bytes is the maximum message body length in bytes.
The count gt max_count is the maximum number of header fields.
k.

(Optional) To match text found in the HTTP response message status line, enter the following
command:
hostname(config-cmap)# match [not] response status-line {regex [regex_name | class
regex_class_name]}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
Step 4

Create an HTTP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect http policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 5

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 6

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the HTTP class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-19

Chapter 43

Configuring Inspection of Basic Internet Protocols

ICMP Inspection

Step 7

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To check for HTTP protocol violations, enter the following command:
hostname(config-pmap-p)# protocol-violation [action [drop-connection | reset | log]]

Where the drop-connection action closes the connection. The reset action closes the connection
and sends a TCP reset to the client. The log action sends a system log message when this policy map
matches traffic.
c.

To substitute a string for the server header field, enter the following command:
hostname(config-pmap-p)# spoof-server string

Where the string argument is the string to substitute for the server header field. Note: WebVPN
streams are not subject to the spoof-server comand.

The following example shows how to define an HTTP inspection policy map that will allow and log any
HTTP connection that attempts to access “www\.xyz.com/.*\.asp" or "www\.xyz[0-9][0-9]\.com" with
methods "GET" or "PUT." All other URL/Method combinations will be silently allowed.
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

regex
regex
regex
regex

url1 “www\.xyz.com/.*\.asp”
url2 “www\.xyz[0-9][0-9]\.com”
get “GET”
put “PUT”

hostname(config)# class-map type regex match-any url_to_log
hostname(config-cmap)# match regex url1
hostname(config-cmap)# match regex url2
hostname(config-cmap)# exit
hostname(config)# class-map type regex match-any methods_to_log
hostname(config-cmap)# match regex get
hostname(config-cmap)# match regex put
hostname(config-cmap)# exit
hostname(config)# class-map type inspect http http_url_policy
hostname(config-cmap)# match request uri regex class url_to_log
hostname(config-cmap)# match request method regex class methods_to_log
hostname(config-cmap)# exit
hostname(config)# policy-map type inspect http http_policy
hostname(config-pmap)# class http_url_policy
hostname(config-pmap-c)# log

ICMP Inspection
The ICMP inspection engine allows ICMP traffic to have a “session” so it can be inspected like TCP and
UDP traffic. Without the ICMP inspection engine, we recommend that you do not allow ICMP through
the ASA in an access list. Without stateful inspection, ICMP can be used to attack your network. The
ICMP inspection engine ensures that there is only one response for each request, and that the sequence
number is correct.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-20

Chapter 43

Configuring Inspection of Basic Internet Protocols
ICMP Error Inspection

ICMP Error Inspection
When this feature is enabled, the ASA creates translation sessions for intermediate hops that send ICMP
error messages, based on the NAT configuration. The ASA overwrites the packet with the translated IP
addresses.
When disabled, the ASA does not create translation sessions for intermediate nodes that generate ICMP
error messages. ICMP error messages generated by the intermediate nodes between the inside host and
the ASA reach the outside host without consuming any additional NAT resource. This is undesirable
when an outside host uses the traceroute command to trace the hops to the destination on the inside of
the ASA. When the ASA does not translate the intermediate hops, all the intermediate hops appear with
the mapped destination IP address.
The ICMP payload is scanned to retrieve the five-tuple from the original packet. Using the retrieved
five-tuple, a lookup is performed to determine the original address of the client. The ICMP error
inspection engine makes the following changes to the ICMP packet:
•

In the IP Header, the mapped IP is changed to the real IP (Destination Address) and the IP checksum
is modified.

•

In the ICMP Header, the ICMP checksum is modified due to the changes in the ICMP packet.

•

In the Payload, the following changes are made:
– Original packet mapped IP is changed to the real IP
– Original packet mapped port is changed to the real Port
– Original packet IP checksum is recalculated

Instant Messaging Inspection
This section describes the IM inspection engine. This section includes the following topics:
•

IM Inspection Overview, page 43-21

•

Configuring an Instant Messaging Inspection Policy Map for Additional Inspection Control,
page 43-21

IM Inspection Overview
The IM inspect engine lets you apply fine grained controls on the IM application to control the network
usage and stop leakage of confidential data, propagation of worms, and other threats to the corporate
network.

Configuring an Instant Messaging Inspection Policy Map for Additional
Inspection Control
To specify actions when a message violates a parameter, create an IM inspection policy map. You can
then apply the inspection policy map when you enable IM inspection.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-21

Chapter 43

Configuring Inspection of Basic Internet Protocols

Instant Messaging Inspection

To create an IM inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Creating a Regular Expression” section on page 13-12. See the types of text you can match in the match
commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.s

Step 3

(Optional) Create an IM inspection class map by performing the following steps.
A class map groups multiple traffic matches. Traffic must match all of the match commands to match
the class map. You can alternatively identify match commands directly in the policy map. The difference
between creating a class map and defining the traffic match directly in the inspection policy map is that
the class map lets you create more complex match criteria, and you can reuse class maps.
To specify traffic that should not match the class map, use the match not command. For example, if the
match not command specifies the string “example.com,” then any traffic that includes “example.com”
does not match the class map.
For the traffic that you identify in this class map, you can specify actions such as drop-connection, reset,
and/or log the connection in the inspection policy map.
If you want to perform different actions for each match command, you should identify the traffic directly
in the policy map.
a.

Create the class map by entering the following command:
hostname(config)# class-map type inspect im [match-all | match-any] class_map_name
hostname(config-cmap)#

Where the class_map_name is the name of the class map. The match-all keyword is the default, and
specifies that traffic must match all criteria to match the class map. The match-any keyword
specifies that the traffic matches the class map if it matches at least one of the criteria. The CLI
enters class-map configuration mode, where you can enter one or more match commands.
b.

(Optional) To add a description to the class map, enter the following command:
hostname(config-cmap)# description string

Where the string is the description of the class map (up to 200 characters).
c.

(Optional) To match traffic of a specific IM protocol, such as Yahoo or MSN, enter the following
command:
hostname(config-cmap)# match [not] protocol {im-yahoo | im-msn}

d.

(Optional) To match a specific IM service, such as chat, file-transfer, webcam, voice-chat,
conference, or games, enter the following command:
hostname(config-cmap)# match [not] service {chat | file-transfer | webcam | voice-chat
| conference | games}

e.

(Optional) To match the source login name of the IM message, enter the following command:
hostname(config-cmap)# match [not] login-name regex {class class_name | regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
f.

(Optional) To match the destination login name of the IM message, enter the following command:
hostname(config-cmap)# match [not] peer-login-name regex {class class_name |
regex_name}

Cisco ASA 5500 Series Configuration Guide using the CLI

43-22

Chapter 43

Configuring Inspection of Basic Internet Protocols
Instant Messaging Inspection

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
g.

(Optional) To match the source IP address of the IM message, enter the following command:
hostname(config-cmap)# match [not] ip-address ip_address ip_address_mask

Where the ip_address and the ip_address_mask is the IP address and netmask of the message source.
h.

(Optional) To match the destination IP address of the IM message, enter the following command:
hostname(config-cmap)# match [not] peer-ip-address ip_address ip_address_mask

Where the ip_address and the ip_address_mask is the IP address and netmask of the message
destination.
i.

(Optional) To match the version of the IM message, enter the following command:
hostname(config-cmap)# match [not] version regex {class class_name | regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
j.

(Optional) To match the filename of the IM message, enter the following command:
hostname(config-cmap)# match [not] filename regex {class class_name | regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.

Note
Step 4

Not supported using MSN IM protocol.

Create an IM inspection policy map, enter the following command:
hostname(config)# policy-map type inspect im policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 5

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 6

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the IM class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

Specify traffic directly in the policy map using one of the match commands described in Step 3. If
you use a match not command, then any traffic that does not match the criterion in the match not
command has the action applied.

You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 7

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {drop-connection | reset | log}

Cisco ASA 5500 Series Configuration Guide using the CLI

43-23

Chapter 43

Configuring Inspection of Basic Internet Protocols

IP Options Inspection

Where the drop-connection action closes the connection. The reset action closes the connection and
sends a TCP reset to the client. The log action sends a system log message when this policy map matches
traffic.

The following example shows how to define an IM inspection policy map.
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

regex
regex
regex
regex
regex
regex
regex

loginname1 “ying\@yahoo.com”
loginname2 “Kevin\@yahoo.com”
loginname3 “rahul\@yahoo.com”
loginname4 “darshant\@yahoo.com”
yahoo_version_regex “1\.0”
gif_files “.*\.gif”
exe_files “.*\.exe”

hostname(config)# class-map type regex match-any yahoo_src_login_name_regex
hostname(config-cmap)# match regex loginname1
hostname(config-cmap)# match regex loginname2
hostname(config)# class-map type regex match-any yahoo_dst_login_name_regex
hostname(config-cmap)# match regex loginname3
hostname(config-cmap)# match regex loginname4
hostname(config)# class-map type inspect im match-any yahoo_file_block_list
hostname(config-cmap)# match filename regex gif_files
hostname(config-cmap)# match filename regex exe_files
hostname(config)# class-map type inspect im match-all yahoo_im_policy
hostname(config-cmap)# match login-name regex class yahoo_src_login_name_regex
hostname(config-cmap)# match peer-login-name regex class yahoo_dst_login_name_regex
hostname(config)# class-map type inspect im match-all yahoo_im_policy2
hostname(config-cmap)# match version regex yahoo_version_regex
hostname(config)# class-map im_inspect_class_map
hostname(config-cmap)# match default-inspection-traffic
hostname(config)# policy-map type inspect im im_policy_all
hostname(config-pmap)# class yahoo_file_block_list
hostname(config-pmap-c)# match service file-transfer
hostname(config-pmap)# class yahoo_im_policy
hostname(config-pmap-c)# drop-connection
hostname(config-pmap)# class yahoo_im_policy2
hostname(config-pmap-c)# reset
hostname(config)# policy-map global_policy_name
hostname(config-pmap)# class im_inspect_class_map
hostname(config-pmap-c)# inspect im im_policy_all

IP Options Inspection
This section describes the IP Options inspection engine. This section includes the following topics:
•

IP Options Inspection Overview, page 43-25

•

Configuring an IP Options Inspection Policy Map for Additional Inspection Control, page 43-25

Cisco ASA 5500 Series Configuration Guide using the CLI

43-24

Chapter 43

Configuring Inspection of Basic Internet Protocols
IP Options Inspection

IP Options Inspection Overview
Each IP packet contains an IP header with the Options field. The Options field, commonly referred to as
IP Options, provide for control functions that are required in some situations but unnecessary for most
common communications. In particular, IP Options include provisions for time stamps, security, and
special routing. Use of IP Options is optional, and the field can contain zero, one, or more options.
You can configure IP Options inspection to control which IP packets with specific IP options are allowed
through the ASA. Configuring this inspection instructs the ASA to allow a packet to pass or to clear the
specified IP options and then allow the packet to pass.
IP Options inspection can check for the following three IP options in a packet:

Note

•

End of Options List (EOOL) or IP Option 0—This option, which contains just a single zero byte,
appears at the end of all options to mark the end of a list of options. This might not coincide with
the end of the header according to the header length.

•

No Operation (NOP) or IP Option 1—The Options field in the IP header can contain zero, one, or
more options, which makes the total length of the field variable. However, the IP header must be a
multiple of 32 bits. If the number of bits of all options is not a multiple of 32 bits, the NOP option
is used as “internal padding” to align the options on a 32-bit boundary.

•

Router Alert (RTRALT) or IP Option 20—This option notifies transit routers to inspect the contents
of the packet even when the packet is not destined for that router. This inspection is valuable when
implementing RSVP and similar protocols require relatively complex processing from the routers
along the packets delivery path.

IP Options inspection is included by default in the global inspection policy. Therefore, the ASA allows
RSVP traffic that contains packets with the Router Alert option (option 20) when the ASA is in routed
mode.
Dropping RSVP packets containing the Router Alert option can cause problems in VoIP
implementations.
When you configure the ASA to clear the Router Alert option from IP headers, the IP header changes in
the following ways:
•

The Options field is padded so that the field ends on a 32 bit boundary.

•

Internet header length (IHL) changes.

•

The total length of the packet changes.

•

The checksum is recomputed.

If an IP header contains additional options other than EOOL, NOP, or RTRALT, regardless of whether
the ASA is configured to allow these options, the ASA will drop the packet.

Configuring an IP Options Inspection Policy Map for Additional Inspection
Control
Step 1

To create an IP Options inspection policy map, enter the following command:
hostname(config)# policy-map type inspect ip-options policy_map_name
hostname(config-pmap)#

Cisco ASA 5500 Series Configuration Guide using the CLI

43-25

Chapter 43

Configuring Inspection of Basic Internet Protocols

IPsec Pass Through Inspection

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 2

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 3

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To allow or clear packets with the End of Options List (EOOL) option, enter the following
command:
hostname(config-pmap-p)# eool action {allow | clear}

This option, which contains just a single zero byte, appears at the end of all options to mark the end
of a list of options. This might not coincide with the end of the header according to the header length.
c.

To allow or clear packets with the No Operation (NOP) option, enter the following command:
hostname(config-pmap-p)# nop action {allow | clear}

The Options field in the IP header can contain zero, one, or more options, which makes the total
length of the field variable. However, the IP header must be a multiple of 32 bits. If the number of
bits of all options is not a multiple of 32 bits, the NOP option is used as “internal padding” to align
the options on a 32-bit boundary.
d.

To allowor clear packets with the Router Alert (RTRALT) option, enter the following command:
hostname(config-pmap-p)# router-alert action {allow | clear}

This option notifies transit routers to inspect the contents of the packet even when the packet is not
destined for that router. This inspection is valuable when implementing RSVP and similar protocols
require relatively complex processing from the routers along the packets delivery path.

Note

Enter the clear command to clear the IP option from the packet before allowing the packet
through the ASA.

IPsec Pass Through Inspection
This section describes the IPsec Pass Through inspection engine. This section includes the following
topics:
•

IPsec Pass Through Inspection Overview, page 43-27

•

“Example for Defining an IPsec Pass Through Parameter Map” section on page 43-27

Cisco ASA 5500 Series Configuration Guide using the CLI

43-26

Chapter 43

Configuring Inspection of Basic Internet Protocols
IPv6 Inspection

IPsec Pass Through Inspection Overview
Internet Protocol Security (IPsec) is a protocol suite for securing IP communications by authenticating
and encrypting each IP packet of a data stream. IPsec also includes protocols for establishing mutual
authentication between agents at the beginning of the session and negotiation of cryptographic keys to
be used during the session. IPsec can be used to protect data flows between a pair of hosts (for example,
computer users or servers), between a pair of security gateways (such as routers or firewalls), or between
a security gateway and a host.
IPsec Pass Through application inspection provides convenient traversal of ESP (IP protocol 50) and AH
(IP protocol 51) traffic associated with an IKE UDP port 500 connection. It avoids lengthy access list
configuration to permit ESP and AH traffic and also provides security using timeout and max
connections.
Specify IPsec Pass Through inspection parameters to identify a specific map to use for defining the
parameters for the inspection. Configure a policy map for Specify IPsec Pass Through inspection to
access the parameters configuration, which lets you specify the restrictions for ESP or AH traffic. You
can set the per client max connections and the idle timeout in parameters configuration.
NAT and non-NAT traffic is permitted. However, PAT is not supported.

Example for Defining an IPsec Pass Through Parameter Map
The following example shows how to use access lists to identify IKE traffic, define an IPsec Pass Thru
parameter map, define a policy, and apply the policy to the outside interface:
hostname(config)# access-list ipsecpassthruacl permit udp any any eq 500
hostname(config)# class-map ipsecpassthru-traffic
hostname(config-cmap)# match access-list ipsecpassthruacl
hostname(config)# policy-map type inspect ipsec-pass-thru iptmap
hostname(config-pmap)# parameters
hostname(config-pmap-p)# esp per-client-max 10 timeout 0:11:00
hostname(config-pmap-p)# ah per-client-max 5 timeout 0:06:00
hostname(config)# policy-map inspection_policy
hostname(config-pmap)# class ipsecpassthru-traffic
hostname(config-pmap-c)# inspect ipsec-pass-thru iptmap
hostname(config)# service-policy inspection_policy interface outside

IPv6 Inspection
You can configure IPv6 Inspection by using MPF rules to selectively block IPv6 traffic based on the
extension header. IPv6 packets are subjected to an early security check. The ASA always passes
hop-by-hop and destination option types of extension headers while blocking router header and no next
header.
You can enable default IPv6 inspection or define IPv6 inspection. By defining an MPF policy map for
IPv6 inspection you can configure the ASA to selectively drop IPv6 packets based on following types of
extension headers found anywhere in the IPv6 packet:
•

Hop-by-Hop Options

•

Routing (Type 0)

•

Fragment

•

Destination Options

Cisco ASA 5500 Series Configuration Guide using the CLI

43-27

Chapter 43

Configuring Inspection of Basic Internet Protocols

NetBIOS Inspection

•

Authentication

•

Encapsulating Security Payload

In addition, default IPv6 inspection checks conformance to RFC 2460 for type and order of extension
headers in IPv6 packets:
•

IPv6 header

•

Hop-by-Hop Options header (0)

•

Destination Options header (60)

•

Routing header (43)

•

Fragment header (44)

•

Authentication (51)

•

Encapsulating Security Payload header(50)

•

Destination Options header (60)

•

No Next Header (59)

When a policy map is not configured for IPv6inspection or a configured policy map is not associated
with an interface, the ASA drops packets with any mobility type and a routing-type IPv6 extension
header that arrive at the interface.
When an IPv6 inspection policy map is created, the ASA automatically generates a configuration to drop
packets that match header routing-type in the range 0-255.

Configuring an IPv6 Inspection Policy Map
You can configure a policy map for IPv6 inspection to handle IPv6 extension headers. The IPv6 policy
map is applied to each classified IPv6 packet on the specified direction. Currently, only incoming IPv6
traffic is inspected.

NetBIOS Inspection
This section describes the IM inspection engine. This section includes the following topics:
•

NetBIOS Inspection Overview, page 43-28

•

Configuring a NetBIOS Inspection Policy Map for Additional Inspection Control, page 43-29

NetBIOS Inspection Overview
NetBIOS inspection is enabled by default. The NetBios inspection engine translates IP addresses in the
NetBios name service (NBNS) packets according to the ASA NAT configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-28

Chapter 43

Configuring Inspection of Basic Internet Protocols
NetBIOS Inspection

Configuring a NetBIOS Inspection Policy Map for Additional Inspection Control
To specify actions when a message violates a parameter, create a NETBIOS inspection policy map. You
can then apply the inspection policy map when you enable NETBIOS inspection.
To create a NETBIOS inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Creating a Regular Expression” section on page 13-12. See the types of text you can match in the match
commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.

Step 3

Create a NetBIOS inspection policy map, enter the following command:
hostname(config)# policy-map type inspect netbios policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 4

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 5

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the NetBIOS class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-29

Chapter 43

Configuring Inspection of Basic Internet Protocols

PPTP Inspection

You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 6

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To check for NETBIOS protocol violations, enter the following command:
hostname(config-pmap-p)# protocol-violation [action [drop-connection | reset | log]]

Where the drop-connection action closes the connection. The reset action closes the connection
and sends a TCP reset to the client. The log action sends a system log message when this policy map
matches traffic.

The following example shows how to define a NETBIOS inspection policy map.
hostname(config)# policy-map type inspect netbios netbios_map
hostname(config-pmap)# protocol-violation drop log
hostname(config)# policy-map netbios_policy
hostname(config-pmap)# class inspection_default
hostname(config-pmap-c)# inspect netbios netbios_map

PPTP Inspection
PPTP is a protocol for tunneling PPP traffic. A PPTP session is composed of one TCP channel and
usually two PPTP GRE tunnels. The TCP channel is the control channel used for negotiating and
managing the PPTP GRE tunnels. The GRE tunnels carries PPP sessions between the two hosts.
When enabled, PPTP application inspection inspects PPTP protocol packets and dynamically creates the
GRE connections and xlates necessary to permit PPTP traffic. Only Version 1, as defined in RFC 2637,
is supported.
PAT is only performed for the modified version of GRE [RFC 2637] when negotiated over the PPTP TCP
control channel. Port Address Translation is not performed for the unmodified version of GRE [RFC
1701, RFC 1702].
Specifically, the ASA inspects the PPTP version announcements and the outgoing call request/response
sequence. Only PPTP Version 1, as defined in RFC 2637, is inspected. Further inspection on the TCP
control channel is disabled if the version announced by either side is not Version 1. In addition, the
outgoing-call request and reply sequence are tracked. Connections and xlates are dynamic allocated as
necessary to permit subsequent secondary GRE data traffic.
The PPTP inspection engine must be enabled for PPTP traffic to be translated by PAT. Additionally, PAT
is only performed for a modified version of GRE (RFC2637) and only if it is negotiated over the PPTP
TCP control channel. PAT is not performed for the unmodified version of GRE (RFC 1701 and
RFC 1702).
As described in RFC 2637, the PPTP protocol is mainly used for the tunneling of PPP sessions initiated
from a modem bank PAC (PPTP Access Concentrator) to the headend PNS (PPTP Network Server).
When used this way, the PAC is the remote client and the PNS is the server.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-30

Chapter 43

Configuring Inspection of Basic Internet Protocols
SMTP and Extended SMTP Inspection

However, when used for VPN by Windows, the interaction is inverted. The PNS is a remote single-user
PC that initiates connection to the head-end PAC to gain access to a central network.

SMTP and Extended SMTP Inspection
This section describes the IM inspection engine. This section includes the following topics:
•

SMTP and ESMTP Inspection Overview, page 43-31

•

Configuring an ESMTP Inspection Policy Map for Additional Inspection Control, page 43-32

SMTP and ESMTP Inspection Overview
ESMTP application inspection provides improved protection against SMTP-based attacks by restricting
the types of SMTP commands that can pass through the ASA and by adding monitoring capabilities.
ESMTP is an enhancement to the SMTP protocol and is similar is most respects to SMTP. For
convenience, the term SMTP is used in this document to refer to both SMTP and ESMTP. The
application inspection process for extended SMTP is similar to SMTP application inspection and
includes support for SMTP sessions. Most commands used in an extended SMTP session are the same
as those used in an SMTP session but an ESMTP session is considerably faster and offers more options
related to reliability and security, such as delivery status notification.
Extended SMTP application inspection adds support for these extended SMTP commands, including
AUTH, EHLO, ETRN, HELP, SAML, SEND, SOML, STARTTLS, and VRFY. Along with the support for
seven RFC 821 commands (DATA, HELO, MAIL, NOOP, QUIT, RCPT, RSET), the ASA supports a total
of fifteen SMTP commands.
Other extended SMTP commands, such as ATRN, ONEX, VERB, CHUNKING, and private extensions
and are not supported. Unsupported commands are translated into Xs, which are rejected by the internal
server. This results in a message such as “500 Command unknown: 'XXX'.” Incomplete commands are
discarded.
The ESMTP inspection engine changes the characters in the server SMTP banner to asterisks except for
the “2”, “0”, “0” characters. Carriage return (CR) and linefeed (LF) characters are ignored.
With SMTP inspection enabled, a Telnet session used for interactive SMTP may hang if the following
rules are not observed: SMTP commands must be at least four characters in length; must be terminated
with carriage return and line feed; and must wait for a response before issuing the next reply.
An SMTP server responds to client requests with numeric reply codes and optional human-readable
strings. SMTP application inspection controls and reduces the commands that the user can use as well
as the messages that the server returns. SMTP inspection performs three primary tasks:
•

Restricts SMTP requests to seven basic SMTP commands and eight extended commands.

•

Monitors the SMTP command-response sequence.

•

Generates an audit trail—Audit record 108002 is generated when invalid character embedded in the
mail address is replaced. For more information, see RFC 821.

SMTP inspection monitors the command and response sequence for the following anomalous signatures:
•

Truncated commands.

•

Incorrect command termination (not terminated with ).

Cisco ASA 5500 Series Configuration Guide using the CLI

43-31

Chapter 43

Configuring Inspection of Basic Internet Protocols

SMTP and Extended SMTP Inspection

•

The MAIL and RCPT commands specify who are the sender and the receiver of the mail. Mail
addresses are scanned for strange characters. The pipeline character (|) is deleted (changed to a blank
space) and “<” ‚”>” are only allowed if they are used to define a mail address (“>” must be preceded
by “<”).

•

Unexpected transition by the SMTP server.

•

For unknown commands, the ASA changes all the characters in the packet to X. In this case, the
server generates an error code to the client. Because of the change in the packed, the TCP checksum
has to be recalculated or adjusted.

•

TCP stream editing.

•

Command pipelining.

Configuring an ESMTP Inspection Policy Map for Additional Inspection Control
ESMTP inspection detects attacks, including spam, phising, malformed message attacks, buffer
overflow/underflow attacks. It also provides support for application security and protocol conformance,
which enforce the sanity of the ESMTP messages as well as detect several attacks, block
senders/receivers, and block mail relay.
To specify actions when a message violates a parameter, create an ESMTP inspection policy map. You
can then apply the inspection policy map when you enable ESMTP inspection.
To create an ESMTP inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Creating a Regular Expression” section on page 13-12. See the types of text you can match in the match
commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.

Step 3

Create an ESMTP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect esmtp policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 4

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 5

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the ESMTP class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

43-32

Chapter 43

Configuring Inspection of Basic Internet Protocols
SMTP and Extended SMTP Inspection

hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 6

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To configure a local domain name, enter the following command:
hostname(config-pmap-p)# mail-relay domain-name action [drop-connection | log]]

Where the drop-connection action closes the connection. The log action sends a system log
message when this policy map matches traffic.
c.

To enforce banner obfuscation, enter the following command:
hostname(config-pmap-p)# mask-banner

The following example shows how to define an ESMTP inspection policy map.
hostname(config)# regex user1 “user1@cisco.com”
hostname(config)# regex user2 “user2@cisco.com”
hostname(config)# regex user3 “user3@cisco.com”
hostname(config)# class-map type regex senders_black_list
hostname(config-cmap)# description “Regular expressions to filter out undesired senders”
hostname(config-cmap)# match regex user1
hostname(config-cmap)# match regex user2
hostname(config-cmap)# match regex user3
hostname(config)# policy-map type inspect esmtp advanced_esmtp_map
hostname(config-pmap)# match sender-address regex class senders_black_list
hostname(config-pmap-c)# drop-connection log
hostname(config)# policy-map outside_policy
hostname(config-pmap)# class inspection_default
hostname(config-pmap-c)# inspect esmtp advanced_esmtp_map
hostname(config)# service-policy outside_policy interface outside

Cisco ASA 5500 Series Configuration Guide using the CLI

43-33

Chapter 43

Configuring Inspection of Basic Internet Protocols

TFTP Inspection

TFTP Inspection
TFTP inspection is enabled by default.
TFTP, described in RFC 1350, is a simple protocol to read and write files between a TFTP server and
client.
The ASA inspects TFTP traffic and dynamically creates connections and translations, if necessary, to
permit file transfer between a TFTP client and server. Specifically, the inspection engine inspects TFTP
read request (RRQ), write request (WRQ), and error notification (ERROR).
A dynamic secondary channel and a PAT translation, if necessary, are allocated on a reception of a valid
read (RRQ) or write (WRQ) request. This secondary channel is subsequently used by TFTP for file
transfer or error notification.
Only the TFTP server can initiate traffic over the secondary channel, and at most one incomplete
secondary channel can exist between the TFTP client and server. An error notification from the server
closes the secondary channel.
TFTP inspection must be enabled if static PAT is used to redirect TFTP traffic.

Cisco ASA 5500 Series Configuration Guide using the CLI

43-34

CH A P T E R

44

Configuring Inspection for Voice and Video
Protocols
This chapter describes how to configure application layer protocol inspection. Inspection engines are
required for services that embed IP addressing information in the user data packet or that open secondary
channels on dynamically assigned ports. These protocols require the ASA to do a deep packet inspection
instead of passing the packet through the fast path. As a result, inspection engines can affect overall
throughput.
Several common inspection engines are enabled on the ASA by default, but you might need to enable
others depending on your network.
This chapter includes the following sections:
•

CTIQBE Inspection, page 44-1

•

H.323 Inspection, page 44-3

•

MGCP Inspection, page 44-11

•

RTSP Inspection, page 44-15

•

SIP Inspection, page 44-19

•

Skinny (SCCP) Inspection, page 44-25

CTIQBE Inspection
This section describes CTIQBE application inspection. This section includes the following topics:
•

CTIQBE Inspection Overview, page 44-1

•

Limitations and Restrictions, page 44-2

•

Verifying and Monitoring CTIQBE Inspection, page 44-2

CTIQBE Inspection Overview
CTIQBE protocol inspection supports NAT, PAT, and bidirectional NAT. This enables Cisco IP
SoftPhone and other Cisco TAPI/JTAPI applications to work successfully with Cisco CallManager for
call setup across the ASA.
TAPI and JTAPI are used by many Cisco VoIP applications. CTIQBE is used by Cisco TSP to
communicate with Cisco CallManager.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-1

Chapter 44

Configuring Inspection for Voice and Video Protocols

CTIQBE Inspection

Limitations and Restrictions
The following summarizes limitations that apply when using CTIQBE application inspection:
•

CTIQBE application inspection does not support configurations with the alias command.

•

Stateful failover of CTIQBE calls is not supported.

•

Entering the debug ctiqbe command may delay message transmission, which may have a
performance impact in a real-time environment. When you enable this debugging or logging and
Cisco IP SoftPhone seems unable to complete call setup through the ASA, increase the timeout
values in the Cisco TSP settings on the system running Cisco IP SoftPhone.

The following summarizes special considerations when using CTIQBE application inspection in specific
scenarios:
•

If two Cisco IP SoftPhones are registered with different Cisco CallManagers, which are connected
to different interfaces of the ASA, calls between these two phones fails.

•

When Cisco CallManager is located on the higher security interface compared to
Cisco IP SoftPhones, if NAT or outside NAT is required for the Cisco CallManager IP address, the
mapping must be static as Cisco IP SoftPhone requires the Cisco CallManager IP address to be
specified explicitly in its Cisco TSP configuration on the PC.

•

When using PAT or Outside PAT, if the Cisco CallManager IP address is to be translated, its TCP
port 2748 must be statically mapped to the same port of the PAT (interface) address for Cisco IP
SoftPhone registrations to succeed. The CTIQBE listening port (TCP 2748) is fixed and is not
user-configurable on Cisco CallManager, Cisco IP SoftPhone, or Cisco TSP.

Verifying and Monitoring CTIQBE Inspection
The show ctiqbe command displays information regarding the CTIQBE sessions established across the
ASA. It shows information about the media connections allocated by the CTIQBE inspection engine.
The following is sample output from the show ctiqbe command under the following conditions. There
is only one active CTIQBE session setup across the ASA. It is established between an internal CTI
device (for example, a Cisco IP SoftPhone) at local address 10.0.0.99 and an external Cisco CallManager
at 172.29.1.77, where TCP port 2748 is the Cisco CallManager. The heartbeat interval for the session is
120 seconds.
hostname# # show ctiqbe
Total: 1
LOCAL
FOREIGN
STATE
HEARTBEAT
--------------------------------------------------------------1
10.0.0.99/1117 172.29.1.77/2748
1
120
---------------------------------------------RTP/RTCP: PAT xlates: mapped to 172.29.1.99(1028 - 1029)
---------------------------------------------MEDIA: Device ID 27
Call ID 0
Foreign 172.29.1.99
(1028 - 1029)
Local
172.29.1.88
(26822 - 26823)
----------------------------------------------

The CTI device has already registered with the CallManager. The device internal address and RTP
listening port is PATed to 172.29.1.99 UDP port 1028. Its RTCP listening port is PATed to UDP 1029.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-2

Chapter 44

Configuring Inspection for Voice and Video Protocols
H.323 Inspection

The line beginning with RTP/RTCP: PAT xlates: appears only if an internal CTI device has registered
with an external CallManager and the CTI device address and ports are PATed to that external interface.
This line does not appear if the CallManager is located on an internal interface, or if the internal CTI
device address and ports are translated to the same external interface that is used by the CallManager.
The output indicates a call has been established between this CTI device and another phone at
172.29.1.88. The RTP and RTCP listening ports of the other phone are UDP 26822 and 26823. The other
phone locates on the same interface as the CallManager because the ASA does not maintain a CTIQBE
session record associated with the second phone and CallManager. The active call leg on the CTI device
side can be identified with Device ID 27 and Call ID 0.
The following is sample output from the show xlate debug command for these CTIBQE connections:
hostname# show xlate debug
3 in use, 3 most used
Flags: D - DNS, d - dump, I - identity, i - inside, n - no random,
r - portmap, s - static
TCP PAT from inside:10.0.0.99/1117 to outside:172.29.1.99/1025 flags ri idle 0:00:22
timeout 0:00:30
UDP PAT from inside:10.0.0.99/16908 to outside:172.29.1.99/1028 flags ri idle 0:00:00
timeout 0:04:10
UDP PAT from inside:10.0.0.99/16909 to outside:172.29.1.99/1029 flags ri idle 0:00:23
timeout 0:04:10

The show conn state ctiqbe command displays the status of CTIQBE connections. In the output, the
media connections allocated by the CTIQBE inspection engine are denoted by a ‘C’ flag. The following
is sample output from the show conn state ctiqbe command:
hostname# show conn state ctiqbe
1 in use, 10 most used
hostname# show conn state ctiqbe detail
1 in use, 10 most used
Flags: A - awaiting inside ACK to SYN, a - awaiting outside ACK to SYN,
B - initial SYN from outside, C - CTIQBE media, D - DNS, d - dump,
E - outside back connection, F - outside FIN, f - inside FIN,
G - group, g - MGCP, H - H.323, h - H.225.0, I - inbound data,
i - incomplete, J - GTP, j - GTP data, k - Skinny media,
M - SMTP data, m - SIP media, O - outbound data, P - inside back connection,
q - SQL*Net data, R - outside acknowledged FIN,
R - UDP RPC, r - inside acknowledged FIN, S - awaiting inside SYN,
s - awaiting outside SYN, T - SIP, t - SIP transient, U - up

H.323 Inspection
This section describes the H.323 application inspection. This section includes the following topics:
•

H.323 Inspection Overview, page 44-4

•

How H.323 Works, page 44-4

•

H.239 Support in H.245 Messages, page 44-5

•

Limitations and Restrictions, page 44-5

•

Configuring an H.323 Inspection Policy Map for Additional Inspection Control, page 44-6

•

Configuring H.323 and H.225 Timeout Values, page 44-9

•

Verifying and Monitoring H.323 Inspection, page 44-9

Cisco ASA 5500 Series Configuration Guide using the CLI

44-3

Chapter 44

Configuring Inspection for Voice and Video Protocols

H.323 Inspection

H.323 Inspection Overview
H.323 inspection provides support for H.323 compliant applications such as Cisco CallManager and
VocalTec Gatekeeper. H.323 is a suite of protocols defined by the International Telecommunication
Union for multimedia conferences over LANs. The ASA supports H.323 through Version 6, including
H.323 v3 feature Multiple Calls on One Call Signaling Channel.
With H.323 inspection enabled, the ASA supports multiple calls on the same call signaling channel, a
feature introduced with H.323 Version 3. This feature reduces call setup time and reduces the use of ports
on the ASA.
The two major functions of H.323 inspection are as follows:
•

NAT the necessary embedded IPv4 addresses in the H.225 and H.245 messages. Because H.323
messages are encoded in PER encoding format, the ASA uses an ASN.1 decoder to decode the
H.323 messages.

•

Dynamically allocate the negotiated H.245 and RTP/RTCP connections.

How H.323 Works
The H.323 collection of protocols collectively may use up to two TCP connection and four to eight UDP
connections. FastConnect uses only one TCP connection, and RAS uses a single UDP connection for
registration, admissions, and status.
An H.323 client can initially establish a TCP connection to an H.323 server using TCP port 1720 to
request Q.931 call setup. As part of the call setup process, the H.323 terminal supplies a port number to
the client to use for an H.245 TCP connection. In environments where H.323 gatekeeper is in use, the
initial packet is transmitted using UDP.
H.323 inspection monitors the Q.931 TCP connection to determine the H.245 port number. If the H.323
terminals are not using FastConnect, the ASA dynamically allocates the H.245 connection based on the
inspection of the H.225 messages.

Note

The H.225 connection can also be dynamically allocated when using RAS.
Within each H.245 message, the H.323 endpoints exchange port numbers that are used for subsequent
UDP data streams. H.323 inspection inspects the H.245 messages to identify these ports and dynamically
creates connections for the media exchange. RTP uses the negotiated port number, while RTCP uses the
next higher port number.
The H.323 control channel handles H.225 and H.245 and H.323 RAS. H.323 inspection uses the
following ports.
•

1718—Gate Keeper Discovery UDP port

•

1719—RAS UDP port

•

1720—TCP Control Port

You must permit traffic for the well-known H.323 port 1719 for RAS signaling. Additionally, you must
permit traffic for the well-known H.323 port 1720 for the H.225 call signaling; however, the H.245
signaling ports are negotiated between the endpoints in the H.225 signaling. When an H.323 gatekeeper
is used, the ASA opens an H.225 connection based on inspection of the ACF and RCF nmessages.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-4

Chapter 44

Configuring Inspection for Voice and Video Protocols
H.323 Inspection

After inspecting the H.225 messages, the ASA opens the H.245 channel and then inspects traffic sent
over the H.245 channel as well. All H.245 messages passing through the ASA undergo H.245 application
inspection, which translates embedded IP addresses and opens the media channels negotiated in H.245
messages.
The H.323 ITU standard requires that a TPKT header, defining the length of the message, precede the
H.225 and H.245, before being passed on to the reliable connection. Because the TPKT header does not
necessarily need to be sent in the same TCP packet as H.225 and H.245 messages, the ASA must
remember the TPKT length to process and decode the messages properly. For each connection, the ASA
keeps a record that contains the TPKT length for the next expected message.
If the ASA needs to perform NAT on IP addresses in messages, it changes the checksum, the UUIE
length, and the TPKT, if it is included in the TCP packet with the H.225 message. If the TPKT is sent in
a separate TCP packet, the ASA proxy ACKs that TPKT and appends a new TPKT to the H.245 message
with the new length.

Note

The ASA does not support TCP options in the Proxy ACK for the TPKT.
Each UDP connection with a packet going through H.323 inspection is marked as an H.323 connection
and times out with the H.323 timeout as configured with the timeout command.

Note

You can enable call setup between H.323 endpoints when the Gatekeeper is inside the network. The ASA
includes options to open pinholes for calls based on the RegistrationRequest/RegistrationConfirm
(RRQ/RCF) messages. Because these RRQ/RCF messages are sent to and from the Gatekeeper, the
calling endpoint's IP address is unknown and the ASA opens a pinhole through source IP address/port
0/0. By default, this option is disabled. To enable call setup between H.323 endpoint, enter the
ras-rcf-pinholes enable command during parameter configuration mode while creating an H.323
Inspection policy map. See Configuring an H.323 Inspection Policy Map for Additional Inspection
Control, page 44-6.

H.239 Support in H.245 Messages
The ASA sits between two H.323 endpoints. When the two H.323 endpoints set up a telepresentation
session so that the endpoints can send and receive a data presentation, such as spreadsheet data, the ASA
ensure successful H.239 negotiation between the endpoints.
H.239 is a standar that provides the ability for H.300 series endpoints to open an additional video channel
in a single call. In a call, an endpoint (such as a video phone), sends a channel for video and a channel
for data presentation. The H.239 negotiation occurs on the H.245 channel.
The ASA opens pinholes for the additional media channel and the media control channel. The endpoints
use open logical channel message (OLC) to signal a new channel creation. The message extension is
part of H.245 version 13.
The decoding and encoding of of the telepresentation session is enabled by default. H.239 encoding and
decoding is preformed by ASN.1 coder.

Limitations and Restrictions
The following are some of the known issues and limitations when using H.323 application inspection:

Cisco ASA 5500 Series Configuration Guide using the CLI

44-5

Chapter 44

Configuring Inspection for Voice and Video Protocols

H.323 Inspection

•

Static PAT may not properly translate IP addresses embedded in optional fields within H.323
messages. If you experience this kind of problem, do not use static PAT with H.323.

•

H.323 application inspection is not supported with NAT between same-security-level interfaces.

•

When a NetMeeting client registers with an H.323 gatekeeper and tries to call an H.323 gateway that
is also registered with the H.323 gatekeeper, the connection is established but no voice is heard in
either direction. This problem is unrelated to the ASA.

•

If you configure a network static address where the network static address is the same as a
third-party netmask and address, then any outbound H.323 connection fails.

Configuring an H.323 Inspection Policy Map for Additional Inspection Control
To specify actions when a message violates a parameter, create an H.323 inspection policy map. You can
then apply the inspection policy map when you enable H.323 inspection.
To create an H.323 inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Creating a Regular Expression” section on page 13-12. See the types of text you can match in the match
commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.s

Step 3

(Optional) Create an H.323 inspection class map by performing the following steps.
A class map groups multiple traffic matches. Traffic must match all of the match commands to match
the class map. You can alternatively identify match commands directly in the policy map. The difference
between creating a class map and defining the traffic match directly in the inspection policy map is that
the class map lets you create more complex match criteria, and you can reuse class maps.
To specify traffic that should not match the class map, use the match not command. For example, if the
match not command specifies the string “example.com,” then any traffic that includes “example.com”
does not match the class map.
For the traffic that you identify in this class map, you can specify actions such as drop-connection, reset,
and/or log the connection in the inspection policy map.
If you want to perform different actions for each match command, you should identify the traffic directly
in the policy map.
a.

Create the class map by entering the following command:
hostname(config)# class-map type inspect h323 [match-all | match-any] class_map_name
hostname(config-cmap)#

Where the class_map_name is the name of the class map. The match-all keyword is the default, and
specifies that traffic must match all criteria to match the class map. The match-any keyword
specifies that the traffic matches the class map if it matches at least one of the criteria. The CLI
enters class-map configuration mode, where you can enter one or more match commands.
b.

(Optional) To add a description to the class map, enter the following command:
hostname(config-cmap)# description string

Where string is the description of the class map (up to 200 characters).
c.

(Optional) To match a called party, enter the following command:
hostname(config-cmap)# match [not] called-party regex {class class_name | regex_name}

Cisco ASA 5500 Series Configuration Guide using the CLI

44-6

Chapter 44

Configuring Inspection for Voice and Video Protocols
H.323 Inspection

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
d.

(Optional) To match a media type, enter the following command:
hostname(config-cmap)# match [not] media-type {audio | data | video}

Step 4

Create an H.323 inspection policy map, enter the following command:
hostname(config)# policy-map type inspect h323 policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 5

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 6

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the H.323 class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 7

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

Cisco ASA 5500 Series Configuration Guide using the CLI

44-7

Chapter 44

Configuring Inspection for Voice and Video Protocols

H.323 Inspection

b.

To enable call setup betweeen H.323 Endpoings, enter the following command:
hostname(config)# ras-rcf-pinholes enable

You can enable call setup between H.323 endpoints when the Gatekeeper is inside the network. The
ASA includes options to open pinholes for calls based on the
RegistrationRequest/RegistrationConfirm (RRQ/RCF) messages. Because these RRQ/RCF
messages are sent to and from the Gatekeeper, the calling endpoint's IP address is unknown and the
ASA opens a pinhole through source IP address/port 0/0. By default, this option is disabled.
c.

To define the H.323 call duration limit, enter the following command:
hostname(config-pmap-p)# call-duration-limit time

Where time is the call duration limit in seconds. Range is from 0:0:0 ti 1163:0;0. A value of 0 means
never timeout.
d.

To enforce call party number used in call setup, enter the following command:
hostname(config-pmap-p)# call-party-number

e.

To enforce H.245 tunnel blocking, enter the following command:
hostname(config-pmap-p)# h245-tunnel-block action {drop-connection | log}

f.

To define an hsi group and enter hsi group configuration mode, enter the following command:
hostname(config-pmap-p)# hsi-group id

Where id is the hsi group ID. Range is from 0 to 2147483647.
To add an hsi to the hsi group, enter the following command in hsi group configuration mode:
hostname(config-h225-map-hsi-grp)# hsi ip_address

Where ip_address is the host to add. A maximum of five hosts per hsi group are allowed.
To add an endpoint to the hsi group, enter the following command in hsi group configuration
mode:
hostname(config-h225-map-hsi-grp)# endpoint ip_address if_name

Where ip_address is the endpoint to add and if_name is the interface through which the endpoint
is connected to the security appliance. A maximum of ten endpoints per hsi group are allowed.
g.

To check RTP packets flowing on the pinholes for protocol conformance, enter the following
command:
hostname(config-pmap-p)# rtp-conformance [enforce-payloadtype]

Where the enforce-payloadtype keyword enforces the payload type to be audio or video based on
the signaling exchange.
h.

To enable state checking validation, enter the following command:
hostname(config-pmap-p)# state-checking {h225 | ras}

The following example shows how to configure phone number filtering:
hostname(config)# regex caller 1 “5551234567”
hostname(config)# regex caller 2 “5552345678”
hostname(config)# regex caller 3 “5553456789”
hostname(config)# class-map type inspect h323 match-all h323_traffic

Cisco ASA 5500 Series Configuration Guide using the CLI

44-8

Chapter 44

Configuring Inspection for Voice and Video Protocols
H.323 Inspection

hostname(config-pmap-c)# match called-party regex caller1
hostname(config-pmap-c)# match calling-party regex caller2
hostname(config)# policy-map type inspect h323 h323_map
hostname(config-pmap)# parameters
hostname(config-pmap-p)# class h323_traffic
hostname(config-pmap-c)# drop

Configuring H.323 and H.225 Timeout Values
To configure the idle time after which an H.225 signalling connection is closed, use the timeout h225
command. The default for H.225 timeout is one hour.
To configure the idle time after which an H.323 control connection is closed, use the timeout h323
command. The default is five minutes.

Verifying and Monitoring H.323 Inspection
This section describes how to display information about H.323 sessions. This section includes the
following topics:
•

Monitoring H.225 Sessions, page 44-9

•

Monitoring H.245 Sessions, page 44-10

•

Monitoring H.323 RAS Sessions, page 44-10

Monitoring H.225 Sessions
The show h225 command displays information for H.225 sessions established across the ASA. Along
with the debug h323 h225 event, debug h323 h245 event, and show local-host commands, this
command is used for troubleshooting H.323 inspection engine issues.
Before entering the show h225, show h245, or show h323-ras commands, we recommend that you
configure the pager command. If there are a lot of session records and the pager command is not
configured, it may take a while for the show command output to reach its end. If there is an abnormally
large number of connections, check that the sessions are timing out based on the default timeout values
or the values set by you. If they are not, then there is a problem that needs to be investigated.
The following is sample output from the show h225 command:
hostname# show h225
Total H.323 Calls: 1
1 Concurrent Call(s) for
Local:
10.130.56.3/1040
1. CRV 9861
Local:
10.130.56.3/1040
0 Concurrent Call(s) for
Local:
10.130.56.4/1050

Foreign: 172.30.254.203/1720
Foreign: 172.30.254.203/1720
Foreign: 172.30.254.205/1720

This output indicates that there is currently 1 active H.323 call going through the ASA between the local
endpoint 10.130.56.3 and foreign host 172.30.254.203, and for these particular endpoints, there is 1
concurrent call between them, with a CRV for that call of 9861.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-9

Chapter 44

Configuring Inspection for Voice and Video Protocols

H.323 Inspection

For the local endpoint 10.130.56.4 and foreign host 172.30.254.205, there are 0 concurrent calls. This
means that there is no active call between the endpoints even though the H.225 session still exists. This
could happen if, at the time of the show h225 command, the call has already ended but the H.225 session
has not yet been deleted. Alternately, it could mean that the two endpoints still have a TCP connection
opened between them because they set “maintainConnection” to TRUE, so the session is kept open until
they set it to FALSE again, or until the session times out based on the H.225 timeout value in your
configuration.

Monitoring H.245 Sessions
The show h245 command displays information for H.245 sessions established across the ASA by
endpoints using slow start. Slow start is when the two endpoints of a call open another TCP control
channel for H.245. Fast start is where the H.245 messages are exchanged as part of the H.225 messages
on the H.225 control channel.) Along with the debug h323 h245 event, debug h323 h225 event, and
show local-host commands, this command is used for troubleshooting H.323 inspection engine issues.
The following is sample output from the show h245 command:
hostname# show h245
Total: 1
LOCAL
TPKT
FOREIGN
TPKT
1
10.130.56.3/1041
0
172.30.254.203/1245
0
MEDIA: LCN 258 Foreign 172.30.254.203 RTP 49608 RTCP 49609
Local
10.130.56.3 RTP 49608 RTCP 49609
MEDIA: LCN 259 Foreign 172.30.254.203 RTP 49606 RTCP 49607
Local
10.130.56.3 RTP 49606 RTCP 49607

There is currently one H.245 control session active across the ASA. The local endpoint is 10.130.56.3,
and we are expecting the next packet from this endpoint to have a TPKT header because the TPKT value
is 0. The TKTP header is a 4-byte header preceding each H.225/H.245 message. It gives the length of
the message, including the 4-byte header. The foreign host endpoint is 172.30.254.203, and we are
expecting the next packet from this endpoint to have a TPKT header because the TPKT value is 0.
The media negotiated between these endpoints have an LCN of 258 with the foreign RTP IP address/port
pair of 172.30.254.203/49608 and an RTCP IP address/port of 172.30.254.203/49609 with a local RTP
IP address/port pair of 10.130.56.3/49608 and an RTCP port of 49609.
The second LCN of 259 has a foreign RTP IP address/port pair of 172.30.254.203/49606 and an RTCP
IP address/port pair of 172.30.254.203/49607 with a local RTP IP address/port pair of
10.130.56.3/49606 and RTCP port of 49607.

Monitoring H.323 RAS Sessions
The show h323-ras command displays information for H.323 RAS sessions established across the ASA
between a gatekeeper and its H.323 endpoint. Along with the debug h323 ras event and show local-host
commands, this command is used for troubleshooting H.323 RAS inspection engine issues.
The show h323-ras command displays connection information for troubleshooting H.323 inspection
engine issues. The following is sample output from the show h323-ras command:
hostname# show h323-ras
Total: 1
GK
Caller
172.30.254.214 10.130.56.14

This output shows that there is one active registration between the gatekeeper 172.30.254.214 and its
client 10.130.56.14.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-10

Chapter 44

Configuring Inspection for Voice and Video Protocols
MGCP Inspection

MGCP Inspection
This section describes MGCP application inspection. This section includes the following topics:
•

MGCP Inspection Overview, page 44-11

•

Configuring an MGCP Inspection Policy Map for Additional Inspection Control, page 44-13

•

Configuring MGCP Timeout Values, page 44-14

•

Verifying and Monitoring MGCP Inspection, page 44-14

MGCP Inspection Overview
MGCP is a master/slave protocol used to control media gateways from external call control elements
called media gateway controllers or call agents. A media gateway is typically a network element that
provides conversion between the audio signals carried on telephone circuits and data packets carried over
the Internet or over other packet networks. Using NAT and PAT with MGCP lets you support a large
number of devices on an internal network with a limited set of external (global) addresses. Examples of
media gateways are:

Note

•

Trunking gateways, that interface between the telephone network and a Voice over IP network. Such
gateways typically manage a large number of digital circuits.

•

Residential gateways, that provide a traditional analog (RJ11) interface to a Voice over IP network.
Examples of residential gateways include cable modem/cable set-top boxes, xDSL devices,
broad-band wireless devices.

•

Business gateways, that provide a traditional digital PBX interface or an integrated soft PBX
interface to a Voice over IP network.

To avoid policy failure when upgrading from ASA version 7.1, all layer 7 and layer 3 policies must have
distinct names. For instance, a previously configured policy map with the same name as a previously
configured MGCP map must be changed before the upgrade.
MGCP messages are transmitted over UDP. A response is sent back to the source address (IP address
and UDP port number) of the command, but the response may not arrive from the same address as the
command was sent to. This can happen when multiple call agents are being used in a failover
configuration and the call agent that received the command has passed control to a backup call agent,
which then sends the response. Figure 44-1 illustrates how NAT can be used with MGCP.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-11

Chapter 44

Configuring Inspection for Voice and Video Protocols

MGCP Inspection

Figure 44-1

Using NAT with MGCP

To PSTN
Cisco
PGW 2200

M

H.323

M
M

Cisco
CallManager

209.165.201.10

209.165.201.11
209.165.201.1
Gateway is told
to send its media
to 209.165.200.231
(public address
of the IP Phone)

209.165.200.231
MGCP

SCCP
RTP to 10.0.0.76
from 209.165.200.231

209.165.200.231
GW

GW

IP

IP

IP

10.0.0.76
Branch offices

119936

RTP to 209.165.201.1
from 209.165.200.231

MGCP endpoints are physical or virtual sources and destinations for data. Media gateways contain
endpoints on which the call agent can create, modify and delete connections to establish and control
media sessions with other multimedia endpoints. Also, the call agent can instruct the endpoints to detect
certain events and generate signals. The endpoints automatically communicate changes in service state
to the call agent.
MGCP transactions are composed of a command and a mandatory response. There are eight types of
commands:
•

CreateConnection

•

ModifyConnection

•

DeleteConnection

•

NotificationRequest

•

Notify

•

AuditEndpoint

•

AuditConnection

•

RestartInProgress

The first four commands are sent by the call agent to the gateway. The Notify command is sent by the
gateway to the call agent. The gateway may also send a DeleteConnection. The registration of the MGCP
gateway with the call agent is achieved by the RestartInProgress command. The AuditEndpoint and the
AuditConnection commands are sent by the call agent to the gateway.
All commands are composed of a Command header, optionally followed by a session description. All
responses are composed of a Response header, optionally followed by a session description.
•

The port on which the gateway receives commands from the call agent. Gateways usually listen to
UDP port 2427.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-12

Chapter 44

Configuring Inspection for Voice and Video Protocols
MGCP Inspection

•

Note

The port on which the call agent receives commands from the gateway. Call agents usually listen to
UDP port 2727.

MGCP inspection does not support the use of different IP addresses for MGCP signaling and RTP data.
A common and recommended practice is to send RTP data from a resilient IP address, such as a loopback
or virtual IP address; however, the ASA requires the RTP data to come from the same address as MGCP
signalling.

Configuring an MGCP Inspection Policy Map for Additional Inspection Control
If the network has multiple call agents and gateways for which the ASA has to open pinholes, create an
MGCP map. You can then apply the MGCP map when you enable MGCP inspection.
To create an MGCP map, perform the following steps:
Step 1

To create an MGCP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect mgcp map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 2

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 3

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To configure the call agents, enter the following command for each call agent:
hostname(config-pmap-p)# call-agent ip_address group_id

Use the call-agent command to specify a group of call agents that can manage one or more gateways.
The call agent group information is used to open connections for the call agents in the group (other
than the one a gateway sends a command to) so that any of the call agents can send the response.
call agents with the same group_id belong to the same group. A call agent may belong to more than
one group. The group_id option is a number from 0 to 4294967295. The ip_address option specifies
the IP address of the call agent.

Note

c.

MGCP call agents send AUEP messages to determine if MGCP end points are present. This
establishes a flow through the ASA and allows MGCP end points to register with the call agent.
To configure the gateways, enter the following command for each gateway:
hostname(config-pmap-p)# gateway ip_address group_id

Use the gateway command to specify which group of call agents are managing a particular gateway.
The IP address of the gateway is specified with the ip_address option. The group_id option is a
number from 0 to 4294967295 that must correspond with the group_id of the call agents that are
managing the gateway. A gateway may only belong to one group.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-13

Chapter 44

Configuring Inspection for Voice and Video Protocols

MGCP Inspection

d.

If you want to change the maximum number of commands allowed in the MGCP command queue,
enter the following command:
hostname(config-pmap-p)# command-queue command_limit

The following example shows how to define an MGCP map:
hostname(config)# policy-map type inspect mgcp sample_map
hostname(config-pmap)# parameters
hostname(config-pmap-p)# call-agent 10.10.11.5 101
hostname(config-pmap-p)# call-agent 10.10.11.6 101
hostname(config-pmap-p)# call-agent 10.10.11.7 102
hostname(config-pmap-p)# call-agent 10.10.11.8 102
hostname(config-pmap-p)# gateway 10.10.10.115 101
hostname(config-pmap-p)# gateway 10.10.10.116 102
hostname(config-pmap-p)# gateway 10.10.10.117 102
hostname(config-pmap-p)# command-queue 150

Configuring MGCP Timeout Values
The timeout mgcp command lets you set the interval for inactivity after which an MGCP media
connection is closed. The default is 5 minutes.
The timeout mgcp-pat command lets you set the timeout for PAT xlates. Because MGCP does not have
a keepalive mechanism, if you use non-Cisco MGCP gateways (call agents), the PAT xlates are torn
down after the default timeout interval, which is 30 seconds.

Verifying and Monitoring MGCP Inspection
The show mgcp commands command lists the number of MGCP commands in the command queue. The
show mgcp sessions command lists the number of existing MGCP sessions. The detail option includes
additional information about each command (or session) in the output. The following is sample output
from the show mgcp commands command:
hostname# show mgcp commands
1 in use, 1 most used, 200 maximum allowed
CRCX, gateway IP: host-pc-2, transaction ID: 2052, idle: 0:00:07

The following is sample output from the show mgcp detail command.
hostname# show mgcp commands detail
1 in use, 1 most used, 200 maximum allowed
CRCX, idle: 0:00:10
Gateway IP
host-pc-2
Transaction ID 2052
Endpoint name
aaln/1
Call ID
9876543210abcdef
Connection ID
Media IP
192.168.5.7
Media port
6058

The following is sample output from the show mgcp sessions command.
hostname# show mgcp sessions
1 in use, 1 most used
Gateway IP host-pc-2, connection ID 6789af54c9, active 0:00:11

Cisco ASA 5500 Series Configuration Guide using the CLI

44-14

Chapter 44

Configuring Inspection for Voice and Video Protocols
RTSP Inspection

The following is sample output from the show mgcp sessions detail command.
hostname# show mgcp sessions detail
1 in use, 1 most used
Session active 0:00:14
Gateway IP
host-pc-2
Call ID
9876543210abcdef
Connection ID
6789af54c9
Endpoint name
aaln/1
Media lcl port 6166
Media rmt IP
192.168.5.7
Media rmt port 6058

RTSP Inspection
This section describes RTSP application inspection. This section includes the following topics:
•

RTSP Inspection Overview, page 44-15

•

Using RealPlayer, page 44-16

•

Restrictions and Limitations, page 44-16

•

Configuring an RTSP Inspection Policy Map for Additional Inspection Control, page 44-16

RTSP Inspection Overview
The RTSP inspection engine lets the ASA pass RTSP packets. RTSP is used by RealAudio,
RealNetworks, Apple QuickTime 4, RealPlayer, and Cisco IP/TV connections.

Note

For Cisco IP/TV, use RTSP TCP port 554 and TCP 8554.
RTSP applications use the well-known port 554 with TCP (rarely UDP) as a control channel. The ASA
only supports TCP, in conformity with RFC 2326. This TCP control channel is used to negotiate the data
channels that is used to transmit audio/video traffic, depending on the transport mode that is configured
on the client.
The supported RDT transports are: rtp/avp, rtp/avp/udp, x-real-rdt, x-real-rdt/udp, and x-pn-tng/udp.
The ASA parses Setup response messages with a status code of 200. If the response message is travelling
inbound, the server is outside relative to the ASA and dynamic channels need to be opened for
connections coming inbound from the server. If the response message is outbound, then the ASA does
not need to open dynamic channels.
Because RFC 2326 does not require that the client and server ports must be in the SETUP response
message, the ASA keeps state and remembers the client ports in the SETUP message. QuickTime places
the client ports in the SETUP message and then the server responds with only the server ports.
RTSP inspection does not support PAT or dual-NAT. Also, the ASA cannot recognize HTTP cloaking
where RTSP messages are hidden in the HTTP messages.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-15

Chapter 44

Configuring Inspection for Voice and Video Protocols

RTSP Inspection

Using RealPlayer
When using RealPlayer, it is important to properly configure transport mode. For the ASA, add an
access-list command from the server to the client or vice versa. For RealPlayer, change transport mode
by clicking Options>Preferences>Transport>RTSP Settings.
If using TCP mode on the RealPlayer, select the Use TCP to Connect to Server and Attempt to use
TCP for all content check boxes. On the ASA, there is no need to configure the inspection engine.
If using UDP mode on the RealPlayer, select the Use TCP to Connect to Server and Attempt to use
UDP for static content check boxes, and for live content not available via Multicast. On the ASA, add
an inspect rtsp port command.

Restrictions and Limitations
The following restrictions apply to the RSTP inspection.
•

The ASA does not support multicast RTSP or RTSP messages over UDP.

•

The ASA does not have the ability to recognize HTTP cloaking where RTSP messages are hidden
in the HTTP messages.

•

The ASA cannot perform NAT on RTSP messages because the embedded IP addresses are contained
in the SDP files as part of HTTP or RTSP messages. Packets could be fragmented and ASA cannot
perform NAT on fragmented packets.

•

With Cisco IP/TV, the number of translates the ASA performs on the SDP part of the message is
proportional to the number of program listings in the Content Manager (each program listing can
have at least six embedded IP addresses).

•

You can configure NAT for Apple QuickTime 4 or RealPlayer. Cisco IP/TV only works with NAT
if the Viewer and Content Manager are on the outside network and the server is on the inside
network.

Configuring an RTSP Inspection Policy Map for Additional Inspection Control
To specify actions when a message violates a parameter, create an RTSP inspection policy map. You can
then apply the inspection policy map when you enable RTSP inspection.
To create an RTSP inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Configuring Regular Expressions” section on page 13-12. See the types of text you can match in the
match commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.

Step 3

(Optional) Create an RTSP inspection class map by performing the following steps.
A class map groups multiple traffic matches. Traffic must match all of the match commands to match
the class map. You can alternatively identify match commands directly in the policy map. The difference
between creating a class map and defining the traffic match directly in the inspection policy map is that
the class map lets you create more complex match criteria, and you can reuse class maps.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-16

Chapter 44

Configuring Inspection for Voice and Video Protocols
RTSP Inspection

To specify traffic that should not match the class map, use the match not command. For example, if the
match not command specifies the string “example.com,” then any traffic that includes “example.com”
does not match the class map.
For the traffic that you identify in this class map, you can specify actions such as drop-connection and/or
log the connection in the inspection policy map.
If you want to perform different actions for each match command, you should identify the traffic directly
in the policy map.
a.

Create the class map by entering the following command:
hostname(config)# class-map type inspect rtsp [match-all | match-any] class_map_name
hostname(config-cmap)#

Where class_map_name is the name of the class map. The match-all keyword is the default, and
specifies that traffic must match all criteria to match the class map. The match-any keyword
specifies that the traffic matches the class map if it matches at least one of the criteria. The CLI
enters class-map configuration mode, where you can enter one or more match commands.
b.

(Optional) To add a description to the class map, enter the following command:
hostname(config-cmap)# description string

c.

(Optional) To match an RTSP request method, enter the following command:
hostname(config-cmap)# match [not] request-method method

Where method is the type of method to match (announce, describe, get_parameter, options, pause,
play, record, redirect, setup, set_parameter, teardown).
d.

(Optional) To match URL filtering, enter the following command:
hostname(config-cmap)# match [not] url-filter regex {class class_name | regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
Step 4

To create an RTSP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect rtsp policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 5

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 6

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the RTSP class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Cisco ASA 5500 Series Configuration Guide using the CLI

44-17

Chapter 44

Configuring Inspection for Voice and Video Protocols

RTSP Inspection

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 7

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To restrict usage on reserve port for media negotiation, enter the following command:
hostname(config-pmap-p)# reserve-port-protect

c.

To set the limit on the URL length allowed in the message, enter the following command:
hostname(config-pmap-p)# url-length-limit length

Where the length argument specifies the URL length in bytes (0 to 6000).

The following example shows a how to define an RTSP inspection policy map.
hostname(config)# regex badurl1 www.url1.com/rtsp.avi
hostname(config)# regex badurl2 www.url2.com/rtsp.rm
hostname(config)# regex badurl3 www.url3.com/rtsp.asp
hostname(config)# class-map type regex match-any badurl-list
hostname(config-cmap)# match regex badurl1
hostname(config-cmap)# match regex badurl2
hostname(config-cmap)# match regex badurl3
hostname(config)# policy-map type inspect rtsp rtsp-filter-map
hostname(config-pmap)# match url-filter regex class badurl-list
hostname(config-pmap-p)# drop-connection
hostname(config)# class-map rtsp-traffic-class
hostname(config-cmap)# match default-inspection-traffic
hostname(config)# policy-map rtsp-traffic-policy
hostname(config-pmap)# class rtsp-traffic-class
hostname(config-pmap-c)# inspect rtsp rtsp-filter-map
hostname(config)# service-policy rtsp-traffic-policy global

Cisco ASA 5500 Series Configuration Guide using the CLI

44-18

Chapter 44

Configuring Inspection for Voice and Video Protocols
SIP Inspection

SIP Inspection
This section describes SIP application inspection. This section includes the following topics:
•

SIP Inspection Overview, page 44-19

•

SIP Instant Messaging, page 44-19

•

Configuring a SIP Inspection Policy Map for Additional Inspection Control, page 44-20

•

Configuring SIP Timeout Values, page 44-24

•

Verifying and Monitoring SIP Inspection, page 44-24

SIP Inspection Overview
SIP, as defined by the IETF, enables call handling sessions, particularly two-party audio conferences, or
“calls.” SIP works with SDP for call signalling. SDP specifies the ports for the media stream. Using SIP,
the ASA can support any SIP VoIP gateways and VoIP proxy servers. SIP and SDP are defined in the
following RFCs:
•

SIP: Session Initiation Protocol, RFC 3261

•

SDP: Session Description Protocol, RFC 2327

To support SIP calls through the ASA, signaling messages for the media connection addresses, media
ports, and embryonic connections for the media must be inspected, because while the signaling is sent
over a well-known destination port (UDP/TCP 5060), the media streams are dynamically allocated.
Also, SIP embeds IP addresses in the user-data portion of the IP packet. SIP inspection applies NAT for
these embedded IP addresses.
The following limitations and restrictions apply when using PAT with SIP:
•

If a remote endpoint tries to register with a SIP proxy on a network protected by the ASA, the
registration fails under very specific conditions, as follows:
– PAT is configured for the remote endpoint.
– The SIP registrar server is on the outside network.
– The port is missing in the contact field in the REGISTER message sent by the endpoint to the

proxy server.
– Configuring static PAT is not supported with SIP inspection. If static PAT is configured for the

Cisco Unified Communications Manager, SIP inspection cannot rewrite the SIP packet.
Configure one-to-one static NAT for the Cisco Unified Communications Manager.
•

If a SIP device transmits a packet in which the SDP portion has an IP address in the owner/creator
field (o=) that is different than the IP address in the connection field (c=), the IP address in the o=
field may not be properly translated. This is due to a limitation in the SIP protocol, which does not
provide a port value in the o= field.

SIP Instant Messaging
Instant Messaging refers to the transfer of messages between users in near real-time. SIP supports the
Chat feature on Windows XP using Windows Messenger RTC Client version 4.7.0105 only. The
MESSAGE/INFO methods and 202 Accept response are used to support IM as defined in the following
RFCs:

Cisco ASA 5500 Series Configuration Guide using the CLI

44-19

Chapter 44

Configuring Inspection for Voice and Video Protocols

SIP Inspection

•

Session Initiation Protocol (SIP)-Specific Event Notification, RFC 3265

•

Session Initiation Protocol (SIP) Extension for Instant Messaging, RFC 3428

MESSAGE/INFO requests can come in at any time after registration/subscription. For example, two
users can be online at any time, but not chat for hours. Therefore, the SIP inspection engine opens
pinholes that time out according to the configured SIP timeout value. This value must be configured at
least five minutes longer than the subscription duration. The subscription duration is defined in the
Contact Expires value and is typically 30 minutes.
Because MESSAGE/INFO requests are typically sent using a dynamically allocated port other than port
5060, they are required to go through the SIP inspection engine.

Note

Only the Chat feature is currently supported. Whiteboard, File Transfer, and Application Sharing are not
supported. RTC Client 5.0 is not supported.
SIP inspection translates the SIP text-based messages, recalculates the content length for the SDP
portion of the message, and recalculates the packet length and checksum. It dynamically opens media
connections for ports specified in the SDP portion of the SIP message as address/ports on which the
endpoint should listen.
SIP inspection has a database with indices CALL_ID/FROM/TO from the SIP payload. These indices
identify the call, the source, and the destination. This database contains the media addresses and media
ports found in the SDP media information fields and the media type. There can be multiple media
addresses and ports for a session. The ASA opens RTP/RTCP connections between the two endpoints
using these media addresses/ports.
The well-known port 5060 must be used on the initial call setup (INVITE) message; however, subsequent
messages may not have this port number. The SIP inspection engine opens signaling connection
pinholes, and marks these connections as SIP connections. This is done for the messages to reach the
SIP application and be translated.
As a call is set up, the SIP session is in the “transient” state until the media address and media port is
received from the called endpoint in a Response message indicating the RTP port the called endpoint
listens on. If there is a failure to receive the response messages within one minute, the signaling
connection is torn down.
Once the final handshake is made, the call state is moved to active and the signaling connection remains
until a BYE message is received.
If an inside endpoint initiates a call to an outside endpoint, a media hole is opened to the outside interface
to allow RTP/RTCP UDP packets to flow to the inside endpoint media address and media port specified
in the INVITE message from the inside endpoint. Unsolicited RTP/RTCP UDP packets to an inside
interface does not traverse the ASA, unless the ASA configuration specifically allows it.

Configuring a SIP Inspection Policy Map for Additional Inspection Control
To specify actions when a message violates a parameter, create a SIP inspection policy map. You can
then apply the inspection policy map when you enable SIP inspection.
To create a SIP inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Configuring Regular Expressions” section on page 13-12. See the types of text you can match in the
match commands described in Step 3.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-20

Chapter 44

Configuring Inspection for Voice and Video Protocols
SIP Inspection

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.s

Step 3

(Optional) Create a SIP inspection class map by performing the following steps.
A class map groups multiple traffic matches. Traffic must match all of the match commands to match
the class map. You can alternatively identify match commands directly in the policy map. The difference
between creating a class map and defining the traffic match directly in the inspection policy map is that
the class map lets you create more complex match criteria, and you can reuse class maps.
To specify traffic that should not match the class map, use the match not command. For example, if the
match not command specifies the string “example.com,” then any traffic that includes “example.com”
does not match the class map.
For the traffic that you identify in this class map, you can specify actions such as drop-connection, reset,
and/or log the connection in the inspection policy map.
If you want to perform different actions for each match command, you should identify the traffic directly
in the policy map.
a.

Create the class map by entering the following command:
hostname(config)# class-map type inspect sip [match-all | match-any] class_map_name
hostname(config-cmap)#

Where the class_map_name is the name of the class map. The match-all keyword is the default, and
specifies that traffic must match all criteria to match the class map. The match-any keyword
specifies that the traffic matches the class map if it matches at leX( The CLI enters class-map
configuration mode, where you can enter one or more match commands.
b.

(Optional) To add a description to the class map, enter the following command:
hostname(config-cmap)# description string

Where string is the description of the class map (up to 200 characters).
c.

(Optional) To match a called party, as specified in the To header, enter the following command:
hostname(config-cmap)# match [not] called-party regex {class class_name | regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
d.

(Optional) To match a calling party, as specified in the From header, enter the following command:
hostname(config-cmap)# match [not] calling-party regex {class class_name | regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
e.

(Optional) To match a content length in the SIP header, enter the following command:
hostname(config-cmap)# match [not] content length gt length

Where length is the number of bytes the content length is greater than. 0 to 65536.
f.

(Optional) To match an SDP content type or regular expression, enter the following command:
hostname(config-cmap)# match [not] content type {sdp | regex {class class_name |
regex_name}}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
g.

(Optional) To match a SIP IM subscriber, enter the following command:
hostname(config-cmap)# match [not] im-subscriber regex {class class_name | regex_name}

Cisco ASA 5500 Series Configuration Guide using the CLI

44-21

Chapter 44

Configuring Inspection for Voice and Video Protocols

SIP Inspection

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
h.

(Optional) To match a SIP via header, enter the following command:
hostname(config-cmap)# match [not] message-path regex {class class_name | regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
i.

(Optional) To match a SIP request method, enter the following command:
hostname(config-cmap)# match [not] request-method method

Where method is the type of method to match (ack, bye, cancel, info, invite, message, notify,
options, prack, refer, register, subscribe, unknown, update).
j.

(Optional) To match the requester of a third-party registration, enter the following command:
hostname(config-cmap)# match [not] third-party-registration regex {class class_name |
regex_name}

Where the regex regex_name argument is the regular expression you created in Step 1. The class
regex_class_name is the regular expression class map you created in Step 2.
k.

(Optional) To match an URI in the SIP headers, enter the following command:
hostname(config-cmap)# match [not] uri {sip | tel} length gt length

Step 4

Where length is the number of bytes the URI is greater than. 0 to 65536.
Create a SIP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect sip policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 5

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 6

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the SIP class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-22

Chapter 44

Configuring Inspection for Voice and Video Protocols
SIP Inspection

The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.
Step 7

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To enable or disable instant messaging, enter the following command:
hostname(config-pmap-p)# im

c.

To enable or disable IP address privacy, enter the following command:
hostname(config-pmap-p)# ip-address-privacy

d.

To enable check on Max-forwards header field being 0 (which cannot be 0 before reaching the
destination), enter the following command:
hostname(config-pmap-p)# max-forwards-validation action {drop | drop-connection |
reset | log} [log]

e.

To enable check on RTP packets flowing on the pinholes for protocol conformance, enter the
following command:
hostname(config-pmap-p)# rtp-conformance [enforce-payloadtype]

Where the enforce-payloadtype keyword enforces the payload type to be audio or video based on
the signaling exchange.
f.

To identify the Server and User-Agent header fields, which expose the software version of either a
server or an endpoint, enter the following command:
hostname(config-pmap-p)# software-version action {mask | log} [log]

Where the mask keyword masks the software version in the SIP messages.
g.

To enable state checking validation, enter the following command:
hostname(config-pmap-p)# state-checking action {drop | drop-connection | reset | log}
[log]

h.

To enable strict verification of the header fields in the SIP messages according to RFC 3261, enter
the following command:
hostname(config-pmap-p)# strict-header-validation action {drop | drop-connection |
reset | log} [log]

i.

To allow non SIP traffic using the well-known SIP signaling port, enter the following command:
hostname(config-pmap-p)# traffic-non-sip

Cisco ASA 5500 Series Configuration Guide using the CLI

44-23

Chapter 44

Configuring Inspection for Voice and Video Protocols

SIP Inspection

j.

To identify the non-SIP URIs present in the Alert-Info and Call-Info header fields, enter the
following command:
hostname(config-pmap-p)# uri-non-sip action {mask | log} [log]

The following example shows how to disable instant messaging over SIP:
hostname(config)# policy-map type inspect sip mymap
hostname(config-pmap)# parameters
hostname(config-pmap-p)# no im
hostname(config)# policy-map global_policy
hostname(config-pmap)# class inspection_default
hostname(config-pmap-c)# inspect sip mymap
hostname(config)# service-policy global_policy global

Configuring SIP Timeout Values
The media connections are torn down within two minutes after the connection becomes idle. This is,
however, a configurable timeout and can be set for a shorter or longer period of time. To configure the
timeout for the SIP control connection, enter the following command:
hostname(config)# timeout sip hh:mm:ss

This command configures the idle timeout after which a SIP control connection is closed.
To configure the timeout for the SIP media connection, enter the following command:
hostname(config)# timeout sip_media hh:mm:ss

This command configures the idle timeout after which a SIP media connection is closed.

Verifying and Monitoring SIP Inspection
The show sip command assists in troubleshooting SIP inspection engine issues and is described with the
inspect protocol sip udp 5060 command. The show timeout sip command displays the timeout value
of the designated protocol.
The show sip command displays information for SIP sessions established across the ASA. Along with
the debug sip and show local-host commands, this command is used for troubleshooting SIP inspection
engine issues.

Note

We recommend that you configure the pager command before entering the show sip command. If there
are a lot of SIP session records and the pager command is not configured, it takes a while for the show
sip command output to reach its end.
The following is sample output from the show sip command:
hostname# show sip
Total: 2
call-id c3943000-960ca-2e43-228f@10.130.56.44
state Call init, idle 0:00:01
call-id c3943000-860ca-7e1f-11f7@10.130.56.45

Cisco ASA 5500 Series Configuration Guide using the CLI

44-24

Chapter 44

Configuring Inspection for Voice and Video Protocols
Skinny (SCCP) Inspection

state Active, idle 0:00:06

This sample shows two active SIP sessions on the ASA (as shown in the Total field). Each call-id
represents a call.
The first session, with the call-id c3943000-960ca-2e43-228f@10.130.56.44, is in the state Call Init,
which means the session is still in call setup. Call setup is not complete until a final response to the call
has been received. For instance, the caller has already sent the INVITE, and maybe received a 100
Response, but has not yet seen the 200 OK, so the call setup is not complete yet. Any non-1xx response
message is considered a final response. This session has been idle for 1 second.
The second session is in the state Active, in which call setup is complete and the endpoints are
exchanging media. This session has been idle for 6 seconds.

Skinny (SCCP) Inspection
This section describes SCCP application inspection. This section includes the following topics:
•

SCCP Inspection Overview, page 44-25

•

Supporting Cisco IP Phones, page 44-26

•

Restrictions and Limitations, page 44-26

•

Configuring a Skinny (SCCP) Inspection Policy Map for Additional Inspection Control, page 44-26

•

Verifying and Monitoring SIP Inspection, page 44-24

SCCP Inspection Overview
Note

For specific information about setting up the Phone Proxy on the ASA, which is part of the Cisco Unified
Communications architecture and supports IP phone deployment, see Chapter 48, “Configuring the
Cisco Phone Proxy.”.
Skinny (SCCP) is a simplified protocol used in VoIP networks. Cisco IP Phones using SCCP can coexist
in an H.323 environment. When used with Cisco CallManager, the SCCP client can interoperate with
H.323 compliant terminals.
The ASA supports PAT and NAT for SCCP. PAT is necessary if you have more IP phones than global IP
addresses for the IP phones to use. By supporting NAT and PAT of SCCP Signaling packets, Skinny
application inspection ensures that all SCCP signalling and media packets can traverse the ASA.
Normal traffic between Cisco CallManager and Cisco IP Phones uses SCCP and is handled by SCCP
inspection without any special configuration. The ASA also supports DHCP options 150 and 66, which
it accomplishes by sending the location of a TFTP server to Cisco IP Phones and other DHCP clients.
Cisco IP Phones might also include DHCP option 3 in their requests, which sets the default route. For
more information, see the “Using Cisco IP Phones with a DHCP Server” section on page 11-6.

Note

The ASA supports inspection of traffic from Cisco IP Phones running SCCP protocol version 19 and
earlier.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-25

Chapter 44

Configuring Inspection for Voice and Video Protocols

Skinny (SCCP) Inspection

Supporting Cisco IP Phones
Note

For specific information about setting up the Phone Proxy on the ASA, which is part of the Cisco Unified
Communications architecture and supports IP phone deployment, see Chapter 48, “Configuring the
Cisco Phone Proxy.”
In topologies where Cisco CallManager is located on the higher security interface with respect to the
Cisco IP Phones, if NAT is required for the Cisco CallManager IP address, the mapping must be static
as a Cisco IP Phone requires the Cisco CallManager IP address to be specified explicitly in its
configuration. An static identity entry allows the Cisco CallManager on the higher security interface to
accept registrations from the Cisco IP Phones.
Cisco IP Phones require access to a TFTP server to download the configuration information they need
to connect to the Cisco CallManager server.
When the Cisco IP Phones are on a lower security interface compared to the TFTP server, you must use
an access list to connect to the protected TFTP server on UDP port 69. While you do need a static entry
for the TFTP server, this does not have to be an identity static entry. When using NAT, an identity static
entry maps to the same IP address. When using PAT, it maps to the same IP address and port.
When the Cisco IP Phones are on a higher security interface compared to the TFTP server and
Cisco CallManager, no access list or static entry is required to allow the Cisco IP Phones to initiate the
connection.

Restrictions and Limitations
The following are limitations that apply to the current version of PAT and NAT support for SCCP:
•

PAT does not work with configurations containing the alias command.

•

Outside NAT or PAT is not supported.

If the address of an internal Cisco CallManager is configured for NAT or PAT to a different IP address
or port, registrations for external Cisco IP Phones fail because the ASA currently does not support NAT
or PAT for the file content transferred over TFTP. Although the ASA supports NAT of TFTP messages
and opens a pinhole for the TFTP file, the ASA cannot translate the Cisco CallManager IP address and
port embedded in the Cisco IP Phone configuration files that are transferred by TFTP during phone
registration.

Note

The ASA supports stateful failover of SCCP calls except for calls that are in the middle of call setup.

Configuring a Skinny (SCCP) Inspection Policy Map for Additional Inspection
Control
To specify actions when a message violates a parameter, create an SCCP inspection policy map. You can
then apply the inspection policy map when you enable SCCP inspection.

Cisco ASA 5500 Series Configuration Guide using the CLI

44-26

Chapter 44

Configuring Inspection for Voice and Video Protocols
Skinny (SCCP) Inspection

To create an SCCP inspection policy map, perform the following steps:
Step 1

(Optional) Add one or more regular expressions for use in traffic matching commands according to the
“Configuring Regular Expressions” section on page 13-12. See the types of text you can match in the
match commands described in Step 3.

Step 2

(Optional) Create one or more regular expression class maps to group regular expressions according to
the “Creating a Regular Expression Class Map” section on page 13-15.

Step 3

Create an SCCP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect skinny policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 4

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 5

To apply actions to matching traffic, perform the following steps.
a.

Specify the traffic on which you want to perform actions using one of the following methods:
•

Specify the SCCP class map that you created in Step 3 by entering the following command:
hostname(config-pmap)# class class_map_name
hostname(config-pmap-c)#

•

b.

Specify traffic directly in the policy map using one of the match commands described in Step 3.
If you use a match not command, then any traffic that does not match the criterion in the match
not command has the action applied.

Specify the action you want to perform on the matching traffic by entering the following command:
hostname(config-pmap-c)# {[drop [send-protocol-error] |
drop-connection [send-protocol-error]| mask | reset] [log] | rate-limit message_rate}

Not all options are available for each match or class command. See the CLI help or the command
reference for the exact options available.
The drop keyword drops all packets that match.
The send-protocol-error keyword sends a protocol error message.
The drop-connection keyword drops the packet and closes the connection.
The mask keyword masks out the matching portion of the packet.
The reset keyword drops the packet, closes the connection, and sends a TCP reset to the server
and/or client.
The log keyword, which you can use alone or with one of the other keywords, sends a system log
message.
The rate-limit message_rate argument limits the rate of messages.
Step 6

You can specify multiple class or match commands in the policy map. For information about the order
of class and match commands, see the “Defining Actions in an Inspection Policy Map” section on
page 33-2.To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

Cisco ASA 5500 Series Configuration Guide using the CLI

44-27

Chapter 44

Configuring Inspection for Voice and Video Protocols

Skinny (SCCP) Inspection

b.

To enforce registration before calls can be placed, enter the following command:
hostname(config-pmap-p)# enforce-registration

c.

To set the maximum SCCP station message ID allowed, enter the following command:
hostname(config-pmap-p)# message-ID max hex_value

Where the hex_value argument is the station message ID in hex.
d.

To check RTP packets flowing on the pinholes for protocol conformance, enter the following
command:
hostname(config-pmap-p)# rtp-conformance [enforce-payloadtype]

Where the enforce-payloadtype keyword enforces the payload type to be audio or video based on
the signaling exchange.
e.

To set the maximum and minimum SCCP prefix length value allowed, enter the following command:
hostname(config-pmap-p)# sccp-prefix-len {max | min} value_length

Where the value_length argument is a maximum or minimum value.
f.

To configure the timeout value for signaling and media connections, enter the following command:
hostname(config-pmap-p)# timeout

The following example shows how to define an SCCP inspection policy map.
hostname(config)# policy-map type inspect skinny skinny-map
hostname(config-pmap)# parameters
hostname(config-pmap-p)# enforce-registration
hostname(config-pmap-p)# match message-id range 200 300
hostname(config-pmap-p)# drop log
hostname(config)# class-map inspection_default
hostname(config-cmap)# match default-inspection-traffic
hostname(config)# policy-map global_policy
hostname(config-pmap)# class inspection_default
hostname(config-pmap-c)# inspect skinny skinny-map
hostname(config)# service-policy global_policy global

Verifying and Monitoring SCCP Inspection
The show skinny command assists in troubleshooting SCCP (Skinny) inspection engine issues. The
following is sample output from the show skinny command under the following conditions. There are
two active Skinny sessions set up across the ASA. The first one is established between an internal Cisco
IP Phone at local address 10.0.0.11 and an external Cisco CallManager at 172.18.1.33. TCP port 2000
is the CallManager. The second one is established between another internal Cisco IP Phone at local
address 10.0.0.22 and the same Cisco CallManager.
hostname# show skinny
LOCAL
FOREIGN
STATE
--------------------------------------------------------------1
10.0.0.11/52238
172.18.1.33/2000
1
MEDIA 10.0.0.11/22948
172.18.1.22/20798
2
10.0.0.22/52232
172.18.1.33/2000
1
MEDIA 10.0.0.22/20798
172.18.1.11/22948

Cisco ASA 5500 Series Configuration Guide using the CLI

44-28

Chapter 44

Configuring Inspection for Voice and Video Protocols
Skinny (SCCP) Inspection

The output indicates that a call has been established between two internal Cisco IP Phones. The RTP
listening ports of the first and second phones are UDP 22948 and 20798 respectively.
The following is sample output from the show xlate debug command for these Skinny connections:
hostname# show xlate debug
2 in use, 2 most used
Flags: D - DNS, d - dump, I - identity, i - inside, n - no random,
r - portmap, s - static
NAT from inside:10.0.0.11 to outside:172.18.1.11 flags si idle 0:00:16 timeout 0:05:00
NAT from inside:10.0.0.22 to outside:172.18.1.22 flags si idle 0:00:14 timeout 0:05:00

Cisco ASA 5500 Series Configuration Guide using the CLI

44-29

Chapter 44
Skinny (SCCP) Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

44-30

Configuring Inspection for Voice and Video Protocols

CH A P T E R

45

Configuring Inspection of Database and
Directory Protocols
This chapter describes how to configure application layer protocol inspection. Inspection engines are
required for services that embed IP addressing information in the user data packet or that open secondary
channels on dynamically assigned ports. These protocols require the ASA to do a deep packet inspection
instead of passing the packet through the fast path. As a result, inspection engines can affect overall
throughput.
Several common inspection engines are enabled on the ASA by default, but you might need to enable
others depending on your network.
This chapter includes the following sections:
•

ILS Inspection, page 45-1

•

SQL*Net Inspection, page 45-2

•

Sun RPC Inspection, page 45-3

ILS Inspection
The ILS inspection engine provides NAT support for Microsoft NetMeeting, SiteServer, and Active
Directory products that use LDAP to exchange directory information with an ILS server.
The ASA supports NAT for ILS, which is used to register and locate endpoints in the ILS or SiteServer
Directory. PAT cannot be supported because only IP addresses are stored by an LDAP database.
For search responses, when the LDAP server is located outside, NAT should be considered to allow
internal peers to communicate locally while registered to external LDAP servers. For such search
responses, xlates are searched first, and then DNAT entries to obtain the correct address. If both of these
searches fail, then the address is not changed. For sites using NAT 0 (no NAT) and not expecting DNAT
interaction, we recommend that the inspection engine be turned off to provide better performance.
Additional configuration may be necessary when the ILS server is located inside the ASA border. This
would require a hole for outside clients to access the LDAP server on the specified port, typically TCP
389.
Because ILS traffic only occurs on the secondary UDP channel, the TCP connection is disconnected after
the TCP inactivity interval. By default, this interval is 60 minutes and can be adjusted using the timeout
command.
ILS/LDAP follows a client/server model with sessions handled over a single TCP connection.
Depending on the client's actions, several of these sessions may be created.

Cisco ASA 5500 Series Configuration Guide using the CLI

45-1

Chapter 45

Configuring Inspection of Database and Directory Protocols

SQL*Net Inspection

During connection negotiation time, a BIND PDU is sent from the client to the server. Once a successful
BIND RESPONSE from the server is received, other operational messages may be exchanged (such as
ADD, DEL, SEARCH, or MODIFY) to perform operations on the ILS Directory. The ADD REQUEST
and SEARCH RESPONSE PDUs may contain IP addresses of NetMeeting peers, used by H.323 (SETUP
and CONNECT messages) to establish the NetMeeting sessions. Microsoft NetMeeting v2.X and v3.X
provides ILS support.
The ILS inspection performs the following operations:
•

Decodes the LDAP REQUEST/RESPONSE PDUs using the BER decode functions

•

Parses the LDAP packet

•

Extracts IP addresses

•

Translates IP addresses as necessary

•

Encodes the PDU with translated addresses using BER encode functions

•

Copies the newly encoded PDU back to the TCP packet

•

Performs incremental TCP checksum and sequence number adjustment

ILS inspection has the following limitations:

Note

•

Referral requests and responses are not supported

•

Users in multiple directories are not unified

•

Single users having multiple identities in multiple directories cannot be recognized by NAT

Because H225 call signalling traffic only occurs on the secondary UDP channel, the TCP connection is
disconnected after the interval specified by the TCP timeout command. By default, this interval is set at
60 minutes.

SQL*Net Inspection
SQL*Net inspection is enabled by default.
The SQL*Net protocol consists of different packet types that the ASA handles to make the data stream
appear consistent to the Oracle applications on either side of the ASA.
The default port assignment for SQL*Net is 1521. This is the value used by Oracle for SQL*Net, but
this value does not agree with IANA port assignments for Structured Query Language (SQL). Use the
class-map command to apply SQL*Net inspection to a range of port numbers.

Note

Disable SQL*Net inspection when SQL data transfer occurs on the same port as the SQL control TCP
port 1521. The security appliance acts as a proxy when SQL*Net inspection is enabled and reduces the
client window size from 65000 to about 16000 causing data transfer issues.
The ASA translates all addresses and looks in the packets for all embedded ports to open for SQL*Net
Version 1.
For SQL*Net Version 2, all DATA or REDIRECT packets that immediately follow REDIRECT packets
with a zero data length will be fixed up.
The packets that need fix-up contain embedded host/port addresses in the following format:
(ADDRESS=(PROTOCOL=tcp)(DEV=6)(HOST=a.b.c.d)(PORT=a))

Cisco ASA 5500 Series Configuration Guide using the CLI

45-2

Chapter 45

Configuring Inspection of Database and Directory Protocols
Sun RPC Inspection

SQL*Net Version 2 TNSFrame types (Connect, Accept, Refuse, Resend, and Marker) will not be
scanned for addresses to NAT nor will inspection open dynamic connections for any embedded ports in
the packet.
SQL*Net Version 2 TNSFrames, Redirect, and Data packets will be scanned for ports to open and
addresses to NAT, if preceded by a REDIRECT TNSFrame type with a zero data length for the payload.
When the Redirect message with data length zero passes through the ASA, a flag will be set in the
connection data structure to expect the Data or Redirect message that follows to be translated and ports
to be dynamically opened. If one of the TNS frames in the preceding paragraph arrive after the Redirect
message, the flag will be reset.
The SQL*Net inspection engine will recalculate the checksum, change IP, TCP lengths, and readjust
Sequence Numbers and Acknowledgment Numbers using the delta of the length of the new and old
message.
SQL*Net Version 1 is assumed for all other cases. TNSFrame types (Connect, Accept, Refuse, Resend,
Marker, Redirect, and Data) and all packets will be scanned for ports and addresses. Addresses will be
translated and port connections will be opened.

Sun RPC Inspection
This section describes Sun RPC application inspection. This section includes the following topics:
•

Sun RPC Inspection Overview, page 45-3

•

Managing Sun RPC Services, page 45-4

•

Verifying and Monitoring Sun RPC Inspection, page 45-4

Sun RPC Inspection Overview
The Sun RPC inspection engine enables or disables application inspection for the Sun RPC protocol. Sun
RPC is used by NFS and NIS. Sun RPC services can run on any port. When a client attempts to access
an Sun RPC service on a server, it must learn the port that service is running on. It does this by querying
the port mapper process, usually rpcbind, on the well-known port of 111.
The client sends the Sun RPC program number of the service and the port mapper process responds with
the port number of the service. The client sends its Sun RPC queries to the server, specifying the port
identified by the port mapper process. When the server replies, the ASA intercepts this packet and opens
both embryonic TCP and UDP connections on that port.
When you configure dynamic access lists on the ASA, they are supported on the ingress direction only
and the ASA drops egress traffic destined to dynamic ports. Therefore, Sun RPC inspection implements
a pinhole mechanism to support egress traffic. Sun RPC inspection uses this pinhole mechanism to
support outbound dynamic access lists.
To view the dynamic access lists configured for the ASA, use the show asp table classify domain
permit command. For information about the show asp table classify domain permit command, see the
CLI configuration guide.

Note

Sun RPC inspection has the limitation that NAT or PAT of Sun RPC payload information is not
supported.

Cisco ASA 5500 Series Configuration Guide using the CLI

45-3

Chapter 45

Configuring Inspection of Database and Directory Protocols

Sun RPC Inspection

Managing Sun RPC Services
Use the Sun RPC services table to control Sun RPC traffic through the ASA based on established Sun
RPC sessions. To create entries in the Sun RPC services table, use the sunrpc-server command in global
configuration mode:
hostname(config)# sunrpc-server interface_name ip_address mask service service_type
protocol {tcp | udp} port[-port] timeout hh:mm:ss

You can use this command to specify the timeout after which the pinhole that was opened by Sun RPC
application inspection will be closed. For example, to create a timeout of 30 minutes to the Sun RPC
server with the IP address 192.168.100.2, enter the following command:
hostname(config)# sunrpc-server inside 192.168.100.2 255.255.255.255 service 100003
protocol tcp 111 timeout 00:30:00

This command specifies that the pinhole that was opened by Sun RPC application inspection will be
closed after 30 minutes. In this example, the Sun RPC server is on the inside interface using TCP port
111. You can also specify UDP, a different port number, or a range of ports. To specify a range of ports,
separate the starting and ending port numbers in the range with a hyphen (for example, 111-113).
The service type identifies the mapping between a specific service type and the port number used for the
service. To determine the service type, which in this example is 100003, use the sunrpcinfo command
at the UNIX or Linux command line on the Sun RPC server machine.
To clear the Sun RPC configuration, enter the following command.
hostname(config)# clear configure sunrpc-server

This removes the configuration performed using the sunrpc-server command. The sunrpc-server
command allows pinholes to be created with a specified timeout.
To clear the active Sun RPC services, enter the following command:
hostname(config)# clear sunrpc-server active

This clears the pinholes that are opened by Sun RPC application inspection for specific services, such
as NFS or NIS.

Verifying and Monitoring Sun RPC Inspection
The sample output in this section is for a Sun RPC server with an IP address of 192.168.100.2 on the
inside interface and a Sun RPC client with an IP address of 209.168.200.5 on the outside interface.
To view information about the current Sun RPC connections, enter the show conn command. The
following is sample output from the show conn command:
hostname# show conn
15 in use, 21 most used
UDP out 209.165.200.5:800 in 192.168.100.2:2049 idle 0:00:04 flags UDP out 209.165.200.5:714 in 192.168.100.2:111 idle 0:00:04 flags UDP out 209.165.200.5:712 in 192.168.100.2:647 idle 0:00:05 flags UDP out 192.168.100.2:0 in 209.165.200.5:714 idle 0:00:05 flags i
hostname(config)#

To display the information about the Sun RPC service table configuration, enter the show
running-config sunrpc-server command. The following is sample output from the show
running-config sunrpc-server command:
hostname(config)# show running-config sunrpc-server

Cisco ASA 5500 Series Configuration Guide using the CLI

45-4

Chapter 45

Configuring Inspection of Database and Directory Protocols
Sun RPC Inspection

sunrpc-server inside 192.168.100.2 255.255.255.255 service 100003 protocol UDP port 111
timeout 0:30:00
sunrpc-server inside 192.168.100.2 255.255.255.255 service 100005 protocol UDP port 111
timeout 0:30:00

This output shows that a timeout interval of 30 minutes is configured on UDP port 111 for the Sun RPC
server with the IP address 192.168.100.2 on the inside interface.
To display the pinholes open for Sun RPC services, enter the show sunrpc-server active command. The
following is sample output from show sunrpc-server active command:
hostname# show sunrpc-server active
LOCAL FOREIGN SERVICE TIMEOUT
----------------------------------------------1 209.165.200.5/0 192.168.100.2/2049 100003 0:30:00
2 209.165.200.5/0 192.168.100.2/2049 100003 0:30:00
3 209.165.200.5/0 192.168.100.2/647 100005 0:30:00
4 209.165.200.5/0 192.168.100.2/650 100005 0:30:00

The entry in the LOCAL column shows the IP address of the client or server on the inside interface, while
the value in the FOREIGN column shows the IP address of the client or server on the outside interface.
To view information about the Sun RPC services running on a Sun RPC server, enter the rpcinfo -p
command from the Linux or UNIX server command line. The following is sample output from the
rpcinfo -p command:
sunrpcserver:~ # rpcinfo -p
program vers proto port
100000 2 tcp 111 portmapper
100000 2 udp 111 portmapper
100024 1 udp 632 status
100024 1 tcp 635 status
100003 2 udp 2049 nfs
100003 3 udp 2049 nfs
100003 2 tcp 2049 nfs
100003 3 tcp 2049 nfs
100021 1 udp 32771 nlockmgr
100021 3 udp 32771 nlockmgr
100021 4 udp 32771 nlockmgr
100021 1 tcp 32852 nlockmgr
100021 3 tcp 32852 nlockmgr
100021 4 tcp 32852 nlockmgr
100005 1 udp 647 mountd
100005 1 tcp 650 mountd
100005 2 udp 647 mountd
100005 2 tcp 650 mountd
100005 3 udp 647 mountd
100005 3 tcp 650 mountd

In this output, port 647 corresponds to the mountd daemon running over UDP. The mountd process
would more commonly be using port 32780. The mountd process running over TCP uses port 650 in this
example.

Cisco ASA 5500 Series Configuration Guide using the CLI

45-5

Chapter 45
Sun RPC Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

45-6

Configuring Inspection of Database and Directory Protocols

CH A P T E R

46

Configuring Inspection for Management
Application Protocols
This chapter describes how to configure application layer protocol inspection. Inspection engines are
required for services that embed IP addressing information in the user data packet or that open secondary
channels on dynamically assigned ports. These protocols require the ASA to do a deep packet inspection
instead of passing the packet through the fast path. As a result, inspection engines can affect overall
throughput.
Several common inspection engines are enabled on the ASA by default, but you might need to enable
others depending on your network.
This chapter includes the following sections:
•

DCERPC Inspection, page 46-1

•

GTP Inspection, page 46-3

•

RADIUS Accounting Inspection, page 46-9

•

RSH Inspection, page 46-11

•

SNMP Inspection, page 46-11

•

XDMCP Inspection, page 46-12

DCERPC Inspection
This section describes the DCERPC inspection engine. This section includes the following topics:
•

DCERPC Overview, page 46-1

•

Configuring a DCERPC Inspection Policy Map for Additional Inspection Control, page 46-2

DCERPC Overview
DCERPC is a protocol widely used by Microsoft distributed client and server applications that allows
software clients to execute programs on a server remotely.
This typically involves a client querying a server called the Endpoint Mapper listening on a well known
port number for the dynamically allocated network information of a required service. The client then sets
up a secondary connection to the server instance providing the service. The security appliance allows the
appropriate port number and network address and also applies NAT, if needed, for the secondary
connection.

Cisco ASA 5500 Series Configuration Guide using the CLI

46-1

Chapter 46

Configuring Inspection for Management Application Protocols

DCERPC Inspection

DCERPC inspect maps inspect for native TCP communication between the EPM and client on well
known TCP port 135. Map and lookup operations of the EPM are supported for clients. Client and server
can be located in any security zone. The embedded server IP address and Port number are received from
the applicable EPM response messages. Since a client may attempt multiple connections to the server
port returned by EPM, multiple use of pinholes are allowed, which have user configurable timeouts.

Note

DCERPC inspection only supports communication between the EPM and clients to open pinholes
through theASA. Clients using RPC communication that does not use the EPM is not supported with
DCERPC inspection.

Configuring a DCERPC Inspection Policy Map for Additional Inspection Control
To specify additional DCERPC inspection parameters, create a DCERPC inspection policy map. You can
then apply the inspection policy map when you enable DCERPC inspection.
To create a DCERPC inspection policy map, perform the following steps:
Step 1

Create a DCERPC inspection policy map, enter the following command:
hostname(config)# policy-map type inspect dcerpc policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 2

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 3

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

b.

To configure the timeout for DCERPC pinholes and override the global system pinhole timeout of
two minutes, enter the following command:
hostname(config-pmap-p)# timeout pinhole hh:mm:ss

Where the hh:mm:ss argument is the timeout for pinhole connections. Value is between 0:0:1 and
1193:0:0.
c.

To configure options for the endpoint mapper traffic, enter the following command:
hostname(config-pmap-p)# endpoint-mapper [epm-service-only] [lookup-operation
[timeout hh:mm:ss]]

Where the hh:mm:ss argument is the timeout for pinholes generated from the lookup operation. If
no timeout is configured for the lookup operation, the timeout pinhole command or the default is
used. The epm-service-only keyword enforces endpoint mapper service during binding so that only
its service traffic is processed. The lookup-operation keyword enables the lookup operation of the
endpoint mapper service.

Cisco ASA 5500 Series Configuration Guide using the CLI

46-2

Chapter 46

Configuring Inspection for Management Application Protocols
GTP Inspection

The following example shows how to define a DCERPC inspection policy map with the timeout
configured for DCERPC pinholes.
hostname(config)# policy-map type inspect dcerpc dcerpc_map
hostname(config-pmap)# timeout pinhole 0:10:00
hostname(config)# class-map dcerpc
hostname(config-cmap)# match port tcp eq 135
hostname(config)# policy-map global-policy
hostname(config-pmap)# class dcerpc
hostname(config-pmap-c)# inspect dcerpc dcerpc-map
hostname(config)# service-policy global-policy global

GTP Inspection
This section describes the GTP inspection engine. This section includes the following topics:

Note

•

GTP Inspection Overview, page 46-3

•

Configuring a GTP Inspection Policy Map for Additional Inspection Control, page 46-4

•

Verifying and Monitoring GTP Inspection, page 46-8

GTP inspection requires a special license. If you enter GTP-related commands on a ASA without the
required license, the ASA displays an error message.

GTP Inspection Overview
GPRS provides uninterrupted connectivity for mobile subscribers between GSM networks and corporate
networks or the Internet. The GGSN is the interface between the GPRS wireless data network and other
networks. The SGSN performs mobility, data session management, and data compression (See
Figure 46-1).

Cisco ASA 5500 Series Configuration Guide using the CLI

46-3

Chapter 46

Configuring Inspection for Management Application Protocols

GTP Inspection

Figure 46-1

GPRS Tunneling Protocol

Internet
Home PLMN
MS
SGSN

Gn

GGSN Gi

Corporate
network 2

Gp
Corporate
network 1

Roaming partner
(visited PLMN)

119935

GRX

The UMTS is the commercial convergence of fixed-line telephony, mobile, Internet and computer
technology. UTRAN is the networking protocol used for implementing wireless networks in this system.
GTP allows multi-protocol packets to be tunneled through a UMTS/GPRS backbone between a GGSN,
an SGSN and the UTRAN.
GTP does not include any inherent security or encryption of user data, but using GTP with the ASA helps
protect your network against these risks.
The SGSN is logically connected to a GGSN using GTP. GTP allows multiprotocol packets to be
tunneled through the GPRS backbone between GSNs. GTP provides a tunnel control and management
protocol that allows the SGSN to provide GPRS network access for a mobile station by creating,
modifying, and deleting tunnels. GTP uses a tunneling mechanism to provide a service for carrying user
data packets.

Note

When using GTP with failover, if a GTP connection is established and the active unit fails before data
is transmitted over the tunnel, the GTP data connection (with a “j” flag set) is not replicated to the
standby unit. This occurs because the active unit does not replicate embryonic connections to the standby
unit.

Configuring a GTP Inspection Policy Map for Additional Inspection Control
If you want to enforce additional parameters on GTP traffic, create and configure a GTP map. If you do
not specify a map with the inspect gtp command, the ASA uses the default GTP map, which is
preconfigured with the following default values:
•

request-queue 200

•

timeout gsn 0:30:00

•

timeout pdp-context 0:30:00

•

timeout request 0:01:00

Cisco ASA 5500 Series Configuration Guide using the CLI

46-4

Chapter 46

Configuring Inspection for Management Application Protocols
GTP Inspection

•

timeout signaling 0:30:00

•

timeout tunnel 0:01:00

•

tunnel-limit 500

To create and configure a GTP map, perform the following steps. You can then apply the GTP map when
you enable GTP inspection according to the “Configuring Application Layer Protocol Inspection”
section on page 42-6.
Step 1

Create a GTP inspection policy map, enter the following command:
hostname(config)# policy-map type inspect gtp policy_map_name
hostname(config-pmap)#

Where the policy_map_name is the name of the policy map. The CLI enters policy-map configuration
mode.
Step 2

(Optional) To add a description to the policy map, enter the following command:
hostname(config-pmap)# description string

Step 3

To match an Access Point name, enter the following command:
hostname(config-pmap)# match [not] apn regex [regex_name | class regex_class_name]

Step 4

To match a message ID, enter the following command:
hostname(config-pmap)# match [not] message id [message_id | range lower_range upper_range]

Where the message_id is an alphanumeric identifier between 1 and 255. The lower_range is lower range
of message IDs. The upper_range is the upper range of message IDs.
Step 5

To match a message length, enter the following command:
hostname(config-pmap)# match [not] message length min min_length max max_length

Where the min_length and max_length are both between 1 and 65536. The length specified by this
command is the sum of the GTP header and the rest of the message, which is the payload of the UDP
packet.
Step 6

To match the version, enter the following command:
hostname(config-pmap)# match [not] version [version_id | range lower_range upper_range]

Where the version_id is between 0and 255. The lower_range is lower range of versions. The
upper_range is the upper range of versions.
Step 7

To configure parameters that affect the inspection engine, perform the following steps:
a.

To enter parameters configuration mode, enter the following command:
hostname(config-pmap)# parameters
hostname(config-pmap-p)#

The mnc network_code argument is a two or three-digit value identifying the network code.
By default, the security appliance does not check for valid MCC/MNC combinations. This command
is used for IMSI Prefix filtering. The MCC and MNC in the IMSI of the received packet is compared
with the MCC/MNC configured with this command and is dropped if it does not match.

Cisco ASA 5500 Series Configuration Guide using the CLI

46-5

Chapter 46

Configuring Inspection for Management Application Protocols

GTP Inspection

This command must be used to enable IMSI Prefix filtering. You can configure multiple instances
to specify permitted MCC and MNC combinations. By default, the ASA does not check the validity
of MNC and MCC combinations, so you must verify the validity of the combinations configured. To
find more information about MCC and MNC codes, see the ITU E.212 recommendation,
Identification Plan for Land Mobile Stations.
b.

To allow invalid GTP packets or packets that otherwise would fail parsing and be dropped, enter the
following command:
hostname(config-pmap-p)# permit errors

By default, all invalid packets or packets that failed, during parsing, are dropped.
c.

To enable support for GSN pooling, use the permit response command.
If the ASA performs GTP inspection, by default the ASA drops GTP responses from GSNs that were
not specified in the GTP request. This situation occurs when you use load-balancing among a pool
of GSNs to provide efficiency and scalability of GPRS.
You can enable support for GSN pooling by using the permit response command. This command
configures the ASA to allow responses from any of a designated set of GSNs, regardless of the GSN
to which a GTP request was sent. You identify the pool of load-balancing GSNs as a network object.
Likewise, you identify the SGSN as a network object. If the GSN responding belongs to the same
object group as the GSN that the GTP request was sent to and if the SGSN is in a object group that
the responding GSN is permitted to send a GTP response to, the ASA permits the response.

d.

To create an object to represent the pool of load-balancing GSNs, perform the following steps:
Use the object-group command to define a new network object group representing the pool of
load-balancing GSNs.
hostname(config)# object-group network GSN-pool-name
hostname(config-network)#

For example, the following command creates an object group named gsnpool32:
hostname(config)# object-group network gsnpool32
hostname(config-network)#

e.

Use the network-object command to specify the load-balancing GSNs. You can do so with one
network-object command per GSN, using the host keyword. You can also using network-object
command to identify whole networks containing GSNs that perform load balancing.
hostname(config-network)# network-object host IP-address

For example, the following commands create three network objects representing individual hosts:
hostname(config-network)# network-object host 192.168.100.1
hostname(config-network)# network-object host 192.168.100.2
hostname(config-network)# network-object host 192.168.100.3
hostname(config-network)#

f.

To create an object to represent the SGSN that the load-balancing GSNs are permitted to respond to,
perform the following steps:
a. Use the object-group command to define a new network object group that will represent the

SGSN that sends GTP requests to the GSN pool.
hostname(config)# object-group network SGSN-name
hostname(config-network)#

For example, the following command creates an object group named sgsn32:
hostname(config)# object-group network sgsn32

Cisco ASA 5500 Series Configuration Guide using the CLI

46-6

Chapter 46

Configuring Inspection for Management Application Protocols
GTP Inspection

hostname(config-network)#

b. Use the network-object command with the host keyword to identify the SGSN.
hostname(config-network)# network-object host IP-address

For example, the following command creates a network objects representing the SGSN:
hostname(config-network)# network-object host 192.168.50.100
hostname(config-network)#

g.

To allow GTP responses from any GSN in the network object representing the GSN pool, defined in
c., d, to the network object representing the SGSN, defined in c., f., enter the following commands:
hostname(config)# gtp-map map_name
hostname(config-gtp-map)# permit response to-object-group SGSN-name from-object-group
GSN-pool-name

For example, the following command permits GTP responses from any host in the object group
named gsnpool32 to the host in the object group named sgsn32:
hostname(config-gtp-map)# permit response to-object-group sgsn32 from-object-group
gsnpool32

The following example shows how to support GSN pooling by defining network objects for the GSN
pool and the SGSN. An entire Class C network is defined as the GSN pool but you can identify
multiple individual IP addresses, one per network-object command, instead of identifying whole
networks. The example then modifies a GTP map to permit responses from the GSN pool to the
SGSN.
hostname(config)# object-group network gsnpool32
hostname(config-network)# network-object 192.168.100.0 255.255.255.0
hostname(config)# object-group network sgsn32
hostname(config-network)# network-object host 192.168.50.100
hostname(config)# gtp-map gtp-policy
hostname(config-gtp-map)# permit response to-object-group sgsn32 from-object-group
gsnpool32

h.

To specify the maximum number of GTP requests that will be queued waiting for a response, enter
the following command:
hostname(config-gtp-map)# request-queue max_requests

where the max_requests argument sets the maximum number of GTP requests that will be queued
waiting for a response, from 1 to 4294967295. The default is 200.
When the limit has been reached and a new request arrives, the request that has been in the queue
for the longest time is removed. The Error Indication, the Version Not Supported and the SGSN
Context Acknowledge messages are not considered as requests and do not enter the request queue
to wait for a response.
i.

To change the inactivity timers for a GTP session, enter the following command:
hostname(config-gtp-map)# timeout {gsn | pdp-context | request | signaling | tunnel}
hh:mm:ss

Enter this command separately for each timeout.
The gsn keyword specifies the period of inactivity after which a GSN will be removed.
The pdp-context keyword specifies the maximum period of time allowed before beginning to
receive the PDP context.

Cisco ASA 5500 Series Configuration Guide using the CLI

46-7

Chapter 46

Configuring Inspection for Management Application Protocols

GTP Inspection

The request keyword specifies the maximum period of time allowed before beginning to receive the
GTP message.
The signaling keyword specifies the period of inactivity after which the GTP signaling will be
removed.
The tunnel keyword specifies the period of inactivity after which the GTP tunnel will be torn down.
The hh:mm:ss argument is the timeout where hh specifies the hour, mm specifies the minutes, and
ss specifies the seconds. The value 0 means never tear down.
j.

To specify the maximum number of GTP tunnels allowed to be active on the ASA, enter the
following command:
hostname(config-gtp-map)# tunnel-limit max_tunnels

where the max_tunnels argument is the maximum number of tunnels allowed, from 1 to
4294967295. The default is 500.
New requests will be dropped once the number of tunnels specified by this command is reached.

The following example shows how to limit the number of tunnels in the network:
hostname(config)# policy-map type inspect gtp gmap
hostname(config-pmap)# parameters
hostname(config-pmap-p)# tunnel-limit 3000
hostname(config)# policy-map global_policy
hostname(config-pmap)# class inspection_default
hostname(config-pmap-c)# inspect gtp gmap
hostname(config)# service-policy global_policy global

Verifying and Monitoring GTP Inspection
To display GTP configuration, enter the show service-policy inspect gtp command in privileged EXEC
mode. For the detailed syntax for this command, see the command page in the command reference.
Use the show service-policy inspect gtp statistics command to show the statistics for GTP inspection.
The following is sample output from the show service-policy inspect gtp statistics command:
hostname# show service-policy inspect gtp statistics
GPRS GTP Statistics:
version_not_support
0
msg_too_short
unknown_msg
0
unexpected_sig_msg
unexpected_data_msg
0
ie_duplicated
mandatory_ie_missing
0
mandatory_ie_incorrect
optional_ie_incorrect
0
ie_unknown
ie_out_of_order
0
ie_unexpected
total_forwarded
0
total_dropped
signalling_msg_dropped
0
data_msg_dropped
signalling_msg_forwarded
0
data_msg_forwarded
total created_pdp
0
total deleted_pdp
total created_pdpmcb
0
total deleted_pdpmcb
pdp_non_existent
0

0
0
0
0
0
0
0
0
0
0
0

You can use the vertical bar (|) to filter the display. Type ?| for more display filtering options.
The following is sample GSN output from the show service-policy inspect gtp statistics gsn command:

Cisco ASA 5500 Series Configuration Guide using the CLI

46-8

Chapter 46

Configuring Inspection for Management Application Protocols
RADIUS Accounting Inspection

hostname# show service-policy inspect gtp statistics gsn 9.9.9.9
1 in use, 1 most used, timeout 0:00:00
GTP GSN Statistics for 9.9.9.9, Idle 0:00:00, restart counter 0
Tunnels Active 0Tunnels Created 0
Tunnels Destroyed 0
Total Messages Received 2
Signaling Messages Data Messages
total received 2 0
dropped 0 0
forwarded 2 0

Use the show service-policy inspect gtp pdp-context command to display PDP context-related
information. The following is sample output from the show service-policy inspect gtp pdp-context
command:
hostname# show service-policy inspect gtp pdp-context detail
1 in use, 1 most used, timeout 0:00:00
Version TID
v1
1234567890123425

MS Addr
10.0.1.1

user_name (IMSI): 214365870921435
primary pdp: Y
sgsn_addr_signal:
10.0.0.2
ggsn_addr_signal:
10.1.1.1
sgsn control teid:
0x000001d1
ggsn control teid:
0x6306ffa0
seq_tpdu_up:
0
signal_sequence:
0
upstream_signal_flow:
0
downstream_signal_flow:
0
RAupdate_flow:
0

SGSN Addr
Idle
10.0.0.2 0:00:13
MS address:
nsapi: 2
sgsn_addr_data:
ggsn_addr_data:
sgsn data teid:
ggsn data teid:
seq_tpdu_down:

APN
gprs.cisco.com

1.1.1.1
10.0.0.2
10.1.1.1
0x000001d3
0x6305f9fc
0

upstream_data_flow:
downstream_data_flow:

0
0

The PDP context is identified by the tunnel ID, which is a combination of the values for IMSI and
NSAPI. A GTP tunnel is defined by two associated PDP contexts in different GSN nodes and is
identified with a Tunnel ID. A GTP tunnel is necessary to forward packets between an external packet
data network and a MS user.
You can use the vertical bar (|) to filter the display, as in the following example:
hostname# show service-policy gtp statistics

|

grep gsn

RADIUS Accounting Inspection
This section describes the IM inspection engine. This section includes the following topics:
•

RADIUS Accounting Inspection Overview, page 46-9

•

Configuring a RADIUS Inspection Policy Map for Additional Inspection Control, page 46-10

RADIUS Accounting Inspection Overview
One of the well known problems is the over-billing attack in GPRS networks. The over-billing attack
can cause consumers anger and frustration by being billed for services that they have not used. In this
case, a malicious attacker sets up a connection to a server and obtains an IP address from the SGSN.
When the attacker ends the call, the malicious server will still send packets to it, which gets dropped by

Cisco ASA 5500 Series Configuration Guide using the CLI

46-9

Chapter 46

Configuring Inspection for Management Application Protocols

RADIUS Accounting Inspection

the GGSN, but the connection from the server remains active. The IP address assigned to the malicious
attacker gets released and reassigned to a legitimate user who will then get billed for services that the
attacker will use.
RADIUS accounting inspection prevents this type of attack by ensuring the traffic seen by the GGSN is
legitimate. With the RADIUS accounting feature properly configured, the security appliance tears down
a connection based on matching the Framed IP attribute in the Radius Accounting Request Start message
with the Radius Accounting Request Stop message. When the Stop message is seen with the matching
IP address in the Framed IP attribute, the security appliance looks for all connections with the source
matching the IP address.
You have the option to configure a secret pre-shared key with the RADIUS server so the security
appliance can validate the message. If the shared secret is not configured, the security appliance does
not need to validate the source of the message and will only check that the source IP address is one of
the configured addresses allowed to send the RADIUS messages.

Note

When using RADIUS accounting inspection with GPRS enabled, theASA checks for the
3GPP-Session-Stop-Indicator in the Accounting Request STOP messages to properly handle secondary
PDP contexts. Specifically, the ASA requires that the Accounting Request STOP messages include the
3GPP-SGSN-Address attribute before it will temrinate the user sessions and all associated connections.
Some third-party GGSNs might not send this attribute by default.

Configuring a RADIUS Inspection Policy Map for Additional Inspection Control
In order to use this feature, the radius-accounting-map will need to be specified in the policy-map type
management and then applied to the service-policy using the new control-plane keyword to specify that
this traffic is for to-the-box inspection.
The following example shows the complete set of commands in context to properly configure this
feature:
Step 1

Configure the class map and the port:
class-map type management c1
match port udp eq 1888

Step 2

Create the policy map, and configure the parameters for RADIUS accounting inspection using the
parameter command to access the proper mode to configure the attributes, host, and key.
policy-map type inspect radius-accounting radius_accounting_map
parameters
host 10.1.1.1 inside key 123456789
send response
enable gprs
validate-attribute 22

Step 3

Configure the service policy and control-plane keywords.
policy-map type management global_policy
class c1
inspect radius-accounting radius_accounting_map
service-policy global_policy control-plane abc global

Cisco ASA 5500 Series Configuration Guide using the CLI

46-10

Chapter 46

Configuring Inspection for Management Application Protocols
RSH Inspection

RSH Inspection
RSH inspection is enabled by default. The RSH protocol uses a TCP connection from the RSH client to
the RSH server on TCP port 514. The client and server negotiate the TCP port number where the client
listens for the STDERR output stream. RSH inspection supports NAT of the negotiated port number if
necessary.

SNMP Inspection
This section describes the IM inspection engine. This section includes the following topics:
•

SNMP Inspection Overview, page 46-11

•

Configuring an SNMP Inspection Policy Map for Additional Inspection Control, page 46-11

SNMP Inspection Overview
SNMP application inspection lets you restrict SNMP traffic to a specific version of SNMP. Earlier
versions of SNMP are less secure; therefore, denying certain SNMP versions may be required by your
security policy. The ASA can deny SNMP versions 1, 2, 2c, or 3. You control the versions permitted by
creating an SNMP map.
You then apply the SNMP map when you enable SNMP inspection according to the “Configuring
Application Layer Protocol Inspection” section on page 42-6.

Configuring an SNMP Inspection Policy Map for Additional Inspection Control
To create an SNMP inspection policy map, perform the following steps:
Step 1

To create an SNMP map, enter the following command:
hostname(config)# snmp-map map_name
hostname(config-snmp-map)#

where map_name is the name of the SNMP map. The CLI enters SNMP map configuration mode.
Step 2

To specify the versions of SNMP to deny, enter the following command for each version:
hostname(config-snmp-map)# deny version version
hostname(config-snmp-map)#

where version is 1, 2, 2c, or 3.

The following example denies SNMP Versions 1 and 2:
hostname(config)# snmp-map sample_map
hostname(config-snmp-map)# deny version 1
hostname(config-snmp-map)# deny version 2

Cisco ASA 5500 Series Configuration Guide using the CLI

46-11

Chapter 46

Configuring Inspection for Management Application Protocols

XDMCP Inspection

XDMCP Inspection
XDMCP inspection is enabled by default; however, the XDMCP inspection engine is dependent upon
proper configuration of the established command.
XDMCP is a protocol that uses UDP port 177 to negotiate X sessions, which use TCP when established.
For successful negotiation and start of an XWindows session, the ASA must allow the TCP back
connection from the Xhosted computer. To permit the back connection, use the established command
on the ASA. Once XDMCP negotiates the port to send the display, The established command is
consulted to verify if this back connection should be permitted.
During the XWindows session, the manager talks to the display Xserver on the well-known port 6000 |
n. Each display has a separate connection to the Xserver, as a result of the following terminal setting.
setenv DISPLAY Xserver:n

where n is the display number.
When XDMCP is used, the display is negotiated using IP addresses, which the ASA can NAT if needed.
XDCMP inspection does not support PAT.

Cisco ASA 5500 Series Configuration Guide using the CLI

46-12

Chapter 46

Configuring Inspection for Management Application Protocols
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-13

Chapter 46
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-14

Configuring Inspection for Management Application Protocols

Chapter 46

Configuring Inspection for Management Application Protocols
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-15

Chapter 46
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-16

Configuring Inspection for Management Application Protocols

Chapter 46

Configuring Inspection for Management Application Protocols
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-17

Chapter 46
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-18

Configuring Inspection for Management Application Protocols

Chapter 46

Configuring Inspection for Management Application Protocols
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-19

Chapter 46
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-20

Configuring Inspection for Management Application Protocols

Chapter 46

Configuring Inspection for Management Application Protocols
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-21

Chapter 46
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-22

Configuring Inspection for Management Application Protocols

Chapter 46

Configuring Inspection for Management Application Protocols
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-23

Chapter 46
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-24

Configuring Inspection for Management Application Protocols

Chapter 46

Configuring Inspection for Management Application Protocols
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-25

Chapter 46
XDMCP Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

46-26

Configuring Inspection for Management Application Protocols

PA R T

11

Configuring Unified Communications

CH A P T E R

47

Information About Cisco Unified
Communications Proxy Features
This chapter describes how to configure the adaptive security appliance for Cisco Unified
Communications Proxy features.
This chapter includes the following sections:
•

Information About the Adaptive Security Appliance in Cisco Unified Communications, page 47-1

•

TLS Proxy Applications in Cisco Unified Communications, page 47-3

•

Licensing for Cisco Unified Communications Proxy Features, page 47-4

Information About the Adaptive Security Appliance in Cisco
Unified Communications
This section describes the Cisco UC Proxy features on the Cisco ASA 5500 series appliances. The
purpose of a proxy is to terminate and reoriginate connections between a client and server. The proxy
delivers a range of security functions such as traffic inspection, protocol conformance, and policy control
to ensure security for the internal network. An increasingly popular function of a proxy is to terminate
encrypted connections in order to apply security policies while maintaining confidentiality of
connections. The Cisco ASA 5500 Series appliances are a strategic platform to provide proxy functions
for unified communications deployments.
The Cisco UC Proxy includes the following solutions:
Phone Proxy: Secure remote access for Cisco encrypted endpoints, and VLAN traversal for Cisco softphones

The phone proxy feature enables termination of Cisco SRTP/TLS-encrypted endpoints for secure remote
access. The phone proxy allows large scale deployments of secure phones without a large scale VPN
remote access hardware deployment. End-user infrastructure is limited to just the IP endpoint, without
VPN tunnels or hardware.
The Cisco adaptive security appliance phone proxy is the replacement product for the Cisco Unified
Phone Proxy. Additionally, the phone proxy can be deployed for voice/data VLAN traversal for
softphone applications. Cisco IP Communicator (CIPC) traffic (both media and signaling) can be
proxied through the ASA, thus traversing calls securely between voice and data VLANs.
For information about the differences between the TLS proxy and phone proxy, go to the following URL
for Unified Communications content, including TLS Proxy vs. Phone Proxy white paper:
http://www.cisco.com/go/secureuc

Cisco ASA 5500 Series Configuration Guide using the CLI

47-1

Chapter 47
Information About the Adaptive Security Appliance in Cisco Unified Communications

Information About Cisco Unified Communications Proxy Features

TLS Proxy: Decryption and inspection of Cisco Unified Communications encrypted signaling

End-to-end encryption often leaves network security appliances “blind” to media and signaling traffic,
which can compromise access control and threat prevention security functions. This lack of visibility can
result in a lack of interoperability between the firewall functions and the encrypted voice, leaving
businesses unable to satisfy both of their key security requirements.
The ASA is able to intercept and decrypt encrypted signaling from Cisco encrypted endpoints to the
Cisco Unified Communications Manager (Cisco UCM), and apply the required threat protection and
access control. It can also ensure confidentiality by re-encrypting the traffic onto the Cisco UCM servers.
Typically, the ASA TLS Proxy functionality is deployed in campus unified communications network.
This solution is ideal for deployments that utilize end to end encryption and firewalls to protect Unified
Communications Manager servers.
Mobility Proxy: Secure connectivity between Cisco Unified Mobility Advantage server and Cisco Unified Mobile
Communicator clients

Cisco Unified Mobility solutions include the Cisco Unified Mobile Communicator (Cisco UMC), an
easy-to-use software application for mobile handsets that extends enterprise communications
applications and services to mobile phones and the Cisco Unified Mobility Advantage (Cisco UMA)
server. The Cisco Unified Mobility solution streamlines the communication experience, enabling single
number reach and integration of mobile endpoints into the Unified Communications infrastructure.
The security appliance acts as a proxy, terminating and reoriginating the TLS signaling between the
Cisco UMC and Cisco UMA. As part of the proxy security functionality, inspection is enabled for the
Cisco UMA Mobile Multiplexing Protocol (MMP), the protocol between Cisco UMC and Cisco UMA.
Presence Federation Proxy: Secure connectivity between Cisco Unified Presence servers and Cisco/Microsoft
Presence servers

Cisco Unified Presence solution collects information about the availability and status of users, such as
whether they are using communication devices, such as IP phones at particular times. It also collects
information regarding their communications capabilities, such as whether web collaboration or video
conferencing is enabled. Using user information captured by Cisco Unified Presence, applications such
as Cisco Unified Personal Communicator and Cisco UCM can improve productivity by helping users
connect with colleagues more efficiently through determining the most effective way for collaborative
communication.
Using the ASA as a secure presence federation proxy, businesses can securely connect their Cisco
Unified Presence (Cisco UP) servers to other Cisco or Microsoft Presence servers, enabling
intra-enterprise communications. The security appliance terminates the TLS connectivity between the
servers, and can inspect and apply policies for the SIP communications between the servers.
Cisco Intercompany Media Engine Proxy: Secure connectivity between Cisco UCM servers in different enterprises
for IP Phone traffic

As more unified communications are deployed within enterprises, cases where business-to-business calls
utilize unified communications on both sides with the Public Switched Network (PSTN) in the middle
become increasingly common. All outside calls go over circuits to telephone providers and from there
are delivered to all external destinations.
The Cisco Intercompany Media Engine gradually creates dynamic, encrypted VoIP connections between
businesses, so that a collection of enterprises that work together end up looking like one giant business
with secure VoIP interconnections between them.
There are three components to a Cisco Intercompany Media Engine deployment within an enterprise: a
Cisco Intercompany Media Engine server, a call agent (the Cisco Unified Communications Manager)
and an ASA running the Cisco Intercompany Media Engine Proxy.

Cisco ASA 5500 Series Configuration Guide using the CLI

47-2

Chapter 47

Information About Cisco Unified Communications Proxy Features
TLS Proxy Applications in Cisco Unified Communications

The ASA provides perimeter security by encrypting signaling connections between enterprises and
preventing unathorized calls. An ASA running the Cisco Intercompany Media Engine Proxy can either
be deployed as an Internet firewall or be designated as a Cisco Intercompany Media Engine Proxy and
placed in the DMZ, off the path of the regular Internet traffic.

TLS Proxy Applications in Cisco Unified Communications
Table 47-1 shows the Cisco Unified Communications applications that utilize the TLS proxy on the
ASA.
Table 47-1

TLS Proxy Applications and the Security Appliance

Security
Appliance
Server Role

Security
Appliance
Client Role

TLS Server

Client
Authentication

Phone Proxy
IP phone
and TLS Proxy

Cisco UCM

Yes

Proxy
certificate,
self-signed or
by internal CA

Local dynamic
certificate
signed by the
ASA CA
(might not need
certificate for
phone proxy
application)

Mobility Proxy Cisco UMC

Cisco UMA

No

Using the
Cisco UMA
private key or
certificate
impersonation

Any static
configured
certificate

Presence
Federation
Proxy

Cisco UP or
MS LCS/OCS

Yes

Proxy
certificate,
self-signed or
by internal CA

Using the
Cisco UP
private key or
certificate
impersonation

Application

TLS Client

Cisco UP or
MS LCS/OCS

The ASA supports TLS proxy for various voice applications. For the phone proxy, the TLS proxy
running on the ASA has the following key features:
•

The ASA forces remote IP phones connecting to the phone proxy through the Internet to be in
secured mode even when the Cisco UCM cluster is in non-secure mode.

•

The TLS proxy is implemented on the ASA to intercept the TLS signaling from IP phones.

•

The TLS proxy decrypts the packets, sends packets to the inspection engine for NAT rewrite and
protocol conformance, optionally encrypts packets, and sends them to Cisco UCM or sends them in
clear text if the IP phone is configured to be in nonsecure mode on the Cisco UCM.

•

The ASA acts as a media terminator as needed and translates between SRTP and RTP media streams.

•

The TLS proxy is a transparent proxy that works based on establishing trusted relationship between
the TLS client, the proxy (the ASA), and the TLS server.

Cisco ASA 5500 Series Configuration Guide using the CLI

47-3

Chapter 47

Information About Cisco Unified Communications Proxy Features

Licensing for Cisco Unified Communications Proxy Features

For the Cisco Unified Mobility solution, the TLS client is a Cisco UMA client and the TLS server is a
Cisco UMA server. The ASA is between a Cisco UMA client and a Cisco UMA server. The mobility
proxy (implemented as a TLS proxy) for Cisco Unified Mobility allows the use of an imported PKCS-12
certificate for server proxy during the handshake with the client. Cisco UMA clients are not required to
present a certificate (no client authentication) during the handshake.
For the Cisco Unified Presence solution, the ASA acts as a TLS proxy between the Cisco UP server and
the foreign server. This allows the ASA to proxy TLS messages on behalf of the server that initiates the
TLS connection, and route the proxied TLS messages to the client. The ASA stores certificate trustpoints
for the server and the client, and presents these certificates on establishment of the TLS session.

Licensing for Cisco Unified Communications Proxy Features
The Cisco Unified Communications proxy features supported by the ASA require a Unified
Communications Proxy license:

Note

•

Phone proxy

•

TLS proxy for encrypted voice inspection

•

Presence federation proxy

•

Intercompany media engine proxy

In Version 8.2(2) and later, the Mobility Advantage proxy no longer requires a Unified Communications
Proxy license.
The following table shows the Unified Communications Proxy license details by platform for the phone
proxy, TLS proxy for encrypted voice inspection, and presence federation proxy:

Note

This feature is not available on No Payload Encryption models.

Model

License Requirement1

ASA 5505

Base License and Security Plus License: 2 sessions.
Optional license: 24 sessions.

ASA 5510

Base License and Security Plus License: 2 sessions.
Optional licenses: 24, 50, or 100 sessions.

ASA 5520

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

ASA 5540

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5550

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

ASA 5580

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions.2

Cisco ASA 5500 Series Configuration Guide using the CLI

47-4

Chapter 47

Information About Cisco Unified Communications Proxy Features
Licensing for Cisco Unified Communications Proxy Features

Model

License Requirement1

ASA 5512-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5515-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5525-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

ASA 5545-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5555-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

ASA 5585-X with
SSP-10

Base License: 2 sessions.

ASA 5585-X with
SSP-20, -40, or -60

Base License: 2 sessions.

Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions. 2

1. The following applications use TLS proxy sessions for their connections. Each TLS proxy session used by these applications (and only these applications)
is counted against the UC license limit:
- Phone Proxy
- Presence Federation Proxy
- Encrypted Voice Inspection
Other applications that use TLS proxy sessions do not count towards the UC limit, for example, Mobility Advantage Proxy (which does not require a
license) and IME (which requires a separate IME 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. 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.
Note: 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
. If you use failover and enter the write standby command 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 towards the SRTP limit; if passthrough is set for the call, even if both legs are
SRTP, they do not count towards the limit.
2. 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.

Table 47-2 shows the default and maximum TLS session details by platform.

Cisco ASA 5500 Series Configuration Guide using the CLI

47-5

Chapter 47

Information About Cisco Unified Communications Proxy Features

Licensing for Cisco Unified Communications Proxy Features

Table 47-2

Default and Maximum TLS Sessions on the Security Appliance

Security Appliance Platform

Default TLS Sessions

Maximum TLS Sessions

ASA 5505

10

80

ASA 5510

100

200

ASA 5520

300

1200

ASA 5540

1000

4500

ASA 5550

2000

4500

ASA 5580

4000

13,000

The following table shows the Unified Communications Proxy license details by platform for
intercompany media engine proxy:

Note

This feature is not available on No Payload Encryption models.

Model

License Requirement

All other models

Intercompany Media Engine license.
When you enable the Intercompany Media Engine (IME) license, you can use TLS proxy sessions up
to the configured TLS proxy limit. If you also have a Unified Communications (UC) license installed
that is higher than the default TLS proxy limit, then the ASA sets the limit to be the UC license limit
plus an additional number of sessions depending on your model. You can manually configure the TLS
proxy limit using the tls-proxy maximum-sessions command. To view the limits of your model, enter
the tls-proxy maximum-sessions ? command. If you also install the UC license, then the TLS proxy
sessions available for UC are also available for IME sessions. For example, if the configured limit is
1000 TLS proxy sessions, and you purchase a 750-session UC license, then the first 250 IME sessions
do not affect the sessions available for UC. If you need more than 250 sessions for IME, then the
remaining 750 sessions of the platform limit are used on a first-come, first-served basis by UC and
IME.
•

For a license part number ending in “K8”, TLS proxy sessions are limited to 1000.

•

For a license part number ending in “K9”, the TLS proxy limit depends on your configuration and
the platform model.

Note

K8 and K9 refer to whether the license is restricted for export: K8 is unrestricted, and K9 is
restricted.

You might also use SRTP encryption sessions for your connections:
•

For a K8 license, SRTP sessions are limited to 250.

•

For a K9 license, there is no 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.

Note

Cisco ASA 5500 Series Configuration Guide using the CLI

47-6

Chapter 47

Information About Cisco Unified Communications Proxy Features
Licensing for Cisco Unified Communications Proxy Features

For more information about licensing, see Chapter 3, “Managing Feature Licenses.”

Cisco ASA 5500 Series Configuration Guide using the CLI

47-7

Chapter 47
Licensing for Cisco Unified Communications Proxy Features

Cisco ASA 5500 Series Configuration Guide using the CLI

47-8

Information About Cisco Unified Communications Proxy Features

CH A P T E R

48

Configuring the Cisco Phone Proxy
This chapter describes how to configure the adaptive security appliance for Cisco Phone Proxy feature.
This chapter includes the following sections:
•

Information About the Cisco Phone Proxy, page 48-1

•

Licensing Requirements for the Phone Proxy, page 48-4

•

Prerequisites for the Phone Proxy, page 48-6

•

Phone Proxy Guidelines and Limitations, page 48-12

•

Configuring the Phone Proxy, page 48-14

•

Troubleshooting the Phone Proxy, page 48-27

•

Configuration Examples for the Phone Proxy, page 48-43

•

Feature History for the Phone Proxy, page 48-53

Information About the Cisco Phone Proxy
The Cisco Phone Proxy on the ASA bridges IP telephony between the corporate IP telephony network
and the Internet in a secure manner by forcing data from remote phones on an untrusted network to be
encrypted.

Phone Proxy Functionality
Telecommuters can connect their IP phones to the corporate IP telephony network over the Internet
securely via the phone proxy without the need to connect over a VPN tunnel as illustrated by
Figure 48-1.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-1

Chapter 48

Configuring the Cisco Phone Proxy

Information About the Cisco Phone Proxy

Figure 48-1

Phone Proxy Secure Deployment

Trusted / Inside / Un-Secured

M

Un-trusted / Outside / Secured

ASA
TCP/RTP

M

M

M

TLS/SRTP

Internet

IP

Home Router
w/NAT

M

Remote
IP phone

IP

Internal
IP phone

IP

Home Router
w/NAT

Remote
IP phone

Unencrypted signaling
Encrypted signaling

271631

Enterprise

The phone proxy supports a Cisco UCM cluster in mixed mode or nonsecure mode. Regardless of the
cluster mode, the remote phones that are capable of encryption are always forced to be in encrypted
mode. TLS (signaling) and SRTP (media) are always terminated on the ASA. The ASA can also perform
NAT, open pinholes for the media, and apply inspection policies for the SCCP and SIP protocols. In a
nonsecure cluster mode or a mixed mode where the phones are configured as nonsecure, the phone proxy
behaves in the following ways:
•

The TLS connections from the phones are terminated on the ASA and a TCP connection is initiated
to the Cisco UCM.

•

SRTP sent from external IP phones to the internal network IP phone via the ASA is converted to
RTP.

In a mixed mode cluster where the internal IP phones are configured as authenticated, the TLS
connection is not converted to TCP to the Cisco UCM but the SRTP is converted to RTP.
In a mixed mode cluster where the internal IP phone is configured as encrypted, the TLS connection
remains a TLS connection to the Cisco UCM and the SRTP from the remote phone remains SRTP to the
internal IP phone.
Since the main purpose of the phone proxy is to make the phone behave securely while making calls to
a nonsecure cluster, the phone proxy performs the following major functions:
•

Creates the certificate trust list (CTL) file, which is used to perform certificate based authentication
with remote phones.

•

Modifies the IP phone configuration file when it is requested via TFTP, changes security fields from
nonsecure to secure, and signs all files sent to the phone. These modifications secure remote phones
by forcing the phones to perform encrypted signaling and media.

•

Terminates TLS signaling from the phone and initiates TCP or TLS to Cisco UCM

•

Inserts itself into the media path by modifying the Skinny and SIP signaling messages.

•

Terminates SRTP and initiates RTP/SRTP to the called party.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-2

Chapter 48

Configuring the Cisco Phone Proxy
Information About the Cisco Phone Proxy

Note

As an alternative to authenticating remote IP phones through the TLS handshake, you can configure
authentication via LSC provisioning. With LSC provisioning you create a password for each remote IP
phone user and each user enters the password on the remote IP phones to retrieve the LSC.
Because using LSC provisioning to authenticate remote IP phones requires the IP phones first register
in nonsecure mode, Cisco recommends LSC provisioning be done inside the corporate network before
giving the IP phones to end-users. Otherwise, having the IP phones register in nonsecure mode requires
the Administrator to open the nonsecure signaling port for SIP and SCCP on the ASA.
See “Example 5: LSC Provisioning in Mixed-mode Cisco UCM cluster; Cisco UCM and TFTP Server
on Publisher, page 48-49“. See also the Cisco Unified Communications Manager Security Guide for
information on Using the Certificate Authority Proxy Function (CAPF) to install a locally significant
certificate (LSC).

Supported Cisco UCM and IP Phones for the Phone Proxy
Cisco Unified Communications Manager

The following release of the Cisco Unified Communications Manager are supported with the phone
proxy:
•

Cisco Unified CallManager Version 4.x

•

Cisco Unified CallManager Version 5.0

•

Cisco Unified CallManager Version 5.1

•

Cisco Unified Communications Manager 6.1

•

Cisco Unified Communications Manager 7.0

Cisco Unified IP Phones

The phone proxy supports these IP phone features:
•

Enterprise features like conference calls on remote phones connected through the phone proxy

•

XML services

The following IP phones in the Cisco Unified IP Phones 7900 Series are supported with the phone proxy:
•

Cisco Unified IP Phone 7975

•

Cisco Unified IP Phone 7971

•

Cisco Unified IP Phone 7970

•

Cisco Unified IP Phone 7965

•

Cisco Unified IP Phone 7962

•

Cisco Unified IP Phone 7961

•

Cisco Unified IP Phone 7961G-GE

•

Cisco Unified IP Phone 7960 (SCCP protocol support only)

•

Cisco Unified IP Phone 7945

•

Cisco Unified IP Phone 7942

•

Cisco Unified IP Phone 7941

Cisco ASA 5500 Series Configuration Guide using the CLI

48-3

Chapter 48

Configuring the Cisco Phone Proxy

Licensing Requirements for the Phone Proxy

•

Cisco Unified IP Phone 7941G-GE

•

Cisco Unified IP Phone 7940 (SCCP protocol support only)

•

Cisco Unified Wireless IP Phone 7921

•

Cisco Unified Wireless IP Phone 7925

Note

•

Note

Note

To support Cisco Unified Wireless IP Phone 7925, you must also configure MIC or LSC on the
IP phone so that it properly works with the phone proxy.
CIPC for softphones ( CIPC versions with Authenticated mode only)

The Cisco IP Communicator is supported with the phone proxy VLAN Traversal in
authenticated TLS mode. We do not recommend it for remote access because SRTP/TLS is not
supported currently on the Cisco IP Communicator.

The ASA supports inspection of traffic from Cisco IP Phones running SCCP protocol version 19 and
earlier.

Licensing Requirements for the Phone Proxy
The Cisco Phone Proxy feature supported by the ASA require a Unified Communications Proxy license.
The following table shows the Unified Communications Proxy license details by platform:

Note

This feature is not available on No Payload Encryption models.

Model

License Requirement1

ASA 5505

Base License and Security Plus License: 2 sessions.
Optional license: 24 sessions.

ASA 5510

Base License and Security Plus License: 2 sessions.
Optional licenses: 24, 50, or 100 sessions.

ASA 5520

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

ASA 5540

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5550

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

ASA 5580

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions.2

Cisco ASA 5500 Series Configuration Guide using the CLI

48-4

Chapter 48

Configuring the Cisco Phone Proxy
Licensing Requirements for the Phone Proxy

Model

License Requirement1

ASA 5512-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5515-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5525-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

ASA 5545-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5555-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

ASA 5585-X with
SSP-10

Base License: 2 sessions.

ASA 5585-X with
SSP-20, -40, or -60

Base License: 2 sessions.

Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions. 2

1. The following applications use TLS proxy sessions for their connections. Each TLS proxy session used by these applications (and only these applications)
is counted against the UC license limit:
- Phone Proxy
- Presence Federation Proxy
- Encrypted Voice Inspection
Other applications that use TLS proxy sessions do not count towards the UC limit, for example, Mobility Advantage Proxy (which does not require a
license) and IME (which requires a separate IME 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. 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.
Note: 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
. If you use failover and enter the write standby command 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 towards the SRTP limit; if passthrough is set for the call, even if both legs are
SRTP, they do not count towards the limit.
2. 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.

For more information about licensing, see Chapter 3, “Managing Feature Licenses.”

Cisco ASA 5500 Series Configuration Guide using the CLI

48-5

Chapter 48

Configuring the Cisco Phone Proxy

Prerequisites for the Phone Proxy

Prerequisites for the Phone Proxy
This section contains the following topics:
•

Media Termination Instance Prerequisites, page 48-6

•

Certificates from the Cisco UCM, page 48-7

•

DNS Lookup Prerequisites, page 48-7

•

Cisco Unified Communications Manager Prerequisites, page 48-7

•

Access List Rules, page 48-7

•

NAT and PAT Prerequisites, page 48-8

•

Prerequisites for IP Phones on Multiple Interfaces, page 48-9

•

7960 and 7940 IP Phones Support, page 48-9

•

Cisco IP Communicator Prerequisites, page 48-10

•

Prerequisites for Rate Limiting TFTP Requests, page 48-11

•

About ICMP Traffic Destined for the Media Termination Address, page 48-11

•

End-User Phone Provisioning, page 48-12

Media Termination Instance Prerequisites
The ASA must have a media termination instance that meets the following criteria:
•

You must configure one media termination for each phone proxy on the ASA. Multiple media
termination instances on the ASA are not supported.

•

For the media termination instance, you can configure a global media-termination address for all
interfaces or configure a media-termination address for different interfaces. However, you cannot
use a global media-termination address and media-termination addresses configured for each
interface at the same time.

•

If you configure a media termination address for multiple interfaces, you must configure an address
on each interface that the ASA uses when communicating with IP phones.
For example, if you had three interfaces on the ASA (one internal interface and two external
interfaces) and only one of the external interfaces were used to communicate with IP phones, you
would configure two media termination addresses: one on the internal interface and one on the
external interface that communicated with the IP phones.

•

Only one media-termination address can be configured per interface.

•

The IP addresses are publicly routable addresses that are unused IP addresses within the address
range on that interface.

•

The IP address on an interface cannot be the same address as that interface on the ASA.

•

The IP addresses cannot overlap with existing static NAT pools or NAT rules.

•

The IP addresses cannot be the same as the Cisco UCM or TFTP server IP address.

•

For IP phones behind a router or gateway, you must also meet this prerequisite. On the router or
gateway, add routes to the media termination address on the ASA interface that the IP phones
communicate with so that the phone can reach the media termination address.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-6

Chapter 48

Configuring the Cisco Phone Proxy
Prerequisites for the Phone Proxy

Certificates from the Cisco UCM
Import the following certificates which are stored on the Cisco UCM. These certificates are required by
the ASA for the phone proxy.
•

Cisco_Manufacturing_CA

•

CAP-RTP-001

•

CAP-RTP-002

•

CAPF certificate (Optional)

If LSC provisioning is required or you have LSC enabled IP phones, you must import the CAPF
certificate from the Cisco UCM. If the Cisco UCM has more than one CAPF certificate, you must import
all of them to the ASA.

Note

You can configure LSC provisioning for additional end-user authentication. See the Cisco Unified
Communications Manager configuration guide for information.
See Importing Certificates from the Cisco UCM, page 48-15. For example, the CA Manufacturer
certificate is required by the phone proxy to validate the IP phone certificate.

DNS Lookup Prerequisites
•

If you have an fully qualified domain name (FQDN) configured for the Cisco UCM rather than an
IP address, you must configure and enable DNS lookup on the ASA. For information about the dns
domain-lookup command and how to use it to configure DNS lookup, see command reference.

•

After configuring the DNS lookup, make sure that the ASA can ping the Cisco UCM with the
configured FQDN.

•

You must configure DNS lookup when you have a CAPF service enabled and the Cisco UCM is not
running on the Publisher but the Publisher is configured with a FQDN instead of an IP address.

Cisco Unified Communications Manager Prerequisites
•

The TFTP server must reside on the same interface as the Cisco UCM.

•

The Cisco UCM can be on a private network on the inside but you need to have a static mapping for
the Cisco UCM on the ASA to a public routable address.

•

If NAT is required for Cisco UCM, it must be configured on the ASA, not on the existing firewall.

Access List Rules
If the phone proxy is deployed behind an existing firewall, access-list rules to permit signaling, TFTP
requests, and media traffic to the phone proxy must be configured.
If NAT is configured for the TFTP server or Cisco UCMs, the translated “global” address must be used
in the access lists.
Table 48-1 lists the ports that are required to be configured on the existing firewall:

Cisco ASA 5500 Series Configuration Guide using the CLI

48-7

Chapter 48

Configuring the Cisco Phone Proxy

Prerequisites for the Phone Proxy

Table 48-1

Port Configuration Requirements

Address

Port

Protocol

Description

Media Termination

1024-65535

UDP

Allow incoming SRTP

TFTP Server

69

UDP

Allow incoming TFTP

Cisco UCM

2443

TCP

Allow incoming secure
SCCP

Cisco UCM

5061

TCP

Allow incoming secure
SIP

CAPF Service (on Cisco 3804
UCM)

TCP

Allow CAPF service for
LSC provisioning

Note

All these ports are configurable on the Cisco UCM, except for TFTP. These are the default
values and should be modified if they are modified on the Cisco UCM. For example, 3804 is the
default port for the CAPF Service. This default value should be modified if it is modified on the
Cisco UCM.

NAT and PAT Prerequisites
NAT Prerequisites
•

If NAT is configured for the TFTP server, the NAT configuration must be configured prior to
configuring the tftp-server command under the phone proxy.

•

If NAT is configured for the TFTP server or Cisco UCMs, the translated “global” address must be
used in the access lists.

PAT Prerequisites
•

When the Skinny inspection global port is configured to use a non-default port, then you must
configure the nonsecure port as the global_sccp_port+443.
Therefore, if global_sccp_port is 7000, then the global secure SCCP port is 7443. Reconfiguring the
port might be necessary when the phone proxy deployment has more than one Cisco UCM and they
must share the interface IP address or a global IP address.
/* use the default ports for the first CUCM */
object network obj-10.0.0.1-01
host 10.0.0.1
nat (inside,outside) static interface service
object network obj-10.0.0.1-02
host 10.0.0.1
nat (inside,outside) static interface service
/* use non-default ports for the 2nd CUCM */
object network obj-10.0.0.2-01
host 10.0.0.2
nat (inside,outside) static interface service
object network obj-10.0.0.2-02
host 10.0.0.2
nat (inside,outside) static interface service

Cisco ASA 5500 Series Configuration Guide using the CLI

48-8

tcp 2000 2000

tcp 2443 2443

tcp 2000 7000

tcp 2443 7443

Chapter 48

Configuring the Cisco Phone Proxy
Prerequisites for the Phone Proxy

Note
•

Both PAT configurations—for the nonsecure and secure ports—must be configured.
When the IP phones must contact the CAPF on the Cisco UCM and the Cisco UCM is configured
with static PAT (LCS provisioning is required), you must configure static PAT for the default CAPF
port 3804.

Prerequisites for IP Phones on Multiple Interfaces
When IP phones reside on multiple interfaces, the phone proxy configuration must have the correct IP
address set for the Cisco UCM in the CTL file.
See the following example topology for information about how to correctly set the IP address:
phones --- (dmz)-----|
|----- ASA PP --- (outside Internet) --- phones
phones --- (inside)--|

In this example topology, the following IP address are set:
•

Cisco UCM on the inside interface is set to 10.0.0.5

•

The DMZ network is 192.168.1.0/24

•

The inside network is 10.0.0.0/24

The Cisco UCM is mapped with different global IP addresses from DMZ > outside and inside interfaces
> outside interface.
In the CTL file, the Cisco UCM must have two entries because of the two different IP addresses. For
example, if the static statements for the Cisco UCM are as follows:
object network obj-10.0.0.5-01
host 10.0.0.5
nat (inside,outside) static 209.165.202.129
object network obj-10.0.0.5-02
host 10.0.0.5
nat (inside,dmz) static 198.168.1.2

There must be two CTL file record entries for the Cisco UCM:
record-entry cucm trustpoint cucm_in_to_out address 209.165.202.129
record-entry cucm trustpoint cucm_in_to_dmz address 192.168.1.2

7960 and 7940 IP Phones Support
•

An LSC must be installed on these IP phones because they do not come pre installed with a MIC.
Install the LSC on each phone before using them with the phone proxy to avoid opening the
nonsecure SCCP port for the IP phones to register in nonsecure mode with the Cisco UCM.
See the following document for the steps to install an LSC on IP phones:
http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/security/7_0_1/secugd/secucapf.html#w
p1093518

Note

If an IP phone already has an LSC installed on it from a different Cisco UCM cluster, delete the
LSC from the different cluster and install an LSC from the current Cisco UCM cluster.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-9

Chapter 48

Configuring the Cisco Phone Proxy

Prerequisites for the Phone Proxy

Note

You can configure LSC provisioning for additional end-user authentication. See the Cisco
Unified Communications Manager configuration guide for information.

•

The CAPF certificate must be imported onto the ASA.

•

The CTL file created on the ASA must be created with a CAPF record-entry.

•

The phone must be configured to use only the SCCP protocol because the SIP protocol does not
support encryption on these IP phones.

•

If LSC provisioning is done via the phone proxy, you must add an ACL to allow the IP phones to
register with the Cisco UCM on the nonsecure port 2000.

Cisco IP Communicator Prerequisites
To configure Cisco IP Communicator (CIPC) with the phone proxy, you must meet the following
prerequisites:
•

Include the cipc security-mode authenticated command under the phone-proxy command when
configuring the phone proxy instance.

•

Create an ACL to allow CIPC to register with the Cisco UCM in nonsecure mode.

•

Configure null-sha1 as one of the SSL encryption ciphers.

Current versions of Cisco IP Communicator (CIPC) support authenticated mode and perform TLS
signaling but not voice encryption. Therefore, you must include the following command when
configuring the phone proxy instance:
cipc security-mode authenticated
Because CIPC requires an LSC to perform the TLS handshake, CIPC needs to register with the Cisco
UCM in nonsecure mode using cleartext signaling. To allow the CIPC to register, create an ACL that
allows the CIPC to connect to the Cisco UCM on the nonsecure SIP/SCCP signalling ports (5060/2000).

Note

You can configure LSC provisioning for additional end-user authentication. See the Cisco Unified
Communications Manager configuration guide for information.
CIPC uses a different cipher when doing the TLS handshake and requires the null-sha1 cipher and SSL
encryption be configured. To add the null-shal cipher, use the show run all ssl command to see the output
for the ssl encryption command and add null-shal to the end of the SSL encryption list.

Note

When used with CIPC, the phone proxy does not support end-users resetting their device name in CIPC
(Preferences > Network tab > Use this Device Name field) or Administrators resetting the device name
in Cisco Unified CM Administration console (Device menu > Phone Configuration > Device Name
field). To function with the phone proxy, the CIPC configuration file must be in the format:
SEP.cnf.xml. If the device name does not follow this format (SEP), CIPC
cannot retrieve its configuration file from Cisco UMC via the phone proxy and CIPC will not function.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-10

Chapter 48

Configuring the Cisco Phone Proxy
Prerequisites for the Phone Proxy

Prerequisites for Rate Limiting TFTP Requests
In a remote access scenario, we recommend that you configure rate limiting of TFTP requests because
any IP phone connecting through the Internet is allowed to send TFTP requests to the TFTP server.
To configure rate limiting of TFTP requests, configure the police command in the Modular Policy
Framework. See the command reference for information about using the police command.
Policing is a way of ensuring that no traffic exceeds the maximum rate (in bits/second) that you
configure, thus ensuring that no one traffic flow can take over the entire resource. When traffic exceeds
the maximum rate, the ASA drops the excess traffic. Policing also sets the largest single burst of traffic
allowed.

Rate Limiting Configuration Example
The following example describes how you configure rate limiting for TFTP requests by using the police
command and the Modular Policy Framework.
Begin by determining the conformance rate that is required for the phone proxy. To determine the
conformance rate, use the following formula:
X * Y * 8

Where
X = requests per second
Y = size of each packet, which includes the L2, L3, and L4 plus the payload
Therefore, if a rate of 300 TFTP requests/second is required, then the conformance rate would be
calculated as follows:
300 requests/second * 80 bytes * 8 = 192000

The example configuration below shows how the calculated conformance rate is used with the police
command:
access-list tftp extended permit udp any host 192.168.0.1 eq tftp
class-map tftpclass
match access-list tftp
policy-map tftpmap
class tftpclass
police output 192000
service-policy tftpmap interface inside

About ICMP Traffic Destined for the Media Termination Address
To control which hosts can ping the media termination address, use the icmp command and apply the
access rule to the outside interface on the ASA.
Any rules for ICMP access applied to the outside interface apply to traffic destined for the media
termination address.
For example, use the following command to deny ICMP pings from any host destined for the media
termination address:
icmp deny any outside

Cisco ASA 5500 Series Configuration Guide using the CLI

48-11

Chapter 48

Configuring the Cisco Phone Proxy

Phone Proxy Guidelines and Limitations

End-User Phone Provisioning
The phone proxy is a transparent proxy with respect to the TFTP and signaling transactions. If NAT is
not configured for the Cisco UCM TFTP server, then the IP phones need to be configured with the Cisco
UCM cluster TFTP server address.
If NAT is configured for the Cisco UCM TFTP server, then the Cisco UCM TFTP server global address
is configured as the TFTP server address on the IP phones.

Ways to Deploy IP Phones to End Users
In both options, deploying a remote IP phone behind a commercial Cable/DSL router with NAT
capabilities is supported.
Option 1 (Recommended)

Stage the IP phones at corporate headquarters before sending them to the end users:
•

The phones register inside the network. IT ensures there are no issues with the phone configurations,
image downloads, and registration.

•

If Cisco UCM cluster was in mixed mode, the CTL file should be erased before sending the phone
to the end user.

Advantages of this option are:
•

Easier to troubleshoot and isolate problems with the network or phone proxy because you know
whether the phone is registered and working with the Cisco UCM.

•

Better user experience because the phone does not have to download firmware from over a
broadband connection, which can be slow and require the user to wait for a longer time.

Option 2

Send the IP phone to the end user. When using option 2, the user must be provided instructions to change
the settings on phones with the appropriate Cisco UCM and TFTP server IP address.

Note

As an alternative to authenticating remote IP phones through the TLS handshake, you can configure
authentication via LSC provisioning. With LSC provisioning you create a password for each remote IP
phone user and each user enters the password on the remote IP phones to retrieve the LSC.
Because using LSC provisioning to authenticate remote IP phones requires the IP phones first register
in nonsecure mode, Cisco recommends LSC provisioning be done inside the corporate network before
giving the IP phones to end-users. Otherwise, having the IP phones register in nonsecure mode requires
the Administrator to open the nonsecure signaling port for SIP and SCCP on the ASA.
See “Example 5: LSC Provisioning in Mixed-mode Cisco UCM cluster; Cisco UCM and TFTP Server
on Publisher, page 48-49“. See also the Cisco Unified Communications Manager Security Guide for
information on Using the Certificate Authority Proxy Function (CAPF) to install a locally significant
certificate (LSC).

Phone Proxy Guidelines and Limitations
This section includes the following topics:

Cisco ASA 5500 Series Configuration Guide using the CLI

48-12

Chapter 48

Configuring the Cisco Phone Proxy
Phone Proxy Guidelines and Limitations

•

General Guidelines and Limitations, page 48-13

•

Media Termination Address Guidelines and Limitations, page 48-14

General Guidelines and Limitations
The phone proxy has the following general limitations:
•

Only one phone proxy instance can be configured on the ASA by using the phone-proxy command.
See the command reference for information about the phone-proxy command. See also Creating the
Phone Proxy Instance, page 48-23.

•

The phone proxy only supports one Cisco UCM cluster. See Creating the CTL File, page 48-18 for
the steps to configure the Cisco UCM cluster for the phone proxy.

•

The phone proxy is not supported when the ASA is running in transparent mode or multiple context
mode.

•

When a remote IP phone calls an invalid internal or external extension, the phone proxy does not
support playing the annunciator message from the Cisco UCM. Instead, the remote IP phone plays
a fast busy signal instead of the annunciator message "Your call cannot be completed ..." However,
when an internal IP phone dials in invalid extension, the annunciator messages plays "Your call
cannot be completed ..."

•

Packets from phones connecting to the phone proxy over a VPN tunnel are not inspected by the ASA
inspection engines.

•

The phone proxy does not support IP phones sending Real-Time Control Protocol (RTCP) packets
through the ASA. Disable RTCP packets in the Cisco Unified CM Administration console from the
Phone Configuration page. See your Cisco Unified Communications Manager (CallManager)
documentation for information about setting this configuration option.

•

When used with CIPC, the phone proxy does not support end-users resetting their device name in
CIPC (Preferences > Network tab > Use this Device Name field) or Administrators resetting the
device name in Cisco Unified CM Administration console (Device menu > Phone Configuration >
Device Name field). To function with the phone proxy, the CIPC configuration file must be in the
format: SEP.cnf.xml. If the device name does not follow this format
(SEP), CIPC cannot retrieve its configuration file from Cisco UMC via the phone
proxy and CIPC will not function.

•

The phone proxy does not support IP phones sending SCCP video messages using Cisco VT
Advantage because SCCP video messages do not support SRTP keys.

•

For mixed-mode clusters, the phone proxy does not support the Cisco Unified Call Manager using
TFTP to send encrypted configuration files to IP phones through the ASA.

•

Multiple IP phones behind one NAT device must be configured to use the same security mode.
When the phone proxy is configured for a mixed-mode cluster and multiple IP phones are behind
one NAT device and registering through the phone proxy, all the SIP and SCCP IP phones must be
configured as authenticated or encrypted, or all as non-secure on the Unified Call Manager.
For example, if there are four IP phones behind one NAT device where two IP phones are configured
using SIP and two IP phones are configured using SCCP, the following configurations on the Unified
Call Manager are acceptable:
– Two SIP IP phones: one IP phone in authenticated mode and one in encrypted mode, both in

authenticated mode, or both in encrypted mode
Two SCCP IP phones: one IP phone in authenticated mode and one in encrypted mode, both in
authenticated mode, or both in encrypted mode

Cisco ASA 5500 Series Configuration Guide using the CLI

48-13

Chapter 48

Configuring the Cisco Phone Proxy

Configuring the Phone Proxy

– Two SIP IP phones: both in non-secure mode

Two SCCP IP phones: one IP phone in authenticated mode and one in encrypted mode, both in
authenticated mode, both in encrypted mode
– Two SIP IP phones: one IP phone in authenticated mode and one in encrypted mode, both in

authenticated mode, both in encrypted mode
Two SCCP IP phones: both in non-secure mode
This limitation results from the way the application-redirect rules (rules that convert TLS to TCP)
are created for the IP phones.

Media Termination Address Guidelines and Limitations
The phone proxy has the following limitations relating to configuring the media-termination address:
•

When configuring the media-termination address, the phone proxy does not support having internal
IP phones (IP phones on the inside network) being on a different network interface from the Cisco
UCM unless the IP phones are forced to use the non-secure Security mode.
When internal IP phones are on a different network interface than the Cisco UCM, the IP phones
signalling sessions still go through ASA; however, the IP phone traffic does not go through the
phone proxy. Therefore, Cisco recommends that you deploy internal IP phones on the same network
interface as the Cisco UMC.
If the Cisco UMC and the internal IP phones must be on different network interfaces, you must add
routes for the internal IP phones to access the network interface of the media-termination address
where Cisco UMC resides.
When the phone proxy is configured to use a global media-termination address, all IP phones see
the same global address, which is a public routable address.

•

If you decide to configure a media-termination address on interfaces (rather than using a global
interface), you must configure a media-termination address on at least two interfaces (the inside and
an outside interface) before applying the phone-proxy service policy. Otherwise, you will receive an
error message when enabling the Phone Proxy with SIP and Skinny Inspection.

•

The phone proxy can use only one type of media termination instance at a time; for example, you
can configure a global media-termination address for all interfaces or configure a media-termination
address for different interfaces. However, you cannot use a global media-termination address and
media-termination addresses configured for each interface at the same time.

Configuring the Phone Proxy
This section includes the following topics:
•

Task Flow for Configuring the Phone Proxy in a Non-secure Cisco UCM Cluster, page 48-15

•

Importing Certificates from the Cisco UCM, page 48-15

•

Task Flow for Configuring the Phone Proxy in a Mixed-mode Cisco UCM Cluster, page 48-17

•

Creating Trustpoints and Generating Certificates, page 48-17

•

Creating the CTL File, page 48-18

•

Using an Existing CTL File, page 48-20

•

Creating the TLS Proxy Instance for a Non-secure Cisco UCM Cluster, page 48-20

Cisco ASA 5500 Series Configuration Guide using the CLI

48-14

Chapter 48

Configuring the Cisco Phone Proxy
Configuring the Phone Proxy

•

Creating the TLS Proxy for a Mixed-mode Cisco UCM Cluster, page 48-21

•

Creating the Media Termination Instance, page 48-22

•

Creating the Phone Proxy Instance, page 48-23

•

Enabling the Phone Proxy with SIP and Skinny Inspection, page 48-25

•

Configuring Linksys Routers with UDP Port Forwarding for the Phone Proxy, page 48-26

Task Flow for Configuring the Phone Proxy in a Non-secure Cisco UCM Cluster
Follow these tasks to configure the phone proxy in a Non-secure Cisco UCM Cluster:
Step 1

Create trustpoints and generate certificates for each entity in the network (Cisco UCM, Cisco UCM and
TFTP, TFTP server, CAPF) that the IP phone must trust. The certificates are used in creating the CTL
file. See Creating Trustpoints and Generating Certificates, page 48-17.

Note

Before you create the trustpoints and generate certificates, you must have imported the required
certificates, which are stored on the Cisco UCM. See Certificates from the Cisco UCM,
page 48-7 and Importing Certificates from the Cisco UCM, page 48-15

Step 2

Create the CTL file for the phone proxy. See Creating the CTL File, page 48-18.

Step 3

Create the TLS proxy instance. See Creating the TLS Proxy Instance for a Non-secure Cisco UCM
Cluster, page 48-20.

Step 4

Create the media termination instance for the phone proxy. See Creating the Media Termination
Instance, page 48-22.

Step 5

Create the phone proxy instance. See Creating the Phone Proxy Instance, page 48-23.

Step 6

Enable the phone proxy y with SIP and Skinny inspection. See Enabling the Phone Proxy with SIP and
Skinny Inspection, page 48-25.

Importing Certificates from the Cisco UCM
For the TLS proxy used by the phone proxy to complete the TLS handshake successfully, it needs to
verify the certificates from the IP phone (and the Cisco UCM if doing TLS with Cisco UCM). To validate
the IP phone certificate, we need the CA Manufacturer certificate which is stored on the Cisco UCM.
Follow these steps to import the CA Manufacturer certificate to the ASA.
Step 1

Go to the Cisco UCM Operating System Administration web page.

Step 2

Choose Security > Certificate Management.

Note

Earlier versions of Cisco UCM have a different UI and way to locate the certificates. For
example, in Cisco UCM version 4.x, certificates are located in the directory C:\Program
Files\Cisco\Certificates. See your Cisco Unified Communications Manager (CallManager)
documentation for information about locating certificates.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-15

Chapter 48

Configuring the Cisco Phone Proxy

Configuring the Phone Proxy

Step 3

Click Find and it will display all the certificates.

Step 4

Find the filename Cisco_Manufacturing_CA. This is the certificate need to verify the IP phone
certificate. Click the .PEM file Cisco_Manufacturing_CA.pem. This will show you the certificate
information and a dialog box that has the option to download the certificate.

Note

If the certificate list contains more than one certificate with the filename
Cisco_Manufacturing_CA, make you select the certificate Cisco_Manufacturing_CA.pem—the
one with the .pem file extension.

Step 5

Click Download and save the file as a text file.

Step 6

On the ASA, create a trustpoint for the Cisco Manufacturing CA and enroll via terminal by entering the
following commands. Enroll via terminal because you will paste the certificate you downloaded in
Step 4.
hostname(config)# crypto ca trustpoint trustpoint_name
hostname(config-ca-trustpoint)# enrollment terminal

Step 7

Authenticate the trustpoint by entering the following command:
hostname(config)# crypto ca authenticate trustpoint

Step 8

Step 9

You are prompted to “Enter the base 64 encoded CA Certificate.” Copy the .PEM file you downloaded
in Step 4 and paste it at the command line. The file is already in base-64 encoding so no conversion is
required. If the certificate is OK, you are prompted to accept it: “Do you accept this certificate?
[yes/no].” Enter yes.

Note

When you copy the certificate, make sure that you also copy also the lines with BEGIN and
END.

Tip

If the certificate is not ok, use the debug crypto ca command to show debug messages for PKI
activity (used with CAs).

Repeat the Step 1 through Step 8 for the next certificate. Table 48-2 shows the certificates that are
required by the ASA.
Table 48-2

Certificates Required by the Security Appliance for the Phone Proxy

Certificate Name

Required for...

CallManager

Authenticating the Cisco UCM during TLS handshake; only
required for mixed-mode clusters.

Cisco_Manufacturing_CA

Authenticating IP phones with a Manufacturer Installed Certificate
(MIC).

CAP-RTP-001

Authenticating IP phones with a MIC.

CAP-RTP-002

Authenticating IP phones with a MIC.

CAPF

Authenticating IP phones with an LSC.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-16

Chapter 48

Configuring the Cisco Phone Proxy
Configuring the Phone Proxy

Task Flow for Configuring the Phone Proxy in a Mixed-mode Cisco UCM Cluster
Note

For mixed-mode clusters, the phone proxy does not support the Cisco Unified Call Manager using TFTP
to send encrypted configuration files to IP phones through the ASA.
Follow these tasks to configure the phone proxy in a Non-secure Cisco UCM Cluster:

Step 1

Create trustpoints and generate certificates for each entity in the network (Cisco UCM, Cisco UCM and
TFTP, TFTP server, CAPF) that the IP phone must trust. The certificates are used in creating the CTL
file. See Creating Trustpoints and Generating Certificates, page 48-17.

Note

Step 2

Before you create the trustpoints and generate certificates, you must have imported the required
certificates, which are stored on the Cisco UCM. See Certificates from the Cisco UCM,
page 48-7 and Importing Certificates from the Cisco UCM, page 48-15

Create the CTL file for the phone proxy. See Creating the CTL File, page 48-18.

Note

When the phone proxy is being configured to run in mixed-mode clusters, you have the
following option to use an existing CTL file to install the trustpoints. See Using an Existing CTL
File, page 48-20.

Step 3

Create the TLS proxy instance. See Creating the TLS Proxy for a Mixed-mode Cisco UCM Cluster,
page 48-21.

Step 4

Create the media termination instance for the phone proxy. See Creating the Media Termination
Instance, page 48-22.

Step 5

Create the phone proxy instance. See Creating the Phone Proxy Instance, page 48-23.

Step 6

While configuring the phone proxy instance (in the Phone Proxy Configuration mode), enter the
following command to configure the mode of the cluster to be mixed mode because the default is
nonsecure:
hostname(config-phone-proxy)# cluster-mode mixed

Step 7

Enable the phone proxy y with SIP and Skinny inspection. See Enabling the Phone Proxy with SIP and
Skinny Inspection, page 48-25.

Creating Trustpoints and Generating Certificates
Create trustpoints and generate certificates for each entity in the network (Cisco UCM, Cisco UCM and
TFTP, TFTP server, CAPF) that the IP phone must trust. The certificates are used in creating the CTL
file.
You need to create trustpoints for each Cisco UCM (primary and secondary if a secondary Cisco UCM
is used) and TFTP server in the network. The trustpoints need to be in the CTL file for the phones to
trust the Cisco UCM.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-17

Chapter 48

Configuring the Cisco Phone Proxy

Configuring the Phone Proxy

Prerequisites

Import the required certificates, which are stored on the Cisco UCM. See Certificates from the Cisco
UCM, page 48-7 and Importing Certificates from the Cisco UCM, page 48-15.
Command

Purpose

Step 1

hostname(config)# crypto key generate rsa label
key-pair-label modulus size
Example:
crypto key generate rsa label cucmtftp_kp modulus
1024

Creates a keypair that can be used for the trustpoints.

Step 2

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
crypto ca trustpoint cucm_tftp_server

Creates the trustpoints for each entity in the network
(primary Cisco UCM, secondary Cisco UCM, and
TFTP server).
Note

You are only required to create a separate
trustpoint for the TFTP server when the
TFTP server resides on a different server
from the Cisco UCM. See Example 3:
Mixed-mode Cisco UCM cluster, Cisco
UCM and TFTP Server on Different Servers,
page 48-46 for an example of this
configuration.

Step 3

hostname(config-ca-trustpoint)# enrollment self

Generates a self-signed certificate.

Step 4

hostname(config-ca-trustpoint)# keypair keyname
Example:
keypair cucmtftp_kp

Specifies the keypair whose public key is being
certified.

Step 5

hostname(config-ca-trustpoint)# exit

Exits from the Configure Trustpoint mode.

Step 6

hostname(config)# crypto ca enroll trustpoint
Example:
crypto ca enroll cucm_tftp_server

Requests the certificate from the CA server and
causes the ASA to generate the certificate.
When prompted to include the device serial number
in the subject name, type Y to include the serial
number or type N to exclude it.
When prompted to generate the self-signed
certificate, type Y.

What to Do Next

Once you have created the trustpoints and generated the certificates, create the CTL file for the phone
proxy. See Creating the CTL File, page 48-18.
If you are configuring the phone proxy in a mixed-mode cluster, you can use an existing CTL file. See
Using an Existing CTL File, page 48-20.

Creating the CTL File
Create the CTL file that will be presented to the IP phones during the TFTP requests.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-18

Chapter 48

Configuring the Cisco Phone Proxy
Configuring the Phone Proxy

Prerequisites

If you are using domain names for your Cisco UCM and TFTP server, you must configure DNS lookup
on the ASA. Add an entry for each of the outside interfaces on the ASA into your DNS server, if such
entries are not already present. Each ASA outside IP address should have a DNS entry associated with
it for lookups. These DNS entries must also be enabled for Reverse Lookup.
Enable DNS lookups on your ASA with the dns domain-lookup interface_name command (where the
interface_name specifies the interface that has a route to your DNS server). Additionally, define your
DNS server IP address on the ASA; for example: dns name-server 10.2.3.4 (IP address of your DNS
server).

Note

You can enter the dns domain-lookup command multiple times to enable DNS lookup on
multiple interfaces. If you enter multiple commands, the ASA tries each interface in the order it
appears in the configuration until it receives a response.

See the command reference for information about the dns domain-lookup command.
Command

Purpose

Step 1

hostname(config)# ctl-file ctl_name
Example:
ctl-file myctl

Creates the CTL file instance.

Step 2

hostname(config-ctl-file)# record-entry tftp
trustpoint trustpoint_name address TFTP_IP_address
Example:
record-entry cucm-tftp trustpoint cucm_tftp_server
address 10.10.0.26

Creates the record entry for the TFTP server.

hostname(config-ctl-file)# record-entry cucm
trustpoint trustpoint_name address IP_address
Example:
record-entry cucm trustpoint cucm_server address
10.10.0.26

Creates the record entry for the each Cisco UCM
(primary and secondary).

hostname(config-ctl-file)# record-entry capf
trustpoint trust_point address
Example:
record-entry capf trustpoint capf address 10.10.0.26

Creates the record entry for CAPF.

hostname(config-ctl-file)# no shutdown

Creates the CTL file.

Step 3

Step 4

Step 5

Note

Note

Note

Use the global or mapped IP address of the
TFTP server or Cisco UCM if NAT is
configured.

Use the global or mapped IP address of the
Cisco UCM.
You only enter this command when LSC
provisioning is required or you have LSC
enabled IP phones.

When the file is created, it creates an internal
trustpoint used by the phone proxy to sign the TFTP
files. The trustpoint is named
_internal_PP_ctl-instance_filename.
Step 6

hostname(config)# copy running-configuration
startup-configuration

Saves the certificate configuration to Flash memory.

What to Do Next

Once you have configured the CTL file for the phone proxy, create the TLS proxy instance. See Creating
the TLS Proxy Instance for a Non-secure Cisco UCM Cluster, page 48-20 to add the TLS proxy when
configuring the phone proxy in a non-secure mode or see Creating the TLS Proxy for a Mixed-mode
Cisco UCM Cluster, page 48-21 if the phone proxy is running in a mixed-mode cluster.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-19

Chapter 48

Configuring the Cisco Phone Proxy

Configuring the Phone Proxy

Using an Existing CTL File
Note

Only when the phone proxy is running in mixed-mode clusters, you have the option to use an existing
CTL file to install trustpoints.
If you have an existing CTL file that contains the correct IP addresses of the entities (namely, the IP
address that the IP phones use for the Cisco UCM or TFTP servers), you can be use it to create a new
CTL file thereby using the existing CTL file to install the trustpoints for each entity in the network (Cisco
UCM, Cisco UCM and TFTP, TFTP server, CAPF) that the IP phones must trust.
Prerequisites

If a CTL file exists for the cluster, copy the CTL file to Flash memory. When you copy the CTL file to
Flash memory, rename the file and do not name the file CTLFile.tlv.
If you are using domain names for your Cisco UCM and TFTP server, you must configure DNS lookup
on the ASA. See the prerequisites for Creating the CTL File, page 48-18.
Command

Purpose

Step 1

hostname(config)# ctl-file ctl_name
Example:
ctl-file myctl

Creates the CTL file instance.

Step 2

hostname(config-ctl-file)# cluster-ctl-file
filename_path
Example:
hostname(config-ctl-file)# cluster-ctl-file
disk0:/old_ctlfile.tlv

Uses the trustpoints that are already in the existing
CTL file stored in Flash memory.
Where the existing CTL file was saved to Flash
memory with a filename other than CTLFile.tlv;
for example, old_ctlfile.tlv.

What to Do Next

When using an existing CTL file to configure the phone proxy, you can add additional entries to the file
as necessary. See Creating the CTL File, page 48-18.
Once you have configured the CTL file for the phone proxy, create the TLS proxy instance. See Creating
the TLS Proxy Instance for a Non-secure Cisco UCM Cluster, page 48-20 to add the TLS proxy when
configuring the phone proxy in a non-secure mode or see Creating the TLS Proxy for a Mixed-mode
Cisco UCM Cluster, page 48-21 if the phone proxy is running in a mixed-mode cluster.

Creating the TLS Proxy Instance for a Non-secure Cisco UCM Cluster
Create the TLS proxy instance to handle the encrypted signaling.
Command

Purpose

Step 1

hostname(config)# tls-proxy proxy_name
Example:
tls-proxy mytls

Creates the TLS proxy instance.

Step 2

hostname(config-tlsp)# server trust-point
_internal_PP_ctl-instance_filename

Configures the server trustpoint and references the
internal trustpoint named
_internal_PP_ctl-instance_filename.

Example:
server trust-point _internal_PP_myctl

Cisco ASA 5500 Series Configuration Guide using the CLI

48-20

Chapter 48

Configuring the Cisco Phone Proxy
Configuring the Phone Proxy

What to Do Next

Once you have created the TLS proxy instance, create the phone proxy instance. See Creating the Phone
Proxy Instance, page 48-23.

Creating the TLS Proxy for a Mixed-mode Cisco UCM Cluster
For mixed mode clusters, there might be IP phones that are already configured as encrypted so it requires
TLS to the Cisco UCM. You must configure the LDC issuer for the TLS proxy.

Step 1

Step 2

Command

Purpose

hostname(config)# crypto key generate rsa label
key-pair-label modulus size
Examples:
hostname(config)# crypto key generate rsa label
ldc_signer_key modulus 1024
hostname(config)# crypto key generate rsa label
phone_common modulus 1024

Creates the necessary RSA key pairs.
Where the key-pair-label is the LDC signer key
and the key for the IP phones.

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
hostname(config)# crypto ca trustpoint ldc_server

Creates an internal local CA to sign the LDC for
Cisco IP phones.

Step 3

hostname(config-ca-trustpoint)# enrollment self

Generates a self-signed certificate.

Step 4

hostname(config-ca-trustpoint)# proxy-ldc-issuer

Defines the local CA role for the trustpoint to issue
dynamic certificates for the TLS proxy.

Step 5

hostname(config-ca-trustpoint)# fqdn fqdn
Example:
hostname(config-ca-trustpoint)# fqdn
my_ldc_ca.example.com

Includes the indicated FQDN in the Subject
Alternative Name extension of the certificate during
enrollment.

Step 6

hostname(config-ca-trustpoint)# subject-name
X.500_name
Example:
hostname(config-ca-trustpoint)# subject-name
cn=FW_LDC_SIGNER_172_23_45_200

Where the trustpoint_name is for the LDC.

Where the fqdn is for the LDC.
Includes the indicated subject DN in the certificate
during enrollment
Where the X.500_name is for the LDC.
Use commas to separate attribute-value pairs. Insert
quotation marks around any value that contains
commas or spaces.
For example:
cn=crl,ou=certs,o="cisco systems, inc.",c=US

The maximum length is 500 characters.
Step 7

hostname(config-ca-trustpoint)# keypair keypair
Example:
hostname(config-ca-trustpoint)# keypair
ldc_signer_key

Specifies the key pair whose public key is to be
certified.

Step 8

hostname(config)# crypto ca enroll ldc_server
Example:
hostname(config)# crypto ca enroll ldc_server

Starts the enrollment process with the CA.

Step 9

hostname(config)# tls-proxy proxy_name
Example:
tls-proxy mytls

Creates the TLS proxy instance.

Where the keypair is for the LDC.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-21

Chapter 48

Configuring the Cisco Phone Proxy

Configuring the Phone Proxy

Command

Purpose

Step 10

hostname(config-tlsp)# server trust-point
_internal_PP_ctl-instance_filename
Example:
hostname(config-tlsp)# server trust-point
_internal_PP_myctl

Configures the server trustpoint and references the
internal trustpoint named
_internal_PP_ctl-instance_filename.

Step 11

hostname(config-tlsp)# client ldc issuer ca_tp_name
Example:
client ldc issuer ldc_server

Specifies the local CA trustpoint to issue client
dynamic certificates.

Step 12

hostname(config-tlsp)# client ldc keypair key_label
Example:
hostname(config-tlsp)# client ldc keypair
phone_common

Specifies the RSA keypair to be used by client
dynamic certificates.

Step 13

hostname(config-tlsp)# client cipher-suite
cipher-suite
Example:
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1

Specifies the cipher suite.

Step 14

Options include des-sha1, 3des-sha1, aes128-sha1,
aes256-sha1, or null-sha1.
Exports the local CA certificate and installs it as a
trusted certificate on the Cisco Unified
Communications Manager server by performing one
of the following actions.

•

hostname(config)# crypto ca export trustpoint
identity-certificate
Example:
hostname(config)# crypto ca export ldc_server
identity-certificate

Exports the certificate if a trustpoint with
proxy-ldc-issuer is used as the signer of the dynamic
certificates.

•

hostname(config)# show crypto ca server certificates

Exports the certificate for the embedded local CA
server LOCAL-CA-SERVER.
After exporting the certificate, you must save the
output to a file and import it on the Cisco Unified
Communications Manager. You can use the Display
Certificates function in the Cisco Unified
Communications Manager software to verify the
installed certificate.
For information about performing these procedures,
see the following URLs:
http://www.cisco.com/en/US/docs/voice_ip_comm/
cucm/cucos/5_0_4/iptpch6.html#wp1040848
http://www.cisco.com/en/US/docs/voice_ip_comm/
cucm/cucos/5_0_4/iptpch6.html#wp1040354

What To Do Next

Once you have created the TLS proxy instance and installed the certificate on the Cisco Unified
Communications Manager, create the phone proxy instance. See Creating the Phone Proxy Instance,
page 48-23.

Creating the Media Termination Instance
Create the media termination instance that you will use in the phone proxy.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-22

Chapter 48

Configuring the Cisco Phone Proxy
Configuring the Phone Proxy

The media termination address you configure must meet the requirements as described in Media
Termination Instance Prerequisites, page 48-6.
Command

Purpose

Step 1

hostname(config)# media-termination instance_name
Example:
hostname(config)# media-termination mediaterm1

Creates the media termination instance that you
attach to the phone proxy.

Step 2

hostname(config-media-termination)# address
ip_address [interface intf_name]
Examples:
hostname(config-media-termination)# address
192.0.2.25 interface inside
hostname(config-media-termination)# address
10.10.0.25 interface outside

Configures the media-termination address used by
the media termination instance. The phone proxy
uses this address for SRTP and RTP.
For the media termination instance, you can
configure a global media-termination address for all
interfaces or configure a media-termination address
for different interfaces. However, you cannot use a
global media-termination address and
media-termination addresses configured for each
interface at the same time.
If you configure a media termination address for
multiple interfaces, you must configure an address
on each interface that the ASA uses when
communicating with IP phones.
The IP addresses are publicly routable addresses that
are unused IP addresses within the address range on
that interface.
See Media Termination Instance Prerequisites,
page 48-6 for the complete list of prerequisites that
you must follow when creating the media
termination instance and configuring the media
termination addresses.

Step 3

(Optional)
hostname(config-media-termination)# rtp-min-port
port1 rtp-max-port port2
Example:
hostname(config-media-termination)# rtp-min-port
2001 rtp-maxport 32770

Specifies the minimum and maximum values for the
RTP port range for the media termination instance.
Where port1 and port2 can be a value from 1024 to
65535.

What To Do Next

Once you have created the media termination instance, create the phone proxy instance. See Creating the
Phone Proxy Instance, page 48-23.

Creating the Phone Proxy Instance
Create the phone proxy instance.
Prerequisites

You must have already created the CTL file and TLS proxy instance for the phone proxy.
See Creating the CTL File, page 48-18 and Creating the TLS Proxy Instance for a Non-secure Cisco
UCM Cluster, page 48-20

Cisco ASA 5500 Series Configuration Guide using the CLI

48-23

Chapter 48

Configuring the Cisco Phone Proxy

Configuring the Phone Proxy

Step 1

Step 2

Command

Purpose

hostname(config)# phone-proxy phone_proxy_name
Example:
hostname(config)# phone-proxy myphoneproxy

Creates the phone proxy instance.

hostname(config-phone-proxy)# media-termination
instance_name
Examples:
hostname(config-phone-proxy)# media-termination
my_mt

Specifies the media termination instance used by the
phone proxy for SRTP and RTP.

Only one phone proxy instance can be configured on
the security appliance.

Note

You must create the media termination
instance before you specify it in the phone
proxy instance.

See Creating the Media Termination Instance,
page 48-22 for the steps to create the media
termination instance.
Step 3

hostname(config-phone-proxy)# tftp-server address
ip_address interface interface
Example:
hostname(config-phone-proxy)# tftp-server address
192.0.2.101 interface inside

Creates the TFTP server using the actual internal
address and specify the interface on which the TFTP
server resides.

Step 4

hostame(config-phone-proxy)# tls-proxy proxy_name
Example:
hostame(config-phone-proxy)# tls-proxy mytls

Configures the TLS proxy instance that you have
already created.

Step 5

hostname(config-phone-proxy)# ctl-file ctl_name
Example:
hostame(config-phone-proxy)# ctl-file myctl

Configures the CTL file instance that you have
already created,

Step 6

hostname(config-phone-proxy)# proxy-server address
ip_address [listen_port] interface ifc
Example:
hostname(config-phone-proxy)# proxy-server
192.168.1.2 interface inside

(Optional) If the operational environment has an
external HTTP proxy to which the IP phones direct
all HTTP request, configures a proxy server.
You can configure only one proxy server while the
phone proxy is in use.
By default, the Phone URL Parameters configured
under the Enterprise Parameters use an FQDN in the
URLs. The parameters might need to be changed to
use an IP address if the DNS lookup for the HTTP
proxy does not resolve the FQDNs.
Note

Cisco ASA 5500 Series Configuration Guide using the CLI

48-24

If the IP phones have already downloaded
their configuration files after you have
configured the proxy server, you must restart
the IP phones so that they get the
configuration file with the proxy server
address in the file.

Chapter 48

Configuring the Cisco Phone Proxy
Configuring the Phone Proxy

Step 7

Command

Purpose

hostname(config-phone-proxy)# cipc security-mode
authenticated

(Optional) Forces Cisco IP Communicator (CIPC)
softphones to operate in authenticated mode when
CIPC softphones are deployed in a voice and data
VLAN scenario.
See Cisco IP Communicator Prerequisites,
page 48-10 for all requirements for using the phone
proxy with CIPC.

Step 8

hostname(config-phone-proxy)# no disable
service-settings

(Optional) Preserve the settings configured on the
Cisco UCM for each IP phone configured.
By default, the following settings are disabled on the
IP phones:
•

PC Port

•

Gratuitous ARP

•

Voice VLAN access

•

Web Access

•

Span to PC Port

What to Do Next

Once you have created the phone proxy instance, configuring SIP and Skinny for the phone proxy. See
Enabling the Phone Proxy with SIP and Skinny Inspection, page 48-25.

Enabling the Phone Proxy with SIP and Skinny Inspection
Enables the phone proxy instance that you created to inspect SIP and Skinny protocol traffic.
Prerequisites

You must have already created the phone proxy instance. See Creating the Phone Proxy Instance,
page 48-23.

Step 1

Command

Purpose

hostname(config)# class-map class_map_name
Example:
class-map sec_sccp

Configures the secure Skinny class of traffic to
inspect. Traffic between the Cisco Unified
Communications Manager and Cisco IP Phones uses
SCCP and is handled by SCCP inspection.
Where class_map_name is the name of the Skinny
class map.

Step 2

hostname(config-cmap)# match port tcp eq 2443

Matches the TCP port 2443 to which you want to
apply actions for secure Skinny inspection.

Step 3

hostname(config-cmap)# exit

Exits from the Class Map configuration mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-25

Chapter 48

Configuring the Cisco Phone Proxy

Configuring the Phone Proxy

Command

Purpose

hostname(config)# class-map class_map_name
Example:
class-map sec_sip

Configures the secure SIP class of traffic to inspect.

Step 5

hostname(config-cmap)# match port tcp eq 5061

Matches the TCP port 5061 to which you want to
apply actions for secure SIP inspection

Step 6

hostname(config-cmap)# exit

Exits from the Class Map configuration mode.

Step 7

hostname(config)# policy-map name
Example:
policy-map pp_policy

Configure the policy map and attach the action to the
class of traffic.

Step 8

hostname(config-pmap)# class classmap-name
Example:
class sec_sccp

Assigns a class map to the policy map so that you
can assign actions to the class map traffic.

Step 4

Where class_map_name is the name of the SIP class
map.

Where classmap_name is the name of the Skinny
class map.
Step 9

hostname(config-pmap-c)# inspect skinny phone-proxy
pp_name
Example:
inspect skinny phone-proxy mypp

Enables SCCP (Skinny) application inspection and
enables the phone proxy for the specified inspection
session.

Step 10

hostnae(config-pmap)# class classmap-name
Example:
class sec_sip

Assigns a class map to the policy map so that you
can assign actions to the class map traffic.
Where classmap_name is the name of the SIP class
map.

Step 11

hostname(config-pmap-c)# inspect sip phone-proxy
pp_name
Example:
inspect sip phone-proxy mypp

Enables SIP application inspection and enables the
phone proxy for the specified inspection session.

Step 12

hostname(config-pmap-c)# exit

Exits from Policy Map configuration mode.

Step 13

hostname(config)# service-policy policymap_name
interface intf
Example:
service-policy pp_policy interface outside

Enables the service policy on the outside interface.

Configuring Linksys Routers with UDP Port Forwarding for the Phone Proxy
When IP phones are behind a NAT-capable router, the router can be configured to forward the UDP ports
to the IP address of the IP phone. Specifically, configure the router for UDP port forwarding when an IP
phone is failing during TFTP requests and the failure is due to the router dropping incoming TFTP data
packets. Configure the router to enable UDP port forwarding on port 69 to the IP phone.
As an alternative of explicit UDP forwarding, some Cable/DSL routers require you to designate the IP
phone as a DMZ host. For Cable/DSL routers, this host is a special host that receives all incoming
connections from the public network.
When configuring the phone proxy, there is no functional difference between an IP phone that has UDP
ports explicitly forwarded or an IP phone designated as a DMZ host. The choice is entirely dependent
upon the capabilities and preference of the end user.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-26

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

Configuring Your Router
Your firewall/router needs to be configured to forward a range of UDP ports to the IP phone. This will
allow the IP phone to receive audio when you make/receive calls.

Note

Different Cable/DSL routers have different procedures for this configuration. Furthermore most
NAT-capable routers will only allow a given port range to be forwarded to a single IP address
The configuration of each brand/model of firewall/router is different, but the task is the same. For
specific instructions for your brand and model of router, please contact the manufacturer’s website.
Linksys Routers

Step 1

From your web browser, connect to the router administrative web page. For Linksys, this is typically
something like http://192.168.1.1.

Step 2

Click Applications & Gaming or the Port Forwarding tab (whichever is present on your router).

Step 3

Locate the table containing the port forwarding data and add an entry containing the following values:

Step 4

Table 48-3

Port Forwarding Values to Add to Router

Application

Start

End

Protocol

IP Address

Enabled

IP phone

1024

65535

UDP

Phone IP address

Checked

TFTP

69

69

UDP

Phone IP address

Checked

Click Save Settings. Port forwarding is configured.

Troubleshooting the Phone Proxy
This section includes the following topics:
•

Debugging Information from the Security Appliance, page 48-27

•

Debugging Information from IP Phones, page 48-31

•

IP Phone Registration Failure, page 48-32

•

Media Termination Address Errors, page 48-40

•

Audio Problems with IP Phones, page 48-41

•

Saving SAST Keys, page 48-41

Debugging Information from the Security Appliance
This section describes how to use the debug, capture, and show commands to obtain debugging
information for the phone proxy. See the command reference for detailed information about the syntax
for these commands.
Table 48-4 lists the debug commands to use with the phone proxy.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-27

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

Table 48-4

Security Appliance Debug Commands to Use with the Phone Proxy

To

Use the Command

Notes

To show error and event messages for
TLS proxy inspection.

debug inspect tls-proxy [events |
errors]

Use this command when your IP phone
has successfully downloaded all TFTP
files but is failing to complete the TLS
handshake with the TLS proxy
configured for the phone proxy.

To show error and event messages of
media sessions for SIP and Skinny
inspections related to the phone proxy.

debug phone-proxy media [events |
errors]

Use this command in conjunction with
the debug sip command and the debug
skinny command if your IP phone is
experiencing call failures or audio
problems.

To show error and event messages of
signaling sessions for SIP and Skinny
inspections related to the phone proxy.

debug phone-proxy signaling
[events | errors]

Use this command in conjunction with
the debug sip command and the debug
skinny command if your IP phone is
failing to register with the Cisco UCM or
if you are experiencing call failure.

To show error and event messages of
TFTP inspection, including creation of
the CTL file and configuration file
parsing.

debug phone-proxy tftp [events |
errors]

To show debug messages for SIP
application inspection.

debug sip

Use this command when your IP phones
are experiencing connection problems;
for example, you can connect within the
network but cannot make calls off the
network. In the output, check for 4XX or
5XX messages.

To show debug messages for SCCP
(Skinny) application inspection.

debug skinny

Use this command when your IP phones
are experiencing connection problems;
for example, you can connect within the
network but cannot make calls off the
network. In the output, check for 4XX or
5XX messages.

Table 48-5 lists the capture commands to use with the phone proxy. Use the capture command on the
appropriate interfaces (IP phones and Cisco UCM) to enable packet capture capabilities for packet
sniffing and network fault isolation.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-28

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

Table 48-5

Security Appliance Capture Commands to Use with the Phone Proxy

To

Use the Command

Notes

To capture packets on the ASA interfaces. capture capture_name interface
interface_name

Use this command if you are
experiencing any problems that might
require looking into the packets.
For example, if there is a TFTP failure
and the output from the debug command
does not indicate the problem clearly, run
the capture command on the interface on
which the IP phone resides and the
interface on which the TFTP server
resides to see the transaction and where
the problem could be.

To capture data from the TLS proxy when capture capture_name packet-length
there is a non-secure IP phone connecting bytes interface inside buffer buf_size
to the phone proxy on the inside interface.
To capture encrypted data from the TLS
proxy when there are secure IP phones
connecting to the phone proxy on the
inside interface.

capture capture_name type tls-proxy
buffer buf_size packet-length bytes
interface inside

capture capture_name type tls-proxy If signaling fails, you might require
To capture encrypted inbound and
outbound data from the TLS proxy on one buffer buf_size packet-length bytes capturing decrypted packets to see the
contents of the SIP and SCCP signaling
or more interfaces.
interface interface_name
message. Use the type tls-proxy option
in the capture command.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-29

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

Table 48-6 lists the show commands to use with the phone proxy.
Table 48-6

Security Appliance Show Commands to Use with the Phone Proxy

To

Use the Command

Notes

To show the packets or connections
show asp drop
dropped by the accelerated security path.

Use this command to troubleshoot audio
quality issues with the IP phones or other
traffic issues with the phone proxy. In
addition to running this command, get
call status from the phone to check for
any dropped packets or jitter. See
Debugging Information from IP Phones,
page 48-31.

To show the classifier contents of the
accelerated security path for the specific
classifier domain.

If the IP phones are not downloading
TFTP files, use this command to check
that the classification rule for the domain
inspect-phone-proxy is set for hosts to
the configured TFTP server under the
phone proxy instance.

show asp table classify domain
domain_name

If the IP phones are failing to register, use
this command to make sure there is a
classification rule for the domain
app-redirect set for the IP phones that
cannot register.
To show the connections that are to the
ASA or from the ASA, in addition to
through-traffic connections.

show conn all

If you are experiencing problems with
audio, use this command to make sure
that there are connections opened from
the IP phone to the media termination
address.
Note

Use the show conn command
with following options to display
TFTP connections that have
replicated (unused) connections:
hostname# show conn |
include p

The output for the TFTP connections
should have a “p” flag at the end:
UDP out 64.169.58.181:9014 in
192.168.200.101:39420 idle 0:01:51
bytes 522 flags p

Using this command shows that the phone
proxy has connections that are going
through “inspect-phone-proxy”, which
inspects TFTP connections. Using this
command verifies that the TFTP requests
are being inspected because the p flag is
there.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-30

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

Table 48-6

Security Appliance Show Commands to Use with the Phone Proxy

To

Use the Command

Notes

To show the logs in the buffer and logging show logging
settings.

Before entering the show logging
command, enable the logging buffered
command so that the show logging
command displays the current message
buffer and the current settings.
Use this command to determine if the
phone proxy and IP phones are
successfully completing the TLS
handshake.
Note

To show the corresponding media
sessions stored by the phone proxy.

Using the show logging
command is useful for
troubleshooting many problems
where packets might be denied or
there are translation failures.

show phone-proxy media-sessions

Use this command to display output from
successful calls. Additionally, use this
command to troubleshoot problems with
IP phone audio, such as one-way audio.

To show the IP phones capable of Secure show phone-proxy secure-phones
mode stored in the database.

For any problems, make sure there is an
entry for the IP phone in this output and
that the port for this IP phone is non-zero,
which indicates that it has successfully
registered with the Cisco UCM.

To show the corresponding signaling
sessions stored by the phone proxy.

show phone-proxy
signaling-sessions

Use this command to troubleshoot media
or signaling failure.

To show the configured service policies.

show service-policy

Use this command to show statistics for
the service policy.

To show active TLS proxy sessions
related to the phone proxy.

show tls-proxy sessions

If the IP phone has failed to register, use
this command to see if the IP phone has
successfully completed the handshake
with the TLS proxy configured for the
phone proxy.

Debugging Information from IP Phones
On the IP phone, perform the following actions:
•

Check the Status messages on the IP phone by selecting the Settings button > Status > Status
Messages and selecting the status item that you want to view.

•

Collect the call-statistics data from the IP phone by selecting the Settings button > Status > Call
Statistic. Data like the following displays:
RxType: G.729
RxSize:
20 ms
RxCnt: 0
AvgJtr:
10
RxDisc: 0000

TxType: G.729
TxSize: 20 ms
TxCnt: 014174
MaxJtr: 59
RxLost: 014001

Cisco ASA 5500 Series Configuration Guide using the CLI

48-31

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

•

Check the Security settings on the IP phone by selecting the Settings button > Security
Configuration. Settings for web access, Security mode, MIC, LSC, CTL file, trust list, and CAPF
appear. Under Security mode, make sure the IP phone is set to Encrypted.

•

Check the IP phone to determine which certificates are installed on the phone by selecting the
Settings button > Security Configuration > Trust List. In the trustlist, verify the following:
– Make sure that there is an entry for each entity that the IP phone will need to contact. If there

is a primary and backup Cisco UCM, the trustlist should contain entries for each Cisco UCM.
– If the IP phone needs an LSC, the record entry should contain a CAPF entry.
– Make sure that the IP addresses listed for each entry are the mapped IP addresses of the entities

that the IP phone can reach.
•

Open a web browser and access the IP phone console logs at the URL http://IP_phone_IP
The device information appears in the page. In the Device Logs section in the left pane,
click Console Logs.

address.

IP Phone Registration Failure
The following errors can make IP phones unable to register with the phone proxy:
•

TFTP Auth Error Displays on IP Phone Console, page 48-32

•

Configuration File Parsing Error, page 48-33

•

Configuration File Parsing Error: Unable to Get DNS Response, page 48-33

•

Non-configuration File Parsing Error, page 48-34

•

Cisco UCM Does Not Respond to TFTP Request for Configuration File, page 48-34

•

IP Phone Does Not Respond After the Security Appliance Sends TFTP Data, page 48-35

•

IP Phone Requesting Unsigned File Error, page 48-36

•

IP Phone Unable to Download CTL File, page 48-36

•

IP Phone Registration Failure from Signaling Connections, page 48-37

•

SSL Handshake Failure, page 48-39

•

Certificate Validation Errors, page 48-40

TFTP Auth Error Displays on IP Phone Console
Problem The IP phone displays the following Status message:
TFTP Auth Error

Solution This Status message can indicate a problem with the IP phone CTL file.

To correct problems with the IP phone CTL file, perform the following:
Step 1

From the IP phone, select the Setting button > Security Configuration > Trust List. Verify that each
entity in the network—Primary Cisco UCM, Secondary Cisco UCM, TFTP server—has its own entry in
the trustlist and that each entity IP address is reachable by the IP phone.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-32

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

Step 2

From the ASA, verify that the CTL file for the phone proxy contains one record entry for each entity in
the network—Primary Cisco UCM, Secondary Cisco UCM, TFTP server—by entering the following
command:
hostname# show running-config all ctl-file [ctl_name]

Each of these record entries creates one entry on the IP phone trustlist. The phone proxy creates one entry
internally with the function CUCM+TFTP.
Step 3

In the CTL file, verify that each IP address is the global or mapped IP address of the entity. If the IP
phones are on multiple interfaces, additional addressing requirements apply. See Prerequisites for IP
Phones on Multiple Interfaces, page 48-9.

Configuration File Parsing Error
Problem When the ASA receives the configuration file from the Cisco UCM and tries to parse it, the
following error appears in the debug output (debug phone-proxy tftp errors):
PP: 192.168.10.5/49357 requesting SEP00010002003.cnf.xml.sgn
PP: opened 0x193166
.......
PP: Beginning of element tag is missing, got !
PP: error parsing config file
PP: Error modifying config file, dropping packet

Solution Perform the following actions to troubleshoot this problem:
Step 1

Enter the following URL in a web browser to obtain the IP phone configuration file from the Cisco
Unified CM Administration console:
http://:6970/

For example, if the Cisco UCM IP address is 128.106.254.2 and the IP phone configuration file name is
SEP000100020003.cnf.xml, enter:
http://128.106.254.2:6970/SEP000100020003.cnf.xml

Step 2

Save this file, open a case with TAC and send them this file and the output from running the debug
phone-proxy tftp command on the ASA.

Configuration File Parsing Error: Unable to Get DNS Response
Problem When the ASA receives the configuration file from the Cisco UCM and tries to parse it, the
following error appears in the debug output (debug phone-proxy tftp errors):
PP: 192.168.10.5/49357 requesting SEP00010002003.cnf.xml.sgn
PP: opened 0x193166
.......
PP: Callback required for parsing config file
PP: Unable to get dns response for id 7
PP: Callback, error modifying config file

The error indicates that the Cisco UCM is configured as an FQDN and the phone proxy is trying to do a
DNS lookup but failed to get a response.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-33

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

Solution
Step 1

Verify that DNS lookup is configured on the ASA.

Step 2

If DNS lookup is configured, determine whether you can ping the FQDN for the Cisco UCM from the
ASA.

Step 3

If ASA cannot ping the Cisco UCM FQDN, check to see if there is a problem with the DNS server.

Step 4

Additionally, use the name command to associate a name with an IP address with the FQDN. See the
command reference for information about using the name command.

Non-configuration File Parsing Error
Problem The ASA receives a file other than an IP phone configuration file from the Cisco UCM and
attempts to parse it. The following error appears in the debug output (debug phone-proxy tftp):
PP: 192.168.10.5/49357 requesting SK72f64050-7ad5-4b47-9bfa-5e9ad9cd4aa9.xml.sgn
PP: opened 0x193166
.......
PP: Beginning of element tag is missing, got !
PP: error parsing config file
PP: Error modifying config file, dropping packet

Solution The phone proxy should parse only the IP phone configuration file. When the phone proxy

TFTP state gets out of state, the phone proxy cannot detect when it is attempting to parse a file other
than the IP phone configuration file and the error above appears in the ASA output from the debug
phone-proxy tftp command.
Perform the following actions to troubleshoot this problem:
Step 1

Reboot the IP phone.

Step 2

On the ASA, enter the following command to obtain the error information from the first TFTP request
to the point where the first error occurred.
hostname# debug phone-proxy tftp

Step 3

Capture the packets from the IP phone to the ASA. Make sure to capture the packets on the interface
facing the IP phone and the interface facing the Cisco UCM. See Debugging Information from the
Security Appliance, page 48-27.

Step 4

Save this troubleshooting data, open a case with TAC and give them this information.

Cisco UCM Does Not Respond to TFTP Request for Configuration File
Problem When the ASA forwards the TFTP request to the Cisco UCM for the IP phone configuration
file, the Cisco UCM does not respond and the following errors appear in the debug output (debug
phone-proxy tftp):
PP: 192.168.10.5/49355 requesting SEP001562106AF3.cnf.xml.sgn
PP: opened 0x17ccde
PP: 192.168.10.5/49355 requesting SEP001562106AF3.cnf.xml.sgn

Cisco ASA 5500 Series Configuration Guide using the CLI

48-34

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

PP: Client outside:192.168.10.5/49355 retransmitting request for Config file
SEP001562106AF3.cnf.xml.sgn
PP: opened 0x17ccde
PP: 192.168.10.5/49355 requesting SEP001562106AF3.cnf.xml.sgn
PP: Client outside:192.168.10.5/49355 retransmitting request for Config file
SEP001562106AF3.cnf.xml.sgn
PP: opened 0x17ccde
PP: 192.168.10.5/49355 requesting SEP001562106AF3.cnf.xml.sgn
PP: Client outside:192.168.10.5/49355 retransmitting request for Config file
SEP001562106AF3.cnf.xml.sgn
PP: opened 0x17ccde

Solution Perform the following actions to troubleshoot this problem:
Step 1

Step 2

Determine why the Cisco UCM is not responding to the TFTP request by performing the following
troubleshooting actions:
•

Use the Cisco UCM to ping the ASA inside interface when PAT is configured for the outside
interface so that the IP phone IP address is uses NAT for the ASA inside interface IP address.

•

Use the Cisco UCM to ping the IP phone IP address when NAT and PAT are not configured.

Verify that the ASA is forwarding the TFTP request. Capture the packets on the interface between the
ASA and Cisco UCM. See Debugging Information from the Security Appliance, page 48-27.

IP Phone Does Not Respond After the Security Appliance Sends TFTP Data
Problem When the ASA receives a TFTP request from the IP phone for the CTL file and forwards the
data to the IP phone, the phone might not see the data and the TFTP transaction fails.

The following errors appear in the debug output (debug phone-proxy tftp):
PP: Client outside:68.207.118.9/33606 retransmitting request for CTL file
CTLSEP001DA2B78E91.tlv
PP: opened 0x214b27a
PP: Data Block 1 forwarded from 168.215.146.220/20168 to 68.207.118.9/33606 ingress ifc
outside
PP: 68.207.118.9/33606 requesting CTLSEP001DA2B78E91.tlv
PP: Client outside:68.207.118.9/33606 retransmitting request for CTL file
CTLSEP001DA2B78E91.tlv
PP: 68.207.118.9/33606 requesting CTLSEP001DA2B78E91.tlv
PP: Client outside:68.207.118.9/33606 retransmitting request for CTL file
CTLSEP001DA2B78E91.tlv

Solution Perform the following actions to determine why the IP phone is not responding and to

troubleshoot the problem:
Step 1

Verify that the ASA is forwarding the TFTP request by entering the following command to capture the
packets on the interface between the ASA and the IP phone:
hostname# capture out interface outside

See the command reference for more information about using the capture command.
Step 2

If the IP phone is behind a router, the router might be dropping the data. Make sure UDP port forwarding
is enabled on the router.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-35

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

Step 3

If the router is a Linksys router, see Configuring Linksys Routers with UDP Port Forwarding for the
Phone Proxy, page 48-26 for information on the configuration requirements.

IP Phone Requesting Unsigned File Error
Problem The IP phone should always request a signed file. Therefore, the TFTP file being requested
always has the .SGN extension.

When the IP phone does not request a signed file, the following error appears in the debug output (debug
phone-proxy tftp errors):
Error: phone requesting for unsigned config file

Solution Most likely, this error occurs because the IP phone has not successfully installed the CTL file

from the ASA.
Determine whether the IP phone has successfully downloaded and installed the CTL file from the ASA
by checking the Status messages on the IP phone. See Debugging Information from IP Phones,
page 48-31 for information.

IP Phone Unable to Download CTL File
Problem The IP phone Status message indicates it cannot download its CTL file and the IP phone cannot
be converted to Secure (encrypted) mode.
Solution If the IP phone did not have an existing CTL file, check the Status messages by selecting the

Settings button > Status > Status Messages. If the list contains a Status message indicating the IP phone
encountered a CTL File Auth error, obtain the IP phone console logs, open a TAC case, and send them
the logs.
Solution This error can appear in the IP phone Status messages when the IP phone already has an existing

CTL file.
Step 1

Check the IP phone to see if a CTL file already exists on it. This can occur if the IP phone previously
registered with a mixed mode cluster Cisco UCM. On the IP phone, select the Settings button > Security
Configuration > CTL file.

Step 2

Erase the existing CTL file by selecting the Settings button > Security Configuration > CTL file > Select.
Press **# on the keypad and select Erase.

Solution Problems downloading the CTL file might be caused by issues with media termination. Enter
the following command to determine if the media-termination address in the phone proxy configuration
is set correctly:
hostname(config)# show running-config all phone-proxy
!
phone-proxy mypp
media-termination address 10.10.0.25
cipc security-mode authenticated
cluster-mode mixed
disable service-settings
timeout secure-phones 0:05:00
hostname(config)#

Cisco ASA 5500 Series Configuration Guide using the CLI

48-36

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

Make sure that each media-termination instance is created correctly and that the address or addresses are
set correctly. The ASA must meet specific criteria for media termination. See Media Termination
Instance Prerequisites, page 48-6 for the complete list of prerequisites that you must follow when
creating the media termination instance and configuring the media termination addresses.

IP Phone Registration Failure from Signaling Connections
Problem The IP phone is unable to complete the TLS handshake with the phone proxy and download its
files using TFTP.
Solution
Step 1

Determine if the TLS handshake is occurring between the phone proxy and the IP phone, perform the
following:
a.

Enable logging with the following command:
hostname(config)# logging buffered debugging

b.

To check the output from the syslogs captured by the logging buffered command, enter the
following command:
hostname# show logging

The syslogs will contain information showing when the IP phone is attempting the TLS handshake,
which happens after the IP phone downloads its configuration file.
Step 2

Determine if the TLS proxy is configured correctly for the phone proxy:
a.

Display all currently running TLS proxy configurations by entering the following command:
hostname# show running-config tls-proxy
tls-proxy proxy
server trust-point _internal_PP_
client ldc issuer ldc_signer
client ldc key-pair phone_common
no client cipher-suite
hostname#

b.

Verify that the output contains the server trust-point command under the tls-proxy command (as
shown in substep a.).
If you are missing the server trust-point command, modify the TLS proxy in the phone proxy
configuration.
See Step 3 in the “Task Flow for Configuring the Phone Proxy in a Non-secure Cisco UCM Cluster”
section on page 48-15, or Step 3 in the “Task Flow for Configuring the Phone Proxy in a
Mixed-mode Cisco UCM Cluster” section on page 48-17.
Having this command missing from the TLS proxy configuration for the phone proxy will cause
TLS handshake failure.

Step 3

Verify that all required certificates are imported into the ASA so that the TLS handshake will succeed.
a.

Determine which certificates are installed on the ASA by entering the following command:
hostname# show running-config crypto

Additionally, determine which certificates are installed on the IP phones. See Debugging
Information from IP Phones, page 48-31 for information about checking the IP phone to determine
if it has MIC installed on it.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-37

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

b.

Verify that the list of installed certificates contains all required certificates for the phone proxy.
See Table 48-2, Certificates Required by the Security Appliance for the Phone Proxy, for
information.

c.
Step 4

Import any missing certificates onto the ASA. See also Importing Certificates from the Cisco UCM,
page 48-15.

If the steps above fail to resolve the issue, perform the following actions to obtain additional
troubleshooting information for Cisco Support.
a.

Enter the following commands to capture additional debugging information for the phone proxy:
hostname# debug inspect tls-proxy error
hostname# show running-config ssl
hostname(config) show tls-proxy tls_name session host host_addr detail

b.

Enable the capture command on the inside and outside interfaces (IP phones and Cisco UCM) to
enable packet capture capabilities for packet sniffing and network fault isolation. See the command
reference for information.

Problem The TLS handshake succeeds, but signaling connections are failing.
Solution Perform the following actions:
•

•

Check to see if SIP and Skinny signaling is successful by using the following commands:
–

debug sip

–

debug skinny

If the TLS handshake is failing and you receive the following syslog, the SSL encryption method
might not be set correctly:
%ASA-6-725001:
session.
%ASA-7-725010:
%ASA-7-725011:
%ASA-7-725008:
%ASA-7-725011:
%ASA-7-725011:
%ASA-7-725014:
%ASA-6-725006:

Starting SSL handshake with client dmz:171.169.0.2/53097 for TLSv1
Device supports the following 1 cipher(s).
Cipher[1] : RC4-SHA
SSL client dmz:171.169.0.2/53097 proposes the following 2 cipher(s).
Cipher[1] : AES256-SHA
Cipher[2] : AES128-SHA
SSL lib error. Function: SSL3_GET_CLIENT_HELLO Reason: no shared cipher
Device failed SSL handshake with dmz client:171.169.0.2/53097

Set the correct ciphers by completing the following procedure:
Step 1

To see the ciphers being used by the phone proxy, enter the following command:
hostname# show run all ssl

Step 2

To add the required ciphers, enter the following command:
hostname(config)# ssl encryption

The default is to have all algorithms available in the following order:
[3des-sha1] [des-sha1] [rc4-md5] [possibly others]
See the command reference for more information about setting ciphers with the ssl encryption
command.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-38

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

SSL Handshake Failure
Problem The phone proxy is not functioning. Initial troubleshooting uncovered the following errors in
the ASA syslogs:
%ASA-7-725014: SSL lib error. Function: SSL3_READ_BYTES Reason: ssl handshake failure
%ASA-7-725014: SSL lib error. Function: SSL3_GET_CLIENT_CERTIFICATE Reason: no certificate
returned
%ASA-6-725006: Device failed SSL handshake with outside client:72.146.123.158/30519
%ASA-3-717009: Certificate validation failed. No suitable trustpoints found to validate
certificate serial number: 62D06172000000143FCC, subject name:
cn=CP-7962G-SEP002155554502,ou=EVVBU,o=Cisco Systems Inc.
%ASA-3-717027: Certificate chain failed validation. No suitable trustpoint was found to
validate chain.

Solution

Verify that all required certificates are imported into the ASA so that the TLS handshake will succeed.
Step 1

Determine which certificates are installed on the ASA by entering the following command:
hostname# show running-config crypto

Additionally, determine which certificates are installed on the IP phones. See Debugging
Information from IP Phones, page 48-31 for information about checking the IP phone to determine
if it has MIC installed on it.
Step 2

Verify that the list of installed certificates contains all required certificates for the phone proxy.
See Table 48-2, Certificates Required by the Security Appliance for the Phone Proxy, for
information.

Step 3

Import any missing certificates onto the ASA. See also Importing Certificates from the Cisco UCM,
page 48-15.

Problem The phone proxy is not functioning. Initial troubleshooting uncovered the following errors in
the ASA syslogs:
%ASA-6-725001:
session.
%ASA-7-725010:
%ASA-7-725011:
%ASA-7-725008:
%ASA-7-725011:
%ASA-7-725011:
%ASA-7-725014:
%ASA-6-725006:

Starting SSL handshake with client dmz:171.169.0.2/53097 for TLSv1
Device supports the following 1 cipher(s).
Cipher[1] : RC4-SHA
SSL client dmz:171.169.0.2/53097 proposes the following 2 cipher(s).
Cipher[1] : AES256-SHA
Cipher[2] : AES128-SHA
SSL lib error. Function: SSL3_GET_CLIENT_HELLO Reason: no shared cipher
Device failed SSL handshake with dmz client:171.169.0.2/53097

Solution the SSL encryption method might not be set correctly. Set the correct ciphers by completing the

following procedure:
Step 1

To see the ciphers being used by the phone proxy, enter the following command:
hostname# show run all ssl

Step 2

To add the required ciphers, enter the following command:
hostname(config)# ssl encryption

The default is to have all algorithms available in the following order:

Cisco ASA 5500 Series Configuration Guide using the CLI

48-39

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

[3des-sha1] [des-sha1] [rc4-md5] [possibly others]
See the command reference for more information about setting ciphers with the ssl encryption
command.

Certificate Validation Errors
Problem Errors in the ASA log indicate that certificate validation errors occurred.

Entering the show logging asdm command, displayed the following errors:
3|Jun 19 2008 17:23:54|717009: Certificate validation failed. No suitable trustpoints
found to validate
certificate serial number: 348FD2760000000E6E27, subject name:
cn=CP-7961G-SEP001819A89CC3,ou=EVVBU,o=Cisco Systems Inc.

Solution

In order for the phone proxy to authenticate the MIC provided by the IP phone, it needs the Cisco
Manufacturing CA (MIC) certificate imported into the ASA.
Verify that all required certificates are imported into the ASA so that the TLS handshake will succeed.
Step 1

Determine which certificates are installed on the ASA by entering the following command:
hostname# show running-config crypto

Additionally, determine which certificates are installed on the IP phones. The certificate information
is shown under the Security Configuration menu. See Debugging Information from IP Phones,
page 48-31 for information about checking the IP phone to determine if it has the MIC installed on
it.
Step 2

Verify that the list of installed certificates contains all required certificates for the phone proxy.
See Table 48-2, Certificates Required by the Security Appliance for the Phone Proxy, for
information.

Step 3

Import any missing certificates onto the ASA. See also Importing Certificates from the Cisco UCM,
page 48-15.

Media Termination Address Errors
Problem Entering the media-termination address command displays the following errors:
hostname(config-phone-proxy)# media-termination address ip_address
ERROR: Failed to apply IP address to interface Virtual254, as the network overlaps with
interface GigabitEthernet0/0. Two interfaces cannot be in the same subnet.
ERROR: Failed to set IP address for the Virtual interface
ERROR: Could not bring up Phone proxy media termination interface
ERROR: Failed to find the HWIDB for the Virtual interface

Solution Enter the following command to determine if the media-termination address in the phone proxy

configuration is set correctly:
hostname(config)# show running-config all phone-proxy
asa2(config)# show running-config all phone-proxy
!

Cisco ASA 5500 Series Configuration Guide using the CLI

48-40

Chapter 48

Configuring the Cisco Phone Proxy
Troubleshooting the Phone Proxy

phone-proxy mypp
media-termination address 10.10.0.25
cipc security-mode authenticated
cluster-mode mixed
disable service-settings
timeout secure-phones 0:05:00
hostname(config)#

Make sure that each media-termination instance is created correctly and that the address or addresses are
set correctly. The ASA must meet specific criteria for media termination. See Media Termination
Instance Prerequisites, page 48-6 for the complete list of prerequisites that you must follow when
creating the media termination instance and configuring the media termination addresses.

Audio Problems with IP Phones
The following audio errors can occur when the IP phones connecting through the phone proxy.

Media Failure for a Voice Call
Problem The call signaling completes but there is one way audio or no audio.
Solution
•

Problems with one way or no audio might be caused by issues with media termination. Enter the
following command to determine if the media-termination address in the phone proxy configuration
is set correctly:
hostname(config)# show running-config all phone-proxy
asa2(config)# show running-config all phone-proxy
!
phone-proxy mypp
media-termination address 10.10.0.25
cipc security-mode authenticated
cluster-mode mixed
disable service-settings
timeout secure-phones 0:05:00
hostname(config)#

•

Make sure that each media-termination instance is created correctly and that the address or
addresses are set correctly. The ASA must meet specific criteria for media termination. See Media
Termination Instance Prerequisites, page 48-6 for the complete list of prerequisites that you must
follow when creating the media termination instance and configuring the media termination
addresses.

•

If each media-termination address meets the requirements, determine whether the IP addresses are
reachable by all IP phones.

•

If each IP address is set correctly and reachable by all IP phones, check the call statistics on an IP
phone (see Debugging Information from IP Phones, page 48-31) and determine if there are Rcvr
packets and Sender packets on the IP phone, or if there are any Rcvr Lost or Discarded packets.

Saving SAST Keys
Site Administrator Security Token (SAST) keys on the ASA can be saved in the event a recovery is
required due to hardware failure and a replacement is required. The following steps shows how to
recover the SAST keys and use them on the new hardware.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-41

Chapter 48

Configuring the Cisco Phone Proxy

Troubleshooting the Phone Proxy

The SAST keys can be seen via the show crypto key mypubkey rsa command. The SAST keys are
associated with a trustpoint that is labeled _internal_ctl-file_name_SAST_X where ctl-file-name is the
name of the CTL file instance that was configured, and X is an integer from 0 to N-1 where N is the
number of SASTs configured for the CTL file (the default is 2).
Step 1

On the ASA, export all the SAST keys in PKCS-12 format by using the crypto ca export command:
hostname(config)# crypto ca export _internal_ctl-file_name_SAST_X pkcs12 passphrase
hostname(config)# Exported pkcs12 follows:
MIIGZwIBAzCCBiEGCSqGSIb3DQEHAaCCBhIEggYOMIIGCjCCBgYGCSqGSIb3DQEH
[snip]
MIIGZwIBAzCCBiEGCSqGSIb3DQEHAaCCBhIEggYOMIIGCjCCBgYGCSqGSIb3DQEH
---End - This line not part of the pkcs12--hostname(config)# crypto ca export _internal_ctl-file_name_SAST_X pkcs12 passphrase
hostname(config)# Exported pkcs12 follows:
MIIGZwIBAzCCBiEGCSqGSIb3DQEHAaCCBhIEggYOMIIGCjCCBgYGCSqGSIb3DQEH
[snip]
mGF/hfDDNAICBAA=
---End - This line not part of the pkcs12--hostname(config)#

Note
Step 2

Save this output somewhere secure.

Import the SAST keys to a new ASA.
a.

To import the SAST key, enter the following command:
hostname(config)# crypto ca import trustpoint pkcs12 passphrase

Where trustpoint is _internal_ctl-file_name_SAST_X and ctl-file-name is the name of the CTL file
instance that was configured, and X is an integer from 0 to 4 depending on what you exported from
the ASA.
b.

Using the PKCS-12 output you saved in Step 1, enter the following command and paste the output
when prompted:
hostname(config)# crypto ca import _internal_ctl-file_name_SAST_X pkcs12 passphrase
hostname(config)# Enter the base 64 encoded pkcs12.
hostname(config)# End with the word "quit" on a line by itself:
MIIGZwIBAzCCBiEGCSqGSIb3DQEHAaCCBhIEggYOMIIGCjCCBgYGCSqGSIb3DQEH
[snip]
muMiZ6eClQICBAA=
hostname(config)# quit
INFO: Import PKCS12 operation completed successfully
hostname(config)# crypto ca import _internal_ctl-file_name_SAST_X pkcs12 passphrase
hostname(config)# Enter the base 64 encoded pkcs12.
hostname(config)# End with the word "quit" on a line by itself:
MIIGZwIBAzCCBiEGCSqGSIb3DQEHAaCCBhIEggYOMIIGCjCCBgYGCSqGSIb3DQEH
[snip]

Cisco ASA 5500 Series Configuration Guide using the CLI

48-42

Chapter 48

Configuring the Cisco Phone Proxy
Configuration Examples for the Phone Proxy

mGF/hfDDNAICBAA=
hostname(config)# quit
INFO: Import PKCS12 operation completed successfully
hostname(config)#

Step 3

Create the CTL file instance on the new ASA using the same name as the one used in the SAST
trustpoints created in Step 2 by entering the following commands. Create trustpoints for each Cisco
UMC (primary and secondary).
hostname(config)# ctl-file
hostname(config-ctl-file)#
hostname(config-ctl-file)#
hostname(config-ctl-file)#

ctl_name
record-entry cucm trustpoint trust_point address address
record-entry capf trustpoint trust_point address address
no shutdown

Configuration Examples for the Phone Proxy
This section includes the following topics:
•

Example 1: Nonsecure Cisco UCM cluster, Cisco UCM and TFTP Server on Publisher, page 48-43

•

Example 2: Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on Publisher,
page 48-45

•

Example 3: Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on Different Servers,
page 48-46

•

Example 4: Mixed-mode Cisco UCM cluster, Primary Cisco UCM, Secondary and TFTP Server on
Different Servers, page 48-47

•

Example 5: LSC Provisioning in Mixed-mode Cisco UCM cluster; Cisco UCM and TFTP Server on
Publisher, page 48-49

•

Example 6: VLAN Transversal, page 48-51

Example 1: Nonsecure Cisco UCM cluster, Cisco UCM and TFTP Server on
Publisher
Figure 48-2 shows an example of the configuration for a non-secure Cisco UCM cluster using the
following topology.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-43

Chapter 48

Configuring the Cisco Phone Proxy

Configuration Examples for the Phone Proxy

Figure 48-2

Nonsecure Cisco UCM cluster, Cisco UCM and TFTP Server on Publisher

Corporate Network
IP

Cisco UCM+TFTP
192.0.2.101

Comcast Address
69.181.112.219
ASA Outside Interface
10.10.0.24

IP

M

Home Router
w/NAT

Comcast Address
98.208.49.30
Home Router
w/NAT

Cisco UCM cluster is in
nonsecure mode

ASA Inside Interface
192.0.2.1

IP

Phone A
192.0.2.16

IP

object network obj-192.0.2.101
host 192.0.2.101
nat (inside,outside) static 10.10.0.26
access-list pp extended permit udp any host 10.10.0.26 eq 69
access-group pp in interface outside
crypto key generate rsa label cucmtftp_kp modulus 1024
crypto ca trustpoint cucm_tftp_server
enrollment self
keypair cucmtftp_kp
crypto ca enroll cucm_tftp_server
ctl-file myctl
record-entry cucm-tftp trustpoint cucm_tftp_server address 10.10.0.26
no shutdown
tls-proxy mytls
server trust-point _internal_PP_myctl
media-termination my_mediaterm
address 192.0.2.25 interface inside
address 10.10.0.25 interface outside
phone-proxy mypp
media-termination my_mediaterm
tftp-server address 192.0.2.101 interface inside
tls-proxy mytls
ctl-file myctl
class-map sec_sccp
match port tcp 2443
class-map sec_sip
match port tcp eq 5061
policy-map pp_policy
class sec_sccp
inspect skinny phone-proxy mypp
class sec_sip
inspect sip phone-proxy mypp
service-policy pp_policy interface outside

Cisco ASA 5500 Series Configuration Guide using the CLI

48-44

271632

Internet

Chapter 48

Configuring the Cisco Phone Proxy
Configuration Examples for the Phone Proxy

Example 2: Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on
Publisher
Figure 48-3 shows an example of the configuration for a mixed-mode Cisco UCM cluster using the
following topology.
Figure 48-3

Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on Publisher

Corporate Network
IP

Cisco UCM+TFTP
192.0.2.101

Comcast Address
69.181.112.219
ASA Outside Interface
10.10.0.24

IP

M

Home Router
w/NAT
Internet

Comcast Address
98.208.49.30
Home Router
w/NAT

Cisco UCM cluster is in
nonsecure mode

ASA Inside Interface
192.0.2.1

IP

Phone A
192.0.2.16
271632

IP

object network obj-192.0.2.101
host 192.0.2.101
nat (inside,outside) static 10.10.0.26
access-list pp extended permit udp any host 10.10.0.26 eq 69
access-group pp in interface outside
crypto key generate rsa label cucmtftp_kp modulus 1024
crypto ca trustpoint cucm_tftp_server
enrollment self
keypair cucmtftp_kp
crypto ca enroll cucm_tftp_server
ctl-file myctl
record-entry cucm-tftp trustpoint cucm_tftp_server address 10.10.0.26
no shutdown
crypto key generate rsa label ldc_signer_key modulus 1024
crypto key generate rsa label phone_common modulus 1024
crypto ca trustpoint ldc_server
enrollment self
proxy_ldc_issuer
fqdn my-ldc-ca.exmaple.com
subject-name cn=FW_LDC_SIGNER_172_23_45_200
keypair ldc_signer_key
crypto ca enroll ldc_server
tls-proxy my_proxy
server trust-point _internal_PP_myctl
client ldc issuer ldc_server
client ldc keypair phone_common
client cipher-suite aes128-sha1 aes256-sha1
media-termination my_mediaterm
address 192.0.2.25 interface inside

Cisco ASA 5500 Series Configuration Guide using the CLI

48-45

Chapter 48

Configuring the Cisco Phone Proxy

Configuration Examples for the Phone Proxy

address 10.10.0.25 interface outside
phone-proxy mypp
media-termination my_mediaterm
tftp-server address 192.0.2.101 interface inside
tls-proxy mytls
ctl-file myctl
cluster-mode mixed
class-map sec_sccp
match port tcp 2443
class-map sec_sip
match port tcp eq 5061
policy-map pp_policy
class sec_sccp
inspect skinny phone-proxy mypp
class sec_sip
inspect sip phone-proxy mypp
service-policy pp_policy interface outside

Example 3: Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on
Different Servers
Figure 48-4 shows an example of the configuration for a mixed-mode Cisco UCM cluster using the
following topology where the TFTP server resides on a different server from the Cisco UCM.
In this sample, the static interface PAT for the TFTP server is configured to appear like the ASA’s outside
interface IP address.
Figure 48-4

Mixed-mode Cisco UCM cluster, Cisco UCM and TFTP Server on Different Servers

Cisco UCM
192.0.2.105
M

TFTP / Publisher
192.0.2.101

ASA Inside Interface
192.0.2.24

M

Corporate
Network

IP

Phone A
192.0.2.102

Internet

ASA Outside Interface
10.10.0.24

IP

Home Router Comcast
Address
w/NAT
98.208.49.30

IP
IP

Home Router Comcast
Address
w/NAT
69.181.112.219
271634

Phone B
192.0.2.103

object network obj-192.0.2.105
host 192.0.2.105
nat (inside,outside) static 10.10.0.26
object network obj-192.0.2.101

Cisco ASA 5500 Series Configuration Guide using the CLI

48-46

Chapter 48

Configuring the Cisco Phone Proxy
Configuration Examples for the Phone Proxy

host 192.0.2.101
nat (inside,outside) static interface udp 69 69
access-list pp extended permit udp any host 10.10.0.24 eq 69
access-group pp in interface outside
crypto key generate rsa label cucm_kp modulus 1024
crypto ca trustpoint cucm
enrollment self
keypair cucm_kp
crypto ca enroll cucm
crypto key generate rsa label tftp_kp modulus 1024
crypto ca trustpoint tftp_server
enrollment self
keypair tftp_kp
crypto ca enroll tftp_server
ctl-file myctl
record-entry cucm trustpoint cucm_server address 10.10.0.26
no shutdown
crypto key generate rsa label ldc_signer_key modulus 1024
crypto key generate rsa label phone_common modulus 1024
crypto ca trustpoint ldc_server
enrollment self
proxy_ldc_issuer
fqdn my-ldc-ca.exmaple.com
subject-name cn=FW_LDC_SIGNER_172_23_45_200
keypair ldc_signer_key
crypto ca enroll ldc_server
tls-proxy my_proxy
server trust-point _internal_PP_myctl
client ldc issuer ldc_server
client ldc keypair phone_common
client cipher-suite aes128-sha1 aes256-sha1
media-termination my_mediaterm
address 192.0.2.25 interface inside
address 10.10.0.25 interface outside
phone-proxy mypp
media-termination my_mediaterm
tftp-server address 192.0.2.101 interface inside
tls-proxy mytls
ctl-file myctl
cluster-mode mixed
class-map sec_sccp
match port tcp 2443
class-map sec_sip
match port tcp eq 5061
policy-map pp_policy
class sec_sccp
inspect skinny phone-proxy mypp
class sec_sip
inspect sip phone-proxy mypp
service-policy pp_policy interface outside

Example 4: Mixed-mode Cisco UCM cluster, Primary Cisco UCM, Secondary
and TFTP Server on Different Servers
Figure 48-5 shows an example of the configuration for a mixed-mode Cisco UCM cluster using the
following topology where the TFTP server resides on a different server from the primary and secondary
Cisco UCMs.
In this sample, the static interface PAT for the TFTP server is configured to appear like the ASA’s outside
interface IP address.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-47

Chapter 48

Configuring the Cisco Phone Proxy

Configuration Examples for the Phone Proxy

Figure 48-5

Mixed-mode Cisco UCM cluster, Primary Cisco UCM, Secondary Cisco UCM, and TFTP
Server on Different Servers

Primary Cisco UCM
192.0.2.105

Secondary Cisco UCM
192.0.2.106

M

M

ASA Inside Interface
192.0.2.24

TFTP / Publisher
192.0.2.101
Corporate
Network

M

IP

Phone A
192.0.2.102

Internet

IP

Home Router Comcast
Address
w/NAT
98.208.49.30
ASA Outside Interface
10.10.0.24

IP
IP

271635

Phone B
192.0.2.103

Home Router Comcast
Address
w/NAT
69.181.112.219

object network obj-192.0.2.105
host 192.0.2.105
nat (inside,outside) static 10.10.0.27
object network obj-192.0.2.101
host 192.0.2.101
nat (inside,outside) static interface udp 69 69
object network obj-192.0.2.106
host 192.0.2.106
nat (inside,outside) static 10.10.0.26
access-list pp extended permit udp any host 10.10.0.24 eq 69
access-group pp in interface outside
crypto key generate rsa label cluster_kp modulus 1024
crypto ca trustpoint pri_cucm
enrollment self
keypair cluster_kp
crypto ca enroll pri_cucm
crypto ca trustpoint sec_cucm
enrollment self
serial-number
keypair cluster_kp
crypto ca enroll sec_cucm
crypto ca trustpoint tftp_server
enrollment self
fqdn my_tftp.example.com
keypair cluster_kp
crypto ca enroll tftp_server
ctl-file myctl
record-entry tftp trustpoint tftp_server address 10.10.0.24
record-entry cucm trustpoint pri_cucm_server address 10.10.0.27
record-entry cucm trustpoint sec_cucm_server address 10.10.0.2
no shutdown
crypto key generate rsa label ldc_signer_key modulus 1024
crypto key generate rsa label phone_common modulus 1024

Cisco ASA 5500 Series Configuration Guide using the CLI

48-48

Chapter 48

Configuring the Cisco Phone Proxy
Configuration Examples for the Phone Proxy

crypto ca trustpoint ldc_server
enrollment self
proxy_ldc_issuer
fqdn my-ldc-ca.exmaple.com
subject-name cn=FW_LDC_SIGNER_172_23_45_200
keypair ldc_signer_key
crypto ca enroll ldc_server
tls-proxy my_proxy
server trust-point _internal_PP_myctl
client ldc issuer ldc_server
client ldc keypair phone_common
client cipher-suite aes128-sha1 aes256-sha1
media-termination my_mediaterm
address 192.0.2.25 interface inside
address 10.10.0.25 interface outside
phone-proxy mypp
media-termination my_mediaterm
tftp-server address 192.0.2.101 interface inside
tls-proxy mytls
ctl-file myctl
cluster-mode mixed
class-map sec_sccp
match port tcp 2443
class-map sec_sip
match port tcp eq 5061
policy-map pp_policy
class sec_sccp
inspect skinny phone-proxy mypp
class sec_sip
inspect sip phone-proxy mypp
service-policy pp_policy interface outside

Example 5: LSC Provisioning in Mixed-mode Cisco UCM cluster; Cisco UCM
and TFTP Server on Publisher
Figure 48-6 shows an example of the configuration for a mixed-mode Cisco UCM cluster where LSC
provisioning is required using the following topology.

Note

Doing LSC provisioning for remote IP phones is not recommended because it requires that the IP phones
first register and they have to register in nonsecure mode. Having the IP phones register in nonsecure
mode requires the Administrator to open the nonsecure signaling port for SIP and SCCP on the ASA. If
possible, LSC provisioning should be done inside the corporate network before giving the IP phones to
the end-users.
In this sample, you create an access list to allow the IP phones to contact the TFTP server and to allow
the IP phones to register in nonsecure mode by opening the nonsecure port for SIP and SCCP as well as
the CAPF port for LSC provisioning.
Additionally, you create the CAPF trustpoint by copying and pasting the CAPF certificate from the Cisco
UCM Certificate Management software.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-49

Chapter 48

Configuring the Cisco Phone Proxy

Configuration Examples for the Phone Proxy

Figure 48-6

TFTP Server
192.0.2.101

LSC Provisioning in Mixed-mode Cisco UCM cluster; Cisco UCM and TFTP Server on
Publisher

ASA Inside Interface
192.0.2.24

M

Corporate
Network

IP

Phone A
192.0.2.102

Internet

ASA Outside Interface
10.10.0.24

IP

Home Router Comcast
Address
w/NAT
98.208.49.30

IP
IP

Home Router Comcast
Address
w/NAT
69.181.112.219
271633

Phone B
192.0.2.103

object network obj-192.0.2.105
host 192.0.2.105
nat (inside,outside) static 10.10.0.26
object network obj-192.0.2.101
host 192.0.2.101
nat (inside,outside) static interface udp 69 69
access-list pp extended permit udp any host 10.10.0.24 eq 69
access-list pp extended permit tcp any host 10.10.0.26 eq 2000
access-list pp extended permit tcp any host 10.10.0.26 eq 5060
access-list pp extended permit tcp any host 10.10.0.26 eq 3804
access-group pp in interface outside
crypto key generate rsa label cluster_kp modulus 1024
crypto ca trustpoint cucm
enrollment self
keypair cluster_kp
crypto ca enroll cucm
crypto ca trustpoint tftp_server
enrollment self
serial-number
keypair cluster_kp
crypto ca enroll tftp_server
crypto ca trustpoint capf
enroll terminal
crypto ca authenticate capf
ctl-file myctl
record-entry cucm trustpoint cucm_server address 10.10.0.26
record-entry capf trustpoint capf address 10.10.0.26
no shutdown
crypto key generate rsa label ldc_signer_key modulus 1024
crypto key generate rsa label phone_common modulus 1024
crypto ca trustpoint ldc_server
enrollment self
proxy_ldc_issuer
fqdn my-ldc-ca.exmaple.com
subject-name cn=FW_LDC_SIGNER_172_23_45_200
keypair ldc_signer_key
crypto ca enroll ldc_server
tls-proxy my_proxy

Cisco ASA 5500 Series Configuration Guide using the CLI

48-50

Chapter 48

Configuring the Cisco Phone Proxy
Configuration Examples for the Phone Proxy

server trust-point _internal_PP_myctl
client ldc issuer ldc_server
client ldc keypair phone_common
client cipher-suite aes128-sha1 aes256-sha1
media-termination my_mediaterm
address 192.0.2.25 interface inside
address 10.10.0.25 interface outside
phone-proxy mypp
media-termination my_mediaterm
tftp-server address 192.0.2.101 interface inside
tls-proxy mytls
ctl-file myctl
cluster-mode mixed
class-map sec_sccp
match port tcp 2443
class-map sec_sip
match port tcp eq 5061
policy-map pp_policy
class sec_sccp
inspect skinny phone-proxy mypp
class sec_sip
inspect sip phone-proxy mypp
service-policy pp_policy interface outside

Example 6: VLAN Transversal
Figure 48-7 shows an example of the configuration to force Cisco IP Communicator (CIPC) softphones
to operate in authenticated mode when CIPC softphones are deployed in a voice and data VLAN
scenario. VLAN transversal is required between CIPC softphones on the data VLAN and hard phones
on the voice VLAN.
In this sample, the Cisco UCM cluster mode is nonsecure.
In this sample, you create an access list to allow the IP phones to contact the TFTP server and to allow
the IP phones to register in nonsecure mode by opening the nonsecure port for SIP and SCCP as well as
the CAPF port for LSC provisioning.
In this sample, you configure NAT for the CIPC by using PAT so that each CIPC is mapped to an IP
address space in the Voice VLAN.
Additionally, you create the CAPF trustpoint by copying and pasting the CAPF certificate from the Cisco
UCM Certificate Management software.

Note

Cisco IP Communicator supports authenticated mode only and does not support encrypted mode;
therefore, there is no encrypted voice traffic (SRTP) flowing from the CIPC softphones.

Cisco ASA 5500 Series Configuration Guide using the CLI

48-51

Chapter 48

Configuring the Cisco Phone Proxy

Configuration Examples for the Phone Proxy

Figure 48-7

VLAN Transversal Between CIPC Softphones on the Data VLAN and Hard Phones on
the Voice VLAN

ASA Data VLAN interface
10.10.0.24

Cisco UCM + TFTP Server
192.0.2.101

Corporate
Network
(Voice VLAN)

M

Cisco IPC
10.130.50.10

Corporate
Network
(Data VLAN)
Cisco IPC
10.130.50.11

IP

ASA Inside Interface
10.130.50.24

IP

object network obj-10.130.50.0
subnet 10.130.50.0 255.255.255.0
nat (data,voice) dynamic 192.0.2.10
object network obj-10.130.50.5
host 10.130.50.5
nat (data,voice) static 192.0.2.101
access-list pp extended permit udp any host 10.130.50.5 eq 69
access-list pp extended permit tcp any host 10.130.50.5 eq 2000
access-list pp extended permit tcp any host 10.130.50.5 eq 5060
access-list pp extended permit tcp any host 10.130.50.5 eq 3804
access-group pp in interface data
crypto ca generate rsa label cucmtftp_kp modulus 1024
crypto ca trustpoint cucm_tftp_server
enrollment self
keypair cucmtftp_kp
crypto ca enroll cucm_tftp_server
crypto ca trustpoint capf
enrollment terminal
crypto ca authenticate capf
ctl-file myctl
record-entry cucm-tftp trustpoint cucm_tftp_server address 10.130.50.5
record-entry capf trustpoint capf address 10.130.50.5
no shutdown
tls-proxy mytls
server trust-point _internal_PP_myctl
media-termination my_mediaterm
address 10.130.50.2
phone-proxy mypp
media-termination my_mediaterm
tftp-server address 10.10.0.20 interface inside
tls-proxy mytls
ctl-file myctl
cipc security-mode authenticated
class-map sec_sccp
match port tcp eq 2443
class-map sec_sip
match port tcp eq 5061
policy-map pp_policy
class sec_sccp
inspect skinny phone-proxy mypp

Cisco ASA 5500 Series Configuration Guide using the CLI

48-52

271636

Cisco IPC
10.130.50.12

Chapter 48

Configuring the Cisco Phone Proxy
Feature History for the Phone Proxy

class sec_sip
inspect sip phone-proxy mypp
service-policy pp_policy interface data

Feature History for the Phone Proxy
Table 48-7 lists the release history for this feature.
Table 48-7

Feature History for Cisco Phone Proxy

Feature Name

Releases

Feature Information

Cisco Phone Proxy

8.0(4)

The phone proxy feature was introduced. The following
new commands were introduced.
cipc security-mode authenticated, clear configure ctl,
clear configure phone-proxy, cluster-ctl-file,
cluster-mode nonsecure, ctl-file (global), ctl-file (phone
proxy), debug phone proxy, disable service-settings,
media-termination address, phone-proxy, proxy-server,
record-entry, sast, show phone-proxy, show
running-config ctl, show running-config phone-proxy,
timeout secure-phones, tftp-server address.

NAT for the media termination address

8.1(2)

The media-termination address command was changed to
allow for NAT:
[no] media-termination address ip_address interface
intf_name
Where the interface inft_name keyword was added.
The rtp-min-port and rtp-max-ports keywords were
removed from the command syntax and included as a
separate command:
rtp-min-port port1 rtp-max-port port2

Cisco ASA 5500 Series Configuration Guide using the CLI

48-53

Chapter 48
Feature History for the Phone Proxy

Cisco ASA 5500 Series Configuration Guide using the CLI

48-54

Configuring the Cisco Phone Proxy

CH A P T E R

49

Configuring the TLS Proxy for Encrypted Voice
Inspection
This chapter describes how to configure the adaptive security appliance for the TLS Proxy for Encrypted
Voice Inspection feature.
This chapter includes the following sections:
•

Information about the TLS Proxy for Encrypted Voice Inspection, page 49-1

•

Licensing for the TLS Proxy, page 49-5

•

Prerequisites for the TLS Proxy for Encrypted Voice Inspection, page 49-7

•

Configuring the TLS Proxy for Encrypted Voice Inspection, page 49-7

•

Monitoring the TLS Proxy, page 49-15

•

Feature History for the TLS Proxy for Encrypted Voice Inspection, page 49-17

Information about the TLS Proxy for Encrypted Voice Inspection
End-to-end encryption often leaves network security appliances “blind” to media and signaling traffic,
which can compromise access control and threat prevention security functions. This lack of visibility can
result in a lack of interoperability between the firewall functions and the encrypted voice, leaving
businesses unable to satisfy both of their key security requirements.
The ASA is able to intercept and decrypt encrypted signaling from Cisco encrypted endpoints to the
Cisco Unified Communications Manager (Cisco UCM), and apply the required threat protection and
access control. It can also ensure confidentiality by re-encrypting the traffic onto the Cisco UCM servers.
Typically, the ASA TLS Proxy functionality is deployed in campus unified communications network.
This solution is ideal for deployments that utilize end to end encryption and firewalls to protect Unified
Communications Manager servers.
The security appliance in Figure 49-1 serves as a proxy for both client and server, with Cisco IP Phone
and Cisco UCM interaction.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-1

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Information about the TLS Proxy for Encrypted Voice Inspection

Figure 49-1

TLS Proxy Flow

Cisco IP Phone

Cisco ASA

Cisco CallManager
M

IP
Client Hello
(Proxy) Server Hello
(Proxy) Server Certificate
(Proxy) Server Key Exchange
Certificate Request
(Proxy) Server Hello Done
Client Certificate
Client Key Exchange
Certificate Verify
[Change Cipher Spec]
Finished
[Change Cipher Spec]
Finished
(Proxy) Client Hello

Server Hello
Server Certificate
Server Key Exchange
Certificate Request
Server Hello Done
(Proxy) Dynamic Client Certificate
(Proxy) Client Key Exchange
Certificate Verify
[Change Cipher Spec]
Finished

Application Data

INSPECTION

Application Data

182831

[Change Cipher Spec]
Finished

Decryption and Inspection of Unified Communications Encrypted Signaling
With encrypted voice inspection, the security appliance decrypts, inspects and modifies (as needed, for
example, performing NAT fixup), and re-encrypts voice signaling traffic while all of the existing VoIP
inspection functions for Skinny and SIP protocols are preserved. Once voice signaling is decrypted, the
plaintext signaling message is passed to the existing inspection engines.
The security appliance acts as a TLS proxy between the Cisco IP Phone and Cisco UCM. The proxy is
transparent for the voice calls between the phone and theCisco UCM. Cisco IP Phones download a
Certificate Trust List from the Cisco UCM before registration which contains identities (certificates) of
the devices that the phone should trust, such as TFTP servers and Cisco UCM servers. To support server

Cisco ASA 5500 Series Configuration Guide using the CLI

49-2

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Information about the TLS Proxy for Encrypted Voice Inspection

proxy, the CTL file must contain the certificate that the security appliance creates for the Cisco UCMs.
To proxy calls on behalf of the Cisco IP Phone, the security appliance presents a certificate that the Cisco
UCM can verify, which is a Local Dynamic Certificate for the phone, issued by the certificate authority
on the security appliance.
TLS proxy is supported by the Cisco Unified CallManager Release 5.1 and later. You should be familiar
with the security features of the Cisco UCM. For background and detailed description of Cisco UCM
security, see the Cisco Unified CallManager document:
http://www.cisco.com/univercd/cc/td/doc/product/voice/c_callmg/5_0/sec_vir/ae/sec504/index.htm
TLS proxy applies to the encryption layer and must be configured with an application layer protocol
inspection. You should be familiar with the inspection features on the ASA, especially Skinny and SIP
inspection.

CTL Client Overview
The CTL Client application supplied by Cisco Unified CallManager Release 5.1 and later supports a TLS
proxy server (firewall) in the CTL file. Figure 49-2 through Figure 49-5 illustrate the TLS proxy features
supported in the CTL Client.
Figure 49-2

CTL Client TLS Proxy Features — Add Firewall

Figure 49-2 shows support for adding a CTL entry consisting of the security appliance as the TLS proxy.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-3

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Information about the TLS Proxy for Encrypted Voice Inspection

Figure 49-3

CTL Client TLS Proxy Features — ASA IP Address or Domain Name

Figure 49-3 shows support for entering the security appliance IP address or domain name in the CTL
Client.
Figure 49-4

CTL Client TLS Proxy Features — CTL Entry for ASA

Figure 49-4 shows that the CTL entry for the security appliance as the TLS proxy has been added. The
CTL entry is added after the CTL Client connects to the CTL Provider service on the security appliance
and retrieves the proxy certificate.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-4

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Licensing for the TLS Proxy

Figure 49-5

CTL Client TLS Proxy Features — CTL File Installed on the ASA

The security appliance does not store the raw CTL file in the flash, rather, it parses the CTL file and
installs appropriate trustpoints. Figure 49-5 indicates the installation was successful.

Licensing for the TLS Proxy
The TLS proxy for encrypted voice inspection feature supported by the ASA require a Unified
Communications Proxy license.
The following table shows the Unified Communications Proxy license details by platform:

Note

This feature is not available on No Payload Encryption models.

Model

License Requirement1

ASA 5505

Base License and Security Plus License: 2 sessions.
Optional license: 24 sessions.

ASA 5510

Base License and Security Plus License: 2 sessions.
Optional licenses: 24, 50, or 100 sessions.

ASA 5520

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

ASA 5540

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5550

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-5

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Licensing for the TLS Proxy

Model

License Requirement1

ASA 5580

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions.2

ASA 5512-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5515-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5525-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

ASA 5545-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5555-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

ASA 5585-X with
SSP-10

Base License: 2 sessions.

ASA 5585-X with
SSP-20, -40, or -60

Base License: 2 sessions.

Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions.2

1. The following applications use TLS proxy sessions for their connections. Each TLS proxy session used by these applications (and only these applications)
is counted against the UC license limit:
- Phone Proxy
- Presence Federation Proxy
- Encrypted Voice Inspection
Other applications that use TLS proxy sessions do not count towards the UC limit, for example, Mobility Advantage Proxy (which does not require a
license) and IME (which requires a separate IME 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. 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.
Note: 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
. If you use failover and enter the write standby command 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 towards the SRTP limit; if passthrough is set for the call, even if both legs are
SRTP, they do not count towards the limit.
2. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-6

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Prerequisites for the TLS Proxy for Encrypted Voice Inspection

Table 49-1 shows the default and maximum TLS session details by platform.
Table 49-1

Default and Maximum TLS Sessions on the Security Appliance

Security Appliance Platform

Default TLS Sessions

Maximum TLS Sessions

ASA 5505

10

80

ASA 5510

100

200

ASA 5520

300

1200

ASA 5540

1000

4500

ASA 5550

2000

4500

ASA 5580

4000

13,000

For more information about licensing, see Chapter 3, “Managing Feature Licenses.”

Prerequisites for the TLS Proxy for Encrypted Voice Inspection
Before configuring TLS proxy, the following prerequisites are required:
•

You must set clock on the security appliance before configuring TLS proxy. To set the clock
manually and display clock, use the clock set and show clock commands. We recommend that the
security appliance use the same NTP server as the Cisco Unified CallManager cluster. TLS
handshake may fail due to certificate validation failure if clock is out of sync between the security
appliance and the Cisco Unified CallManager server.

•

3DES-AES license is needed to interoperate with the Cisco Unified CallManager. AES is the default
cipher used by the Cisco Unified CallManager and Cisco IP Phone.

•

Import the following certificates which are stored on the Cisco UCM. These certificates are required
by the ASA for the phone proxy.
– Cisco_Manufacturing_CA
– CAP-RTP-001
– CAP-RTP-002
– CAPF certificate (Optional)

If LSC provisioning is required or you have LSC enabled IP phones, you must import the CAPF
certificate from the Cisco UCM. If the Cisco UCM has more than one CAPF certificate, you
must import all of them to the ASA.
See Chapter 48, “Configuring the Cisco Phone Proxy.”For example, the CA Manufacturer certificate
is required by the phone proxy to validate the IP phone certificate.

Configuring the TLS Proxy for Encrypted Voice Inspection
This section includes the following topics:
•

Task flow for Configuring the TLS Proxy for Encrypted Voice Inspection, page 49-8

•

Creating Trustpoints and Generating Certificates, page 49-9

•

Creating an Internal CA, page 49-10

Cisco ASA 5500 Series Configuration Guide using the CLI

49-7

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Configuring the TLS Proxy for Encrypted Voice Inspection

•

Creating a CTL Provider Instance, page 49-11

•

Creating the TLS Proxy Instance, page 49-12

•

Enabling the TLS Proxy Instance for Skinny or SIP Inspection, page 49-13

Task flow for Configuring the TLS Proxy for Encrypted Voice Inspection
To configure the security appliance for TLS proxy, perform the following steps:
Step 1

(Optional) Set the maximum number of TLS proxy sessions to be supported by the security appliance
using the following command, for example:
hostname(config)# tls-proxy maximum-sessions 1200

Note

The tls-proxy maximum-sessions command controls the memory size reserved for
cryptographic applications such as TLS proxy. Crypto memory is reserved at the time of system
boot. You may need to reboot the security appliance for the configuration to take effect if the
configured maximum sessions number is greater than the currently reserved.

Step 2

Create trustpoints and generate certificates for the TLS Proxy for Encrypted Voice Inspection. See
Creating Trustpoints and Generating Certificates, page 49-9.

Step 3

Create the internal CA to sign the LDC for Cisco IP Phones. See Creating an Internal CA, page 49-10.

Step 4

Create the CTL provider instance. See Creating a CTL Provider Instance, page 49-11.

Step 5

Create the TLS proxy instance. See Creating the TLS Proxy Instance, page 49-12.

Step 6

Enable the TLS proxy y with SIP and Skinny inspection. See Enabling the TLS Proxy Instance for
Skinny or SIP Inspection, page 49-13.

Step 7

Export the local CA certificate (ldc_server) and install it as a trusted certificate on the Cisco UCM server.
a.

Use the following command to export the certificate if a trust-point with proxy-ldc-issuer is used
as the signer of the dynamic certificates, for example:
hostname(config)# crypto ca export ldc_server identity-certificate

b.

For the embedded local CA server LOCAL-CA-SERVER, use the following command to export its
certificate, for example:
hostname(config)# show crypto ca server certificate

Save the output to a file and import the certificate on the Cisco UCM. For more information, see the
Cisco Unified CallManager document:
http://www.cisco.com/univercd/cc/td/doc/product/voice/c_callmg/5_0/iptp_adm/504/iptpch6.htm#wp1
040848
After this step, you may use the Display Certificates function on the Cisco Unified CallManager GUI to
verify the installed certificate:
http://www.cisco.com/univercd/cc/td/doc/product/voice/c_callmg/5_0/iptp_adm/504/iptpch6.htm#wp1
040354
Step 8

Run the CTL Client application to add the server proxy certificate (ccm_proxy) to the CTL file and
install the CTL file on the security appliance. See the Cisco Unified CallManager document for
information on how to configure and use CTL Client:

Cisco ASA 5500 Series Configuration Guide using the CLI

49-8

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Configuring the TLS Proxy for Encrypted Voice Inspection

http://www.cisco.com/univercd/cc/td/doc/product/voice/c_callmg/5_1/nci/p08/secuauth.htm

Note

You will need the CTL Client that is released with Cisco Unified CallManager Release 5.1 to
interoperate with the security appliance. See the “CTL Client Overview” section on page 49-3
for more information regarding TLS proxy support.

Creating Trustpoints and Generating Certificates
The Cisco UCM proxy certificate could be self-signed or issued by a third-party CA. The certificate is
exported to the CTL client.
Prerequisites

Import the required certificates, which are stored on the Cisco UCM. See the “Certificates from the Cisco
UCM” section on page 48-7 and the “Importing Certificates from the Cisco UCM” section on
page 48-15.
Command
Step 1

Step 2

hostname(config)# crypto key
key-pair-label modulus size
Examples:
hostname(config)# crypto key
ccm_proxy_key modulus 1024
hostname(config)# crypto key
ldc_signer_key modulus 1024
hostname(config)# crypto key
phone_common modulus 1024

Purpose
generate rsa label

Creates the RSA keypair that can be used for the
trustpoints.

generate rsa label

The keypair is used by the self-signed certificate
presented to the local domain containing the Cisco
UP (proxy for the remote entity).

generate rsa label
generate rsa label

Note

We recommend that you create a different
key pair for each role.

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
hostname(config)# ! for self-signed CCM proxy
certificate
hostname(config)# crypto ca trustpoint ccm_proxy

Enters the trustpoint configuration mode for the
specified trustpoint so that you can create the
trustpoint for the Cisco UMA server.

Step 3

hostname(config-ca-trustpoint)# enrollment self

Generates a self-signed certificate.

Step 4

hostname(config-ca-trustpoint)# fqdn none

Specifies not to include a fully qualified domain
name (FQDN) in the Subject Alternative Name
extension of the certificate during enrollment.

A trustpoint represents a CA identity and possibly a
device identity, based on a certificate issued by the
CA.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-9

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Configuring the TLS Proxy for Encrypted Voice Inspection

Step 5

Command

Purpose

hostname(config-ca-trustpoint)# subject-name
X.500_name
Example:
hostname(config-ca-trustpoint)# subject-name
cn=EJW-SV-1-Proxy

Includes the indicated subject DN in the certificate
during enrollment
Cisco IP Phones require certain fields from the
X.509v3 certificate to be present to validate the
certificate via consulting the CTL file.
Consequently, the subject-name entry must be
configured for a proxy certificate trustpoint. The
subject name must be composed of the ordered
concatenation of the CN, OU and O fields. The CN
field is mandatory; the others are optional.

Note

Each of the concatenated fields (when
present) are separated by a semicolon,
yielding one of the following forms:
CN=xxx;OU=yyy;O=zzz
CN=xxx;OU=yyy
CN=xxx;O=zzz
CN=xxx

Step 6

hostname(config-ca-trustpoint)# keypair keyname
Example:
hostname(config-ca-trustpoint)# keypair
ccm_proxy_key

Specifies the key pair whose public key is to be
certified.

Step 7

hostname(config-ca-trustpoint)# exit

Exits from the CA Trustpoint configuration mode.

Step 8

hostname(config)# crypto ca enroll trustpoint
Example:
hostname(config)# crypto ca enroll ccm_proxy

Starts the enrollment process with the CA and
specifies the name of the trustpoint to enroll with.

What to Do Next

Once you have created the trustpoints and generated the certificates, create the internal CA to sign the
LDC for Cisco IP Phones. See Creating an Internal CA, page 49-10.

Creating an Internal CA
Create an internal local CA to sign the LDC for Cisco IP Phones.
This local CA is created as a regular self-signed trustpoint with proxy-ldc-issuer enabled. You can use
the embedded local CA LOCAL-CA-SERVER on the ASA to issue the LDC.
Command

Purpose

Step 1

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
hostname(config)# ! for the internal local LDC
issuer
hostname(config)# crypto ca trustpoint ldc_server

Enters the trustpoint configuration mode for the
specified trustpoint so that you can create the
trustpoint for the LDC issurer.

Step 2

hostname(config-ca-trustpoint)# enrollment self

Generates a self-signed certificate.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-10

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Configuring the TLS Proxy for Encrypted Voice Inspection

Step 3

Command

Purpose

hostname(config-ca-trustpoint)# proxy-ldc-issuer

Issues TLS proxy local dynamic certificates. The
proxy-ldc-issuer command grants a crypto
trustpoint the role as local CA to issue the LDC and
can be accessed from crypto ca trustpoint
configuration mode.
The proxy-ldc-issuer command defines the local
CA role for the trustpoint to issue dynamic
certificates for TLS proxy. This command can only
be configured under a trustpoint with "enrollment
self."

Step 4

hostname(config-ca-trustpoint)# fqdn fqdn
Example:
hostname(config-ca-trustpoint)# fqdn
my-ldc-ca.exmaple.com

Includes the indicated FQDN in the Subject
Alternative Name extension of the certificate during
enrollment.

Step 5

hostname(config-ca-trustpoint)# subject-name
X.500_name
Example:
hostname(config-ca-trustpoint)# subject-name
cn=FW_LDC_SIGNER_172_23_45_200

Includes the indicated subject DN in the certificate
during enrollment

Step 6

hostname(config-ca-trustpoint)# keypair keyname
Example:
hostname(config-ca-trustpoint)# keypair
ldc_signer_key

Specifies the key pair whose public key is to be
certified.

Step 7

hostname(config-ca-trustpoint)# exit

Exits from the CA Trustpoint configuration mode.

Step 8

hostname(config)# crypto ca enroll trustpoint
Example:
hostname(config)# crypto ca enroll ldc_server

Starts the enrollment process with the CA and
specifies the name of the trustpoint to enroll with.

What to Do Next

Once you have created the internal CA, create the CTL provider instance. See Creating a CTL Provider
Instance, page 49-11.

Creating a CTL Provider Instance
Create a CTL Provider instance in preparation for a connection from the CTL Client.
The default port number listened by the CTL Provider is TCP 2444, which is the default CTL port on the
Cisco UCM. Use the service port command to change the port number if a different port is used by the
Cisco UCM cluster.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-11

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Configuring the TLS Proxy for Encrypted Voice Inspection

Command

Purpose

Step 1

hostname(config)# ctl-provider ctl_name
Example:
hostname(config)# ctl-provider my_ctl

Enters the CTL provider configuration mode so that
you can create the Certificate Trust List provider
instance.

Step 2

hostname(config-ctl-provider)# client interface
if_name ipv4_addr
Example:
hostname(config-ctl-provider)# client interface
inside address 172.23.45.1

Specifies clients allowed to connect to the
Certificate Trust List provider.
Where interface if_name specifies the interface
allowed to connect and ipv4_addr specifies the IP
address of the client.
More than one command may be issued to define
multiple clients.

Step 3

Step 4

hostname(config-ctl-provider)# client username
user_name password password encrypted
Example:
hostname(config-ctl-provider)# client username
CCMAdministrator password XXXXXX encrypted

Specifies the username and password for client
authentication.

hostname(config-ctl-provider)# export certificate
trustpoint_name
Example:
hostname(config-ctl-provider)# export certificate

Specifies the certificate to be exported to the client.
The certificate will be added to the Certificate Trust
List file composed by the CTL client.

The username and password must match the
username and password for Cisco UCM
administration.

The trustpoint name in the export command is the
proxy certificate for the Cisco UCM server.
Step 5

hostname(config-ctl-provider)# ctl install

Enables the CTL provider to parse the CTL file from
the CTL client and install trustpoints for entries
from the CTL file. Ttrustpoints installed by this
command have names prefixed with
"_internal_CTL_."

What to Do Next

Once you have created the CTL provider instance, create the TLS proxy instance. See Creating the TLS
Proxy Instance, page 49-12.

Creating the TLS Proxy Instance
Create the TLS proxy instance to handle the encrypted signaling.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-12

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Configuring the TLS Proxy for Encrypted Voice Inspection

Command

Purpose

Step 1

hostname(config)# tls-proxy proxy_name
Example:
hostname(config)# tls-proxy my_proxy

Creates the TLS proxy instance.

Step 2

hostname(config-tlsp)# server trust-point
proxy_trustpoint
Example:
hostname(config-tlsp)# server trust-point ccm_proxy

Specifies the proxy trustpoint certificate to present
during TLS handshake.

hostname(config-tlsp)# client ldc issuer ca_tp_name
Example:
hostname(config-tlsp)# client ldc issuer ldc_server

Sets the local dynamic certificate issuer. The local
CA to issue client dynamic certificates is defined by
the crypto ca trustpoint command and the
trustpoint must have proxy-ldc-issuer configured,
or the default local CA server
(LOCAL-CA-SERVER).

Step 3

The server command configures the proxy
parameters for the original TLS server. In other
words, the parameters for the ASA to act as the
server during a TLS handshake, or facing the
original TLS client.

Where ldc issuer ca_tp_name specifies the local
CA trustpoint to issue client dynamic certificates.
Step 4

Step 5

hostname(config-tlsp)# client ldc key-pair key_label
Example:
hostname(config-tlsp)# client ldc key-pair
phone_common

Sets the keypair.

hostname(config-tlsp)# client cipher-suite
cipher_suite
Example:
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1

Sets the user-defined cipher suite.

The keypair value must have been generated with the
crypto key generate command.
For client proxy (the proxy acts as a TLS client to
the server), the user-defined cipher suite replaces the
default cipher suite, or the one defined by the ssl
encryption command. You can use this command to
achieve difference ciphers between the two TLS
sessions. You should use AES ciphers with the
CallManager server.

What to Do Next

Once you have created TLS proxy instance, enable the TLS proxy instance for Skinny and SIP
inspection. See Enabling the TLS Proxy Instance for Skinny or SIP Inspection, page 49-13.

Enabling the TLS Proxy Instance for Skinny or SIP Inspection
Enable TLS proxy for the Cisco IP Phones and Cisco UCMs in Skinny or SIP inspection. The following
procedure shows how to enable the TLS proxy instance for Skinny inspection.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-13

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Configuring the TLS Proxy for Encrypted Voice Inspection

Step 1

Command

Purpose

hostname(config)# class-map class_map_name
Example:
hostname(config)# class-map sec_skinny

Configures the secure Skinny class of traffic to
inspect.
Where class_map_name is the name of the Skinny
class map.

Step 2

hostname(config-cmap)# match port tcp eq 2443

Step 3

hostname(config-cmap)# exit

Step 4

hostname(config)# policy-map type inspect skinny
policy_map_name
Example:
hostname(config)# policy-map type inspect skinny
skinny_inspect

Defines special actions for Skinny inspection
application traffic.

Step 5

hostname(config-pmap)# parameters
hostname(config-pmap-p)# ! Skinny inspection
parameters

Specifies the parameters for Skinny inspection.
Parameters affect the behavior of the inspection
engine.

Matches the TCP port 2443 to which you want to
apply actions for secure Skinny inspection

The commands available in parameters
configuration mode depend on the application.
Step 6

hostname(config-pmap-p)# exit

Exits from Policy Map configuration mode.

Step 7

hostname(config)# policy-map name
Example:
hostname(config)# policy-map global_policy

Configure the policy map and attach the action to the
class of traffic.

Step 8

hostname(config-pmap)# class inspection_default

Specifies the default class map.
The configuration includes a default Layer 3/4 class
map that the ASA uses in the default global policy.
It is called inspection_default and matches the
default inspection traffic,

Step 9

hostname(config-pmap-c)# inspect skinny skinny_map
Example:
hostname(config-pmap-c)# inspect skinny
skinny_inspect

Enables SCCP (Skinny) application inspection.

Step 10

hostname(config-pmap)# class classmap_name
Example:
hostname(config-pmap)# class sec_skinny

Assigns a class map to the policy map where you can
assign actions to the class map traffic.

Step 11

hostname(config-pmap-c)# inspect skinny skinny_map
tls-proxy proxy_name
Example:
hostname(config-pmap-c)# inspect skinny
skinny_inspect tls-proxy my_proxy

Enables TLS proxy for the specified inspection
session.

Step 12

hostname(config-pmap-c)# exit

Exits from the Policy Map configuration mode.

Step 13

hostname(config)# service-policy policymap_name
global
Example:
hostname(config)# service-policy global_policy
global

Enables the service policy on all interfaces.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-14

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Monitoring the TLS Proxy

Monitoring the TLS Proxy
You can enable TLS proxy debug flags along with SSL syslogs to debug TLS proxy connection
problems. For example, using the following commands to enable TLS proxy-related debug and syslog
output only:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

debug inspect tls-proxy events
debug inspect tls-proxy errors
logging enable
logging timestamp
logging list loglist message 711001
logging list loglist message 725001-725014
logging list loglist message 717001-717038
logging buffer-size 1000000
logging buffered loglist
logging debug-trace

The following is sample output reflecting a successful TLS proxy session setup for a SIP phone:
hostname(config)# show log
Apr 17 2007 23:13:47: %ASA-6-725001: Starting SSL handshake with client
outside:133.9.0.218/49159 for TLSv1 session.
Apr 17 2007 23:13:47: %ASA-7-711001: TLSP cbad5120: Set up proxy for Client
outside:133.9.0.218/49159 <-> Server inside:195.168.2.201/5061
Apr 17 2007 23:13:47: %ASA-7-711001: TLSP cbad5120: Using trust point 'local_ccm' with the
Client, RT proxy cbae1538
Apr 17 2007 23:13:47: %ASA-7-711001: TLSP cbad5120: Waiting for SSL handshake from Client
outside:133.9.0.218/49159.
Apr 17 2007 23:13:47: %ASA-7-725010: Device supports the following 4 cipher(s).
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[1] : RC4-SHA
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[2] : AES128-SHA
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[3] : AES256-SHA
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[4] : DES-CBC3-SHA
Apr 17 2007 23:13:47: %ASA-7-725008: SSL client outside:133.9.0.218/49159 proposes the
following 2 cipher(s).
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[1] : AES256-SHA
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[2] : AES128-SHA
Apr 17 2007 23:13:47: %ASA-7-725012: Device chooses cipher : AES128-SHA for the SSL
session with client outside:133.9.0.218/49159
Apr 17 2007 23:13:47: %ASA-7-725014: SSL lib error. Function: SSL23_READ Reason: ssl
handshake failure
Apr 17 2007 23:13:47: %ASA-7-717025: Validating certificate chain containing 1
certificate(s).
Apr 17 2007 23:13:47: %ASA-7-717029: Identified client certificate within certificate
chain. serial number: 01, subject name: cn=SEP0017593F50A8.
Apr 17 2007 23:13:47: %ASA-7-717030: Found a suitable trustpoint
_internal_ejw-sv-2_cn=CAPF-08a91c01 to validate certificate.
Apr 17 2007 23:13:47: %ASA-6-717022: Certificate was successfully validated. serial
number: 01, subject name: cn=SEP0017593F50A8.
Apr 17 2007 23:13:47: %ASA-6-717028: Certificate chain was successfully validated with
warning, revocation status was not checked.
Apr 17 2007 23:13:47: %ASA-6-725002: Device completed SSL handshake with client
outside:133.9.0.218/49159
Apr 17 2007 23:13:47: %ASA-6-725001: Starting SSL handshake with server
inside:195.168.2.201/5061 for TLSv1 session.
Apr 17 2007 23:13:47: %ASA-7-725009: Device proposes the following 2 cipher(s) to server
inside:195.168.2.201/5061
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[1] : AES128-SHA
Apr 17 2007 23:13:47: %ASA-7-725011: Cipher[2] : AES256-SHA
Apr 17 2007 23:13:47: %ASA-7-711001: TLSP cbad5120: Generating LDC for client
'cn=SEP0017593F50A8', key-pair 'phone_common', issuer 'LOCAL-CA-SERVER', RT proxy cbae1538
Apr 17 2007 23:13:47: %ASA-7-711001: TLSP cbad5120: Started SSL handshake with Server

Cisco ASA 5500 Series Configuration Guide using the CLI

49-15

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection

Monitoring the TLS Proxy

Apr 17 2007 23:13:47: %ASA-7-711001: TLSP cbad5120: Data channel ready for the Client
Apr 17 2007 23:13:47: %ASA-7-725013: SSL Server inside:195.168.2.201/5061 choose cipher :
AES128-SHA
Apr 17 2007 23:13:47: %ASA-7-717025: Validating certificate chain containing 1
certificate(s).
Apr 17 2007 23:13:47: %ASA-7-717029: Identified client certificate within certificate
chain. serial number: 76022D3D9314743A, subject name: cn=EJW-SV-2.inside.com.
Apr 17 2007 23:13:47: %ASA-6-717022: Certificate was successfully validated. Certificate
is resident and trusted, serial number: 76022D3D9314743A, subject name:
cn=EJW-SV-2.inside.com.
Apr 17 2007 23:13:47: %ASA-6-717028: Certificate chain was successfully validated with
revocation status check.
Apr 17 2007 23:13:47: %ASA-6-725002: Device completed SSL handshake with server
inside:195.168.2.201/5061
Apr 17 2007 23:13:47: %ASA-7-711001: TLSP cbad5120: Data channel ready for the Server

Use the show tls-proxy commands with different options to check the active TLS proxy sessions. The
following are some sample outputs:
hostname(config-tlsp)# show tls-proxy
Maximum number of sessions: 1200
TLS-Proxy 'sip_proxy': ref_cnt 1, seq# 3
Server proxy:
Trust-point: local_ccm
Client proxy:
Local dynamic certificate issuer: LOCAL-CA-SERVER
Local dynamic certificate key-pair: phone_common
Cipher suite: aes128-sha1 aes256-sha1
Run-time proxies:
Proxy 0xcbae1538: Class-map: sip_ssl, Inspect: sip
Active sess 1, most sess 3, byte 3456043
TLS-Proxy 'proxy': ref_cnt 1, seq# 1
Server proxy:
Trust-point: local_ccm
Client proxy:
Local dynamic certificate issuer: ldc_signer
Local dynamic certificate key-pair: phone_common
Cipher-suite: 
Run-time proxies:
Proxy 0xcbadf720: Class-map: skinny_ssl, Inspect: skinny
Active sess 1, most sess 1, byte 42916
hostname(config-tlsp)# show tls-proxy session count
2 in use, 4 most used
hostname(config-tlsp)# show tls-proxy session
2 in use, 4 most used
outside 133.9.0.211:50437 inside 195.168.2.200:2443 P:0xcbadf720(proxy) S:0xcbc48a08 byte
42940
outside 133.9.0.218:49159 inside 195.168.2.201:5061 P:0xcbae1538(sip_proxy) S:0xcbad5120
byte 8786
hostname(config-tlsp)# show tls-proxy session detail
2 in use, 4 most used
outside 133.9.0.211:50437 inside 195.168.2.200:2443 P:0xcbadf720(proxy) S:0xcbc48a08 byte
42940
Client: State SSLOK Cipher AES128-SHA Ch 0xca55e498 TxQSize 0 LastTxLeft 0 Flags 0x1
Server: State SSLOK Cipher AES128-SHA Ch 0xca55e478 TxQSize 0 LastTxLeft 0 Flags 0x9
Local Dynamic Certificate
Status: Available
Certificate Serial Number: 29
Certificate Usage: General Purpose

Cisco ASA 5500 Series Configuration Guide using the CLI

49-16

Chapter 49

Configuring the TLS Proxy for Encrypted Voice Inspection
Feature History for the TLS Proxy for Encrypted Voice Inspection

Public Key Type: RSA (1024 bits)
Issuer Name:
cn=TLS-Proxy-Signer
Subject Name:
cn=SEP0002B9EB0AAD
o=Cisco Systems Inc
c=US
Validity Date:
start date: 09:25:41 PDT Apr 16 2007
end
date: 09:25:41 PDT Apr 15 2008
Associated Trustpoints:
outside 133.9.0.218:49159 inside 195.168.2.201:5061 P:0xcbae1538(sip_proxy) S:0xcbad5120
byte 8786
Client: State SSLOK Cipher AES128-SHA Ch 0xca55e398 TxQSize 0 LastTxLeft 0 Flags 0x1
Server: State SSLOK Cipher AES128-SHA Ch 0xca55e378 TxQSize 0 LastTxLeft 0 Flags 0x9
Local Dynamic Certificate
Status: Available
Certificate Serial Number: 2b
Certificate Usage: General Purpose
Public Key Type: RSA (1024 bits)
Issuer Name:
cn=F1-ASA.default.domain.invalid
Subject Name:
cn=SEP0017593F50A8
Validity Date:
start date: 23:13:47 PDT Apr 16 2007
end
date: 23:13:47 PDT Apr 15 2008
Associated Trustpoints:

Feature History for the TLS Proxy for Encrypted Voice Inspection
Table 49-2 lists the release history for this feature.
Table 49-2

Feature History for Cisco Phone Proxy

Feature Name

Releases

Feature Information

TLS Proxy

8.0(2)

The TLS proxy feature was introduced.

Cisco ASA 5500 Series Configuration Guide using the CLI

49-17

Chapter 49
Feature History for the TLS Proxy for Encrypted Voice Inspection

Cisco ASA 5500 Series Configuration Guide using the CLI

49-18

Configuring the TLS Proxy for Encrypted Voice Inspection

CH A P T E R

50

Configuring Cisco Mobility Advantage
This chapter describes how to configure the adaptive security appliance for Cisco Unified
Communications Mobility Advantage Proxy features.
This chapter includes the following sections:
•

Information about the Cisco Mobility Advantage Proxy Feature, page 50-1

•

Licensing for the Cisco Mobility Advantage Proxy Feature, page 50-6

•

Configuring Cisco Mobility Advantage, page 50-6

•

Monitoring for Cisco Mobility Advantage, page 50-10

•

Configuration Examples for Cisco Mobility Advantage, page 50-11

•

Feature History for Cisco Mobility Advantage, page 50-14

Information about the Cisco Mobility Advantage Proxy Feature
This section contains the following topics:
•

Cisco Mobility Advantage Proxy Functionality, page 50-1

•

Mobility Advantage Proxy Deployment Scenarios, page 50-2

•

Trust Relationships for Cisco UMA Deployments, page 50-5

Cisco Mobility Advantage Proxy Functionality
To support Cisco UMA for the Cisco Mobility Advantage solution, the mobility advantage proxy
(implemented as a TLS proxy) includes the following functionality:
•

The ability to allow no client authentication during the handshake with clients.

•

Allowing an imported PKCS-12 certificate to server as a proxy certificate.

The ASA includes an inspection engine to validate the Cisco UMA Mobile Multiplexing Protocol
(MMP).
MMP is a data transport protocol for transmitting data entities between Cisco UMA clients and servers.
As shown in Figure 50-1, MMP must be run on top of a connection-oriented protocol (the underlying
transport) and is intended to be run on top of a secure transport protocol such as TLS. The Orative
Markup Language (OML) protocol is intended to be run on top of MMP for the purposes of data
synchronization, as well as the HTTP protocol for uploading and downloading large files.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-1

Chapter 50

Configuring Cisco Mobility Advantage

Information about the Cisco Mobility Advantage Proxy Feature

Figure 50-1

OML

MMP Stack

HTTP

etc.

MMP
TLS/SSL

IP

271645

TCP

The TCP/TLS default port is 5443. There are no embedded NAT or secondary connections.
Cisco UMA client and server communications can be proxied via TLS, which decrypts the data, passes
it to the inspect MMP module, and re-encrypt the data before forwarding it to the endpoint. The inspect
MMP module verifies the integrity of the MMP headers and passes the OML/HTTP to an appropriate
handler. The ASA takes the following actions on the MMP headers and data:

Note

•

Verifies that client MMP headers are well-formed. Upon detection of a malformed header, the TCP
session is terminated.

•

Verifies that client to server MMP header lengths are not exceeded. If an MMP header length is
exceeded (4096), then the TCP session is terminated.

•

Verifies that client to server MMP content lengths are not exceeded. If an entity content length is
exceeded (4096), the TCP session is terminated.

4096 is the value currently used in MMP implementations.
Because MMP headers and entities can be split across packets, the ASA buffers data to ensure consistent
inspection. The SAPI (stream API) handles data buffering for pending inspection opportunities. MMP
header text is treated as case insensitive and a space is present between header text and values.
Reclaiming of MMP state is performed by monitoring the state of the TCP connection.

Mobility Advantage Proxy Deployment Scenarios
Figure 50-2 and Figure 50-3 show the two deployment scenarios for the TLS proxy used by the Cisco
Mobility Advantage solution. In scenario 1 (the recommended deployment architecture), the ASA
functions as both the firewall and TLS proxy. In scenario 2, the ASA functions as the TLS proxy only
and works with an existing firewall. In both scenarios, the clients connect from the Internet.
In the scenario 1 deployment, the ASA is between a Cisco UMA client and a Cisco UMA server. The
Cisco UMA client is an executable that is downloaded to each smartphone. The Cisco UMA client
applications establishes a data connection, which is a TLS connection, to the corporate Cisco UMA
server. The ASA intercepts the connections and inspects the data that the client sends to the Cisco UMA
server.

Note

The TLS proxy for the Cisco Mobility Advantage solution does not support client authentication because
the Cisco UMA client cannot present a certificate. The following commands can be used to disable
authentication during the TLS handshake.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-2

Configuring Cisco Mobility Advantage
Information about the Cisco Mobility Advantage Proxy Feature

hostname(config)# tls-proxy my_proxy
hostname(config-tlsp)# no server authenticate-client

Figure 50-2

Security Appliance as Firewall with Mobility Advantage Proxy and MMP Inspection

Enterprise Services

Mobile Data
Network (GPRS
Data Channel)

Network: Active Directory
10.1.1.0/24
Exchange
IP Address:
10.1.1.2
Port: 5443
Cisco Unified
ASA with
Presence
TLS Proxy
Firewall

MMP/SSL/TLS

MMP/SSL/TLS

Cisco UMC Client

PSTN

Hostname:
cuma.example.com
Network: 192.0.2.0/24
IP Address: 192.0.2.140
Port: 5443
Voice Channel

Network:
10.1.1.0/24
IP Address:
10.1.1.1

Cisco UMA
Server

Voice mail

MP

Conference
M

271641

Chapter 50

Cisco UCM

In Figure 50-2, the ASA performs static NAT by translating the Cisco UMA server 10.1.1.2 IP address
to 192.0.2.140.
Figure 50-3 shows deployment scenario 2, where the ASA functions as the TLS proxy only and does not
function as the corporate firewall. In this scenario, the ASA and the corporate firewall are performing
NAT. The corporate firewall will not be able to predict which client from the Internet needs to connect
to the corporate Cisco UMA server. Therefore, to support this deployment, you can take the following
actions:
•

Set up a NAT rule for inbound traffic that translates the destination IP address 192.0.2.41 to
172.16.27.41.

•

Set up an interface PAT rule for inbound traffic translating the source IP address of every packet so
that the corporate firewall does not need to open up a wildcard pinhole. The Cisco UMA server
receives packets with the source IP address 192.0.12.183.
hostname(config)# object network obj-0.0.0.0-01
hostname(config-network-object)# subnet 0.0.0.0 0.0.0.0
hostname(config-network-object)# nat (outside,inside) dynamic 192.0.2.183

See Chapter 30, “Configuring Network Object NAT” and Chapter 31, “Configuring Twice NAT” for
information.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-3

Chapter 50

Configuring Cisco Mobility Advantage

Information about the Cisco Mobility Advantage Proxy Feature

Note

This interface PAT rule converges the Cisco UMA client IP addresses on the outside interface of
the ASA into a single IP address on the inside interface by using different source ports.
Performing this action is often referred as “outside PAT”. “Outside PAT” is not recommended
when TLS proxy for Cisco Mobility Advantage is enabled on the same interface of the ASA with
phone proxy, Cisco Unified Presence, or any other features involving application inspection.
“Outside PAT” is not supported completely by application inspection when embedded address
translation is needed.

Figure 50-3

Cisco UMC/Cisco UMA Architecture – Scenario 2: Security Appliance as Mobility
Advantage Proxy Only

Client connects to
cuma.example.com
(192.0.2.41)
Cisco UMC Client

Internet

ISP
Gateway

DMZ

Corporate
Firewall

Internal Network
IP Address:
172.16.27.41
(DMZ routable)

192.0.2.41/24
outside

192.0.2.182/24
inside

eth0

Cisco UMA
M

ASA with
TLS Proxy

Active
Directory

Cisco UCM

MP

Cisco Unified
Presence

Conference
Voice mail

271642

Exchange

Enterprise Network

Mobility Advantage Proxy Using NAT/PAT
In both scenarios (Figure 50-2 and Figure 50-3), NAT can be used to hide the private address of the Cisco
UMA servers.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-4

Chapter 50

Configuring Cisco Mobility Advantage
Information about the Cisco Mobility Advantage Proxy Feature

In scenario 2 (Figure 50-3), PAT can be used to converge all client traffic into one source IP, so that the
firewall does not have to open up a wildcard pinhole for inbound traffic.
hostname(config)# access-list cumc extended permit tcp any host 172.16.27.41 eq 5443

versus
hostname(config)# access-list cumc extended permit tcp host 192.0.2.183 host 172.16.27.41
eq 5443

Trust Relationships for Cisco UMA Deployments
To establish a trust relationship between the Cisco UMC client and the ASA, the ASA uses the Cisco
UMA server certificate and keypair or the ASA obtains a certificate with the Cisco UMA server FQDN
(certificate impersonation). Between the ASA and the Cisco UMA server, the ASA and Cisco UMA
server use self-signed certificates or certificates issued by a local certificate authority.
Figure 50-4 shows how you can import the Cisco UMA server certificate onto the ASA. When the Cisco
UMA server has already enrolled with a third-party CA, you can import the certificate with the private
key onto the ASA. Then, the ASA has the full credentials of the Cisco UMA server. When a Cisco UMA
client connects to the Cisco UMA server, the ASA intercepts the handshake and uses the Cisco UMA
server certificate to perform the handshake with the client. The ASA also performs a handshake with the
server.
Figure 50-4

How the Security Appliance Represents Cisco UMA – Private Key Sharing

3rd Party CA
Certificate
Authority
Enroll with FQDN
of Cisco UMA
Certificate
Cisco UMA

ASA

271643

Internet

Cisco UMC Client
Certificate with
Private Key

TLS (Cisco UMA Certificate)
Key 1

Inspected and
Modified
(if needed)

TLS (Self-signed,
or from local CA)
Key 2

Figure 50-5 shows another way to establish the trust relationship. Figure 50-5 shows a green field
deployment, because each component of the deployment has been newly installed. The ASA enrolls with
the third-party CA by using the Cisco UMA server FQDN as if the ASA is the Cisco UMA server. When
the Cisco UMA client connects to the ASA, the ASA presents the certificate that has the Cisco UMA
server FQDN. The Cisco UMA client believes it is communicating to with the Cisco UMA server.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-5

Chapter 50

Configuring Cisco Mobility Advantage

Licensing for the Cisco Mobility Advantage Proxy Feature

Figure 50-5

How the Security Appliance Represents Cisco UMA – Certificate Impersonation

3rd Party CA
Certificate
Authority
Enroll with FQDN
of Cisco UMA
Certificate
Cisco UMA
271644

ASA
Internet

Cisco UMC Client

TLS (ASA Certificate with Cisco UMA FQDN)
Key 1

Inspected and
Modified
(if needed)

TLS (Self-signed,
or from local CA)
Key 2

A trusted relationship between the ASA and the Cisco UMA server can be established with self-signed
certificates. The ASA's identity certificate is exported, and then uploaded on the Cisco UMA server
truststore. The Cisco UMA server certificate is downloaded, and then uploaded on the ASA truststore
by creating a trustpoint and using the crypto ca authenticate command.

Licensing for the Cisco Mobility Advantage Proxy Feature
The Cisco Unified Communications proxy features (Cisco Phone Proxy, TLS proxy for encrypted voice
inspection, and the Cisco Presence Federation Proxy) supported by the ASA require a Unified
Communications Proxy license. However, in Version 8.2(2) and later, the Mobility Advantage proxy no
longer requires a Unified Communications Proxy license.
The following table shows the licensing requirements for the Mobility Advantage proxy:
Model

License Requirement

All models

Base License.
For more information about licensing, see Chapter 3, “Managing Feature Licenses.”

Configuring Cisco Mobility Advantage
This section includes the following topics:
•

Task Flow for Configuring Cisco Mobility Advantage, page 50-7

•

Installing the Cisco UMA Server Certificate, page 50-7

•

Creating the TLS Proxy Instance, page 50-8

Cisco ASA 5500 Series Configuration Guide using the CLI

50-6

Chapter 50

Configuring Cisco Mobility Advantage
Configuring Cisco Mobility Advantage

•

Enabling the TLS Proxy for MMP Inspection, page 50-9

Task Flow for Configuring Cisco Mobility Advantage
To configure for the ASA to perform TLS proxy and MMP inspection as shown in Figure 50-2 and
Figure 50-3, perform the following tasks.
It is assumed that self-signed certificates are used between the ASA and the Cisco UMA server.
Prerequisites

Export the Cisco UMA server certificate and keypair in PKCS-12 format so that you can import it onto
the ASA. The certificate will be used during the handshake with the Cisco UMA clients.
Step 1

Create the static NAT for the Cisco UMA server by entering the following commands:
hostname(config)# object network name
hostname(config-network-object)# host real_ip
hostname(config-network-object)# nat (real_ifc,mapped_ifc) static mapped_ip

Step 2

Import the Cisco UMA server certificate onto the ASA by entering the following commands:
hostname(config)# crypto ca import trustpoint pkcs12 passphrase
[paste base 64 encoded pkcs12]
hostname(config)# quit

Step 3

Install the Cisco UMA server certificate on the ASA. See Installing the Cisco UMA Server Certificate,
page 50-7.

Step 4

Create the TLS proxy instance for the Cisco UMA clients connecting to the Cisco UMA server. See
Creating the TLS Proxy Instance, page 50-8.

Step 5

Enable the TLS proxy for MMP inspection. See Enabling the TLS Proxy for MMP Inspection,
page 50-9.

Installing the Cisco UMA Server Certificate
Install the Cisco UMA server self-signed certificate in the ASA truststore. This task is necessary for the
ASA to authenticate the Cisco UMA server during the handshake between the ASA proxy and Cisco
UMA server.
Prerequisites

Export the Cisco UMA server certificate and keypair in PKCS-12 format so that you can import it onto
the ASA.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-7

Chapter 50

Configuring Cisco Mobility Advantage

Configuring Cisco Mobility Advantage

Step 1

Command

Purpose

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
hostname(config)# crypto ca trustpoint cuma_server

Enters the trustpoint configuration mode for the
specified trustpoint so that you can create the
trustpoint for the Cisco UMA server.
A trustpoint represents a CA identity and possibly a
device identity, based on a certificate issued by the
CA.

Step 2

hostname(config-ca-trustpoint)# enrollment terminal

Specifies cut and paste enrollment with this
trustpoint (also known as manual enrollment).

Step 3

hostname(config-ca-trustpoint)# exit

Exits from the CA Trustpoint configuration mode.

Step 4

hostname(config)# crypto ca authenticate trustpoint
Example:
hostname(config)# crypto ca authenticate cuma_server
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line
by itself

Installs and authenticates the CA certificates
associated with a trustpoint created for the Cisco
UMA server.

[ certificate data omitted ]
Certificate has the following attributes:
Fingerprint: 21B598D5 4A81F3E5 0B24D12E 3F89C2E4
% Do you accept this certificate? [yes/no]: yes
Trustpoint CA certificate accepted.
% Certificate successfully imported
hostname(config)#

Where trustpoint specifies the trustpoint from which
to obtain the CA certificate. Maximum name length
is 128 characters.
The ASA prompts you to paste the base-64
formatted CA certificate onto the terminal.

What to Do Next

Once you have created the trustpoints and installed the Cisco UMA certificate on the ASA, create the
TLS proxy instance. See Creating the TLS Proxy Instance, page 50-8.

Creating the TLS Proxy Instance
Create a TLS proxy instance for the Cisco UMA clients connecting to the Cisco UMA server.
Prerequisites

Before you can create the TLS proxy instance, you must have installed the Cisco UMA server self-signed
certificate in the ASA truststore.
Command

Purpose

Step 1

hostname(config)# tls-proxy proxy_name
Example:
tls-proxy cuma_tlsproxy

Creates the TLS proxy instance.

Step 2

hostname(config-tlsp)# server trust-point proxy_name
Example:
hostname(config-tlsp)# server trust-point cuma_proxy

Specifies the proxy trustpoint certificate presented
during TLS handshake.
The certificate must be owned by the ASA (identity
certificate).

Cisco ASA 5500 Series Configuration Guide using the CLI

50-8

Chapter 50

Configuring Cisco Mobility Advantage
Configuring Cisco Mobility Advantage

Step 3

Command

Purpose

hostname(config-tlsp)# client trust-point proxy_name
Example:
hostname(config-tlsp)# client trust-point cuma_proxy

Specifies the trustpoint and associated certificate
that the ASA uses in the TLS handshake when the
ASA assumes the role of the TLS client.
The certificate must be owned by the ASA (identity
certificate).

Step 4

hostname(config-tlsp)# no server authenticate-client

Disables client authentication.
Disabling TLS client authentication is required
when the ASA must interoperate with a Cisco UMA
client or clients such as a Web browser that are
incapable of sending a client certificate.

Step 5

Specifies cipher suite configuration.

hostname(config-tlsp)# client cipher-suite
cipher_suite
Example:
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1

For client proxy (the proxy acts as a TLS client to
the server), the user-defined cipher suite replaces the
default cipher suite.

What to Do Next

Once you have created the TLS proxy instance, enable it for MMP inspection. See Enabling the TLS
Proxy for MMP Inspection, page 50-9.

Enabling the TLS Proxy for MMP Inspection
Cisco UMA client and server communications can be proxied via TLS, which decrypts the data, passes
it to the inspect MMP module, and re-encrypt the data before forwarding it to the endpoint. The inspect
MMP module verifies the integrity of the MMP headers and passes the OML/HTTP to an appropriate
handler.

Step 1

Command

Purpose

hostname(config)# class-map class_map_name
Example:
hostname(config)# class-map cuma_tlsproxy

Configures the class of traffic to inspect. Traffic
between the Cisco UMA server and client uses MMP
and is handled by MMP inspection.
Where class_map_name is the name of the MMP
class map.

Step 2

hostname(config-cmap)# match port tcp eq port
Example:
hostname(config-cmap)# match port tcp eq 5443

Matches the TCP port to which you want to apply
actions for MMP inspection.
The TCP/TLS default port for MMP inspection is
5443.

Step 3

hostname(config-cmap)# exit

Exits from the Class Map configuration mode.

Step 4

hostname(config)# policy-map name
Example:
hostname(config)# policy-map global_policy

Configures the policy map and attaches the action to
the class of traffic.

Step 5

hostname(config-pmap)# class classmap-name
Example:
hostname(config-pmap)# class cuma_proxy

Assigns a class map to the policy map so that you
can assign actions to the class map traffic.
Where classmap_name is the name of the Skinny
class map.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-9

Chapter 50

Configuring Cisco Mobility Advantage

Monitoring for Cisco Mobility Advantage

Command

Purpose

Step 6

hostname(config-pmap)# inspect mmp tls-proxy
proxy_name
Example:
hostname(config-pmap)# inspect mmp tls-proxy
cuma_proxy

Enables SCCP (Skinny) application inspection and
enables the phone proxy for the specified inspection
session.

Step 7

hostname(config-pmap)# exit

Exits from the Policy Map configuration mode.

Step 8

hostname(config)# service-policy policy_map_name
global
Example:
service-policy global_policy global

Enables the service policy on all interfaces.

Monitoring for Cisco Mobility Advantage
Mobility advantage proxy can be debugged the same way as IP Telephony. You can enable TLS proxy
debug flags along with SSL syslogs to debug TLS proxy connection problems.
For example, using the following commands to enable TLS proxy-related debugging and syslog output
only:
hostname# debug inspect tls-proxy events
hostname# debug inspect tls-proxy errors
hostname# config terminal
hostname(config)# logging enable
hostname(config)# logging timestamp
hostname(config)# logging list loglist message 711001
hostname(config)# logging list loglist message 725001-725014
hostname(config)# logging list loglist message 717001-717038
hostname(config)# logging buffer-size 1000000
hostname(config)# logging buffered loglist
hostname(config)# logging debug-trace

For information about TLS proxy debugging techniques and sample output, see the Monitoring the TLS
Proxy, page 49-15.
Enable the debug mmp command for MMP inspection engine debugging:
MMP::
MMP::
MMP::
MMP::
MMP::
MMP::
MMP::
MMP::
MMP::
MMP::

received 60 bytes from outside:1.1.1.1/2000 to inside:2.2.2.2/5443
version OLWP-2.0
forward 60/60 bytes from outside:1.1.1.1/2000 to inside:2.2.2.2/5443
received 100 bytes from inside:2.2.2.2/5443 to outside:1.1.1.1/2000
session-id: ABCD_1234
status: 201
forward 100/100 bytes from inside:2.2.2.2/5443 to outside 1.1.1.1/2000
received 80 bytes from outside:1.1.1.1/2000 to inside:2.2.2.2/5443
content-type: http/1.1
content-length: 40

You can also capture the raw and decrypted data by the TLS proxy by entering the following commands:
hostname#
hostname#
hostname#
hostname#

capture mycap interface outside (capturing raw packets)
capture mycap-dec type tls-proxy interface outside (capturing decrypted data)
show capture capture_name
copy /pcap capture:capture_name tftp://tftp_location

Cisco ASA 5500 Series Configuration Guide using the CLI

50-10

Chapter 50

Configuring Cisco Mobility Advantage
Configuration Examples for Cisco Mobility Advantage

Configuration Examples for Cisco Mobility Advantage
•

Example 1: Cisco UMC/Cisco UMA Architecture – Security Appliance as Firewall with TLS Proxy
and MMP Inspection, page 50-11

•

Example 2: Cisco UMC/Cisco UMA Architecture – Security Appliance as TLS Proxy Only,
page 50-12

This section describes sample configurations that apply to two deployment scenarios for the TLS proxy
used by the Cisco Mobility Advantage solution—scenario 1 where the ASA functions as both the firewall
and TLS proxy and scenario 2 where the ASA functions as the TLS proxy only. In both scenarios, the
clients connect from the Internet.
In the samples, you export the Cisco UMA server certificate and key-pair in PKCS-12 format and import
it to the ASA. The certificate will be used during handshake with the Cisco UMA clients.
Installing the Cisco UMA server self-signed certificate in the ASA truststore is necessary for the ASA
to authenticate the Cisco UMA server during handshake between the ASA proxy and Cisco UMA server.
You create a TLS proxy instance for the Cisco UMA clients connecting to the Cisco UMA server. Lastly,
you must enable TLS proxy for MMP inspection.

Example 1: Cisco UMC/Cisco UMA Architecture – Security Appliance as
Firewall with TLS Proxy and MMP Inspection
As shown in Figure 50-6 (scenario 1—the recommended architecture), the ASA functions as both the
firewall and TLS proxy. In the scenario 1 deployment, the ASA is between a Cisco UMA client and a
Cisco UMA server. In this scenario, the ASA performs static NAT by translating the Cisco UMA server
10.1.1.2 IP address to 192.0.2.140.
Figure 50-6

Cisco UMC/Cisco UMA Architecture – Scenario 1: Security Appliance as Firewall with
TLS Proxy and MMP Inspection

Enterprise Services

Network: Active Directory
10.1.1.0/24
Exchange
IP Address:
10.1.1.2
Port: 5443
Cisco Unified
ASA with
Presence
TLS Proxy
Firewall

Mobile Data
Network (GPRS
Data Channel)

MMP/SSL/TLS

MMP/SSL/TLS

PSTN

Voice Channel

Network:
10.1.1.0/24
IP Address:
10.1.1.1

Cisco UMA
Server

Voice mail

MP

Conference
M

271641

Cisco UMC Client

Hostname:
cuma.example.com
Network: 192.0.2.0/24
IP Address: 192.0.2.140
Port: 5443

Cisco UCM

Cisco ASA 5500 Series Configuration Guide using the CLI

50-11

Chapter 50

Configuring Cisco Mobility Advantage

Configuration Examples for Cisco Mobility Advantage

object network obj-10.1.1.2-01
host 10.1.1.2
nat (inside,outside) static 192.0.2.140
crypto ca import cuma_proxy pkcs12 sample_passphrase

quit
! for CUMA server’s self-signed certificate
crypto ca trustpoint cuma_server
enrollment terminal
crypto ca authenticate cuma_server
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
tls-proxy cuma_proxy
server trust-point cuma_proxy
no server authenticate-client
client cipher-suite aes128-sha1 aes256-sha1
class-map cuma_proxy
match port tcp eq 5443
policy-map global_policy
class cuma_proxy
inspect mmp tls-proxy cuma_proxy
service-policy global_policy global

Example 2: Cisco UMC/Cisco UMA Architecture – Security Appliance as TLS
Proxy Only
As shown in Figure 50-7 (scenario 2), the ASA functions as the TLS proxy only and works with an
existing firewall. The ASA and the corporate firewall are performing NAT. The corporate firewall will
not be able to predict which client from the Internet needs to connect to the corporate Cisco UMA server.
Therefore, to support this deployment, you can take the following actions:
•

Set up a NAT rule for inbound traffic that translates the destination IP address 192.0.2.41 to
172.16.27.41.

•

Set up an interface PAT rule for inbound traffic translating the source IP address of every packet so
that the corporate firewall does not need to open up a wildcard pinhole. The Cisco UMA server
receives packets with the source IP address 192.0.2.183.
hostname(config)# object network obj-0.0.0.0-01
hostname(config-network-object)# subnet 0.0.0.0 0.0.0.0
hostname(config-network-object)# nat (outside,inside) dynamic 192.0.2.183

Cisco ASA 5500 Series Configuration Guide using the CLI

50-12

Configuring Cisco Mobility Advantage
Configuration Examples for Cisco Mobility Advantage

Figure 50-7

Cisco UMC/Cisco UMA Architecture – Scenario 2: Security Appliance as TLS Proxy
Only

Client connects to
cuma.example.com
(192.0.2.41)
Cisco UMC Client

Internet

ISP
Gateway

DMZ

Corporate
Firewall

Internal Network
IP Address:
172.16.27.41
(DMZ routable)

192.0.2.41/24
outside

eth0

192.0.2.182/24
inside

Cisco UMA
M

ASA with
TLS Proxy

Active
Directory

Cisco UCM

MP

Exchange
Cisco Unified
Presence

Conference
Voice mail

271642

Chapter 50

Enterprise Network
object network obj-172.16.27.41-01
host 172.16.27.41
nat (inside,outside) static 192.0.2.140
object network obj-0.0.0.0-01
subnet 0.0.0.0 0.0.0.0
nat (outside,inside) dynamic 192.0.2.183
crypto ca import cuma_proxy pkcs12 sample_passphrase

quit
! for CUMA server’s self-signed certificate
crypto ca trustpoint cuma_server
enrollment terminal
crypto ca authenticate cuma_server
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

Cisco ASA 5500 Series Configuration Guide using the CLI

50-13

Chapter 50

Configuring Cisco Mobility Advantage

Feature History for Cisco Mobility Advantage

tls-proxy cuma_proxy
server trust-point cuma_proxy
no server authenticate-client
client cipher-suite aes128-sha1 aes256-sha1
class-map cuma_proxy
match port tcp eq 5443
policy-map global_policy
class cuma_proxy
inspect mmp tls-proxy cuma_proxy
service-policy global_policy global

Feature History for Cisco Mobility Advantage
Table 50-1 lists the release history for this feature.
Table 50-1

Feature History for Cisco Phone Proxy

Feature Name

Releases

Feature Information

Cisco Mobility Advantage Proxy

8.0(4)

The Cisco Mobility Advantage Proxy feature was
introduced.

Cisco Mobility Advantage Proxy

8.3(1)

The Unified Communications Wizard was added to ASDM.
By using the wizard, you can configure the Cisco Mobility
Advantage Proxy.

Cisco ASA 5500 Series Configuration Guide using the CLI

50-14

CH A P T E R

51

Configuring Cisco Unified Presence
This chapter describes how to configure the adaptive security appliance for Cisco Unified Presence.
This chapter includes the following sections:
•

Information About Cisco Unified Presence, page 51-1

•

Licensing for Cisco Unified Presence, page 51-7

•

Configuring Cisco Unified Presence Proxy for SIP Federation, page 51-8

•

Monitoring Cisco Unified Presence, page 51-14

•

Configuration Example for Cisco Unified Presence, page 51-14

•

Feature History for Cisco Unified Presence, page 51-20

Information About Cisco Unified Presence
This section includes the following topics:
•

Architecture for Cisco Unified Presence for SIP Federation Deployments, page 51-1

•

Trust Relationship in the Presence Federation, page 51-4

•

Security Certificate Exchange Between Cisco UP and the Security Appliance, page 51-5

•

XMPP Federation Deployments, page 51-5

•

Configuration Requirements for XMPP Federation, page 51-6

Architecture for Cisco Unified Presence for SIP Federation Deployments
Figure 51-1 depicts a Cisco Unified Presence/LCS Federation scenario with the ASA as the presence
federation proxy (implemented as a TLS proxy). The two entities with a TLS connection are the
“Routing Proxy” (a dedicated Cisco UP) in Enterprise X and the Microsoft Access Proxy in Enterprise
Y. However, the deployment is not limited to this scenario. Any Cisco UP or Cisco UP cluster could be
deployed on the left side of the ASA; the remote entity could be any server (an LCS, an OCS, or another
Cisco UP).
The following architecture is generic for two servers using SIP (or other ASA inspected protocols) with
a TLS connection.
Entity X: Cisco UP/Routing Proxy in Enterprise X
Entity Y: Microsoft Access Proxy/Edge server for LCS/OCS in Enterprise Y

Cisco ASA 5500 Series Configuration Guide using the CLI

51-1

Chapter 51

Configuring Cisco Unified Presence

Information About Cisco Unified Presence

Figure 51-1

Typical Cisco Unified Presence/LCS Federation Scenario

Enterprise X
private
Cisco UCM

Cisco UCM

Cisco UP
(UK)

Cisco UP
(HK)

Enterprise Y

DMZ

DMZ

private network

AD
Cisco UCM
Cisco UP
(US)

Orative
(Ann)

Routing
Inside ASA Outside
Proxy
8.0.4
(Cisco UP)

IPPM
(Ann)

SIP
Internet

192.0.2.254
Access
LCS
Proxy
Director

Functions as:
• TLS Proxy
• NAT w/SIP
rewrite
• Firewall

MOC
(Yao)

LCS

MOC
(Zak)
271637

UC
(Ann)

192.0.2.1

10.0.0.2

In the above architecture, the ASA functions as a firewall, NAT, and TLS proxy, which is the
recommended architecture. However, the ASA can also function as NAT and the TLS proxy alone,
working with an existing firewall.
Either server can initiate the TLS handshake (unlike IP Telephony or Cisco Unified Mobility, where only
the clients initiate the TLS handshake). There are by-directional TLS proxy rules and configuration.
Each enterprise can have an ASA as the TLS proxy.
In Figure 51-1, NAT or PAT can be used to hide the private address of Entity X. In this situation, static
NAT or PAT must be configured for foreign server (Entity Y) initiated connections or the TLS handshake
(inbound). Typically, the public port should be 5061. The following static PAT command is required for
the Cisco UP that accepts inbound connections:
hostname(config)# object network obj-10.0.0.2-01
hostname(config-network-object)# host 10.0.0.2
hostname(config-network-object)# nat (inside,outside) static 192.0.2.1 service tcp 5061
5061

The following static PAT must be configured for each Cisco UP that could initiate a connection (by
sending SIP SUBSCRIBE) to the foreign server.
For Cisco UP with the address 10.0.0.2, enter the following command:
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#
5062
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#
5070
hostname(config)# object network
hostname(config-network-object)#

Cisco ASA 5500 Series Configuration Guide using the CLI

51-2

obj-10.0.0.2-02
host 10.0.0.2
nat (inside,outside) static 192.0.2.1 service tcp 5062
obj-10.0.0.2-03
host 10.0.0.2
nat (inside,outside) static 192.0.2.1 service udp 5070
obj-10.0.0.2-04
host 10.0.0.2

Configuring Cisco Unified Presence
Information About Cisco Unified Presence

hostname(config-network-object)# nat (inside,outside) static 192.0.2.1 service tcp 5060
5060

For another Cisco UP with the address 10.0.0.3, you must use a different set of PAT ports, such as 45062
or 45070:
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#
45061
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#
45062
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#
5070
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#
45070
hostname(config)# object network
hostname(config-network-object)#
hostname(config-network-object)#
45060

obj-10.0.0.3-01
host 10.0.0.3
nat (inside,outside) static 192.0.2.1 service tcp 5061
obj-10.0.0.3-02
host 10.0.0.3
nat (inside,outside) static 192.0.2.1 service tcp 5062
obj-10.0.0.3-03
host 10.0.0.3
nat (inside,outside) static 192.0.2.1 service udp 5070
obj-10.0.0.2-03
host 10.0.0.2
nat (inside,outside) static 192.0.2.1 service tcp 5070
obj-10.0.0.3-04
host 10.0.0.3
nat (inside,outside) static 192.0.2.1 service tcp 5060

Dynamic NAT or PAT can be used for the rest of the outbound connections or the TLS handshake. The
ASA SIP inspection engine takes care of the necessary translation (fixup).
hostname(config)# object network obj-0.0.0.0-01
hostname(config-network-object)# subnet 0.0.0.0 0.0.0.0
hostname(config-network-object)# nat (inside,outside) dynamic 192.0.2.1

Figure 51-2 illustrates an abstracted scenario with Entity X connected to Entity Y through the presence
federation proxy on the ASA. The proxy is in the same administrative domain as Entity X. Entity Y could
have another ASA as the proxy but this is omitted for simplicity.
Figure 51-2

Abstracted Presence Federation Proxy Scenario between Two Server Entities

Enterprise X

Entity X
10.0.0.2

Inside

10.0.0.1

ASA
TLS Proxy

Outside

192.0.2.1

Enterprise Y

SIP/TLS
Internet

Entity Y
192.0.2.254

192.0.2.2
Enterprise Y Firewall omitted

271638

Chapter 51

For the Entity X domain name to be resolved correctly when the ASA holds its credential, the ASA could
be configured to perform NAT for Entity X, and the domain name is resolved as the Entity X public
address for which the ASA provides proxy service.
For further information about configuring Cisco Unified Presence Federation for SIP Federation, see the
Integration Guide for Configuring Cisco Unified Presence for Interdomain Federation.:

Cisco ASA 5500 Series Configuration Guide using the CLI

51-3

Chapter 51

Configuring Cisco Unified Presence

Information About Cisco Unified Presence

http://www.cisco.com/en/US/products/ps6837/products_installation_and_configuration_guides_list.ht
ml

Trust Relationship in the Presence Federation
Within an enterprise, setting up a trust relationship is achievable by using self-signed certificates or you
can set it up on an internal CA.
Establishing a trust relationship cross enterprises or across administrative domains is key for federation.
Cross enterprises you must use a trusted third-party CA (such as, VeriSign). The ASA obtains a
certificate with the FQDN of the Cisco UP (certificate impersonation).
For the TLS handshake, the two entities could validate the peer certificate via a certificate chain to
trusted third-party certificate authorities. Both entities enroll with the CAs. The ASA as the TLS proxy
must be trusted by both entities. The ASA is always associated with one of the enterprises. Within that
enterprise (Enterprise X in Figure 51-1), the entity and the ASA could authenticate each other via a local
CA, or by using self-signed certificates.
To establish a trusted relationship between the ASA and the remote entity (Entity Y), the ASA can enroll
with the CA on behalf of Entity X (Cisco UP). In the enrollment request, the Entity X identity (domain
name) is used.
Figure 51-3 shows the way to establish the trust relationship. The ASA enrolls with the third party CA
by using the Cisco UP FQDN as if the ASA is the Cisco UP.
Figure 51-3

How the Security Appliance Represents Cisco Unified Presence – Certificate
Impersonate

3rd Party CA
Certificate
Authority

Cisco UP

Certificate
Microsoft Presence Server

ASA

Access
Proxy

Internet

Certificate with
Private Key
TLS (Self-signed,
or from local CA)
Key 1

Inspected and
Modified
(if needed)

Cisco ASA 5500 Series Configuration Guide using the CLI

51-4

TLS (Cisco UP Certificate)
Key 2

LCS/OCS
Director

271639

Enroll with FQDN
of Cisco UP

Chapter 51

Configuring Cisco Unified Presence
Information About Cisco Unified Presence

Security Certificate Exchange Between Cisco UP and the Security Appliance
You need to generate the keypair for the certificate (such as cup_proxy_key) used by the ASA, and
configure a trustpoint to identify the self-signed certificate sent by the ASA to Cisco UP (such as
cup_proxy) in the TLS handshake.
For the ASA to trust the Cisco UP certificate, you need to create a trustpoint to identify the certificate
from the Cisco UP (such as cert_from_cup), and specify the enrollment type as terminal to indicate that
you will paste the certificate received from the Cisco UP into the terminal.

XMPP Federation Deployments
Figure 51-4 provides an example of an XMPP federated network between Cisco Unified Presence
enterprise deployment and an IBM Sametime enterprise deployment. TLS is optional for XMPP
federation. ASA acts only as a firewall for XMPP federation; it does not provide TLS proxy functionality
or PAT for XMPP federation.
Figure 51-4

Basic XMPP Federated Network between Cisco Unified Presence and IBM Sametime

Enterprise X
CUCM
Inter-cluster
communication

private

DMZ

DMZ
Pass-through for
XMPP Requests
No Termination
of connections

CUP
CUP
CUP (UK)

CUCM
*ASA

CUP

Enterprise Z

Internet
XMPP

private network
Directory

IBM
Sametime
Gateway

IBM
Sametime
Sametime
Gateway
Server

CUP
CUP (US)

XMPP
Client
(Tom)

*Cisco Adaptive Security Appliance

Sametime Sametime
(Bob)
(Bill)

277887

XMPP
Client
(Ann)

ASA functions as:
• Firewall
• Open Port 5269

There are two DNS servers within the internal Cisco Unified Presence enterprise deployment. One DNS
server hosts the Cisco Unified Presence private address. The other DNS server hosts the Cisco Unified
Presence public address and a DNS SRV records for SIP federation (_sipfederationtle), and XMPP
federation (_xmpp-server) with Cisco Unified Presence. The DNS server that hosts the Cisco Unified
Presence public address is located in the local DMZ.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-5

Chapter 51

Configuring Cisco Unified Presence

Information About Cisco Unified Presence

For further information about configuring Cisco Unified Presence Federation for XMPP Federation, see
the Integration Guide for Configuring Cisco Unified Presence Release 8.0 for Interdomain Federation:
http://www.cisco.com/en/US/products/ps6837/products_installation_and_configuration_guides_list.ht
ml

Configuration Requirements for XMPP Federation
For XMPP Federation, ASA acts as a firewall only. You must open port 5269 for both incoming and
outgoing XMPP federated traffic on ASA.
These are sample access lists to open port 5269 on ASA.
Allow traffic from any address to any address on port 5269:
access-list ALLOW-ALL extended permit tcp any any eq 5269

Allow traffic from any address to any single node on port 5269:
access-list ALLOW-ALL extended permit tcp any host  eq 5269

If you do not configure the access list above, and you publish additional XMPP federation nodes in DNS,
you must configure access to each of these nodes, for example:
object network obj_host_
#host 
object network obj_host_
#host 
object network obj_host_
#host 

....
Configure the following NAT commands:
nat (inside,outside) source static obj_host_ obj_host_
service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_ obj_host_
service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269

If you publish a single public IP address in DNS, and use arbitrary ports, configure the following:
(This example is for two additional XMPP federation nodes)
nat (inside,outside) source static obj_host_ obj_host_
service
obj_udp_source_eq_5269 obj_udp_source_eq_25269
nat (inside,outside) source static obj_host_ obj_host_
service
obj_tcp_source_eq_5269 obj_tcp_source_eq_25269
nat (inside,outside) source static obj_host_ obj_host_
service
obj_udp_source_eq_5269 obj_udp_source_eq_35269
nat (inside,outside) source static obj_host_ obj_host_
service
obj_tcp_source_eq_5269 obj_tcp_source_eq_35269

If you publish multiple public IP addresses in DNS all using port 5269, configure the following:
(This example is for two additional XMPP federation nodes)

Cisco ASA 5500 Series Configuration Guide using the CLI

51-6

Chapter 51

Configuring Cisco Unified Presence
Licensing for Cisco Unified Presence

nat (inside,outside) source static obj_host_ obj_host_
service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_ obj_host_
service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269
nat (inside,outside) source static obj_host_ obj_host_
service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_ obj_host_
service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269

Licensing for Cisco Unified Presence
The Cisco Unified Presence feature supported by the ASA require a Unified Communications Proxy
license.
The following table shows the Unified Communications Proxy license details by platform:

Note

This feature is not available on No Payload Encryption models.

Model

License Requirement1

ASA 5505

Base License and Security Plus License: 2 sessions.
Optional license: 24 sessions.

ASA 5510

Base License and Security Plus License: 2 sessions.
Optional licenses: 24, 50, or 100 sessions.

ASA 5520

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

ASA 5540

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5550

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

ASA 5580

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions.2

ASA 5512-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5515-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, or 500 sessions.

ASA 5525-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, or 1000 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-7

Chapter 51

Configuring Cisco Unified Presence

Configuring Cisco Unified Presence Proxy for SIP Federation

Model

License Requirement1

ASA 5545-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, or 2000 sessions.

ASA 5555-X

Base License: 2 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.

ASA 5585-X with
SSP-10

Base License: 2 sessions.

ASA 5585-X with
SSP-20, -40, or -60

Base License: 2 sessions.

Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, or 3000 sessions.
Optional licenses: 24, 50, 100, 250, 500, 750, 1000, 2000, 3000, 5000, or 10,000 sessions.2

1. The following applications use TLS proxy sessions for their connections. Each TLS proxy session used by these applications (and only these applications)
is counted against the UC license limit:
- Phone Proxy
- Presence Federation Proxy
- Encrypted Voice Inspection
Other applications that use TLS proxy sessions do not count towards the UC limit, for example, Mobility Advantage Proxy (which does not require a
license) and IME (which requires a separate IME 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. 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.
Note: 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
. If you use failover and enter the write standby command 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 towards the SRTP limit; if passthrough is set for the call, even if both legs are
SRTP, they do not count towards the limit.
2. 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.

For more information about licensing, see Chapter 3, “Managing Feature Licenses.”

Configuring Cisco Unified Presence Proxy for SIP Federation
This section contains the following topics:
•

Task Flow for Configuring Cisco Unified Presence Federation Proxy for SIP Federation, page 51-9

•

Creating Trustpoints and Generating Certificates, page 51-9

•

Installing Certificates, page 51-10

Cisco ASA 5500 Series Configuration Guide using the CLI

51-8

Chapter 51

Configuring Cisco Unified Presence
Configuring Cisco Unified Presence Proxy for SIP Federation

•

Creating the TLS Proxy Instance, page 51-12

•

Enabling the TLS Proxy for SIP Inspection, page 51-13

Task Flow for Configuring Cisco Unified Presence Federation Proxy for SIP
Federation
To configure a Cisco Unified Presence/LCS Federation scenario with the ASA as the TLS proxy where
there is a single Cisco UP that is in the local domain and self-signed certificates are used between the
Cisco UP and the ASA (like the scenario shown in Figure 51-1), perform the following tasks.
Step 1

Create the following static NAT for the local domain containing the Cisco UP.
For the inbound connection to the local domain containing the Cisco UP, create static PAT by entering
the following command:
hostname(config)# object network name
hostname(config-network-object)# host real_ip
hostname(config-network-object)# nat (real_ifc,mapped_ifc) static mapped_ip service {tcp |
udp} real_port mapped_port

Note

For each Cisco UP that could initiate a connection (by sending SIP SUBSCRIBE) to the foreign
server, you must also configure static PAT by using a different set of PAT ports.

For outbound connections or the TLS handshake, use dynamic NAT or PAT. The ASA SIP inspection
engine takes care of the necessary translation (fixup).
hostname(config)# object network name
hostname(config-network-object)# subnet real_ip netmask
hostname(config-network-object)# nat (real_ifc,mapped_ifc) dynamic mapped_ip

For information about configuring NAT and PAT for the Cisco Presence Federation proxy, see
Chapter 30, “Configuring Network Object NAT” and Chapter 31, “Configuring Twice NAT”.
Step 2

Create the necessary RSA keypairs and proxy certificate, which is a self-signed certificate, for the
remote entity. See Creating Trustpoints and Generating Certificates, page 51-9.

Step 3

Install the certificates. See Installing Certificates, page 51-10.

Step 4

Create the TLS proxy instance for the Cisco UP clients connecting to the Cisco UP server. See Creating
the TLS Proxy Instance, page 51-12.

Step 5

Enable the TLS proxy for SIP inspection. See Enabling the TLS Proxy for SIP Inspection, page 51-13.

Creating Trustpoints and Generating Certificates
You need to generate the keypair for the certificate (such as cup_proxy_key) used by the ASA, and
configure a trustpoint to identify the self-signed certificate sent by the ASA to Cisco UP (such as
cup_proxy) in the TLS handshake.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-9

Chapter 51

Configuring Cisco Unified Presence

Configuring Cisco Unified Presence Proxy for SIP Federation

Step 1

Step 2

Command

Purpose

hostname(config)# crypto key generate rsa label
key-pair-label modulus size
Example:
crypto key generate rsa label ent_y_proxy_key
modulus 1024
INFO: The name for the keys will be: ent_y_proxy_key
Keypair generation process begin. Please wait...
hostname(config)#

Creates the RSA keypair that can be used for the
trustpoints.

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
hostname(config)# crypto ca trustpoint ent_y_proxy

Enters the trustpoint configuration mode for the
specified trustpoint so that you can create the
trustpoint for the remote entity.

The keypair is used by the self-signed certificate
presented to the local domain containing the Cisco
UP (proxy for the remote entity).

A trustpoint represents a CA identity and possibly a
device identity, based on a certificate issued by the
CA.
Step 3

hostname(config-ca-trustpoint)# enrollment self

Generates a self-signed certificate.

Step 4

hostname(config-ca-trustpoint)# fqdn none

Specifies not to include a fully qualified domain
name (FQDN) in the Subject Alternative Name
extension of the certificate during enrollment.

Step 5

hostname(config-ca-trustpoint)# subject-name
X.500_name
Example:
hostname(config-ca-trustpoint)# subject-name
cn=Ent-Y-Proxy

Includes the indicated subject DN in the certificate
during enrollment

Step 6

hostname(config-ca-trustpoint)# keypair keyname
Example:
hostname(config-ca-trustpoint)# keypair
ent_y_proxy_key

Specifies the key pair whose public key is to be
certified.

Step 7

hostname(config-ca-trustpoint)# exit

Exits from the CA Trustpoint configuration mode.

Step 8

hostname(config)# crypto ca enroll trustpoint
Example:
hostname(config)# crypto ca enroll ent_y_proxy

Starts the enrollment process with the CA and
specifies the name of the trustpoint to enroll with.

What to Do Next

Install the certificate on the local entity truststore. You could also enroll the certificate with a local CA
trusted by the local entity. See the “Installing Certificates” section on page 51-10.

Installing Certificates
Export the self-signed certificate for the ASA created in the “Creating Trustpoints and Generating
Certificates” section on page 51-9 and install it as a trusted certificate on the local entity. This task is
necessary for local entity to authenticate the ASA.
Prerequisites

To create a proxy certificate on the ASA that is trusted by the remote entity, obtain a certificate from a
trusted CA. For information about obtaining a certificate from a trusted CA, see the “Configuring Digital
Certificates” section on page 41-9.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-10

Chapter 51

Configuring Cisco Unified Presence
Configuring Cisco Unified Presence Proxy for SIP Federation

Command

Purpose

Step 1

hostname(config)# crypto ca export trustpoint
identity-certificate
Example:
hostname(config)# crypto ca export ent_y_proxy
identity-certificate

Export the ASA self-signed (identity) certificate.

Step 2

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
hostname(config)# crypto ca trustpoint ent_x_cert
! for Entity X’s self-signed certificate

Enters the trustpoint configuration mode for the
specified trustpoint so that you can create the
trustpoint for the local entity.

hostname(config-ca-trustpoint)# enrollment terminal

Specifies cut and paste enrollment with this
trustpoint (also known as manual enrollment).

Step 3

A trustpoint represents a CA identity and possibly a
device identity, based on a certificate issued by the
CA.

If the local entity uses a self-signed certificate, the
self-signed certificate must be installed; if the local
entity uses a CA-issued certificate, the CA
certificate needs to be installed. This configuration
shows the commands for using a self-signed
certificate.
Step 4

hostname(config-ca-trustpoint)# exit

Exits from the CA Trustpoint configuration mode.

Step 5

hostname(config)# crypto ca authenticate trustpoint
Example:
hostname(config)# crypto ca authenticate ent_x_cert
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line
by itself
[ certificate data omitted ]
Certificate has the following attributes:
Fingerprint: 21B598D5 4A81F3E5 0B24D12E 3F89C2E4
% Do you accept this certificate? [yes/no]: yes
Trustpoint CA certificate accepted.
% Certificate successfully imported

Installs and authenticates the CA certificates
associated with a trustpoint created for the local
entity.

Step 6

hostname(config)# crypto ca trustpoint
trustpoint_name
Example:
hostname(config)# crypto ca trustpoint ent_y_ca
! for Entity Y’s CA certificate

Install the CA certificate that signs the remote entity
certificate on the ASA by entering the following
commands. This step is necessary for the ASA to
authenticate the remote entity.

Step 7

hostname(config-ca-trustpoint)# enrollment terminal

Specifies cut and paste enrollment with this
trustpoint (also known as manual enrollment).

Step 8

hostname(config-ca-trustpoint)# exit

Exits from the CA Trustpoint configuration mode.

Step 9

hostname(config)# crypto ca authenticate trustpoint
Example:
hostname(config)# crypto ca authenticate ent_y_ca
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line
by itself
MIIDRTCCAu+gAwIBAgIQKVcqP/KW74VP0NZzL+JbRTANBgkqhkiG
9w0BAQUFADCB
[ certificate data omitted ]
/7QEM8izy0EOTSErKu7Nd76jwf5e4qttkQ==

Installs and authenticates the CA certificates
associated with a trustpoint created for the local
entity.

Where trustpoint specifies the trustpoint from which
to obtain the CA certificate. Maximum name length
is 128 characters.
The ASA prompts you to paste the base-64
formatted CA certificate onto the terminal.

The ASA prompts you to paste the base-64
formatted CA certificate onto the terminal.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-11

Chapter 51

Configuring Cisco Unified Presence

Configuring Cisco Unified Presence Proxy for SIP Federation

What to Do Next

Once you have created the trustpoints and installed the certificates for the local and remote entities on
the ASA, create the TLS proxy instance. See Creating the TLS Proxy Instance, page 51-12.

Creating the TLS Proxy Instance
Because either server can initiate the TLS handshake (unlike IP Telephony or Cisco Unified Mobility,
where only the clients initiate the TLS handshake), you must configure by-directional TLS proxy rules.
Each enterprise can have an ASA as the TLS proxy.
Create TLS proxy instances for the local and remote entity initiated connections respectively. The entity
that initiates the TLS connection is in the role of “TLS client”. Because the TLS proxy has a strict
definition of “client” and “server” proxy, two TLS proxy instances must be defined if either of the
entities could initiate the connection.
Command

Purpose

Step 1

! Local entity to remote entity
hostname(config)# tls-proxy proxy_name
Example:
hostname(config)# tls-proxy ent_x_to_y

Creates the TLS proxy instance.

Step 2

hostname(config-tlsp)# server trust-point proxy_name
Example:
hostname(config-tlsp)# server trust-point
ent_y_proxy

Specifies the proxy trustpoint certificate presented
during TLS handshake.
The certificate must be owned by the ASA (identity
certificate).
Where the proxy_name for the server trust-point
command is the remote entity proxy name.

Step 3

hostname(config-tlsp)# client trust-point
proxy_trustpoint
Example:
hostname(config-tlsp)# client trust-point
ent_x_proxy

Specifies the trustpoint and associated certificate
that the ASA uses in the TLS handshake when the
ASA assumes the role of the TLS client.
The certificate must be owned by the ASA (identity
certificate).
Where the proxy_trustpoint for the client
trust-point command is the local entity proxy.

Step 4

hostname(config-tlsp)# client cipher-suite
cipher_suite
Example:
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1

Specifies cipher suite configuration.

Step 5

! Remote entity to local entity
hostname(config)# tls-proxy proxy_name
Example:
tls-proxy ent_y_to_x

Creates the TLS proxy instance.

Step 6

hostname(config-tlsp)# server trust-point proxy_name
Example:
hostname(config-tlsp)# server trust-point
ent_x_proxy

Specifies the proxy trustpoint certificate presented
during TLS handshake.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-12

For client proxy (the proxy acts as a TLS client to
the server), the user-defined cipher suite replaces the
default cipher suite.

Where the proxy_name for the server trust-point
command is the local entity proxy name

Chapter 51

Configuring Cisco Unified Presence
Configuring Cisco Unified Presence Proxy for SIP Federation

Step 7

Step 8

Command

Purpose

hostname(config-tlsp)# client trust-point
proxy_trustpoint
Example:
hostname(config-tlsp)# client trust-point
ent_y_proxy

Specifies the trustpoint and associated certificate
that the ASA uses in the TLS handshake when the
ASA assumes the role of the TLS client.
Where the proxy_trustpoint for the client
trust-point command is the remote entity proxy.
Specifies cipher suite configuration.

hostname(config-tlsp)# client cipher-suite
cipher_suite
Example:
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1

What to Do Next

Once you have created the TLS proxy instance, enable it for SIP inspection. See Enabling the TLS Proxy
for SIP Inspection, page 51-13.

Enabling the TLS Proxy for SIP Inspection
Enable the TLS proxy for SIP inspection and define policies for both entities that could initiate the
connection.
Command

Purpose

Step 1

hostname(config)# access-list id extended permit tcp
host src_ip host dest_ip eq port
Examples:
access-list ent_x_to_y extended permit tcp host
10.0.0.2 host 192.0.2.254 eq 5061
access-list ent_y_to_x extended permit tcp host
192.0.2.254 host 192.0.2.1 eq 5061

Adds an Access Control Entry. The access list is
used to specify the class of traffic to inspect.

Step 2

hostname(config)# class-map class_map_name
Example:
hostname(config)# class-map ent_x_to_y

Configures the secure SIP class of traffic to inspect.

Step 3

hostname(config-cmap)# match access-list
access_list_name
Example:
hostname(config-cmap)# match access-list ent_x_to_y

Identifies the traffic to inspect.

Step 4

hostname(config-cmap)# exit

Exits from Class Map configuration mode.

Step 5

hostname(config)# policy-map type inspect sip
policy_map_name
Example:
hostname(config)# policy-map type inspect sip
sip_inspect

Defines special actions for SIP inspection
application traffic.

Step 6

hostname(config-pmap)# parameters
! SIP inspection parameters

Specifies the parameters for SIP inspection.
Parameters affect the behavior of the inspection
engine.

Where class_map_name is the name of the SIP class
map.

The commands available in parameters
configuration mode depend on the application.
Step 7

hostname(config-pmap)# exit

Exits from Policy Map configuration mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-13

Chapter 51

Configuring Cisco Unified Presence

Monitoring Cisco Unified Presence

Command

Purpose

Step 8

hostname(config)# policy-map name
Example:
hostname(config)# policy-map global_policy

Configure the policy map and attach the action to the
class of traffic.

Step 9

hostname(config-pmap)# class classmap_name
Example:
hostname(config-pmap)# class ent_x_to_y

Assigns a class map to the policy map so that you
can assign actions to the class map traffic.
Where classmap_name is the name of the SIP class
map.

Step 10

hostname(config-pmap)# inspect sip sip_map tls-proxy
proxy_name
hostname(config-pmap)# inspect sip sip_inspect
tls-proxy ent_x_to_y

Enables TLS proxy for the specified SIP inspection
session.

Step 11

hostname(config-pmap)# exit

Exits from Policy Map configuration mode.

Step 12

hostname(config)# service-policy policy_map_name
global
Example:
hostname(config)# service-policy global_policy
global

Enables the service policy for SIP inspection for all
interfaces.
Where name for the policy-map command is the
name of the global policy map.

Monitoring Cisco Unified Presence
Debugging is similar to debugging TLS proxy for IP Telephony. You can enable TLS proxy debug flags
along with SSL syslogs to debug TLS proxy connection problems.
For example, use the following commands to enable TLS proxy-related debug and syslog output only:
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#
hostname(config)#

debug inspect tls-proxy events
debug inspect tls-proxy errors
logging enable
logging timestamp
logging list loglist message 711001
logging list loglist message 725001-725014
logging list loglist message 717001-717038
logging buffer-size 1000000
logging buffered loglist
logging debug-trace

For information about TLS proxy debugging techniques and sample output, see Monitoring the TLS
Proxy, page 49-15.
Enable the debug sip command for SIP inspection engine debugging. See the command reference.
Additionally, you can capture the raw and decrypted data by the TLS proxy by entering the following
commands:
hostname#
hostname#
hostname#
hostname#

capture mycap interface outside (capturing raw packets)
capture mycap-dec type tls-proxy interface outside (capturing decrypted data)
show capture capture_name
copy /pcap capture:capture_name tftp://tftp_location

Configuration Example for Cisco Unified Presence
This section contains the following topics:
•

Example Configuration for SIP Federation Deployments, page 51-15

Cisco ASA 5500 Series Configuration Guide using the CLI

51-14

Chapter 51

Configuring Cisco Unified Presence
Configuration Example for Cisco Unified Presence

•

Example Access List Configuration for XMPP Federation, page 51-17

•

Example NAT Configuration for XMPP Federation, page 51-18

Example Configuration for SIP Federation Deployments
The following sample illustrates the necessary configuration for the ASA to perform TLS proxy for
Cisco Unified Presence as shown in Figure 51-5. It is assumed that a single Cisco UP (Entity X) is in the
local domain and self-signed certificates are used between Entity X and the ASA.
For each Cisco UP that could initiate a connection (by sending SIP SUBSCRIBE) to the foreign server,
you must also configure static PAT and if you have another Cisco UP with the address (10.0.0.3 in this
sample), it must use a different set of PAT ports (such as 45062 or 45070). Dynamic NAT or PAT can be
used for outbound connections or TLS handshake. The ASA SIP inspection engine takes care of the
necessary translation (fixup).
When you create the necessary RSA key pairs, a key pair is used by the self-signed certificate presented
to Entity X (proxy for Entity Y). When you create a proxy certificate for Entity Y, the certificate is
installed on the Entity X truststore. It could also be enrolled with a local CA trusted by Entity X.
Exporting the ASA self-signed certificate (ent_y_proxy) and installing it as a trusted certificate on Entity
X is necessary for Entity X to authenticate the ASA. Exporting the Entity X certificate and installing it
on the ASA is needed for the ASA to authenticate Entity X during handshake with X. If Entity X uses a
self-signed certificate, the self-signed certificate must be installed; if Entity X uses a CA issued the
certificate, the CA’s certificated needs to be installed.
For about obtaining a certificate from a trusted CA, see the “Configuring Digital Certificates” section on
page 41-9.
Installing the CA certificate that signs the Entity Y certificate on the ASA is necessary for the ASA to
authenticate Entity Y.
When creating TLS proxy instances for Entity X and Entity Y, the entity that initiates the TLS connection
is in the role of “TLS client”. Because the TLS proxy has strict definition of “client” and “server” proxy,
two TLS proxy instances must be defined if either of the entities could initiate the connection.
When enabling the TLS proxy for SIP inspection, policies must be defined for both entities that could
initiate the connection.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-15

Chapter 51

Configuring Cisco Unified Presence

Configuration Example for Cisco Unified Presence

Figure 51-5

Typical Cisco Unified Presence/LCS Federation Scenario

Enterprise X
private
Cisco UCM

Cisco UCM

Cisco UP
(UK)

Cisco UP
(HK)

Enterprise Y

DMZ

DMZ

private network

AD
Cisco UCM
Cisco UP
(US)

Orative
(Ann)

Routing
Inside ASA Outside
Proxy
8.0.4
(Cisco UP)

IPPM
(Ann)

SIP
Internet

192.0.2.254
Access
LCS
Proxy
Director

Functions as:
• TLS Proxy
• NAT w/SIP
rewrite
• Firewall

MOC
(Yao)

LCS

MOC
(Zak)
271637

UC
(Ann)

192.0.2.1

10.0.0.2

object network obj-10.0.0.2-01
host 10.0.0.2
nat (inside,outside) static 192.0.2.1 service tcp
object network obj-10.0.0.2-02
host 10.0.0.2
nat (inside,outside) static 192.0.2.1 service tcp
object network obj-10.0.0.2-03
host 10.0.0.2
nat (inside,outside) static 192.0.2.1 service udp
object network obj-10.0.0.3-01
host 10.0.0.3
nat (inside,outside) static 192.0.2.1 service tcp
object network obj-10.0.0.3-02
host 10.0.0.3
nat (inside,outside) static 192.0.2.1 service udp
object network obj-0.0.0.0-01
subnet 0.0.0.0 0.0.0.0
nat (inside,outside) dynamic 192.0.2.1
crypto key generate rsa label ent_y_proxy_key modulus
! for self-signed Entity Y proxy certificate
crypto ca trustpoint ent_y_proxy
enrollment self
fqdn none
subject-name cn=Ent-Y-Proxy
keypair ent_y_proxy_key
crypto ca enroll ent_y_proxy
crypto ca export ent_y_proxy identity-certificate
! for Entity X’s self-signed certificate
crypto ca trustpoint ent_x_cert
enrollment terminal
crypto ca authenticate ent_x_cert
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line by
[ certificate data omitted ]

Cisco ASA 5500 Series Configuration Guide using the CLI

51-16

5061 5061

5062 5062

5070 5070

5062 45062

5070 45070

1024

itself

Chapter 51

Configuring Cisco Unified Presence
Configuration Example for Cisco Unified Presence

quit
! for Entity Y’s CA certificate
crypto ca trustpoint ent_y_ca
enrollment terminal
crypto ca authenticate ent_y_ca
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
! Entity X to Entity Y
tls-proxy ent_x_to_y
server trust-point ent_y_proxy
client trust-point ent_x_proxy
client cipher-suite aes128-sha1 aes256-sha1 3des-sha1 null-sha1
! Entity Y to Entity X
tls-proxy ent_y_to_x
server trust-point ent_x_proxy
client trust-point ent_y_proxy
client cipher-suite aes128-sha1 aes256-sha1 3des-sha1 null-sha1
access-list ent_x_to_y extended permit tcp host 10.0.0.2 host 192.0.2.254 eq 5061
access-list ent_y_to_x extended permit tcp host 192.0.2.254 host 192.0.2.1 eq 5061
class-map ent_x_to_y
match access-list ent_x_to_y
class-map ent_y_to_x
match access-list ent_y_to_x
policy-map type inspect sip sip_inspect
parameters
! SIP inspection parameters
policy-map global_policy
class ent_x_to_y
inspect sip sip_inspect tls-proxy ent_x_to_y
class ent_y_to_x
inspect sip sip_inspect tls-proxy ent_y_to_x
service-policy global_policy global

Example Access List Configuration for XMPP Federation
Example 1: This example access list configuration allows from any address to any address on port 5269:
access-list ALLOW-ALL extended permit tcp any any eq 5269

Example 2: This example access list configuration allows from any address to any single XMPP
federation node on port 5269. The following values are used in this example:
•

Private XMPP federation Cisco Unified Presence Release 8.0 IP address = 1.1.1.1

•

XMPP federation listening port = 5269

access-list ALLOW-ALL extended permit tcp any host 1.1.1.1 eq 5269

Example 3: This example access list configuration allows from any address to specific XMPP federation
nodes published in DNS.

Note

The public addresses are published in DNS, but the private addresses are configured in the access-list
command.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-17

Chapter 51

Configuring Cisco Unified Presence

Configuration Example for Cisco Unified Presence

The following values are used in this sample configuration:
• Private XMPP federation Cisco Unified Presence Release 8.0 IP address = 1.1.1.1
• Private second Cisco Unified Presence Release 8.0 IP address= 2.2.2.2
• Private third Cisco Unified Presence Release 7.x IP address = 3.3.3.3
• XMPP federation listening port = 5269
access-list ALLOW-ALL extended permit tcp any host 1.1.1.1 eq 5269
access-list ALLOW-ALL extended permit tcp any host 2.2.2.2 eq 5269
access-list ALLOW-ALL extended permit tcp any host 3.3.3.3 eq 5269

Example 4: This example access list configuration allows only from a specific federated domain
interface to specific XMPP federation nodes published in DNS.

Note

The public addresses are published in DNS, but the private addresses are configured in the access-list
command.
The following values are used in this sample configuration:
•

Private XMPP federation Cisco Unified Presence Release 8.0 IP address = 1.1.1.1

•

Private second Cisco Unified Presence Release 8.0 IP address = 2.2.2.2

•

Private third Cisco Unified Presence Release 7.x IP address = 3.3.3.3

•

XMPP federation listening port = 5269

•

External interface of the foreign XMPP enterprise = 100.100.100.100

access-list ALLOW-ALL extended permit tcp host 100.100.100.100 host 1.1.1.1 eq 5269
access-list ALLOW-ALL extended permit tcp host 100.100.100.100 host 2.2.2.2 eq 5269
access-list ALLOW-ALL extended permit tcp host 100.100.100.100 host 3.3.3.3 eq 5269

Example NAT Configuration for XMPP Federation
Example 1: Single node with XMPP federation enabled
The following values are used in this sample configuration:
•

Public Cisco Unified Presence IP address = 10.10.10.10

•

Private XMPP federation Cisco Unified Presence Release 8.0 IP address = 1.1.1.1

•

XMPP federation listening port = 5269

nat (inside,outside) source static obj_host_1.1.1.1 obj_host_10.10.10.10 service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_1.1.1.1 obj_host_10.10.10.10 service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269

Example 2: Multiple nodes with XMPP federation, each with a public IP address in DNS
The following values are used in this sample configuration:
•

Public Cisco Unified Presence IP addresses = 10.10.10.10, 20.20.20.20, 30.30.30.30

•

Private XMPP federation Cisco Unified Presence Release 8.0 IP address = 1.1.1.1

•

Private second Cisco Unified Presence Release 8.0 IP address = 2.2.2.2

Cisco ASA 5500 Series Configuration Guide using the CLI

51-18

Chapter 51

Configuring Cisco Unified Presence
Configuration Example for Cisco Unified Presence

•

Private third Cisco Unified Presence Release 7.x IP address = 3.3.3.3

•

XMPP federation listening port = 5269

nat (inside,outside) source static obj_host_1.1.1.1 obj_host_10.10.10.10 service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_1.1.1.1 obj_host_10.10.10.10 service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269
nat (inside,outside) source static obj_host_2.2.2.2 obj_host_20.20.20.20 service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_2.2.2.2 obj_host_20.20.20.20 service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269
nat (inside,outside) source static obj_host_3.3.3.3 obj_host_30.30.30.30 service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_3.3.3.3 obj_host_30.30.30.30 service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269

Example 3: Multiple nodes with XMPP federation, but a single public IP address in DNS with arbitrary
ports published in DNS (PAT).
The following values are used in this sample configuration:
•

Public Cisco Unified Presence IP Address = 10.10.10.10

•

Private XMPP federation Cisco Unified Presence Release 8.0 IP address = 1.1.1.1, port 5269

•

Private second Cisco Unified Presence Release 8.0 IP address = 2.2.2.2, arbitrary port 25269

•

Private third Cisco Unified Presence Release 7.x IP address = 3.3.3.3, arbitrary port 35269

nat (inside,outside) source static obj_host_1.1.1.1 obj_host_10.10.10.10 service
obj_udp_source_eq_5269 obj_udp_source_eq_5269
nat (inside,outside) source static obj_host_1.1.1.1 obj_host_10.10.10.10 service
obj_tcp_source_eq_5269 obj_tcp_source_eq_5269
nat (inside,outside) source static obj_host_2.2.2.2 obj_host_10.10.10.10 service
obj_udp_source_eq_5269 obj_udp_source_eq_25269
nat (inside,outside) source static obj_host_2.2.2.2 obj_host_10.10.10.10 service
obj_tcp_source_eq_5269 obj_tcp_source_eq_25269
nat (inside,outside) source static obj_host_3.3.3.3 obj_host_10.10.10.10 service
obj_udp_source_eq_5269 obj_udp_source_eq_35269
nat (inside,outside) source static obj_host_3.3.3.3 obj_host_10.10.10.10 service
obj_tcp_source_eq_5269 obj_tcp_source_eq_35269

Cisco ASA 5500 Series Configuration Guide using the CLI

51-19

Chapter 51

Configuring Cisco Unified Presence

Feature History for Cisco Unified Presence

Feature History for Cisco Unified Presence
Table 51-1 lists the release history for this feature.
Table 51-1

Feature History for Cisco Unified Presence

Feature Name

Releases

Feature Information

Cisco Presence Federation Proxy

8.0(4)

The Cisco Unified Presence proxy feature was introduced.

Cisco Presence Federation Proxy

8.3(1)

The Unified Communications Wizard was added to ASDM.
By using the wizard, you can configure the Cisco Presence
Federation Proxy.
Support for XMPP Federation was introduced.

Cisco ASA 5500 Series Configuration Guide using the CLI

51-20

CH A P T E R

52

Configuring Cisco Intercompany Media Engine
Proxy
This chapter describes how to configure the adaptive security appliance for Cisco Intercompany Media
Engine Proxy.
This chapter includes the following sections:
•

Information About Cisco Intercompany Media Engine Proxy, page 52-1

•

Licensing for Cisco Intercompany Media Engine, page 52-8

•

Guidelines and Limitations, page 52-9

•

Configuring Cisco Intercompany Media Engine Proxy, page 52-11

•

Troubleshooting Cisco Intercompany Media Engine Proxy, page 52-34

•

Feature History for Cisco Intercompany Media Engine Proxy, page 52-37

Information About Cisco Intercompany Media Engine Proxy
This section includes the following topics:
•

Features of Cisco Intercompany Media Engine Proxy, page 52-1

•

How the UC-IME Works with the PSTN and the Internet, page 52-2

•

Tickets and Passwords, page 52-3

•

Call Fallback to the PSTN, page 52-5

•

Architecture and Deployment Scenarios for Cisco Intercompany Media Engine, page 52-5

Features of Cisco Intercompany Media Engine Proxy
Cisco Intercompany Media Engine enables companies to interconnect on-demand, over the Internet with
advanced features made available by VoIP technologies. Cisco Intercompany Media Engine allows for
business-to-business federation between Cisco Unified Communications Manager clusters in different
enterprises by utilizing peer-to-peer, security, and SIP protocols to create dynamic SIP trunks between
businesses. A collection of enterprises work together to end up looking like one large business with
inter-cluster trunks between them.
The adaptive security appliance applies its existing TLS proxy, SIP Application Layer Gateway (ALG),
and SIP verification features to the functioning of Cisco Intercompany Media Engine.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-1

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Information About Cisco Intercompany Media Engine Proxy

Cisco Intercompany Media Engine has the following key features:
•

Works with existing phone numbers: Cisco Intercompany Media Engine works with the phone
numbers an enterprise currently has and does not require an enterprise to learn new numbers or
change providers to use Cisco Intercompany Media Engine.

•

Works with existing IP phones: Cisco Intercompany Media Engine works with the existing IP
phones within an enterprise. However, the feature set in business-to-business calls is limited to the
capabilities of the IP phones.

•

Does not require purchasing new services: Cisco Intercompany Media Engine does not require any
new services from any service providers. Customers continue to use the PSTN connectivity they
have and the Internet connectivity they have today. Cisco Intercompany Media Engine gradually
moves calls off the PSTN and onto the Internet.

•

Provides a full Cisco Unified Communications experience: Because Cisco Intercompany Media
Engine creates inter-cluster SIP trunks between enterprises, any Unified Communication features
that work over the SIP trunk and only require a SIP trunk work with the Cisco Intercompany Media
Engine, thus providing a Unified Communication experience across enterprises.

•

Works on the Internet: Cisco Intercompany Media Engine was designed to work on the Internet. It
can also work on managed extranets.

•

Provides worldwide reach: Cisco Intercompany Media Engine can connect to any enterprise
anywhere in the world, as long as the enterprise is running Cisco Intercompany Media Engine
technology. There are no regional limitations. This is because Cisco Intercompany Media Engine
utilizes two networks that both have worldwide reach—the Internet and the PSTN.

•

Allows for unlimited scale: Cisco Intercompany Media Engine can work with any number of
enterprises.

•

Is self-learning: The system is primarily self-learning. Customers do not have to enter information
about other businesses: no phone prefixes, no IP address, no ports, no domain names, nor
certificates. Customers need to configure information about their own networks, and provide policy
information if they want to limit the scope of Cisco Intercompany Media Engine.

•

Is secure: Cisco Intercompany Media Engine is secure, utilizing a large number of different
technologies to accomplish this security.

•

Includes anti-spam: Cisco Intercompany Media Engine prevents people from setting up software on
the Internet that spams enterprises with phone calls. It provides an extremely high barrier to entry.

•

Provides for QoS management: Cisco Intercompany Media Engine provides features that help
customers manage the QoS on the Internet, such as the ability to monitor QoS of the RTP traffic in
real-time and fallback to PSTN automatically if problems arise.

How the UC-IME Works with the PSTN and the Internet
The Cisco Intercompany Media Engine utilizes two networks that both have worldwide reach—the
Internet and the PSTN. Customers continue to use the PSTN connectivity they have. The Cisco
Intercompany Media Engine gradually moves calls off the PSTN and onto the Internet. However, if QoS
problems arise, the Cisco Intercompany Media Engine Proxy monitors QoS of the RTP traffic in
real-time and fallbacks to PSTN automatically.
The Cisco Intercompany Media Engine uses information from PSTN calls to validate that the
terminating side owns the number that the originated side had called. After the PSTN call terminates,
the enterprises involved in the call send information about the call to their Cisco IME server. The Cisco
IME server on the originating side validates the call. Figure 52-1 shows the initial call flow through the
PSTN.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-2

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Information About Cisco Intercompany Media Engine Proxy

On successful verification, the terminating side creates a ticket that grants permission to the call
originator to make a Cisco IME call to a specific number. See Tickets and Passwords, page 52-3 for
information.
Figure 52-1

Interaction of the UC-IME Proxy with the PSTN

Enterprise A

Enterprise B
UC-IME
Server

UC-IME
Server

IP

Cisco UCM

Public
Internet

M
IP

IP

Cisco UCM
M

ASA

ASA

IP

248906

PSTN

Tickets and Passwords
Cisco Intercompany Media Engine utilizes tickets and passwords to provide enterprise verification.
Verification through the creation of tickets ensures an enterprise is not subject to denial-of-service
(DOS) attacks from the Internet or endless VoIP spam calls. Ticket verification prevents spam and DOS
attacks because it introduces a cost to the VoIP caller; namely, the cost of a PSTN call. A malicious user
cannot set up just an open source asterisk PBX on the Internet and begin launching SIP calls into an
enterprise running Cisco Intercompany Media Engine. Having the Cisco Intercompany Media Engine
Proxy verify tickets allows incoming calls from a particular enterprise to a particular number only when
that particular enterprise has previously called that phone number on the PSTN.
To send a spam VoIP call to every phone within an enterprise, an organization would have to purchase
the Cisco Intercompany Media Engine and Cisco Unified Communications Manager and have called
each phone number within the enterprise over the PSTN and completed each call successfully. Only then
can it launch a VoIP call to each number.
The Cisco Intercompany Media Engine server creates tickets and the ASA validates them. The ASA and
Cisco Intercompany Media Engine server share a password that is configured so that the ASA detects
the ticket was created by a trusted Cisco Intercompany Media Engine server. The ticket contains
information that indicates that the enterprise is authorized to call specific phone numbers at the target
enterprise. See Figure 52-2 for the ticket verification process and how it operates between the originating
and terminating-call enterprises.

Note

Because the initial calls are over the PSTN, they are subject to any national regulations regarding
telemarketing calling. For example, within the United States, they would be subject to the national
do-not-call registry.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-3

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Information About Cisco Intercompany Media Engine Proxy

Ticket Verification Process with Cisco Intercompany Media Engine

1
Enterprise A

UC-IME
Server

Enterprise B gets
authorization ticket
from A at end of
validation protocol

Enterprise B

2
UC-IME server passes
ticket to UCM and it’s
stored as part of VoIP
route

UC-IME
Server

Internet

M

M

Cisco UCM

Cisco UCM
ASA
IP
IP

4

ASA validates
ticket

3
Enterprise B
calls A and
includes ticket

ASA

IP
IP
248761

Figure 52-2

As illustrated in Figure 52-2. Enterprise B makes a PSTN call to enterprise A. That call completes
successfully. Later, Enterprise B Cisco Intercompany Media Engine server initiates validation
procedures with Enterprise A. These validation procedures succeed. During the validation handshake,
Enterprise B sends Enterprise A its domain name. Enterprise A verifies that this domain name is not on
the blacklisted set of domains. Assuming it is not, Enterprise A creates a ticket.
Subsequently, someone in Enterprise B calls that number again. That call setup message from Enterprise
B to Enterprise A includes the ticket in the X-Cisco-UC-IME-Ticket header field in the SIP INVITE
message. This message arrives at the Enterprise A ASA. The ASA verifies the signature and computes
several checks on the ticket to make sure it is valid. If the ticket is valid, the ASA forwards the request
to Cisco UCM (including the ticket). Because the ASA drops requests that lack a valid ticket,
unauthorized calls are never received by Cisco UCM.
The ticket password is a 128 bit random key, which can be thought of as a shared password between the
adaptive security appliance and the Cisco Intercompany Media Engine server. This password is
generated by the Cisco Intercompany Media Engine server and is used by a Cisco Intercompany Media
Engine SIP trunk to generate a ticket to allow a call to be made between Cisco Intercompany Media
Engine SIP trunks. A ticket is a signed object that contains a number of fields that grant permission to
the calling domain to make a Cisco Intercompany Media Engine call to a specific number. The ticket is
signed by the ticket password.
The Cisco Intercompany Media Engine also required that you configure an epoch for the password. The
epoch contains an integer that updates each time that the password is changed. When the proxy is
configured the first time and a password entered for the first time, enter 1 for the epoch integer. Each
time you change the password, increment the epoch to indicate the new password. You must increment
the epoch value each time your change the password.
Typically, you increment the epoch sequentially; however, the ASA allows you to choose any value when
you update the epoch. If you change the epoch value, the tickets in use at remote enterprises become
invalid. The incoming calls from the remote enterprises fallback to the PSTN until the terminating
enterprise reissues tickets with the new epoch value and password.
The epoch and password that you configure on the ASA must match the epoch and password configured
on the Cisco Intercompany Media Engine server. If you change the password or epoch on the ASA, you
must update them on the Cisco Intercompany Media Engine server. See the Cisco Intercompany Media
Engine server documentation for information.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-4

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Information About Cisco Intercompany Media Engine Proxy

Call Fallback to the PSTN
Cisco Intercompany Media Engine provides features that manage the QoS on the Internet, such as the
ability to monitor QoS of the RTP traffic in real-time and fallback to PSTN automatically if problems
arise. Call fallback from Internet VoIP calls to the public switched telephone network (PSTN) can occur
for two reasons changes in connection quality and signal failure for the Cisco Intercompany Media
Engine.
Internet connections can vary wildly in their quality and vary over time. Therefore, even if a call is sent
over VoIP because the quality of the connection was good, the connection quality might worsen mid-call.
To ensure an overall good experience for the end user, Cisco Intercompany Media Engine attempts to
perform a mid-call fallback.
Performing a mid-call fallback requires the adaptive security appliance to monitor the RTP packets
coming from the Internet and send information into an RTP Monitoring Algorithm (RMA) API, which
will indicates to the adaptive security appliance whether fallback is required. If fallback is required, the
adaptive security appliance sends a REFER message to Cisco UCM to tell it that it needs to fallback the
call to PSTN.
The TLS signaling connections from the Cisco UCM are terminated on the adaptive security appliance
and a TCP or TLS connection is initiated to the Cisco UCM. SRTP (media) sent from external IP phones
to the internal network IP phone via the adaptive security appliance is converted to RTP. The adaptive
security appliance inserts itself into the media path by modifying the SIP signaling messages that are
sent over the SIP trunk between Cisco UCMs. TLS (signaling) and SRTP are always terminated on the
adaptive security appliance.
If signaling problems occur, the call falls back to the PSTN; however, the Cisco UCM initiates the PSTN
fall back and the adaptive security appliance does not send REFER message.

Architecture and Deployment Scenarios for Cisco Intercompany Media Engine
This section includes the following topics:
•

Architecture, page 52-5

•

Basic Deployment, page 52-6

•

Off Path Deployment, page 52-7

Architecture
Within the enterprise, Cisco Intercompany Media Engine is deployed with the following components for
the following purposes:
•

The adaptive security appliance—Enabled with the Cisco Intercompany Media Engine Proxy,
provides perimeter security functions and inspects SIP signaling between SIP trunks.

•

Cisco Intercompany Media Engine (UC-IME) server— Located in the DMZ, provides an automated
provisioning service by learning new VoIP routes to particular phone numbers, and recording those
routes in Cisco UCM. The Cisco Intercompany Media Engine server does not perform call control.

•

Cisco Unified Communications Manager (Cisco UCM)—Responsible for call control and
processing. Cisco UCM connects to the Cisco Intercompany Media Engine server by using the
Access Protocol to publish and exchange updates. The architecture can consist of a single Cisco
UCM or a Cisco UCM cluster within the enterprise.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-5

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Information About Cisco Intercompany Media Engine Proxy

•

Cisco Intercompany Media Engine (UC-IME) Bootstrap server—Provides a certificate required
admission onto the public peer-to-peer network for Cisco Intercompany Media Engine.

Figure 52-3 illustrates the components of the Cisco Intercompany Media Engine in a basic deployment.
Cisco Intercompany Media Engine Architecture in a Basic Deployment

Inside Enterprise

Permiter Security

Figure 52-3

DMZ

Cisco UCM Cluster

Outside Enterprise

UC-IME
Bootstrap Server

UC-IME
Access Protocol

M

Peer-to-peer
Validation

M

M

TCP/TLS

M

M

UC-IME Server

SIP/TLS

ASA Enabled with
UC-IME Proxy
SIP/SCCP

IP

IP

SRTP
248760

RTP/SRTP

IP

Basic Deployment
In a basic deployment, the Cisco Intercompany Media Engine Proxy sits in-line with the Internet firewall
such that all Internet traffic traverses the adaptive security appliance. In this deployment, a single Cisco
UCM or a Cisco UCM cluster is centrally deployed within the enterprise, along with a Cisco
Intercompany Media Engine server (and perhaps a backup).
As shown in Figure 52-4, the adaptive security appliance sits on the edge of the enterprise and inspects
SIP signaling by creating dynamic SIP trunks between enterprises.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-6

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Information About Cisco Intercompany Media Engine Proxy

Basic Deployment Scenario

UC-IME
Bootstrap Server

Enterprise A

Enterprise B

Internet

UC-IME
Server

UC-IME
Server

SIP Trunk

M

M
Cisco UCM

Cisco UCM
ASA Enabled
with UC-IME Proxy
IP

ASA Enabled
with UC-IME Proxy
IP

IP

V
PSTN Gateway

PSTN

IP

V

248762

Figure 52-4

PSTN Gateway

Off Path Deployment
In an off path deployment, inbound and outbound Cisco Intercompany Media Engine calls pass through
an adaptive security appliance enabled with the Cisco Intercompany Media Engine Proxy. The adaptive
security appliance is located in the DMZ and is configured to support only the Cisco Intercompany
Media Engine traffic (SIP signaling and RTP traffic). Normal Internet facing traffic does not flow
through this adaptive security appliance.
For all inbound calls, the signaling is directed to the adaptive security appliance because destined Cisco
UCMs are configured with the global IP address on the adaptive security appliance. For outbound calls,
the called party could be any IP address on the Internet; therefore, the adaptive security appliance is
configured with a mapping service that dynamically provides an internal IP address on the adaptive
security appliance for each global IP address of the called party on the Internet.
Cisco UCM sends all outbound calls directly to the mapped internal IP address on the adaptive security
appliance instead of the global IP address of the called party on the Internet. The adaptive security
appliance then forwards the calls to the global IP address of the called party.
Figure 52-5 illustrates the architecture of the Cisco Intercompany Media Engine in an off path
deployment.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-7

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Licensing for Cisco Intercompany Media Engine

Off Path Deployment of the Adaptive Security Appliance

Inside Enterprise

DMZ
UC-IME
Server

Cisco UCM Cluster

Outside Enterprise

Permiter Security

Figure 52-5

UC-IME
Bootstrap Server

M
M

M

Internet

M

M

Internet
Firewall

Intranet
Firewall
ASA enabled
with UC-IME proxy
IP

IP

Only UC-IME calls pass
through the ASA enabled
with the UC-IME proxy.

V

PSTN

PSTN
Gateway

248763

IP

Licensing for Cisco Intercompany Media Engine
The Cisco Intercompany Media Engine feature supported by the ASA require a Unified Communications
Proxy license.
The following table shows the details of the Unified Communications Proxy license:

Note

This feature is not available on No Payload Encryption models.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-8

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Guidelines and Limitations

Model

License Requirement

All other models

Intercompany Media Engine license.
When you enable the Intercompany Media Engine (IME) license, you can use TLS proxy sessions up
to the configured TLS proxy limit. If you also have a Unified Communications (UC) license installed
that is higher than the default TLS proxy limit, then the ASA sets the limit to be the UC license limit
plus an additional number of sessions depending on your model. You can manually configure the TLS
proxy limit using the tls-proxy maximum-sessions command. To view the limits of your model, enter
the tls-proxy maximum-sessions ? command. If you also install the UC license, then the TLS proxy
sessions available for UC are also available for IME sessions. For example, if the configured limit is
1000 TLS proxy sessions, and you purchase a 750-session UC license, then the first 250 IME sessions
do not affect the sessions available for UC. If you need more than 250 sessions for IME, then the
remaining 750 sessions of the platform limit are used on a first-come, first-served basis by UC and
IME.
•

For a license part number ending in “K8”, TLS proxy sessions are limited to 1000.

•

For a license part number ending in “K9”, the TLS proxy limit depends on your configuration and
the platform model.

Note

K8 and K9 refer to whether the license is restricted for export: K8 is unrestricted, and K9 is
restricted.

You might also use SRTP encryption sessions for your connections:
•

For a K8 license, SRTP sessions are limited to 250.

•

For a K9 license, there is no 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.

For more information about licensing, see Chapter 3, “Managing Feature Licenses.”

Guidelines and Limitations
Context Mode Guidelines

Supported in single context mode only.
Firewall Mode Guidelines

Supported in routed firewall mode only.
IPv6 Guidelines

Does not support IPv6 addresses.
Additional Guidelines and Limitations

Cisco Intercompany Media Engine has the following limitations:
•

Fax is not supported. Fax capability needs to be disabled on the SIP trunk.

•

Stateful failover of Cisco Unified Intercompany Media Engine is not supported. During failover,
existing calls traversing the Cisco Intercompany Media Engine Proxy disconnect; however, new
calls successfully traverse the proxy after the failover completes.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-9

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Guidelines and Limitations

•

Having Cisco UCMs on more than one of the ASA interfaces is not supported with the Cisco
Intercompany Media Engine Proxy. Having the Cisco UCMs on one trusted interface is especially
necessary in an off path deployment because the ASA requires that you specify the listening
interface for the mapping service and the Cisco UCMs must be connected on one trusted interface.

•

Multipart MIME is not supported.

•

Only existing SIP features and messages are supported.

•

H.264 is not supported.

•

RTCP is not supported. The ASA drops any RTCP traffic sent from the inside interface to the outside
interface. The ASA does not convert RTCP traffic from the inside interface into SRTP traffic.

•

The Cisco Intercompany Media Engine Proxy configured on the ASA creates a dynamic SIP trunk
for each connection to a remote enterprise. However, you cannot configure a unique subject name
for each SIP trunk. The Cisco Intercompany Media Engine Proxy can have only one subject name
configured for the proxy.
Additionally, the subject DN you configure for the Cisco Intercompany Media Engine Proxy match
the domain name that has been set for the local Cisco UCM.

•

If a service policy rule for the Cisco Intercompany Media Engine Proxy is removed (by using the no
service policy command) and reconfigured, the first call traversing the ASA will fail. The call fails
over to the PSTN because the Cisco UCM does not know the connections are cleared and tries to
use the recently cleared IME SIP trunk for the signaling.
To resolve this issue, you must additionally enter the clear connection all command and restart the
ASA. If the failure is due to failover, the connections from the primary ASA are not synchronized
to the standby ASA.

•

After the clear connection all command is issued on an ASA enabled with a UC-IME Proxy and
the IME call fails over to the PSTN, the next IME call between an originating and terminating SCCP
IP phone completes but does not have audio and is dropped after the signaling session is established.
An IME call between SCCP IP phones use the IME SIP trunk in both directions. Namely, the
signaling from the calling to called party uses the IME SIP trunk. Then, the called party uses the
reverse IME SIP trunk for the return signaling and media exchange. However, this connection is
already cleared on the ASA, which causes the IME call to fail.
The next IME call (the third call after the clear connection all command is issued), will be
completely successful.

Note

•

This limitation does not apply when the originating and terminating IP phones are
configured with SIP.

The ASA must be licensed and configured with enough TLS proxy sessions to handle the IME call
volume. See Licensing for Cisco Intercompany Media Engine for information about the licensing
requirements for TLS proxy sessions.
This limitation occurs because an IME call cannot fall back to the PSTN when there are not enough
TLS proxy sessions left to complete the IME call. An IME call between two SCCP IP phones
requires the ASA to use two TLS proxy sessions to successfully complete the TLS handshake.
Assume for example, the ASA is configured to have a maximum of 100 TLS proxy sessions and IME
calls between SCCP IP phones establish 101 TLS proxy sessions. In this example, the next IME call
is initiated successfully by the originating SCCP IP phone but fails after the call is accepted by the
terminating SCCP IP phone. The terminating IP phone rings and on answering the call, the call
hangs due to an incomplete TLS handshake. The call does not fall back to the PSTN.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-10

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy
This section contains the following topics:
•

Task Flow for Configuring Cisco Intercompany Media Engine, page 52-11

•

Configuring NAT for Cisco Intercompany Media Engine Proxy, page 52-12

•

Configuring PAT for the Cisco UCM Server, page 52-14

•

Creating Access Lists for Cisco Intercompany Media Engine Proxy, page 52-16

•

Creating the Media Termination Instance, page 52-17

•

Creating the Cisco Intercompany Media Engine Proxy, page 52-18

•

Creating Trustpoints and Generating Certificates, page 52-21

•

Creating the TLS Proxy, page 52-24

•

Enabling SIP Inspection for the Cisco Intercompany Media Engine Proxy, page 52-25

•

(Optional) Configuring TLS within the Local Enterprise, page 52-27

•

(Optional) Configuring Off Path Signaling, page 52-30

Task Flow for Configuring Cisco Intercompany Media Engine
Figure 52-6 provides an example for a basic deployment of the Cisco Intercompany Media Engine. The
following tasks include command line examples based on Figure 52-6.
Figure 52-6

Example for Basic (in-line) Deployment Tasks

Local Enterprise
Local
UC-IME
Server

Local
Cisco UCMs

192.168.10.12

Remote
UC-IME
Server

M
192.168.10.30
192.168.10.31
TCP

Corporate
Network
IP

IP

Note

UC-IME
Bootstrap
Server

IP

ASA outside interface

ASA inside
209.165.200.225
interface
Internet
192.168.10.1
TLS
Inside media
Outside media termination
termination
209.165.200.226
192.168.10.3 Local ASA
Outside Cisco UMC
209.165.200.228

Remote ASA

M
Remote
Cisco UCM

248764

M

Remote Enterprise

Step 1 through Step 8 apply to both basic (in-line) and off path deployments and Step 9 applies only to
off path deployment.
To configure a Cisco Intercompany Media Engine for a basic deployment, perform the following tasks.

Step 1

Configure static NAT for Cisco UCM. See Configuring NAT for Cisco Intercompany Media Engine
Proxy, page 52-12.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-11

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Or
Configure PAT for the UCM server. See Configuring PAT for the Cisco UCM Server, page 52-14.
Step 2

Create access lists for Cisco Intercompany Media Engine Proxy. See Creating Access Lists for Cisco
Intercompany Media Engine Proxy, page 52-16.

Step 3

Create the media termination address instance for Cisco Intercompany Media Engine Proxy. See
Creating the Media Termination Instance, page 52-17.

Step 4

Create the Cisco Intercompany Media Engine Proxy. See Creating the Cisco Intercompany Media
Engine Proxy, page 52-18.

Step 5

Create trustpoints and generate certificates for the Cisco Intercompany Media Engine Proxy. See
Creating Trustpoints and Generating Certificates, page 52-21.

Step 6

Create the TLS proxy. See Creating the TLS Proxy, page 52-24.

Step 7

Configure SIP inspection for the Cisco Intercompany Media Engine Proxy. See Enabling SIP Inspection
for the Cisco Intercompany Media Engine Proxy, page 52-25.

Step 8

(Optional) Configure TLS within the enterprise. See (Optional) Configuring TLS within the Local
Enterprise, page 52-27.

Step 9

(Optional) Configure off path signaling. See (Optional) Configuring Off Path Signaling, page 52-30.

Note

You only perform Step 9 when you are configuring the Cisco Intercompany Media Engine Proxy
in an off path deployment.

Configuring NAT for Cisco Intercompany Media Engine Proxy
To configure auto NAT, you first configure an object; then use the nat command in the object
configuration mode.
The example command lines in this task are based on a basic (in-line) deployment. See Figure 52-6 on
page 52-11 for an illustration explaining the example command lines in this task.
Alternatively, you can configure PAT for the Cisco Intercompany Media Engine Proxy. See Configuring
PAT for the Cisco UCM Server, page 52-14.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-12

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Figure 52-7

Example for Configuring NAT for a Deployment

Local Enterprise
Local Cisco UCMs
192.168.10.30
199.168.10.31

Configure NAT:
192.168.10.30
192.168.10.31

209.165.200.227
209.165.200.228

M

M
TLS

Corporate
Network

Local ASA

Outside Cisco UCM addresses
209.165.200.227
209.165.200.228

IP

IP

Internet

IP

248905

TCP

To configure auto NAT rules for the Cisco UCM server, perform the following steps:
Command

Purpose

Step 1

hostname(config)# object network name
Examples:
hostname(config)# object network
ucm_real_192.168.10.30
hostname(config)# object network
ucm_real_192.168.10.31

Configures a network object for the real address of
Cisco UCM that you want to translate.

Step 2

hostname(config-network-object)# host ip_address
Examples:
hostname(config-network-object)# host 192.168.10.30
hostname(config-network-object)# host 192.168.10.31

Specifies the real IP address of the Cisco UCM host
for the network object.

Step 3

(Optional)

Provides a description of the network object.

hostname(config-network-object)# description string
Example:
hostname(config-network-object)# description “Cisco
UCM Real Address”

Step 4

hostname(config-network-object)# exit

Exits from the objects configuration mode.

Step 5

hostname(config)# object network name
Example:
hostname(config)# object network
ucm_map_209.165.200.228

Configures a network object for the mapped address
of the Cisco UCM.

Step 6

hostname(config-network-object)# host ip_address
Example:
hostname(config-network-object)# host
209.165.200.228

Specifies the mapped IP address of the Cisco UCM
host for the network object.

Step 7

(Optional)

Provides a description of the network object.

hostname(config-network-object)# description string
Example:
hostname(config-network-object)# description “Cisco
UCM Mapped Address”

Cisco ASA 5500 Series Configuration Guide using the CLI

52-13

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Command

Purpose

Step 8

hostname(config-network-object)# exit

Exits from the objects configuration mode.

Step 9

hostname(config)# nat (inside,outside) source static
real_obj mapped_obj
Examples:
hostname(config)# nat (inside,outside) source static
ucm_real_192.168.10.30 ucm_209.165.200.228
hostname(config)# nat (inside,outside) source static
ucm_real_192.168.10.31 ucm_209.165.200.228

Specifies the address translation on the network
objects created in this procedure.
Where real_obj is the name that you created in
Step 1 in this task.
Where mapped_obj is the name that you created in
Step 5 in this task.

What to Do Next

Create the access lists for the Cisco Intercompany Media Engine Proxy. See Creating Access Lists for
Cisco Intercompany Media Engine Proxy, page 52-16.

Configuring PAT for the Cisco UCM Server
Perform this task as an alternative to configuring NAT for the Cisco Intercompany Media Engine Proxy.
Figure 52-8

Example for Configuring PAT for a Deployment

Local Enterprise
Configure PAT:
192.168.10.30:5070
192.168.10.30:5071

Local Cisco UCM
192.168.10.30

209.165.200.228:5570
209.165.200.228:5571

M
TCP
Corporate
Network

TLS

IP

IP

Outside Cisco UCM address
209.165.200.228

You only perform this step when NAT is not configured for the Cisco UCM server.
To configure PAT for the Cisco UCM server, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

52-14

248765

Local ASA
IP

Note

Internet

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Command

Purpose

Step 1

hostname(config)# object network name
Examples:
hostname(config)# object network
ucm-pat-209.165.200.228

Configures a network object for the outside IP
address of Cisco UCM that you want to translate.

Step 2

hostname(config-network-object)# host ip_address
Example:
hostname(config-network-object)# host
209.165.200.228

Specifies the real IP address of the Cisco UCM host
for the network object.

Step 3

hostname(config-network-object)# exit

Exits from the objects configuration mode.

Step 4

hostname(config)# object service name
Examples:
hostname(config)# object service tcp_5070
hostname(config)# object service tcp_5071

Creates a service object for the outside Cisco
Intercompany Media Engine port.

Step 5

hostname(config-service-object)# tcp source eq port
Examples:
hostname(config-service-object)# tcp source eq 5070
hostname(config-service-object)# tcp source eq 5071

Specifies the port number.

Step 6

hostname(config-service-object)# exit

Exits from the objects configuration mode.

Step 7

hostname(config)# object network name
Examples:
hostname(config)# object network
ucm-real-192.168.10.30
hostname(config)# object network
ucm-real-192.168.10.31

Configures a network object to represent the real IP
address of Cisco UCM.

Step 8

hostname(config-network-object)# host ip_address
Examples:
hostname(config-network-object)# host 192.168.10.30
hostname(config-network-object)# host 192.168.10.31

Specifies the real IP address of the Cisco UCM host
for the network object.

Step 9

hostname(config-network-object)# exit

Exits from the objects configuration mode.

Step 10

hostname(config)# object service name
Examples:
hostname(config)# object service tcp_5570
hostname(config)# object service tcp_5571

Creates a service objects for Cisco UCM SIP port.

Step 11

hostname(config-service-object)# tcp source eq port
Example:
hostname(config-service-object)# tcp source eq 5570
hostname(config-service-object)# tcp source eq 5571

Specifies the port number.

Step 12

hostname(config-service-object)# exit

Exits from the objects configuration mode.

Step 13

hostname(config)# nat (inside,outside) source static
real_obj mapped_obj service real_port mapped_port
Examples:
hostname(config)# nat (inside,outside) source static
ucm-real-192.168.10.30 ucm-pat-209.165.200.228
service tcp_5070 tcp_5570
hostname(config)# nat (inside,outside) source static
ucm-real-192.168.10.31 ucm-pat-128.106.254.5 service
tcp_5071 tcp_5571

Creates a static mapping for Cisco UCM.
Where real_obj is the name that you created in
Step 1 in this task.
Where mapped_obj is the name that you created in
Step 7 in this task.
Where real_port is the name that you created in
Step 4 in this task.
Where mapped_obj is the name that you created in
Step 10 in this task.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-15

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Creating Access Lists for Cisco Intercompany Media Engine Proxy
To configure access lists for the Cisco Intercompany Media Engine Proxy to reach the Cisco UCM
server, perform the following steps.
The example command lines in this task are based on a basic (in-line) deployment. See Figure 52-6 on
page 52-11 for an illustration explaining the example command lines in this task.

Step 1

Command

Purpose

hostname(config)# access-list id extended permit tcp
any host ip_address eq port
Example:
hostname(config)# access-list incoming extended
permit tcp any host 192.168.10.30 eq 5070

Adds an Access Control Entry (ACE). An access list
is made up of one or more ACEs with the same
access list ID. This ACE provides access control by
allowing incoming access for Cisco Intercompany
Media Engine connections on the specified port.
In the ip_address argument, provide the real IP
address of Cisco UCM.

Step 2

hostname(config)# access-group access-list in
interface interface_name
Example:
hostname(config)# access-group incoming in interface
outside

Binds the access list to an interface.

Step 3

hostname(config)# access-list id extended permit tcp
any host ip_address eq port
Example:
hostname(config)# access-list ime-inbound-sip
extended permit tcp any host 192.168.10.30 eq 5070

Adds an ACE. This ACE allows the ASA to allow
inbound SIP traffic for Cisco Intercompany Media
Engine. This entry is used to classify traffic for the
class and policy map.
Note

Step 4

hostname(config)# access-list id extended permit tcp
ip_address mask any range range
Example:
hostname(config)# access-list ime-outbound-sip
extended permit tcp 192.168.10.30 255.255.255.255
any range 5000 6000

The port that you configure here must match
the trunk settings configured on Cisco UCM.
See the Cisco Unified Communications
Manager documentation for information
about this configuration setting.

Adds an ACE. This ACE allows the ASA to allow
outbound SIP traffic for Cisco Intercompany Media
Engine (in the example, any TCP traffic with source
as 192.168.10.30 and destination port range between
5000 and 6000). This entry is used to classify traffic
for the class and policy map.
Note

Ensure that TCP traffic between Cisco UCM
and the Cisco Intercompany Media Engine
server does not use this port range (if that
connection goes through the ASA).

Step 5

hostname(config)# access-list id permit tcp any host
ip_address eq 6084
Example:
hostname(config)# access-list ime-traffic permit tcp
any host 192.168.10.12 eq 6084

Adds an ACE. This ACE allows the ASA to allow
traffic from the Cisco Intercompany Media Engine
server to remote Cisco Intercompany Media Engine
servers.

Step 6

hostname(config)# access-list id permit tcp any host
ip_address eq 8470
Example:
hostname(config)# access-list ime-bootserver-traffic
permit tcp any host 192.168.10.12 eq 8470

Adds an ACE. This ACE allows the ASA to allow
traffic from the Cisco Intercompany Media Engine
server to the Bootstrap server for the Cisco
Intercompany Media Engine.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-16

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

What to Do Next

Create the media termination instance on the ASA for the Cisco Intercompany Media Engine Proxy. See
Creating the Media Termination Instance, page 52-17.

Creating the Media Termination Instance
Guidelines

The media termination address you configure must meet these requirements:
•

Note

•

Note

If you decide to configure a media-termination address on interfaces (rather than using a global
interface), you must configure a media-termination address on at least two interfaces (the inside and
an outside interface) before applying the service policy for the Cisco Intercompany Media Engine
Proxy. Otherwise, you will receive an error message when enabling the proxy with SIP inspection.

Cisco recommends that you configure the media-termination address for the Cisco Intercompany
Media Engine Proxy on interfaces rather than configuring a global media-termination address.
The Cisco Intercompany Media Engine Proxy can use only one type of media termination instance
at a time; for example, you can configure a global media-termination address for all interfaces or
configure a media-termination address for different interfaces. However, you cannot use a global
media-termination address and media-termination addresses configured for each interface at the
same time.
If you change any Cisco Intercompany Media Engine Proxy settings after you create the
media-termination address for the proxy, you must reconfigure the media-termination address by
using the no media-termination command, and then reconfiguring it as described in this
procedure.

Procedure

Create the media termination instance to use with the Cisco Intercompany Media Engine Proxy.
The example command lines in this task are based on a basic (in-line) deployment. See Figure 52-6 on
page 52-11 for an illustration explaining the example command lines in this task.
To create the media termination instance for the Cisco Intercompany Media Engine Proxy, perform the
following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

52-17

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Command

Purpose

Step 1

hostname(config)# media-termination instance_name
Example:
hostname(config)# media-termination
uc-ime-media-term

Creates the media termination instance that you
attach to the Cisco Intercompany Media Engine
Proxy.

Step 2

hostname(config-media-termination)# address
ip_address interface intf_name
Examples:
hostname(config-media-termination)# address
209.165.200.228 interface outside

Configures the media-termination address used by
the outside interface of the ASA.
The outside IP address must be a publicly routable
address that is an unused IP address within the
address range on that interface.
See Creating the Cisco Intercompany Media Engine
Proxy, page 52-18 for information about the
UC-IME proxy settings. See CLI configuration
guide for information about the no service-policy
command.

Step 3

Step 4

hostname(config-media-termination)# address
ip_address interface intf_name
Examples:
hostname(config-media-termination)# address
192.168.10.3 interface inside

Configures a media termination address used by the
inside interface of the ASA.

(Optional)

Configures the rtp-min-port and rtp-max-port limits
for the Cisco Intercompany Media Engine Proxy.
Configure the RTP port range for the media
termination point when you need to scale the
number of calls that the Cisco Intercompany Media
Engine supports.

hostname(config-media-termination)# rtp-min-port
port1 rtp-maxport port2
Examples:
hostname(config-media-termination)# rtp-min-port
1000 rtp-maxport 2000

Note

The IP address must be an unused IP address
within the same subnet on that interface.

Where port1 specifies the minimum value for the
RTP port range for the media termination point,
where port1 can be a value from 1024 to 65535. By
default, the value for port1 is 16384.
Where port2 specifies the maximum value for the
RTP port range for the media termination point,
where port2 can be a value from 1024 to 65535. By
default, the value for port2 is 32767.
What To Do Next

Once you have created the media termination instance, create the Cisco Intercompany Media Engine
Proxy. See Creating the Cisco Intercompany Media Engine Proxy, page 52-18.

Creating the Cisco Intercompany Media Engine Proxy
To create the Cisco Intercompany Media Engine Proxy, perform the following steps.
The example command lines in this task are based on a basic (in-line) deployment. See Figure 52-6 on
page 52-11 for an illustration explaining the example command lines in this task.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-18

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Note

Step 1

You cannot change any of the configuration settings for the Cisco Intercompany Media Engine
Proxy described in this procedure when the proxy is enabled for SIP inspection. Remove the
Cisco Intercompany Media Engine Proxy from SIP inspection before changing any of the
settings described in this procedure.

Command

Purpose

hostname(config)# uc-ime uc_ime_name
Example:
hostname(config)# uc-ime local-ent-ime

Configures the Cisco Intercompany Media Engine
Proxy.
Where uc_ime_name is the name of the Cisco
Intercompany Media Engine Proxy. The name is
limited to 64 characters.
Only one Cisco Intercompany Media Engine Proxy
can be configured on the ASA.

Step 2

hostname(config-uc-ime)# media-termination
mta_instance_name
Example:
hostname(config-uc-ime)# media-termination
ime-media-term

Specifies the media termination instance used by the
Cisco Intercompany Media Engine Proxy.
Note

You must create the media termination
instance before you specify it in the Cisco
Intercompany Media Engine Proxy.

Where mta_instance_name is the instance_name
that you created in Step 1 of Creating the Media
Termination Instance.
See Creating the Media Termination Instance,
page 52-17 for the steps to create the media
termination instance.
Step 3

hostname(config-uc-ime)# ucm address ip_address
trunk-security-mode [nonsecure | secure]
Example:
hostname(config-uc-ime)# ucm address 192.168.10.30
trunk-security-mode non-secure

Specifies the Cisco UCM server in the enterprise.
You must specify the real IP address of the Cisco
UCM server. Do not specify a mapped IP address for
the server.
Note

You must include an entry for each Cisco
UCM in the cluster with Cisco Intercompany
Media Engine that has a SIP trunk enabled.

Where the nonsecure and secure options specify the
security mode of the Cisco UCM or cluster of Cisco
UCMs.
Note

Specifying secure for Cisco UCM or Cisco
UCM cluster indicates that Cisco UCM or
Cisco UCM cluster is initiating TLS;
therefore, you must configure TLS for
components. See (Optional) Configuring
TLS within the Local Enterprise,
page 52-27.

You can specify the secure option in this task or you
can update it later while configuring TLS for the
enterprise. See Step 11 in (Optional) Configuring
TLS within the Local Enterprise, page 52-27.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-19

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Step 4

Command

Purpose

hostname(config-uc-ime)# ticket epoch n password
password
Example:
hostname(config-uc-ime)# ticket epoch 1 password
password1234

Configures the ticket epoch and password for Cisco
Intercompany Media Engine.
Where n is an integer from 1-255. The epoch
contains an integer that updates each time that the
password is changed. When the proxy is configured
the first time and a password entered for the first
time, enter 1 for the epoch integer. Each time you
change the password, increment the epoch to
indicate the new password. You must increment the
epoch value each time your change the password.
Typically, you increment the epoch sequentially;
however, the ASA allows you to choose any value
when you update the epoch.
If you change the epoch value, the current password
is invalidated and you must enter a new password.
Where password contains a minimum of 10 and a
maximum of 64 printable character from the
US-ASCII character set. The allowed characters
include 0x21 to 0x73 inclusive, and exclude the
space character.
We recommend a password of at least 20 characters.
Only one password can be configured at a time.
The ticket password is stored onto flash. The output
of the show running-config uc-ime command
displays ***** instead of the password string.
Note

Cisco ASA 5500 Series Configuration Guide using the CLI

52-20

The epoch and password that you configure
on the ASA must match the epoch and
password configured on the Cisco
Intercompany Media Engine server. See the
Cisco Intercompany Media Engine server
documentation for information.

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Step 5

Command

Purpose

(Optional)

Specifies the fallback timers for Cisco Intercompany
Media Engine.

hostname(config-uc-ime)# fallback monitoring timer
timer_millisec | hold-down timer timer_sec
Examples:
hostname(config-uc-ime)# fallback monitoring timer
120
hostname(config-uc-ime)# fallback hold-down timer 30

Specifying monitoring timer sets the time between
which the ASA samples the RTP packets received
from the Internet. The ASA uses the data sample to
determine if fallback to the PSTN is needed for a
call.
Where timer_millisec specifies the length of the
monitoring timer. By default, the length is 100
milliseconds for the monitoring timer and the
allowed range is 10-600 ms.
Specifying hold-down timer sets the amount of
time that ASA waits before notifying Cisco UCM
whether to fall back to PSTN.
Where timer_sec specifies the length of the
hold-down timer. By default, the length is 20
seconds for the hold-down timer and the allowed
range is 10-360 seconds.
If you do not use this command to specify fallback
timers, the ASA uses the default settings for the
fallback timers.

Step 6

(Optional)

Specifies the file to use for mid-call PSTN fallback.

hostname(config-uc-ime)# fallback sensitivity-file
file_name
Example:
hostname(config-uc-ime)# fallback sensitivity-file
ime-fallback-sensitvity.fbs

Where file_name must be the name of a file on disk
that includes the .fbs file extension.
The fallback file is used to determine whether the
QoS of the call is poor enough for the Cisco
Intercompany Media Engine to move the call to the
PSTN.

What to Do Next

Install the certificate on the local entity truststore. You could also enroll the certificate with a local CA
trusted by the local entity.

Creating Trustpoints and Generating Certificates
You need to generate the keypair for the certificate used by the ASA, and configure a trustpoint to
identify the certificate sent by the ASA in the TLS handshake.
The example command lines in this task are based on a basic (in-line) deployment. See Figure 52-6 on
page 52-11 for an illustration explaining the example command lines in this task.

Note

This task instructs you on how to create trustpoints for the local enterprise and the remote enterprise and
how to exchange certificates between these two enterprises. This task does not provide steps for creating
trustpoints and exchanging certificates between the local Cisco UCM and the local ASA. However, if
you require additional security within the local enterprise, you must perform the optional task (Optional)

Cisco ASA 5500 Series Configuration Guide using the CLI

52-21

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Configuring TLS within the Local Enterprise, page 52-27. Performing that task allows for secure TLS
connections between the local Cisco UCM and the local ASA. The instructions in that task describe how
to create trustpoints between the local Cisco UCM and the local ASA.
Prerequisites for Installing Certificates

To create a proxy certificate on the ASA that is trusted by the remote entity, obtain a certificate from a
trusted CA or export it from the remote enterprise ASA.
To export the certificate from the remote enterprise, you enter the following command on the remote
ASA:
hostname(config)# crypto ca export trustpoint identity-certificate
The ASA prompts displays the certificate in the terminal screen. Copy the certificate from the terminal
screen. You will need the certificate text in Step 5 of this task.
Procedure

To create the trustpoints and generate certificates, perform the following steps:

Step 1

Command

Purpose

hostname(config)# crypto key generate rsa label
key-pair-label modulus size
Example:
hostname(config)# crypto key generate rsa label
local-ent-key modulus 2048

On the local ASA, creates the RSA keypair that
can be used for the trustpoints. This is the
keypair and trustpoint for the local entities
signed certificate.
The modulus key size that you select depends on
the level of security that you want to configure
and on any limitations imposed by the CA from
which you are obtaining the certificate. The
larger the number that you select, the higher the
security level will be for the certificate. Most
CAs recommend 2048 for the key modulus size;
however,
Note

Step 2

hostname(config)# crypto ca trustpoint trustpoint_name
Example:
hostname(config)# crypto ca trustpoint local_ent

GoDaddy requires a key modulus size of
2048.

Enters the trustpoint configuration mode for the
specified trustpoint so that you can create the
trustpoint for the local entity.
A trustpoint represents a CA identity and
possibly a device identity, based on a certificate
issued by the CA. Maximum name length is 128
characters.

Step 3

hostname(config-ca-trustpoint)# subject-name X.500_name
Example:
hostname(config-ca-trustpoint)# subject-name
cn=Ent-local-domain-name**

Cisco ASA 5500 Series Configuration Guide using the CLI

52-22

Includes the indicated subject DN in the
certificate during enrollment.
Note

The domain name that you enter here
must match the domain name that has
been set for the local Cisco UCM.
For information about how to configure
the domain name for Cisco UCM, see the
Cisco Unified Communications
Manager documentation for information.

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Command

Purpose

Step 4

hostname(config-ca-trustpoint)# keypair keyname
Example:
hostname(config-ca-trustpoint)# keypair local-ent-key

Specifies the key pair whose public key is to be
certified.

Step 5

hostname(config-ca-trustpoint)# enroll terminal

Specifies that you will use the “copy and paste”
method of enrollment with this trustpoint (also
known as manual enrollment).

Step 6

hostname(config-ca-trustpoint)# exit

Exits from the CA Trustpoint configuration
mode.

Step 7

hostname(config)# crypto ca enroll trustpoint
Example:
hostname(config)# crypto ca enroll remote-ent
%
% Start certificate enrollment ...
% The subject name in the certificate will be:
% cn=enterpriseA
% The fully-qualified domain name in the certificate will
@ be: ciscoasa
% Include the device serial number in the subject name?
[yes/no]: no
Display Certificate Request to terminal? [yes/no]: yes

Starts the enrollment process with the CA.
Where trustpoint is the same as the value you
entered for trustpoint_name in Step 2.
When the trustpoint is configured for manual
enrollment (enroll terminal command), the
ASA writes a base-64-encoded PKCS10
certification request to the console and then
displays the CLI prompt. Copy the text from the
prompt.
Submit the certificate request to the CA, for
example, by pasting the text displayed at the
prompt into the certificate signing request
enrollment page on the CA website.
When the CA returns the signed identity
certificate, proceed to Step 8 in this procedure.

Step 8

hostname(config)# crypto ca import trustpoint certificate
Example:
hostname(config)# crypto ca import remote-ent certificate

Imports the signed certificate received from the
CA in response to a manual enrollment request.
Where trustpoint specifies the trustpoint you
created in Step 2.
The ASA prompts you to paste the base-64
formatted signed certificate onto the terminal.

Step 9

hostname(config)# crypto ca authenticate trustpoint
Example:
hostname(config)# crypto ca authenticate remote-ent

Authenticates the third-party identity certificate
received from the CA. The identity certificate is
associated with a trustpoint created for the
remote enterprise.
The ASA prompts you to paste the base-64
formatted identity certificate from the CA onto
the terminal.

What to Do Next

Create the TLS proxy for the Cisco Intercompany Media Engine. See the “Creating the TLS Proxy”
section on page 52-24.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-23

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Creating the TLS Proxy
Because either enterprise, namely the local or remote Cisco UCM servers, can initiate the TLS
handshake (unlike IP Telephony or Cisco Mobility Advantage, where only the clients initiate the TLS
handshake), you must configure by-directional TLS proxy rules. Each enterprise can have an ASA as the
TLS proxy.
Create TLS proxy instances for the local and remote entity initiated connections respectively. The entity
that initiates the TLS connection is in the role of “TLS client.” Because the TLS proxy has a strict
definition of “client” and “server” proxy, two TLS proxy instances must be defined if either of the
entities could initiate the connection.
The example command lines in this task are based on a basic (in-line) deployment. See Figure 52-6 on
page 52-11 for an illustration explaining the example command lines in this task.
To create the TLS proxy, perform the following steps:
Command

Purpose

Step 1

hostname(config)# tls-proxy proxy_name
Example:
hostname(config)# tls-proxy local_to_remote-ent

Creates the TLS proxy for the outbound
connections.

Step 2

hostname(config-tlsp)# client trust-point
proxy_trustpoint
Example:
hostname(config-tlsp)# client trust-point local-ent

For outbound connections, specifies the trustpoint
and associated certificate that the adaptive security
appliance uses in the TLS handshake when the
adaptive security appliance assumes the role of the
TLS client. The certificate must be owned by the
adaptive security appliance (identity certificate).
Where proxy_trustpoint specifies the trustpoint
defined by the crypto ca trustpoint command in
Step 2 in “Creating Trustpoints and Generating
Certificates” section on page 52-21.

Step 3

hostname(config-tlsp)# client cipher-suite
cipher_suite
Example:
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1

For outbound connections, controls the TLS
handshake parameter for the cipher suite.
Where cipher_suite includes des-sha1, 3des-sha1,
aes128-sha1, aes256-sha1, or null-sha1.
For client proxy (the proxy acts as a TLS client to
the server), the user-defined cipher suite replaces the
default cipher suite, or the one defined by the ssl
encryption command. Use this command to achieve
difference ciphers between the two TLS sessions.
You should use AES ciphers with the Cisco UCM
server.

Step 4

hostname(config-tlsp)# exit

Exits from the TLS proxy configuration mode.

Step 5

hostname(config)# tls-proxy proxy_name
Example:
hostname(config)# tls-proxy remote_to_local-ent

Create the TLS proxy for inbound connections.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-24

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Step 6

Command

Purpose

hostname(config-tlsp)# server trust-point
proxy_trustpoint
Example:
hostname(config-tlsp)# server trust-point local-ent

For inbound connections, specifies the proxy
trustpoint certificate presented during TLS
handshake. The certificate must be owned by the
adaptive security appliance (identity certificate).
Where proxy_trustpoint specifies the trustpoint
defined by the crypto ca trustpoint command in
Step 2 in “Creating Trustpoints and Generating
Certificates” section on page 52-21.
Because the TLS proxy has strict definition of client
proxy and server proxy, two TLS proxy instances
must be defined if either of the entities could initiate
the connection.

Step 7

hostname(config-tlsp)# client cipher-suite
cipher_suite
Example:
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1

For inbound connections, controls the TLS
handshake parameter for the cipher suite.

Step 8

hostname(config-tlsp)# exit

Exits from the TSL proxy configuration mode.

Step 9

hostname(config)# ssl encryption 3des-shal
aes128-shal [algorithms]

Specifies the encryption algorithms that the
SSL/TLS protocol uses. Specifying the 3des-shal
and aes128-shal is required. Specifying other
algorithms is optional.

Where cipher_suite includes des-sha1, 3des-sha1,
aes128-sha1, aes256-sha1, or null-sha1.

Note

The Cisco Intercompany Media Engine
Proxy requires that you use strong
encryption. You must specify this command
when the proxy is licensed using a K9
license.

What to Do Next

Once you have created the TLS proxy, enable it for SIP inspection.

Enabling SIP Inspection for the Cisco Intercompany Media Engine Proxy
Enable the TLS proxy for SIP inspection and define policies for both entities that could initiate the
connection.
The example command lines in this task are based on a basic (in-line) deployment. See Figure 52-6 on
page 52-11 for an illustration explaining the example command lines in this task.

Note

If you want to change any Cisco Intercompany Media Engine Proxy settings after you enable SIP
inspection, you must enter the no service-policy command, and then reconfigure the service policy as
described in this procedure. Removing and reconfiguring the service policy does not affect existing calls;
however, the first call traversing the Cisco Intercompany Media Engine Proxy will fail. Enter the clear
connection command and restart the ASA.
To enable SIP inspection for the Cisco Intercompany Media Engine Proxy, perform the following steps:

Cisco ASA 5500 Series Configuration Guide using the CLI

52-25

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Command

Purpose

Step 1

hostname(config)# class-map class_map_name
Examples:
hostname(config)# class-map ime-inbound-sip

Defines a class for the inbound Cisco Intercompany
Media Engine SIP traffic.

Step 2

hostname(config-cmap)# match access-list
access_list_name
Examples:
hostname(config-cmap)# match access-list
ime-inbound-sip

Identifies the SIP traffic to inspect.
Where the access_list_name is the access list you
created in Step 3, page 52-16 of the task Creating
Access Lists for Cisco Intercompany Media Engine
Proxy.

Step 3

hostname(config-cmap)# exit

Exits from the class map configuration mode.

Step 4

hostname(config)# class-map class_map_name
Examples:
hostname(config)# class-map ime-outbound-sip

Defines a class for the outbound SIP traffic from
Cisco Intercompany Media Engine.

Step 5

hostname(config)# match access-list access_list_name
Examples:
hostname(config-cmap)# match access-list
ime-outbound-sip

Identifies which outbound SIP traffic to inspect.
Where the access_list_name is the access list you
created in Step 4, page 52-16 of the task Creating
Access Lists for Cisco Intercompany Media Engine
Proxy.

Step 6

hostname(config-cmap)# exit

Exits from the class map configuration mode.

Step 7

hostname(config)# policy-map name
Examples:
hostname(config)# policy-map ime-policy

Defines the policy map to which to attach the actions
for the class of traffic.

Step 8

hostname(config-pmap)# class classmap_name
Examples:
hostname(config-pmap)# class ime-outbound-sip

Assigns a class map to the policy map so that you
can assign actions to the class map traffic.
Where classmap_name is the name of the SIP class
map that you created in Step 1 in this task.

Step 9

hostname(config-pmap-c)# inspect sip [sip_map]
tls-proxy proxy_name uc-ime uc_ime_map
Examples:
hostname(config-pmap-c)# inspect sip tls-proxy
local_to_remote-ent uc-ime local-ent-ime

Enables the TLS proxy and Cisco Intercompany
Media Engine Proxy for the specified SIP inspection
session.

Step 10

hostname(config-cmap-c)# exit

Exits from the policy map class configuration mode.

Step 11

hostname(config-pmap)# class class_map_name
Examples:
hostname(config-pmap)# class ime-inbound-sip

Assigns a class map to the policy map so that you
can assign actions to the class map traffic.
Where classmap_name is the name of the SIP class
map that you created in Step 4 in this task.

Step 12

hostname(config-pmap-c)# inspect sip [sip_map]
tls-proxy proxy_name uc-ime uc_ime_map
Examples:
hostname(config-pmap-c)# inspect sip tls-proxy
remote-to-local-ent uc-ime local-ent-ime

Enables the TLS proxy and Cisco Intercompany
Media Engine Proxy for the specified SIP inspection
session.

Step 13

hostname(config-pmap-c)# exit

Exits from the policy map class configuration mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-26

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Command

Purpose

Step 14

hostname(config-pmap)# exit

Exits from the policy map configuration mode.

Step 15

hostname(config)# service-policy policymap_name
global
Examples:
hostname(config)# service-policy ime-policy global

Enables the service policy for SIP inspection for all
interfaces.
Where policymap_name is the name of the policy
map you created in Step 7 of this task.
See Creating the Cisco Intercompany Media Engine
Proxy, page 52-18 for information about the
UC-IME proxy settings. See CLI configuration
guide for information about the no service-policy
command.

What to Do Next

Once you have enabled the TLS proxy for SIP inspection, if necessary, configure TLS within the
enterprise. See (Optional) Configuring TLS within the Local Enterprise, page 52-27.

(Optional) Configuring TLS within the Local Enterprise
This task is not required if TCP is allowable within the inside network.
TLS within the enterprise refers to the security status of the Cisco Intercompany Media Engine trunk as
seen by the ASA.

Note

If the transport security for the Cisco Intercompany Media Engine trunk changes on Cisco UCM, it must
be changed on the ASA as well. A mismatch will result in call failure. The ASA does not support SRTP
with non-secure IME trunks. The ASA assumes SRTP is allowed with secure trunks. So ‘SRTP Allowed’
must be checked for IME trunks if TLS is used. The ASA supports SRTP fallback to RTP for secure IME
trunk calls.
Prerequisites

On the local Cisco UCM, download the Cisco UCM certificate. See the Cisco Unified Communications
Manager documentation for information. You will need this certificate when performing Step 6 of this
procedure.
Procedure

To configure TLS within the local enterprise, perform the following steps on the local ASA:

Cisco ASA 5500 Series Configuration Guide using the CLI

52-27

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Step 1

Commands

Purpose

hostname(config)# crypto key generate rsa label
key-pair-label
hostname(config)# crypto ca trustpoint
trustpoint_name
hostname(config-ca-trustpoint)# enroll self
hostname(config-ca-trustpoint)# keypair keyname
hostname(config-ca-trustpoint)# subject-name
x.500_name
Example:
hostname(config)# crypto key generate rsa label
local-ent-key
hostname(config)# crypto ca trustpoint local-asa
hostname(config-ca-trustpoint)# enroll self
hostname(config-ca-trustpoint)# keypair
key-local-asa
hostname(config-ca-trustpoint)# subject-name
cn=Ent-local-domain-name**., o="Example Corp"

Creates an RSA key and trustpoint for the
self-signed certificate.
Where key-pair-label is the RSA key for the local
ASA.
Where trustpoint_name is the trustpoint for the
local ASA.
Where keyname is key pair for the local ASA.
Where x.500_name includes the X.500 distinguished
name of the local ASA; for example,
cn=Ent-local-domain-name**.
Note

The domain name that you enter here must
match the domain name that has been set for
the local Cisco UCM. For information about
how to configure the domain name for Cisco
UCM, see the Cisco Unified
Communications Manager documentation
for information.

Step 2

hostname(config-ca-trustpoint)# exit

Exits from Trustpoint Configuration mode.

Step 3

hostname(config)# crypto ca export trustpoint
identity-certificate
Example:
hostname(config)# crypto ca export local-asa
identity-certificate

Exports the certificate you created in Step 1. The
certificate contents appear on the terminal screen.
Copy the certificate from the terminal screen. This
certificate enables Cisco UCM to validate the
certificate that the ASA sends in the TLS handshake.
On the local Cisco UCM, upload the certificate into
the Cisco UCM trust store. See the Cisco Unified
Communications Manager documentation for
information.
Note

Step 4

Step 5

Creates a trustpoint for local Cisco UCM.

hostname(config)# crypto ca trustpoint
trustpoint_name
hostname(config-ca-trustpoint)# enroll terminal
Example:
hostname(config)# crypto ca trustpoint local-ent-ucm
hostname(config-ca-trustpoint)# enroll terminal

Where trustpoint_name is the trustpoint for the
local Cisco UCM.

hostname(config-ca-trustpoint)# exit

Exits from Trustpoint Configuration mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-28

The subject name you enter while uploading
the certificate to the local Cisco UCM is
compared with the X.509 Subject Name
field entered on the SIP Trunk Security
Profile on Cisco UCM. For example,
“Ent-local-domain-name” was entered in
Step 1 of this task; therefore,
“Ent-local-domain-name” should be entered
in the Cisco UCM configuration.

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Step 6

Commands

Purpose

hostname(config)# crypto ca authenticate trustpoint
Example:
hostname(config)# crypto ca authenticate
local-ent-ucm

Imports the certificate from local Cisco UCM.
Where trustpoint is the trustpoint for the local Cisco
UCM.
Paste the certificate downloaded from the local
Cisco UCM. This certificate enables the ASA to
validate the certificate that Cisco UCM sends in the
TLS handshake.

Step 7

hostname(config)# tls-proxy proxy_name
hostname(config-tlsp)# server trust-point
proxy_trustpoint
hostname(config-tlsp)# client trust-point
proxy_trustpoint
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1
Example:
hostname(config)# tls-proxy local_to_remote-ent
hostname(config-tlsp)# server trust-point
local-ent-ucm
hostname(config-tlsp)# client trust-point local-ent
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1

Updates the TLS proxy for outbound connections.
Where proxy_name is the name you entered in
Step 1 of the task Creating the TLS Proxy.
Where proxy_trustpoint for the server trust-point
command is the name you entered in Step 4 of this
procedure.
Where proxy_trustpoint for the client trust-point
command is the name you entered in Step 2 of the
task Creating Trustpoints and Generating
Certificates.
Note

In this step, you are creating different
trustpoints for the client and the server.

Step 8

hostname(config-tlsp)# exit

Exits from TLS Proxy Configuration mode.

Step 9

hostname(config)# tls-proxy proxy_name
hostname(config-tlsp)# server trust-point
proxy_trustpoint
hostname(config-tlsp)# client trust-point
proxy_trustpoint
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1
Example:
hostname(config)# tls-proxy remote_to_local-ent
hostname(config-tlsp)# server trust-point local-ent
hostname(config-tlsp)# client trust-point
local-ent-ucm
hostname(config-tlsp)# client cipher-suite
aes128-sha1 aes256-sha1 3des-sha1 null-sha1

Updates the TLS proxy for inbound connections.

Step 10

hostname(config-tlsp)# exit

Exits from TLS Proxy Configuration mode.

Step 11

hostname(config)# uc-ime uc_ime_name
hostname(config-uc-ime)# ucm address ip_address
trunk-security-mode secure
Example:
hostname(config)# uc-ime local-ent-ime
hostname(config-uc-ime)# ucm address 192.168.10.30
trunk-security-mode secure

Updates the Cisco Intercompany Media Engine
Proxy for trunk-security-mode.

Where proxy_name is the name you entered in
Step 5 of the task Creating the TLS Proxy.
Where proxy_trustpoint for the server trust-point
command is the name you entered in Step 2 of the
task Creating Trustpoints and Generating
Certificates.
Where proxy_trustpoint for the client trust-point
command is the name you entered in Step 4 of this
procedure.

Where uc_ime_name is the name you entered in
Step 1 of the task Creating the Cisco Intercompany
Media Engine Proxy.
Only perform this step if you entered nonsecure in
Step 3 of the task Creating the Cisco Intercompany
Media Engine Proxy.

What to Do Next

Once you have configured the TLS within the enterprise, if necessary, configure off path signaling for
an off path deployment. See (Optional) Configuring Off Path Signaling, page 52-30.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-29

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

(Optional) Configuring Off Path Signaling
Perform this task only when you are configuring the Cisco Intercompany Media Engine Proxy as part of
an off path deployment. You might choose to have an off path deployment when you want to use the
Cisco Intercompany Media Engine but do not want to replace your existing Internet firewall with an ASA
enabled with the Cisco Intercompany Media Engine Proxy.
In an off path deployment, the existing firewall that you have deployed in your environment is not
capable of transmitting Cisco Intercompany Media Engine traffic.
Off path signaling requires that outside IP addresses translate to an inside IP address. The inside
interface address can be used for this mapping service configuration. For the Cisco Intercompany Media
Engine Proxy, the ASA creates dynamic mappings for external addresses to the internal IP address;
therefore, using the dynamic NAT configuration on outbound calls, Cisco UCM sends SIP traffic to this
internal IP address, and the ASA uses that mapping to determine the real destination on inbound calls.
The static NAT or PAT mapping is used for inbound calls in an off path configuration.
Figure 52-9

Example for Configuring Off Path Signaling in an Off Path Deployment

OUTSIDE 0.0.0.0 0.0.0.0

Local Enterprise

192.168.10.1

Local Cisco UCM

ip_address:port

ASA inside interface
192.168.10.1

M
192.168.10.30

TLS

TCP

Local ASA
IP

IP

Outside Cisco UCM address
209.165.200.228

Remote ASA
10.10.0.24
248766

Corporate
Network

Internet

IP

After you configure off path signaling, the ASA mapping service listens on interface “inside” for
requests. When it receives a request, it creates a dynamic mapping for the “outside” as the destination
interface.
To configure off path signaling for the Cisco Intercompany Media Engine Proxy, perform the following
steps:
Command

Purpose

Step 1

hostname(config)# object network name
Example:
hostname(config)# object network outside-any

For the off path ASA, creates a network object to
represent all outside addresses.

Step 2

hostname(config-network-object)# subnet ip_address
Example:
hostname(config-network-object)# subnet 0.0.0.0
0.0.0.0

Specifies the IP address of the subnet.

Step 3

hostname(config-network-object)# nat
(outside,inside) dynamic interface inside

Creates a mapping for the Cisco UCM of remote
enterprises.

Step 4

hostname(config-network-object)# exit

Exits from the objects configuration mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-30

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Step 5

Command

Purpose

hostname(config)# uc-ime uc_ime_name
Example:
hostname(config)# uc-ime local-ent-ime

Specifies the Cisco Intercompany Media Engine
Proxy that you created in the task Creating the Cisco
Intercompany Media Engine Proxy, page 52-18.
Where uc_ime_name is the name you specified in
Step 1 of Creating the Cisco Intercompany Media
Engine Proxy, page 52-18.

Step 6

hostname(config)# mapping-service
listening-interface interface_name [listening-port
port] uc-ime-interface uc-ime-interface_name
Example:
hostname(config-uc-ime)# mapping-service
listening-interface inside listening-port 8060
uc-ime-interface outside

For the off path ASA, adds the mapping service to
the Cisco Intercompany Media Engine Proxy.
Specifies the interface and listening port for the
ASA mapping service.
You can only configure one mapping server for the
Cisco Intercompany Media Engine Proxy.
Where interface_name is the name of the interface
on which the ASA listens for the mapping requests.
Where port is the TCP port on which the ASA listens
for the mapping requests. The port number must be
between 1024 and 65535 to avoid conflicts with
other services on the device, such as Telnet or SSH.
By default, the port number is TCP 8060.
Where uc-ime-interface_name is the name of the
interface that connects to the remote Cisco UCM.

This section contains the following sections:
•

Configuring the Cisco UC-IMC Proxy by using the UC-IME Proxy Pane, page 52-31

•

Configuring the Cisco UC-IMC Proxy by using the Unified Communications Wizard, page 52-33

Configuring the Cisco UC-IMC Proxy by using the UC-IME Proxy Pane
Use the Configure Cisco Intercompany Media Engine (UC-IME) proxy pane to add or edit a Cisco
Intercompany Media Engine Proxy instance.

Note

The Cisco Intercompany Media Engine Proxy does not appear as an option under the Unified
Communications section of the navigation pane unless the license required for this proxy is installed on
the ASA.
Use this pane to create the proxy instance; however, for the UC-IME proxy to be fully functionally, you
must complete additional tasks, such as create the required NAT statements, access lists, and MTA, set
up the certificates, create the TLS Proxy, and enable SIP inspection.
Depending on whether the UC-IME proxy is deployed off path or in-line of Internet traffic, you must
create the appropriate network objects with embedded NAT/PAT statements for the Cisco UCMs.
This pane is available from the Configuration > Firewall > Unified Communications > UC-IME Proxy.

Step 1

Open the Configuration > Firewall > Unified Communications > UC-IME Proxy pane.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-31

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Configuring Cisco Intercompany Media Engine Proxy

Step 2

Check the Enable Cisco UC-IME proxy check box to enable the feature.

Step 3

In the Unified CM Servers area, enter an IP address or hostname for the Cisco Unified Communications
Manager (Cisco UCM) or click the ellipsis to open a dialog and browse for an IP address or hostname.

Step 4

In the Trunk Security Mode field, click a security option. Specifying secure for Cisco UCM or Cisco
UCM cluster indicates that Cisco UCM or Cisco UCM cluster is initiating TLS.

Step 5

Click Add to add the Cisco UCM for the Cisco Intercompany Media Engine Proxy. You must include an
entry for each Cisco UCM in the cluster with Cisco Intercompany Media Engine that has a SIP trunk
enabled.

Step 6

In the Ticket Epoch field, enter an integer from 1-255.
The epoch contains an integer that updates each time that the password is changed. When the proxy is
configured the first time and a password entered for the first time, enter 1 for the epoch integer. Each
time you change the password, increment the epoch to indicate the new password. You must increment
the epoch value each time your change the password.
Typically, you increment the epoch sequentially; however, the ASA allows you to choose any value when
you update the epoch.
If you change the epoch value, the current password is invalidated and you must enter a new password.

Note

The epoch and password that you configure in this step on the ASA must match the epoch and password
that you configure on the Cisco Intercompany Media Engine server. See the Cisco Intercompany Media
Engine server documentation for information.

Step 7

In the Ticket Password field, enter a minimum of 10 printable character from the US-ASCII character
set. The allowed characters include 0x21 to 0x73 inclusive, and exclude the space character. The ticket
password can be up to 64 characters. Confirm the password you entered. Only one password can be
configured at a time.

Step 8

Check the Apply MTA to UC-IME Link proxy check box to associate the media termination address with
the Cisco Intercompany Media Engine Proxy.

Note

Step 9

You must create the media termination instance before you associate it with the Cisco
Intercompany Media Engine Proxy. If necessary, click the Configure MTA button to configure a
media termination address instance.

If the Cisco Intercompany Media Engine Proxy is being configured as part of off path deployment, check
the Enable off path address mapping service checkbox and configure the off path deployment settings:
a.

From the Listening Interface field, select an ASA interface. This is the interface on which the ASA
listens for the mapping requests.

b.

In the Port field, enter a number between 1024 and 65535 as the TCP port on which the ASA listens
for the mapping requests. The port number must be 1024 or higher to avoid conflicts with other
services on the device, such as Telnet or SSH. By default, the port number is TCP 8060.

c.

From the UC-IME Interface field, select an interface from the list. This is the interface that the ASA
uses to connect to the remote Cisco UCM.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-32

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Configuring Cisco Intercompany Media Engine Proxy

Note

Step 10

In the Fallback area, configure the fallback timer for the Cisco Intercompany Media Engine by
specifying the following settings:
a.

In the Fallback Sensitivity File field, enter the path to a file in flash memory that the ASA uses for
mid-call PSTN fallback. The file name that you enter must be the name of a file on disk that includes
the .fbs file extension. Alternatively, click the Browse Flash button to locate and select the file from
flash memory.

b.

In the Call Quality Evaluation Interval field, enter a number between 10-600 (in milliseconds). This
number controls the frequency at which the ASA samples the RTP packets received from the
Internet. The ASA uses the data sample to determine if fallback to the PSTN is needed for a call. By
default, the length is 100 milliseconds for the timer.

c.

In the Notification Interval field, enter a number between 10-360 (in seconds). This number controls
the amount of time that the ASA waits before notifying Cisco UCM whether to fall back to PSTN.
By default, the length is 20 seconds for this timer.

Note

Step 11

In an off path deployment any existing ASA that you have deployed in your environment are not
capable of transmitting Cisco Intercompany Media Engine traffic. Off-path signaling requires
that outside addresses are translated (using NAT) to an inside IP address. The inside interface
address can be used for this mapping service configuration. For the Cisco Intercompany Media
Engine Proxy, the ASA creates dynamic mappings for external addresses to the internal IP
address.

When you change the fallback timer for the Cisco Intercompany Media Engine Proxy, ASDM
automatically removes the proxy from SIP inspection and then reapplies SIP inspection when
the proxy is re-enabled.

Click Apply to save the configuration changes for the Cisco Intercompany Media Engine Proxy.

Configuring the Cisco UC-IMC Proxy by using the Unified Communications
Wizard
To configure the Cisco Intercompany Media Engine Proxy by using ASDM, choose Wizards > Unified
Communications Wizard from the menu. The Unified Communications Wizard opens. From the first
page, select the Cisco Intercompany Media Engine Proxy option under the Business-to-Business section.
The wizard automatically creates the necessary TLS proxy, then guides you through creating the
Intercompany Media Engine proxy, importing and installing the required certificates, and finally enables
the SIP inspection for the Intercompany Media Engine traffic automatically.
The wizard guides you through these steps to create the Cisco Intercompany Media Engine Proxy:
Step 1

Select the Intercompany Media Engine Proxy option.

Step 2

Select the topology of the Cisco Intercompany Media Engine Proxy, namely whether the ASA is an edge
firewall with all Internet traffic flowing through it or whether the ASA is off the path of the main Internet
traffic (referred to as an off path deployment).

Step 3

Specify private network settings such as the Cisco UCM IP addresses and the ticket settings.

Cisco ASA 5500 Series Configuration Guide using the CLI

52-33

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Troubleshooting Cisco Intercompany Media Engine Proxy

Step 4

Specify the public network settings.

Step 5

Specify the media termination address settings of Cisco UCM.

Step 6

Configure the local-side certificate management, namely the certificates that are exchanged between the
local Cisco Unified Communications Manager servers and the ASA. The identity certificate that the
wizard generates in this step needs to be installed on each Cisco Unified Communications Manager
(UCM) server in the cluster with the proxy and each identity certificate from the Cisco UCMs need to
be installed on the ASA. The certificates are used by the ASA and the Cisco UCMs to authenticate each
other, respectively, during TLS handshakes. The wizard only supports self-signed certificates for this
step.

Step 7

Configure the remote-side certificate management, namely the certificates that are exchanged between
the remote server and the ASA. In this step, the wizard generates a certificate signing request (CSR).
After successfully generating the identity certificate request for the proxy, the wizard prompts you to
save the file.
You must send the CSR text file to a certificate authority (CA), for example, by pasting the text file into
the CSR enrollment page on the CA website. When the CA returns the Identity Certificate, you must
install it on the ASA. This certificate is presented to remote servers so that they can authenticate the ASA
as a trusted server.
Finally, this step of the wizard assists you in installing the root certificates of the CA from the remote
servers so that the ASA can determine that the remote servers are trusted.

The wizard completes by displaying a summary of the configuration created for Cisco Intercompany
Media Engine. See the Unified Communications Wizard section in this documentation for more
information.

Troubleshooting Cisco Intercompany Media Engine Proxy
This section describes how to certain options of the show uc-ime command to obtain troubleshooting
information for the Cisco Intercompany Media Engine Proxy. See the command reference for detailed
information about the syntax for these commands.
show uc-ime signaling-sessions

Displays the corresponding SIP signaling sessions stored by the Cisco Intercompany Media Engine
Proxy. Use this command to troubleshoot media or signaling failure. The command also displays the
fallback parameters extracted from the SIP message headers, whether RTP monitoring is enabled or
disabled, and whether SRTP keys are set.
Through the use of the Cisco Intercompany Media Engine Proxy, not only signaling but also media is
secured for communication. It provides signaling encryption and SRTP/RTP conversion with SRTP
enforced on the Internet side. The Cisco Intercompany Media Engine Proxy inserts itself into the media
path by modifying the SIP signaling messages from Cisco UCMs.The Cisco Intercompany Media Engine
Proxy sits on the edge of the enterprise and inspects SIP signaling between SIP trunks created between
enterprises. It terminates TLS signaling from the Internet and initiates TCP or TLS to the local Cisco
UCM.
hostname# show uc-ime signaling-sessions
1 in use, 3 most used
inside 192.168.10.30:39608 outside 10.194.108.118:5070
Local Media (audio) conn: 10.194.108.119/29824 to 10.194.108.109/21558

Cisco ASA 5500 Series Configuration Guide using the CLI

52-34

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Troubleshooting Cisco Intercompany Media Engine Proxy

Local SRTP key set : Remote SRTP key set
Remote Media (audio) conn: 192.168.10.51/19520 to 192.168.10.3/30930
Call-ID: ab6d7980-a7d11b08-50-1e0aa8c0@192.168.10.30
FB Sensitivity: 3
Session ID: 2948-32325449-0@81a985c9-f3a1-55a0-3b19-96549a027259
SIP Trunk URI: 81a985c9-f3a1-55a0-3b19-9654@UCM-30;maddr=192.168.10.30
Codec-name: G722
Payload type: 9

Note

If calls are not going through the Cisco Intercompany Media Engine, you can also use the show
tls-proxy session command to troubleshoot the success of the TLS handshake between the
components in the Cisco Intercompany Media Engine system. See the command reference for
information about this command.

show uc-ime signaling-sessions statistics

Displays statistical information about corresponding signaling sessions stored by Cisco Intercompany
Media Engine Proxy. Failure of signaling sessions in the Cisco Intercompany Media Engine can occur
for different call-related reasons; such as failure of ticket verification or domain name verification, or
offering RTP over the Internet.
hostname# show uc-ime signaling-sessions statistics
10 in use, 20 most used
15 terminated
Ticket integrity check failed: 2
Ticket decode failed: 1
Ticket epoch mismatch: 1
Ticket DID mismatch: 0
Ticket timestamp invalid: 4
Ticket domain check failed: 2
Ticket not found: 0
Route domain name check failed: 1
RTP over UC-IME: 2

Note

Call-related failures, for example, can be due to the service policy rule being reconfigured or the primary
ASA operating in failover mode. If a service policy rule for the Cisco Intercompany Media Engine Proxy
is removed (by using the no service policy command) and reconfigured, the first call trasversing the
ASA will fail. To resolve this issue, you must additionally enter the clear connection command and
restart the ASA. If the failure is due to failover, the connections from the primary ASA are not
synchronized to the standby ASA.
show uc-ime media-sessions detail

Displays the details about all active media sessions (calls) stored for the Cisco Intercompany Media
Engine Proxy. Use this command to display output from successful calls. Additionally, use this
command to troubleshoot problems with IP phone audio, such as one-way audio. If no calls are currently
up, this output will be blank.
hostname(config)# show uc-ime media-sessions detail
2 in use, 5 most used
Media-session: 10.194.108.109/21558 :: client ip 192.168.10.51/19520
Call ID: ab6d7980-a7d11b08-50-1e0aa8c0@192.168.10.30
Session ID: 2948-32325449-0@81a985c9-f3a1-55a0-3b19-96549a027259
Lcl SRTP conn 10.194.108.109/21558 to 10.194.108.119/29824 tx_pkts 20203 rx_pkts 20200
refcnt 3 : created by Inspect SIP, passthrough not set
RTP monitoring is enabled
Failover_state
: 0

Cisco ASA 5500 Series Configuration Guide using the CLI

52-35

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy

Troubleshooting Cisco Intercompany Media Engine Proxy

Sum_all_packets
: 20196
Codec_payload_format
: 9
RTP_ptime_ms
: 20
Max_RBLR_pct_x100
: 0
Max_ITE_count_in_8_sec
: 0
Max_BLS_ms
: 0
Max_PDV_usec
: 1000
Min_PDV_usec
: 0
Mov_avg_PDV_usec
: 109
Total_ITE_count
: 0
Total_sec_count
: 403
Concealed_sec_count
: 0
Severely_concealed_sec_count : 0
Max_call_interval_ms
: 118
Total_SequenceNumber_Resets
: 0
Media-session: 192.168.10.3/30930 :: client ip 10.194.108.119/29824
Call ID: N/A
Lcl RTP conn 192.168.10.3/30930 to 192.168.10.51/19520 tx_pkts 20201 rx_pkts 20203

show uc-ime fallback-notification statistics

Displays statistics about the PSTN fallback notifications to the Cisco UMC. Even if a call is sent over
VoIP because the quality of the connection was good, the connection quality might worsen mid-call. To
ensure an overall good experience for the end user, Cisco Intercompany Media Engine attempts to
perform a mid-call fallback. Performing a mid-call fallback requires the adaptive security appliance to
monitor the RTP packets coming from the Internet. If fallback is required, the adaptive security
appliance sends a REFER message to Cisco UCM to tell it that it needs to fallback the call to PSTN.
Cisco Intercompany Media Engine uses a configurable hold-down timer to set the amount of time that
adaptive security appliance waits before notifying Cisco UCM whether to fall back to PSTN.
hostname# show uc-ime fallback-notification statistics
UCM address: 172.23.32.37
Total Notifications Sent: 10

show uc-ime mapping-service-sessions

When the Cisco Intercompany Media Engine Proxy is configured for an off path deployment, displays
mapping-service requests and replies between the proxy and the local Cisco UMC. A TCP port on the
ASA is configured to listen for mapping requests.
The port number must be 1024 or higher to avoid conflicts with other services on the device, such as
Telnet or SSH. By default, the port number is TCP 8060.
Hostname# show uc-b2blink mapping-service-sessions
Total active sessions: 2
Session client (IP:Port)
Idle time
192.168.1.10:2001
0:01:01
192.168.1.20:3001
0:10:20

show uc-ime mapping-service-sessions statistics

Displays statistical information about the Cisco Intercompany Media Engine Proxy mapping service
used in off path signaling.
Hostname# show uc-ime mapping-service-sessions statistics
Total active sessions: 2
Session client
Total
Responses
Failed
Pending
(IP:Port)
requests
sent
requests
responses
192.168.1.10:2001
10
9
1
0
192.168.1.20:3001
19
19
0
0

Cisco ASA 5500 Series Configuration Guide using the CLI

52-36

Idle
time
0:01:01
0:10:20

Chapter 52

Configuring Cisco Intercompany Media Engine Proxy
Feature History for Cisco Intercompany Media Engine Proxy

Feature History for Cisco Intercompany Media Engine Proxy
Table 52-1 lists the release history for this feature.
Table 52-1

Feature History for Cisco Phone Proxy

Feature Name

Releases

Feature Information

Cisco Intercompany Media Engine Proxy

8.3(1)

The Cisco Intercompany Media Engine Proxy was
introduced.
The following commands were added to the CLI to support
configuration of this new feature.
[no] uc-ime uc_ime_name
[no] fallback hold-down | monitoring timer value
[no] fallback sensitivity-file filename
[no] mapping-service listening-interface ifc_name
[listening-port port] uc-ime-interface b2b-ifc
[no] ticket epoch epoch password pwd
[no] ucm address ip_addr trunk-security-mode
nonsecure | secure
clear configure uc-ime [uc_ime_name]
[no] debug uc-ime [mapping-service | media |
notification | rma | signaling] [errors | events]
show uc-ime
show running-config [all] uc-ime [uc_ime_map]
The following command was updated by adding options for
the UC-IME proxy.
inspect sip uc-ime uc-ime-name tls-proxy tls-proxy-name

Cisco ASA 5500 Series Configuration Guide using the CLI

52-37

Chapter 52
Feature History for Cisco Intercompany Media Engine Proxy

Cisco ASA 5500 Series Configuration Guide using the CLI

52-38

Configuring Cisco Intercompany Media Engine Proxy

PA R T

12

Configuring Connection Settings and QoS

CH A P T E R

53

Configuring Connection Settings
This chapter describes how to configure connection settings for connections that go through the ASA,
or for management connections, that go to the ASA. Connection settings include:
•

Maximum connections (TCP and UDP connections, embryonic connections, per-client connections)

•

Connection timeouts

•

Dead connection detection

•

TCP sequence randomization

•

TCP normalization customization

•

TCP state bypass

•

Global timeouts

This chapter includes the following sections:
•

Information About Connection Settings, page 53-1

•

Licensing Requirements for Connection Settings, page 53-4

•

Guidelines and Limitations, page 53-5

•

Default Settings, page 53-5

•

Configuring Connection Settings, page 53-6

•

Monitoring Connection Settings, page 53-14

•

Configuration Examples for Connection Settings, page 53-14

•

Feature History for Connection Settings, page 53-16

Information About Connection Settings
This section describes why you might want to limit connections and includes the following topics:
•

TCP Intercept and Limiting Embryonic Connections, page 53-2

•

Disabling TCP Intercept for Management Packets for Clientless SSL Compatibility, page 53-2

•

Dead Connection Detection (DCD), page 53-2

•

TCP Sequence Randomization, page 53-3

•

TCP Normalization, page 53-3

•

TCP State Bypass, page 53-3

Cisco ASA 5500 Series Configuration Guide using the CLI

53-1

Chapter 53

Configuring Connection Settings

Information About Connection Settings

TCP Intercept and Limiting Embryonic Connections
Limiting the number of embryonic connections protects you from a DoS attack. The ASA uses the
per-client limits and the embryonic connection limit to trigger TCP Intercept, which protects inside
systems from a DoS attack perpetrated by flooding an interface with TCP SYN packets. An embryonic
connection is a connection request that has not finished the necessary handshake between source and
destination. TCP Intercept uses the SYN cookies algorithm to prevent TCP SYN-flooding attacks. A
SYN-flooding attack consists of a series of SYN packets usually originating from spoofed IP addresses.
The constant flood of SYN packets keeps the server SYN queue full, which prevents it from servicing
connection requests. When the embryonic connection threshold of a connection is crossed, the ASA acts
as a proxy for the server and generates a SYN-ACK response to the client SYN request. When the ASA
receives an ACK back from the client, it can then authenticate the client and allow the connection to the
server.

Note

When you use TCP SYN cookie protection to protect servers from SYN attacks, you must set the
embryonic connection limit lower than the TCP SYN backlog queue on the server that you want to
protect. Otherwise, valid clients can nolonger access the server during a SYN attack.
To view TCP Intercept statistics, including the top 10 servers under attack, see Chapter 56, “Configuring
Threat Detection.”

Disabling TCP Intercept for Management Packets for Clientless SSL
Compatibility
By default, TCP management connections have TCP Intercept always enabled. When TCP Intercept is
enabled, it intercepts the 3-way TCP connection establishment handshake packets and thus deprives the
ASA from processing the packets for clientless SSL. Clientless SSL requires the ability to process the
3-way handshake packets to provide selective ACK and other TCP options for clientless SSL
connections. To disable TCP Intercept for management traffic, you can set the embryonic connection
limit; only after the embryonic connection limit is reached is TCP Intercept enabled.

Dead Connection Detection (DCD)
DCD detects a dead connection and allows it to expire, without expiring connections that can still handle
traffic. You configure DCD when you want idle, but valid connections to persist.
When you enable DCD, idle timeout behavior changes. With idle timeout, DCD probes are sent to each
of the two end-hosts to determine the validity of the connection. If an end-host fails to respond after
probes are sent at the configured intervals, the connection is freed, and reset values, if configured, are
sent to each of the end-hosts. If both end-hosts respond that the connection is valid, the activity timeout
is updated to the current time and the idle timeout is rescheduled accordingly.
Enabling DCD changes the behavior of idle-timeout handling in the TCP normalizer. DCD probing
resets the idle timeout on the connections seen in the show conn command. To determine when a
connection that has exceeded the configured timeout value in the timeout command but is kept alive due
to DCD probing, the show service-policy command includes counters to show the amount of activity
from DCD.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-2

Chapter 53

Configuring Connection Settings
Information About Connection Settings

TCP Sequence Randomization
Each TCP connection has two ISNs: one generated by the client and one generated by the server. The
ASA randomizes the ISN of the TCP SYN passing in both the inbound and outbound directions.
Randomizing the ISN of the protected host prevents an attacker from predecting the next ISN for a new
connection and potentially hijacking the new session.
TCP initial sequence number randomization can be disabled if required. For example:
•

If another in-line firewall is also randomizing the initial sequence numbers, there is no need for both
firewalls to be performing this action, even though this action does not affect the traffic.

•

If you use eBGP multi-hop through the ASA, and the eBGP peers are using MD5. Randomization
breaks the MD5 checksum.

•

You use a WAAS device that requires the ASA not to randomize the sequence numbers of
connections.

TCP Normalization
The TCP normalization feature identifies abnormal packets that the ASA can act on when they are
detected; for example, the ASA can allow, drop, or clear the packets. TCP normalization helps protect
the ASA from attacks. TCP normalization is always enabled, but you can customize how some features
behave.
The TCP normalizer includes non-configurable actions and configurable actions. Typically,
non-configurable actions that drop or clear connections apply to packets that are always bad.
Configurable actions (as detailed in “Customizing the TCP Normalizer with a TCP Map” section on
page 53-6) might need to be customized depending on your network needs.
See the following guidelines for TCP normalization:
•

The normalizer does not protect from SYN floods. The ASA includes SYN flood protection in other
ways.

•

The normalizer always sees the SYN packet as the first packet in a flow unless the ASA is in loose
mode due to failover.

TCP State Bypass
By default, all traffic that goes through the ASA is inspected using the Adaptive Security Algorithm and
is either allowed through or dropped based on the security policy. The ASA maximizes the firewall
performance by checking the state of each packet (is this a new connection or an established

Cisco ASA 5500 Series Configuration Guide using the CLI

53-3

Chapter 53

Configuring Connection Settings

Licensing Requirements for Connection Settings

connection?) and assigning it to either the session management path (a new connection SYN packet), the
fast path (an established connection), or the control plane path (advanced inspection). See the “Stateful
Inspection Overview” section on page 1-27 for more detailed information about the stateful firewall.
TCP packets that match existing connections in the fast path can pass through the ASA without
rechecking every aspect of the security policy. This feature maximizes performance. However, the
method of establishing the session in the fast path using the SYN packet, and the checks that occur in
the fast path (such as TCP sequence number), can stand in the way of asymmetrical routing solutions:
both the outbound and inbound flow of a connection must pass through the same ASA.
For example, a new connection goes to ASA 1. The SYN packet goes through the session management
path, and an entry for the connection is added to the fast path table. If subsequent packets of this
connection go through ASA 1, then the packets will match the entry in the fast path, and are passed
through. But if subsequent packets go to ASA 2, where there was not a SYN packet that went through
the session management path, then there is no entry in the fast path for the connection, and the packets
are dropped. Figure 53-1 shows an asymmetric routing example where the outbound traffic goes through
a different ASA than the inbound traffic:
Figure 53-1

Asymmetric Routing

ISP A

ISP B

Security
appliance 1

Security
appliance 2

Return?Traffic

Inside
network

251155

Outbound?Traffic

If you have asymmetric routing configured on upstream routers, and traffic alternates between two
ASAs, then you can configure TCP state bypass for specific traffic. TCP state bypass alters the way
sessions are established in the fast path and disables the fast path checks. This feature treats TCP traffic
much as it treats a UDP connection: when a non-SYN packet matching the specified networks enters the
ASA, and there is not an fast path entry, then the packet goes through the session management path to
establish the connection in the fast path. Once in the fast path, the traffic bypasses the fast path checks.

Licensing Requirements for Connection Settings
Model

License Requirement

All models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-4

Chapter 53

Configuring Connection Settings
Guidelines and Limitations

Guidelines and Limitations
This section includes the following guidelines and limitations:
•

TCP State Bypass Guidelines and Limitations, page 53-5

TCP State Bypass Guidelines and Limitations
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent mode.
Failover Guidelines

Failover is supported.
Unsupported Features

The following features are not supported when you use TCP state bypass:
•

Application inspection—Application inspection requires both inbound and outbound traffic to go
through the same ASA, so application inspection is not supported with TCP state bypass.

•

AAA authenticated sessions—When a user authenticates with one ASA, traffic returning via the
other ASA will be denied because the user did not authenticate with that ASA.

•

TCP Intercept, maximum embryonic connection limit, TCP sequence number randomization—The
ASA does not keep track of the state of the connection, so these features are not applied.

•

TCP normalization—The TCP normalizer is disabled.

•

SSM and SSC functionality—You cannot use TCP state bypass and any application running on an
SSM or SSC, such as IPS or CSC.

NAT Guidelines

Because the translation session is established separately for each ASA, be sure to configure static NAT
on both ASAs for TCP state bypass traffic; if you use dynamic NAT, the address chosen for the session
on ASA 1 will differ from the address chosen for the session on ASA 2.

Default Settings
TCP State Bypass

TCP state bypass is disabled by default.
TCP Normalizer

The default configuration includes the following settings:
no check-retransmission
no checksum-verification

Cisco ASA 5500 Series Configuration Guide using the CLI

53-5

Chapter 53

Configuring Connection Settings

Configuring Connection Settings

exceed-mss allow
queue-limit 0 timeout 4
reserved-bits allow
syn-data allow
synack-data drop
invalid-ack drop
seq-past-window drop
tcp-options range 6 7 clear
tcp-options range 9 255 clear
tcp-options selective-ack allow
tcp-options timestamp allow
tcp-options window-scale allow
ttl-evasion-protection
urgent-flag clear
window-variation allow-connection

Configuring Connection Settings
This section includes the following topics:
•

Customizing the TCP Normalizer with a TCP Map, page 53-6

•

Configuring Connection Settings, page 53-10

Task Flow For Configuring Configuration Settings (Except Global Timeouts)
Step 1

For TCP normalization customization, create a TCP map according to the “Customizing the TCP
Normalizer with a TCP Map” section on page 53-6.

Step 2

For all connection settings except for global timeouts, configure a service policy according to
Chapter 32, “Configuring a Service Policy Using the Modular Policy Framework.”

Step 3

Configure connection settings according to the “Configuring Connection Settings” section on
page 53-10.

Customizing the TCP Normalizer with a TCP Map
To customize the TCP normalizer, first define the settings using a TCP map.

Detailed Steps
Step 1

To specify the TCP normalization criteria that you want to look for, create a TCP map by entering the
following command:
hostname(config)# tcp-map tcp-map-name

For each TCP map, you can customize one or more settings.
Step 2

(Optional) Configure the TCP map criteria by entering one or more of the following commands (see
Table 53-1). If you want to customize some settings, then the defaults are used for any commands you
do not enter.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-6

Chapter 53

Configuring Connection Settings
Configuring Connection Settings

Table 53-1

tcp-map Commands

Command

Notes

check-retransmission

Prevents inconsistent TCP retransmissions.

checksum-verification

Verifies the checksum.

exceed-mss {allow | drop}

Sets the action for packets whose data length exceeds the TCP
maximum segment size.
(Default) The allow keyword allows packets whose data length
exceeds the TCP maximum segment size.
The drop keyword drops packets whose data length exceeds the
TCP maximum segment size.

invalid-ack {allow | drop}

Sets the action for packets with an invalid ACK. You might see
invalid ACKs in the following instances:
•

In the TCP connection SYN-ACK-received status, if the ACK
number of a received TCP packet is not exactly same as the
sequence number of the next TCP packet sending out, it is an
invalid ACK.

•

Whenever the ACK number of a received TCP packet is
greater than the sequence number of the next TCP packet
sending out, it is an invalid ACK.

The allow keyword allows packets with an invalid ACK.
(Default) The drop keyword drops packets with an invalid ACK.
Note

TCP packets with an invalid ACK are automatically
allowed for WAAS connections.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-7

Chapter 53

Configuring Connection Settings

Configuring Connection Settings

Table 53-1

tcp-map Commands (continued)

Command

Notes

queue-limit pkt_num
[timeout seconds]

Sets the maximum number of out-of-order packets that can be
buffered and put in order for a TCP connection, between 1 and 250
packets. The default is 0, which means this setting is disabled and
the default system queue limit is used depending on the type of
traffic:
•

Connections for application inspection (the inspect
command), IPS (the ips command), and TCP
check-retransmission (the TCP map check-retransmission
command) have a queue limit of 3 packets. If the ASA
receives a TCP packet with a different window size, then the
queue limit is dynamically changed to match the advertised
setting.

•

For other TCP connections, out-of-order packets are passed
through untouched.

If you set the queue-limit command to be 1 or above, then the
number of out-of-order packets allowed for all TCP traffic matches
this setting. For example, for application inspection, IPS, and TCP
check-retransmission traffic, any advertised settings from TCP
packets are ignored in favor of the queue-limit setting. For other
TCP traffic, out-of-order packets are now buffered and put in order
instead of passed through untouched.
The timeout seconds argument sets the maximum amount of time
that out-of-order packets can remain in the buffer, between 1 and
20 seconds; if they are not put in order and passed on within the
timeout period, then they are dropped. The default is 4 seconds.
You cannot change the timeout for any traffic if the pkt_num
argument is set to 0; you need to set the limit to be 1 or above for
the timeout keyword to take effect.
reserved-bits {allow | clear |
drop}

Sets the action for reserved bits in the TCP header.
(Default) The allow keyword allows packets with the reserved bits
in the TCP header.
The clear keyword clears the reserved bits in the TCP header and
allows the packet.
The drop keyword drops the packet with the reserved bits in the
TCP header.

seq-past-window {allow | drop}

Sets the action for packets that have past-window sequence
numbers, namely the sequence number of a received TCP packet
is greater than the right edge of the TCP receiving window.
The allow keyword allows packets that have past-window
sequence numbers. This action is only allowed if the queue-limit
command is set to 0 (disabled).
(Default) The drop keyword drops packets that have past-window
sequence numbers.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-8

Chapter 53

Configuring Connection Settings
Configuring Connection Settings

Table 53-1

tcp-map Commands (continued)

Command

Notes

synack-data {allow | drop}

Sets the action for TCP SYNACK packets that contain data.
The allow keyword allows TCP SYNACK packets that contain
data.
(Default) The drop keyword drops TCP SYNACK packets that
contain data.

syn-data {allow | drop}

Sets the action for SYN packets with data.
(Default) The allow keyword allows SYN packets with data.
The drop keyword drops SYN packets with data.

tcp-options {selective-ack |
timestamp | window-scale}
{allow | clear}

Sets the action for packets with TCP options, including the
selective-ack, timestamp, or window-scale TCP options.

Or

(Default) The allow keyword allows packets with the specified
option.

tcp-options range lower upper
{allow | clear | drop}

(Default for range) The clear keyword clears the option and
allows the packet.
The drop keyword drops the packet with the specified option.
The selective-ack keyword sets the action for the SACK option.
The timestamp keyword sets the action for the timestamp option.
Clearing the timestamp option disables PAWS and RTT.
The widow-scale keyword sets the action for the window scale
mechanism option.
The range keyword specifies a range of options. The lower
argument sets the lower end of the range as 6, 7, or 9 through 255.
The upper argument sets the upper end of the range as 6, 7, or 9
through 255.

ttl-evasion-protection

Enables the TTL evasion protection. Do not disable this command
it you want to prevent attacks that attempt to evade security policy.
For example, an attacker can send a packet that passes policy with
a very short TTL. When the TTL goes to zero, a router between the
ASA and the endpoint drops the packet. It is at this point that the
attacker can send a malicious packet with a long TTL that appears
to the ASA to be a retransmission and is passed. To the endpoint
host, however, it is the first packet that has been received by the
attacker. In this case, an attacker is able to succeed without
security preventing the attack.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-9

Chapter 53

Configuring Connection Settings

Configuring Connection Settings

Table 53-1

tcp-map Commands (continued)

Command

Notes

urgent-flag {allow | clear}

Sets the action for packets with the URG flag. The URG flag is
used to indicate that the packet contains information that is of
higher priority than other data within the stream. The TCP RFC is
vague about the exact interpretation of the URG flag, therefore end
systems handle urgent offsets in different ways, which may make
the end system vulnerable to attacks.
The allow keyword allows packets with the URG flag.
(Default) The clear keyword clears the URG flag and allows the
packet.

window-variation {allow | drop} Sets the action for a connection that has changed its window size
unexpectedly. The window size mechanism allows TCP to
advertise a large window and to subsequently advertise a much
smaller window without having accepted too much data. From the
TCP specification, “shrinking the window” is strongly
discouraged. When this condition is detected, the connection can
be dropped.
(Default) The allow keyword allows connections with a window
variation.
The drop keyword drops connections with a window variation.

Configuring Connection Settings
To set connection settings, perform the following steps.

Guidelines and Limitations
Depending on the number of CPU cores on your ASA model, the maximum concurrent and embryonic
connections may exceed the configured numbers due to the way each core manages connections. In the
worst case scenario, the ASA allows up to n-1 extra connections and embryonic connections, where n is
the number of cores. For example, if your model has 4 cores, if you configure 6 concurrent connections
and 4 embryonic connections, you could have an additional 3 of each type. To determine the number of
cores for your model, enter the show cpu core command.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-10

Chapter 53

Configuring Connection Settings
Configuring Connection Settings

Detailed Steps

Step 1

Command

Purpose

class-map name

Creates a class map to identify the traffic for which you want to
disable stateful firewall inspection.

Example:
hostname(config)# class-map bypass_traffic

Step 2

match parameter

Specifies the traffic in the class map. See the “Identifying Traffic
(Layer 3/4 Class Maps)” section on page 32-12 for more
information.

Example:
hostname(config-cmap)# match access-list
bypass

Step 3

policy-map name

Adds or edits a policy map that sets the actions to take with the
class map traffic.

Example:
hostname(config)# policy-map
tcp_bypass_policy

Step 4

class name

Identifies the class map created in Step 1

Example:
hostname(config-pmap)# class
bypass_traffic

Step 5

Do one or more of the following:

Cisco ASA 5500 Series Configuration Guide using the CLI

53-11

Chapter 53

Configuring Connection Settings

Configuring Connection Settings

Command

Purpose

set connection {[conn-max n]
[embryonic-conn-max n]
[per-client-embryonic-max n]
[per-client-max n] [random-sequence-number
{enable | disable}]}

Sets maximum connection limits or whether TCP sequence
randomization is enabled.

Example:

If two servers are configured to allow simultaneous TCP and/or
UDP connections, the connection limit is applied to each
configured server separately.

hostname(config-pmap-c)# set connection
conn-max 256 random-sequence-number
disable

The conn-max n argument sets the maximum number of
simultaneous TCP and/or UDP connections that are allowed,
between 0 and 2000000. The default is 0, which allows unlimited
connections.

When configured under a class, this argument restricts the
maximum number of simultaneous connections that are allowed
for the entire class. In this case, one attack host can consume all
the connections and leave none of the rest of the hosts matched in
the access list under the class.
The embryonic-conn-max n argument sets the maximum number
of simultaneous embryonic connections allowed, between 0 and
2000000. The default is 0, which allows unlimited connections.
The per-client-embryonic-max n argument sets the maximum
number of simultaneous embryonic connections allowed per
client, between 0 and 2000000. The default is 0, which allows
unlimited connections.
The per-client-max n argument sets the maximum number of
simultaneous connections allowed per client, between 0 and
2000000. The default is 0, which allows unlimited connections.
When configured under a class, this argument restricts the
maximum number of simultaneous connections that are allowed
for each host that is matched through an access list under the
class.
The random-sequence-number {enable | disable} keyword
enables or disables TCP sequence number randomization. See the
“TCP Sequence Randomization” section on page 53-3 section for
more information.
You can enter this command all on one line (in any order), or you
can enter each attribute as a separate command. The ASA
combines the command into one line in the running configuration.

Note

Cisco ASA 5500 Series Configuration Guide using the CLI

53-12

For management traffic, you can only set the conn-max
and embryonic-conn-max keywords.

Chapter 53

Configuring Connection Settings
Configuring Connection Settings

Command

Purpose

set connection timeout {[embryonic
hh:mm:ss] {idle hh:mm:ss [reset]]
[half-closed hh:mm:ss] [dcd hh:mm:ss
[max_retries]]}

Sets connection timeouts.

Example:

The idle hh:mm:ss keyword sets the idle timeout for all protocols
between 0:0:1 and 1193:0:0. The default is 1:0:0. You can also set
this value to 0, which means the connection never times out. For
TCP traffic, the reset keyword sends a reset to TCP endpoints
when the connection times out.

hostname(config-pmap-c)# set connection
timeout idle 2:0:0 embryonic 0:40:0
half-closed 0:20:0 dcd

The embryonic hh:mm:ss keyword sets the timeout period until a
TCP embryonic (half-open) connection is closed, between 0:0:5
and 1193:0:0. The default is 0:0:30. You can also set this value to
0, which means the connection never times out.

The half-closed hh:mm:ss keyword sets the idle timeout between
0:5:0 and 1193:0:0. The default is 0:10:0. Half-closed
connections are not affected by DCD. Also, the ASA does not
send a reset when taking down half-closed connections.
The dcd keyword enables DCD. DCD detects a dead connection
and allows it to expire, without expiring connections that can still
handle traffic. You configure DCD when you want idle, but valid
connections to persist. After a TCP connection times out, the ASA
sends DCD probes to the end hosts to determine the validity of the
connection. If one of the end hosts fails to respond after the
maximum retries are exhausted, the ASA frees the connection. If
both end hosts respond that the connection is valid, the ASA
updates the activity timeout to the current time and reschedules
the idle timeout accordingly. The retry-interval sets the time
duration in hh:mm:ss format to wait after each unresponsive DCD
probe before sending another probe, between 0:0:1 and 24:0:0.
The default is 0:0:15. The max-retries sets the number of
consecutive failed retries for DCD before declaring the
connection as dead. The minimum value is 1 and the maximum
value is 255. The default is 5.
The default tcp idle timeout is 1 hour.
The default udp idle timeout is 2 minutes.
The default icmp idle timeout is 2 seconds.
The default esp and ha idle timeout is 30 seconds.
For all other protocols, the default idle timeout is 2 minutes.
To never time out, enter 0:0:0.
You can enter this command all on one line (in any order), or you
can enter each attribute as a separate command. The command is
combined onto one line in the running configuration.

Note

This command is not available for management traffic.

Cisco ASA 5500 Series Configuration Guide using the CLI

53-13

Chapter 53

Configuring Connection Settings

Monitoring Connection Settings

Command

Purpose

set connection advanced-options
tcp-map-name

Customizes the TCP normalizer. See the “Customizing the TCP
Normalizer with a TCP Map” section on page 53-6 to create a
TCP map.

Example:
hostname(config-pmap-c)# set connection
advanced-options tcp_map1

Enables TCP state bypass.

set connection advanced-options
tcp-state-bypass

Example:
hostname(config-pmap-c)# set connection
advanced-options tcp-state-bypass

Step 6

service-policy policymap_name {global |
interface interface_name}

Example:
hostname(config)# service-policy
tcp_bypass_policy outside

Activates the policy map on one or more interfaces. global 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.

Monitoring Connection Settings
This section includes the following topics:
•

Monitoring TCP State Bypass, page 53-14

Monitoring TCP State Bypass
To monitor TCP state bypass, perform one of the following tasks:
Command

Purpose

show conn

If you use the show conn command, the display for connections that use
TCP state bypass includes the flag “b.”

Configuration Examples for Connection Settings
This section includes the following topics:
•

Configuration Examples for Connection Limits and Timeouts, page 53-15

•

Configuration Examples for TCP State Bypass, page 53-15

•

Configuration Examples for TCP Normalization, page 53-15

Cisco ASA 5500 Series Configuration Guide using the CLI

53-14

Chapter 53

Configuring Connection Settings
Configuration Examples for Connection Settings

Configuration Examples for Connection Limits and Timeouts
The following example sets the connection limits and timeouts for all traffic:
hostname(config)# class-map CONNS
hostname(config-cmap)# match any
hostname(config-cmap)# policy-map CONNS
hostname(config-pmap)# class CONNS
hostname(config-pmap-c)# set connection conn-max 1000 embryonic-conn-max 3000
hostname(config-pmap-c)# set connection timeout idle 2:0:0 embryonic 0:40:0 half-closed
0:20:0 dcd
hostname(config-pmap-c)# service-policy CONNS interface outside

You can enter set connection commands with multiple parameters or you can enter each parameter as a
separate command. The ASA combines the commands into one line in the running configuration. For
example, if you entered the following two commands in class configuration mode:
hostname(config-pmap-c)# set connection conn-max 600
hostname(config-pmap-c)# set connection embryonic-conn-max 50

the output of the show running-config policy-map command would display the result of the two
commands in a single, combined command:
set connection conn-max 600 embryonic-conn-max 50

Configuration Examples for TCP State Bypass
The following is a sample configuration for TCP state bypass:
hostname(config)# access-list tcp_bypass extended permit tcp 10.1.1.0 255.255.255.224 any
hostname(config)# class-map tcp_bypass
hostname(config-cmap)# description "TCP traffic that bypasses stateful firewall"
hostname(config-cmap)# match access-list tcp_bypass
hostname(config-cmap)# policy-map tcp_bypass_policy
hostname(config-pmap)# class tcp_bypass
hostname(config-pmap-c)# set connection advanced-options tcp-state-bypass
hostname(config-pmap-c)# service-policy tcp_bypass_policy outside
hostname(config-pmap-c)# static (inside,outside) 209.165.200.224 10.1.1.0 netmask
255.255.255.224

Configuration Examples for TCP Normalization
For example, to allow urgent flag and urgent offset packets for all traffic sent to the range of TCP ports
between the well known FTP data port and the Telnet port, enter the following commands:
hostname(config)# tcp-map tmap
hostname(config-tcp-map)# urgent-flag allow
hostname(config-tcp-map)# class-map urg-class
hostname(config-cmap)# match port tcp range ftp-data telnet
hostname(config-cmap)# policy-map pmap
hostname(config-pmap)# class urg-class
hostname(config-pmap-c)# set connection advanced-options tmap
hostname(config-pmap-c)# service-policy pmap global

Cisco ASA 5500 Series Configuration Guide using the CLI

53-15

Chapter 53

Configuring Connection Settings

Feature History for Connection Settings

Feature History for Connection Settings
Table 53-2 lists each feature change and the platform release in which it was implemented.
Table 53-2

Feature History for Connection Settings

Feature Name

Platform
Releases

TCP state bypass

8.2(1)

This feature was introduced. The following command was
introduced: set connection advanced-options
tcp-state-bypass.

Connection timeout for all protocols

8.2(2)

The idle timeout was changed to apply to all protocols, not
just TCP.

Feature Information

The following command was modified: set connection
timeout
Timeout for connections using a backup static
route

8.2(5)/8.4(2)

When multiple static routes exist to a network with different
metrics, the ASA uses the one with the best metric at the
time of connection creation. If a better route becomes
available, then this timeout lets connections be closed so a
connection can be reestablished to use the better route. The
default is 0 (the connection never times out). To take
advantage of this feature, change the timeout to a new value.
We modified the following command: timeout
floating-conn.

Configurable timeout for PAT xlate

8.4(3)

When a PAT xlate times out (by default after 30 seconds),
and the ASA reuses the port for a new translation, some
upstream routers might reject the new connection because
the previous connection might still be open on the upstream
device. The PAT xlate timeout is now configurable, to a
value between 30 seconds and 5 minutes.
We introduced the following command: timeout pat-xlate.
This feature is not available in 8.5(1) or 8.6(1).

Increased maximum connection limits for
service policy rules

8.4(5)

The maximum number of connections for service policy
rules was increased from 65535 to 2000000.
We modified the following commands: set connection
conn-max, set connection embryonic-conn-max, set
connection per-client-embryonic-max, set connection
per-client-max.
This feature is not available in 8.5(1) or 8.6(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

53-16

CH A P T E R

54

Configuring QoS
Have you ever participated in a long-distance phone call that involved a satellite connection? The
conversation might be interrupted with brief, but perceptible, gaps at odd intervals. Those gaps are the
time, called the latency, between the arrival of packets being transmitted over the network. Some network
traffic, such as voice and video, cannot tolerate long latency times. Quality of service (QoS) is a feature
that lets you give priority to critical traffic, prevent bandwidth hogging, and manage network bottlenecks
to prevent packet drops.
This chapter describes how to apply QoS policies and includes the following sections:
•

Information About QoS, page 54-1

•

Licensing Requirements for QoS, page 54-5

•

Guidelines and Limitations, page 54-5

•

Configuring QoS, page 54-6

•

Monitoring QoS, page 54-15

•

Feature History for QoS, page 54-18

Information About QoS
You should consider that in an ever-changing network environment, QoS is not a one-time deployment,
but an ongoing, essential part of network design.
This section describes the QoS features supported by the ASA and includes the following topics:
•

Supported QoS Features, page 54-2

•

What is a Token Bucket?, page 54-2

•

Information About Policing, page 54-3

•

Information About Priority Queuing, page 54-3

•

Information About Traffic Shaping, page 54-4

•

How QoS Features Interact, page 54-4

•

DSCP and DiffServ Preservation, page 54-5

Cisco ASA 5500 Series Configuration Guide using the CLI

54-1

Chapter 54

Configuring QoS

Information About QoS

Supported QoS Features
The ASA supports the following QoS features:
•

Policing—To prevent individual flows from hogging the network bandwidth, you can limit the
maximum bandwidth used per flow. See the “Information About Policing” section on page 54-3 for
more information.

•

Priority queuing—For critical traffic that cannot tolerate latency, such as Voice over IP (VoIP), you
can identify traffic for Low Latency Queuing (LLQ) so that it is always transmitted ahead of other
traffic. See the “Information About Priority Queuing” section on page 54-3 for more information.

•

Traffic shaping—If you have a device that transmits packets at a high speed, such as a ASA with
Fast Ethernet, and it is connected to a low speed device such as a cable modem, then the cable
modem is a bottleneck at which packets are frequently dropped. To manage networks with differing
line speeds, you can configure the ASA to transmit packets at a fixed slower rate. See the
“Information About Traffic Shaping” section on page 54-4 for more information.

What is a Token Bucket?
A token bucket is used to manage a device that regulates the data in a flow. For example, the regulator
might be a traffic policer or a traffic shaper. A token bucket itself has no discard or priority policy.
Rather, a token bucket discards tokens and leaves to the flow the problem of managing its transmission
queue if the flow overdrives the regulator.
A token bucket is a formal definition of a rate of transfer. It has three components: a burst size, an
average rate, and a time interval. Although the average rate is generally represented as bits per second,
any two values may be derived from the third by the relation shown as follows:
average rate = burst size / time interval
Here are some definitions of these terms:
•

Average rate—Also called the committed information rate (CIR), it specifies how much data can be
sent or forwarded per unit time on average.

•

Burst size—Also called the Committed Burst (Bc) size, it specifies in bits or bytes per burst how
much traffic can be sent within a given unit of time to not create scheduling concerns. (For traffic
shaping, it specifies bits per burst; for policing, it specifies bytes per burst.)

•

Time interval—Also called the measurement interval, it specifies the time quantum in seconds per
burst.

In the token bucket metaphor, tokens are put into the bucket at a certain rate. The bucket itself has a
specified capacity. If the bucket fills to capacity, newly arriving tokens are discarded. Each token is
permission for the source to send a certain number of bits into the network. To send a packet, the
regulator must remove from the bucket a number of tokens equal in representation to the packet size.
If not enough tokens are in the bucket to send a packet, the packet either waits until the bucket has
enough tokens (in the case of traffic shaping) or the packet is discarded or marked down (in the case of
policing). If the bucket is already full of tokens, incoming tokens overflow and are not available to future
packets. Thus, at any time, the largest burst a source can send into the network is roughly proportional
to the size of the bucket.
Note that the token bucket mechanism used for traffic shaping has both a token bucket and a data buffer,
or queue; if it did not have a data buffer, it would be a policer. For traffic shaping, packets that arrive that
cannot be sent immediately are delayed in the data buffer.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-2

Chapter 54

Configuring QoS
Information About QoS

For traffic shaping, a token bucket permits burstiness but bounds it. It guarantees that the burstiness is
bounded so that the flow will never send faster than the token bucket capacity, divided by the time
interval, plus the established rate at which tokens are placed in the token bucket. See the following
formula:
(token bucket capacity in bits / time interval in seconds) + established rate in bps = maximum flow speed
in bps
This method of bounding burstiness also guarantees that the long-term transmission rate will not exceed
the established rate at which tokens are placed in the bucket.

Information About Policing
Policing is a way of ensuring that no traffic exceeds the maximum rate (in bits/second) that you
configure, thus ensuring that no one traffic flow or class can take over the entire resource. When traffic
exceeds the maximum rate, the ASA drops the excess traffic. Policing also sets the largest single burst
of traffic allowed.

Information About Priority Queuing
LLQ priority queuing lets you prioritize certain traffic flows (such as latency-sensitive traffic like voice
and video) ahead of other traffic.
The ASA supports two types of priority queuing:
•

Standard priority queuing—Standard priority queuing uses an LLQ priority queue on an interface
(see the “Configuring the Standard Priority Queue for an Interface” section on page 54-7), while all
other traffic goes into the “best effort” queue. Because queues are not of infinite size, they can fill
and overflow. When a queue is full, any additional packets cannot get into the queue and are
dropped. This is called tail drop. To avoid having the queue fill up, you can increase the queue buffer
size. You can also fine-tune the maximum number of packets allowed into the transmit queue. These
options let you control the latency and robustness of the priority queuing. Packets in the LLQ queue
are always transmitted before packets in the best effort queue.

•

Hierarchical priority queuing—Hierarchical priority queuing is used on interfaces on which you
enable a traffic shaping queue. A subset of the shaped traffic can be prioritized. The standard priority
queue is not used. See the following guidelines about hierarchical priority queuing:
– Priority packets are always queued at the head of the shape queue so they are always transmitted

ahead of other non-priority queued packets.
– Priority packets are never dropped from the shape queue unless the sustained rate of priority

traffic exceeds the shape rate.
– For IPsec-encrypted packets, you can only match traffic based on the DSCP or precedence

setting.
– IPsec-over-TCP is not supported for priority traffic classification.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-3

Chapter 54

Configuring QoS

Information About QoS

Information About Traffic Shaping
Traffic shaping is used to match device and link speeds, thereby controlling packet loss, variable delay,
and link saturation, which can cause jitter and delay.

Note

Traffic shaping is not supported on multi-processor models, such as the ASA 5580 or ASA 5585-X.
•

Traffic shaping must be applied to all outgoing traffic on a physical interface or in the case of the
ASA 5505, on a VLAN. You cannot configure traffic shaping for specific types of traffic.

•

Traffic shaping is implemented when packets are ready to be transmitted on an interface, so the rate
calculation is performed based on the actual size of a packet to be transmitted, including all the
possible overhead such as the IPsec header and L2 header.

•

The shaped traffic includes both through-the-box and from-the-box traffic.

•

The shape rate calculation is based on the standard token bucket algorithm. The token bucket size is
twice the Burst Size value. See the “What is a Token Bucket?” section on page 54-2.

•

When bursty traffic exceeds the specified shape rate, packets are queued and transmitted later.
Following are some characteristics regarding the shape queue (for information about hierarchical
priority queuing, see the “Information About Priority Queuing” section on page 54-3):
– The queue size is calculated based on the shape rate. The queue can hold the equivalent of

200-milliseconds worth of shape rate traffic, assuming a 1500-byte packet. The minimum queue
size is 64.
– When the queue limit is reached, packets are tail-dropped.
– Certain critical keep-alive packets such as OSPF Hello packets are never dropped.
– The time interval is derived by time_interval = burst_size / average_rate. The larger the time

interval is, the burstier the shaped traffic might be, and the longer the link might be idle. The
effect can be best understood using the following exaggerated example:
Average Rate = 1000000
Burst Size = 1000000
In the above example, the time interval is 1 second, which means, 1 Mbps of traffic can be
bursted out within the first 10 milliseconds of the 1-second interval on a 100 Mbps FE link and
leave the remaining 990 milliseconds idle without being able to send any packets until the next
time interval. So if there is delay-sensitive traffic such as voice traffic, the Burst Size should be
reduced compared to the average rate so the time interval is reduced.

How QoS Features Interact
You can configure each of the QoS features alone if desired for the ASA. Often, though, you configure
multiple QoS features on the ASA so you can prioritize some traffic, for example, and prevent other
traffic from causing bandwidth problems.
See the following supported feature combinations per interface:
•

Standard priority queuing (for specific traffic) + Policing (for the rest of the traffic).
You cannot configure priority queuing and policing for the same set of traffic.

•

Traffic shaping (for all traffic on an interface) + Hierarchical priority queuing (for a subset of
traffic).

Cisco ASA 5500 Series Configuration Guide using the CLI

54-4

Chapter 54

Configuring QoS
Licensing Requirements for QoS

You cannot configure traffic shaping and standard priority queuing for the same interface; only
hierarchical priority queuing is allowed. For example, if you configure standard priority queuing for the
global policy, and then configure traffic shaping for a specific interface, the feature you configured last
is rejected because the global policy overlaps the interface policy.
Typically, if you enable traffic shaping, you do not also enable policing for the same traffic, although the
ASA does not restrict you from configuring this.

DSCP and DiffServ Preservation
•

DSCP markings are preserved on all traffic passing through the ASA.

•

The ASA does not locally mark/remark any classified traffic, but it honors the Expedited Forwarding
(EF) DSCP bits of every packet to determine if it requires “priority” handling and will direct those
packets to the LLQ.

•

DiffServ marking is preserved on packets when they traverse the service provider backbone so that
QoS can be applied in transit (QoS tunnel pre-classification).

Licensing Requirements for QoS
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode only. Does not support multiple context mode.
Firewall Mode Guidelines

Supported in routed firewall mode only. Does not support transparent firewall mode.
IPv6 Guidelines

Does not support IPv6.
Model Guidelines
•

(Multi-processor models, such as the ASA 5500-X, ASA 5580, ASA 5585-X, and ASASM) Traffic
shaping is not supported.

•

(ASA 5580) You cannot create a standard priority queue for a Ten Gigabit Ethernet interface. Note:
For the ASA 5585-X, standard priority queuing is supported on a Ten Gigabit Interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-5

Chapter 54

Configuring QoS

Configuring QoS

•

(ASA 5512-X through ASA 5555-X) Priority queuing is not supported on the Management 0/0
interface.

Additional Guidelines and Limitations
•

For traffic shaping, you can only use the class-default class map, which is automatically created by
the ASA, and which matches all traffic.

•

For priority traffic, you cannot use the class-default class map.

•

For hierarchical priority queuing, for encrypted VPN traffic, you can only match traffic based on the
DSCP or precedence setting; you cannot match a tunnel group.

•

For hierarchical priority queuing, IPsec-over-TCP traffic is not supported.

•

You cannot configure traffic shaping and standard priority queuing for the same interface; only
hierarchical priority queuing is allowed.

•

For standard priority queuing, the queue must be configured for a physical interface or, for the ASA
5505, a VLAN.

Configuring QoS
This section includes the following topics:
•

Determining the Queue and TX Ring Limits for a Standard Priority Queue, page 54-6

•

Configuring the Standard Priority Queue for an Interface, page 54-7

•

Configuring a Service Rule for Standard Priority Queuing and Policing, page 54-9

•

Configuring a Service Rule for Traffic Shaping and Hierarchical Priority Queuing, page 54-12

Determining the Queue and TX Ring Limits for a Standard Priority Queue
To determine the priority queue and TX ring limits, use the worksheets below.
Table 54-1 shows how to calculate the priority queue size. Because queues are not of infinite size, they
can fill and overflow. When a queue is full, any additional packets cannot get into the queue and are
dropped (called tail drop). To avoid having the queue fill up, you can adjust the queue buffer size
according to the “Configuring the Standard Priority Queue for an Interface” section on page 54-7.
Table 54-1

Queue Limit Worksheet

Step 1

__________

Mbps

Outbound
bandwidth
(Mbps or Kbps)1

x

125

=

__________
# of bytes/ms

Kbps

x

.125

=

__________
# of bytes/ms

Step 2

___________
# of bytes/ms
from Step 1

÷

__________
Average packet
size (bytes)2

Cisco ASA 5500 Series Configuration Guide using the CLI

54-6

x

__________
Delay (ms)

3

=

__________
Queue limit
(# of packets)

Chapter 54

Configuring QoS
Configuring QoS

1. For example, DSL might have an uplink speed of 768 Kbps. Check with your provider.
2. Determine this value from a codec or sampling size. For example, for VoIP over VPN, you might use 160 bytes. We recommend 256
bytes if you do not know what size to use.
3. The delay depends on your application. For example, the recommended maximum delay for VoIP is 200 ms. We recommend 500 ms
if you do not know what delay to use.

Table 54-2 shows how to calculate the TX ring limit. This limit determines the maximum number of
packets allowed into the Ethernet transmit driver before the driver pushes back to the queues on the
interface to let them buffer packets until the congestion clears. This setting guarantees that the
hardware-based transmit ring imposes a limited amount of extra latency for a high-priority packet.
Table 54-2

TX Ring Limit Worksheet

Step 1

__________

Mbps

Outbound
bandwidth
(Mbps or Kbps)1

x

=

125

__________
# of bytes/ms

Kbps

x

=

0.125

__________
# of bytes/ms

Step 2

___________
# of bytes/ms
from Step 1

÷

x

__________
Maximum packet
size (bytes)2

__________
Delay (ms)

3

=

__________
TX ring limit
(# of packets)

1. For example, DSL might have an uplink speed of 768 Kbps.Check with your provider.
2. Typically, the maximum size is 1538 bytes, or 1542 bytes for tagged Ethernet. If you allow jumbo frames (if supported for your
platform), then the packet size might be larger.
3. The delay depends on your application. For example, to control jitter for VoIP, you should use 20 ms.

Configuring the Standard Priority Queue for an Interface
If you enable standard priority queuing for traffic on a physical interface, then you need to also create
the priority queue on each interface. Each physical interface uses two queues: one for priority traffic,
and the other for all other traffic. For the other traffic, you can optionally configure policing.

Note

The standard priority queue is not required for hierarchical priority queuing with traffic shaping; see the
“Information About Priority Queuing” section on page 54-3 for more information.

Restrictions
•

(ASASM) The ASASM does not support priority queuing.

•

(ASA 5580) You cannot create a standard priority queue for a Ten Gigabit Ethernet interface. Note:
For the ASA 5585-X, standard priority queuing is supported on a Ten Gigabit Ethernet interface.

•

(ASA 5512-X through ASA 5555-X) Priority queuing is not supported on the Management 0/0
interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-7

Chapter 54

Configuring QoS

Configuring QoS

Detailed Steps

Step 1

Command

Purpose

priority-queue interface_name

Creatse the priority queue, where the interface_name argument
specifies the physical interface name on which you want to enable
the priority queue, or for the ASA 5505 or ASASM, the VLAN
interface name.

Example:
hostname(config)# priority-queue inside

Step 2

queue-limit number_of_packets

Example:
hostname(config-priority-queue)#
queue-limit 260

Changes the size of the priority queues. The default queue limit is
1024 packets. Because queues are not of infinite size, they can fill
and overflow. When a queue is full, any additional packets cannot
get into the queue and are dropped (called tail drop). To avoid
having the queue fill up, you can use the queue-limit command to
increase the queue buffer size.
The upper limit of the range of values for the queue-limit
command is determined dynamically at run time. To view this
limit, enter queue-limit ? on the command line. The key
determinants are the memory needed to support the queues and
the memory available on the device.
The queue-limit that you specify affects both the higher priority
low-latency queue and the best effort queue.

Step 3

tx-ring-limit number_of_packets

Example:
hostname(config-priority-queue)#
tx-ring-limit 3

Specifies the depth of the priority queues. The default
tx-ring-limit is 128 packets. This command sets the maximum
number of low-latency or normal priority packets allowed into the
Ethernet transmit driver before the driver pushes back to the
queues on the interface to let them buffer packets until the
congestion clears. This setting guarantees that the hardware-based
transmit ring imposes a limited amount of extra latency for a
high-priority packet.
The upper limit of the range of values for the tx-ring-limit
command is determined dynamically at run time. To view this
limit, enter tx-ring-limit ? on the command line. The key
determinants are the memory needed to support the queues and
the memory available on the device.
The tx-ring-limit that you specify affects both the higher priority
low-latency queue and the best-effort queue.

Examples
The following example establishes a priority queue on interface “outside” (the GigabitEthernet0/1
interface), with the default queue-limit and tx-ring-limit:
hostname(config)# priority-queue outside

The following example establishes a priority queue on the interface “outside” (the GigabitEthernet0/1
interface), sets the queue-limit to 260 packets, and sets the tx-ring-limit to 3:
hostname(config)# priority-queue outside
hostname(config-priority-queue)# queue-limit 260
hostname(config-priority-queue)# tx-ring-limit 3

Cisco ASA 5500 Series Configuration Guide using the CLI

54-8

Chapter 54

Configuring QoS
Configuring QoS

Configuring a Service Rule for Standard Priority Queuing and Policing
You can configure standard priority queuing and policing for different class maps within the same policy
map. See the “How QoS Features Interact” section on page 54-4 for information about valid QoS
configurations.
To create a policy map, perform the following steps.

Restrictions
•

You cannot use the class-default class map for priority traffic.

•

You cannot configure traffic shaping and standard priority queuing for the same interface; only
hierarchical priority queuing is allowed.

•

(ASASM) The ASASM only supports policing.

•

For priority traffic, identify only latency-sensitive traffic.

•

For policing traffic, you can choose to police all other traffic, or you can limit the traffic to certain
types.

Guidelines

Detailed Steps

Step 1

Command

Purpose

class-map policing_map_name

For policing traffic, creates a class map to identify the traffic for
which you want to perform policing.

Example:
hostname(config)# class-map
policing_traffic

Step 2

match parameter

Example:

Specifies the traffic in the class map. See the “Identifying Traffic
(Layer 3/4 Class Maps)” section on page 32-12 for more
information.

hostname(config-cmap)# match access-list
policing

Step 3

class-map priority_map_name

For priority traffic, creates a class map to identify the traffic for
which you want to perform priority queuing.

Example:
hostname(config)# class-map
priority_traffic

Step 4

match parameter

Example:

Specifies the traffic in the class map. See the “Identifying Traffic
(Layer 3/4 Class Maps)” section on page 32-12 for more
information.

hostname(config-cmap)# match access-list
priority

Step 5

policy-map name

Adds or edits a policy map.

Example:
hostname(config)# policy-map QoS_policy

Cisco ASA 5500 Series Configuration Guide using the CLI

54-9

Chapter 54

Configuring QoS

Configuring QoS

Step 6

Command

Purpose

class policing_map_name

Identifies the class map you created for policed traffic in Step 1.

Example:
hostname(config-pmap)# class
policing_class

Step 7

police {output | input} conform-rate
[conform-burst] [conform-action [drop |
transmit]] [exceed-action [drop |
transmit]]

Configures policing for the class. See the followingoptions:
•

conform-burst argument—Specifies the maximum number of
instantaneous bytes allowed in a sustained burst before
throttling to the conforming rate value, between 1000 and
512000000 bytes.

•

conform-action—Sets the action to take when the rate is less
than the conform_burst value.

•

conform-rate—Sets the rate limit for this traffic flow;
between 8000 and 2000000000 bits per second.]

•

drop—Drops the packet.

•

exceed-action—Sets the action to take when the rate is
between the conform-rate value and the conform-burst value.

•

input—Enables policing of traffic flowing in the input
direction.

•

output—Enables policing of traffic flowing in the output
direction.

•

transmit—Transmits the packet.

Example:
hostname(config-pmap-c)# police output
56000 10500

Step 8

class priority_map_name

Identifies the class map you created for prioritized traffic in
Step 3.

Example:
hostname(config-pmap)# class
priority_class

Step 9

Configures priority queuing for the class.

priority

Example:
hostname(config-pmap-c)# priority

Step 10

service-policy policymap_name {global |
interface interface_name}

Example:
hostname(config)# service-policy
QoS_policy interface inside

Activates the policy map on one or more interfaces. global 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.

Examples
Example 54-1 Class Map Examples for VPN Traffic

In the following example, the class-map command classifies all non-tunneled TCP traffic, using an
access list named tcp_traffic:
hostname(config)# access-list tcp_traffic permit tcp any any

Cisco ASA 5500 Series Configuration Guide using the CLI

54-10

Chapter 54

Configuring QoS
Configuring QoS

hostname(config)# class-map tcp_traffic
hostname(config-cmap)# match access-list tcp_traffic

In the following example, other, more specific match criteria are used for classifying traffic for specific,
security-related tunnel groups. These specific match criteria stipulate that a match on tunnel-group (in
this case, the previously-defined Tunnel-Group-1) is required as the first match characteristic to classify
traffic for a specific tunnel, and it allows for an additional match line to classify the traffic (IP differential
services code point, expedited forwarding).
hostname(config)# class-map TG1-voice
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# match dscp ef

In the following example, the class-map command classifies both tunneled and non-tunneled traffic
according to the traffic type:
hostname(config)# access-list tunneled extended permit ip 10.10.34.0 255.255.255.0
192.168.10.0 255.255.255.0
hostname(config)# access-list non-tunneled extended permit tcp any any
hostname(config)# tunnel-group tunnel-grp1 type IPsec_L2L
hostname(config)# class-map browse
hostname(config-cmap)# description "This class-map matches all non-tunneled tcp traffic."
hostname(config-cmap)# match access-list non-tunneled
hostname(config-cmap)#
hostname(config-cmap)#
tunnel-grp 1."
hostname(config-cmap)#
hostname(config-cmap)#

class-map TG1-voice
description "This class-map matches all dscp ef traffic for

hostname(config-cmap)#
hostname(config-cmap)#
tunnel-grp1."
hostname(config-cmap)#
hostname(config-cmap)#

class-map TG1-BestEffort
description "This class-map matches all best-effort traffic for

match dscp ef
match tunnel-group tunnel-grp1

match tunnel-group tunnel-grp1
match flow ip destination-address

The following example shows a way of policing a flow within a tunnel, provided the classed traffic is
not specified as a tunnel, but does go through the tunnel. In this example, 192.168.10.10 is the address
of the host machine on the private side of the remote tunnel, and the access list is named “host-over-l2l”.
By creating a class-map (named “host-specific”), you can then police the “host-specific” class before the
LAN-to-LAN connection polices the tunnel. In this example, the “host-specific” traffic is rate-limited
before the tunnel, then the tunnel is rate-limited:
hostname(config)# access-list host-over-l2l extended permit ip any host 192.168.10.10
hostname(config)# class-map host-specific
hostname(config-cmap)# match access-list host-over-l2l

The following example builds on the configuration developed in the previous section. As in the previous
example, there are two named class-maps: tcp_traffic and TG1-voice.
hostname(config)# class-map TG1-best-effort
hostname(config-cmap)# match tunnel-group Tunnel-Group-1
hostname(config-cmap)# match flow ip destination-address

Adding a third class map provides a basis for defining a tunneled and non-tunneled QoS policy, as
follows, which creates a simple QoS policy for tunneled and non-tunneled traffic, assigning packets of
the class TG1-voice to the low latency queue and setting rate limits on the tcp_traffic and
TG1-best-effort traffic flows.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-11

Chapter 54

Configuring QoS

Configuring QoS

Example 54-2 Priority and Policing Example

In this example, the maximum rate for traffic of the tcp_traffic class is 56,000 bits/second and a
maximum burst size of 10,500 bytes per second. For the TG1-BestEffort class, the maximum rate is
200,000 bits/second, with a maximum burst of 37,500 bytes/second. Traffic in the TG1-voice class has
no policed maximum speed or burst rate because it belongs to a priority class.
hostname(config)# access-list tcp_traffic permit tcp any any
hostname(config)# class-map tcp_traffic
hostname(config-cmap)# match access-list tcp_traffic
hostname(config)# class-map TG1-voice
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# match dscp ef
hostname(config-cmap)# class-map TG1-BestEffort
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# match flow ip destination-address
hostname(config)# policy-map qos
hostname(config-pmap)# class tcp_traffic
hostname(config-pmap-c)# police output 56000 10500
hostname(config-pmap-c)# class TG1-voice
hostname(config-pmap-c)# priority
hostname(config-pmap-c)# class TG1-best-effort
hostname(config-pmap-c)# police output 200000 37500
hostname(config-pmap-c)# class class-default
hostname(config-pmap-c)# police output 1000000 37500
hostname(config-pmap-c)# service-policy qos global

Configuring a Service Rule for Traffic Shaping and Hierarchical Priority
Queuing
You can configure traffic shaping for all traffic on an interface, and optionally hierarchical priority
queuing for a subset of latency-sensitive traffic.
This section includes the following topics:
•

(Optional) Configuring the Hierarchical Priority Queuing Policy, page 54-12

•

Configuring the Service Rule, page 54-13

(Optional) Configuring the Hierarchical Priority Queuing Policy
You can optionally configure priority queuing for a subset of latency-sensitive traffic.

Guidelines
•

One side-effect of priority queuing is packet re-ordering. For IPsec packets, out-of-order packets
that are not within the anti-replay window generate warning syslog messages. These warnings are
false alarms in the case of priority queuing. You can configure the IPsec anti-replay window size to
avoid possible false alarms. See the crypto ipsec security-association replay command in the
command reference.For hierarchical priority queuing, you do not need to create a priority queue on
an interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-12

Chapter 54

Configuring QoS
Configuring QoS

Restrictions
•

For hierarchical priority queuing, for encrypted VPN traffic, you can only match traffic based on the
DSCP or precedence setting; you cannot match a tunnel group.

•

For hierarchical priority queuing, IPsec-over-TCP traffic is not supported.

Detailed Steps

Step 1

Command

Purpose

class-map priority_map_name

For hierarchical priority queuing, creates a class map to identify
the traffic for which you want to perform priority queuing.

Example:
hostname(config)# class-map
priority_traffic

Step 2

hostname(config-cmap)# match access-list
priority

Specifies the traffic in the class map. See the “Identifying Traffic
(Layer 3/4 Class Maps)” section on page 32-12 for more
information. For encrypted VPN traffic, you can only match
traffic based on the DSCP or precedence setting; you cannot
match a tunnel group.

policy-map priority_map_name

Creates a policy map.

match parameter

Example:

Step 3

Example:
hostname(config)# policy-map
priority-sub-policy

Step 4

class priority_map_name

Specifies the class map you created in Step 1.

Example:
hostname(config-pmap)# class
priority-sub-map

Step 5

Applies the priority queuing action to a class map.

priority

Note

Example:
hostname(config-pmap-c)# priority

This policy has not yet been activated. You must activate
it as part of the shaping policy. See the “Configuring the
Service Rule” section on page 54-13.

Configuring the Service Rule
To configure traffic shaping and optional hiearchical priority queuing, perform the following steps.

Restrictions
•

Traffic shaping is not supported on the multi-processor models.

•

For traffic shaping, you can only use the class-default class map, which is automatically created by
the ASA, and which matches all traffic.

•

You cannot configure traffic shaping and standard priority queuing for the same interface; only
hierarchical priority queuing is allowed. See the “How QoS Features Interact” section on page 54-4
for information about valid QoS configurations.

•

You cannot configure traffic shaping in the global policy.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-13

Chapter 54

Configuring QoS

Configuring QoS

Detailed Steps

Step 1

Command

Purpose

policy-map name

Adds or edits a policy map. This policy map must be different
from the hierarchical priority-queuing map.

Example:
hostname(config)# policy-map shape_policy

Step 2

class class-default

Example:

Identifies all traffic for traffic shaping; you can only use the
class-default class map, which is defined as match any, because
the ASA requires all traffic to be matched for traffic shaping.

hostname(config-pmap)# class class-default

Step 3

shape average rate [burst_size]

Example:
hostname(config-pmap-c)# shape average
70000 4000

Enables traffic shaping, where the average rate argument sets the
average rate of traffic in bits per second over a given fixed time
period, between 64000 and 154400000. Specify a value that is a
multiple of 8000. See the “Information About Traffic Shaping”
section on page 54-4 for more information about how the time
period is calculated.
The burst_size argument sets the average burst size in bits that can
be transmitted over a given fixed time period, between 2048 and
154400000. Specify a value that is a multiple of 128. If you do not
specify the burst_size, the default value is equivalent to
4-milliseconds of traffic at the specified average rate. For
example, if the average rate is 1000000 bits per second, 4 ms
worth = 1000000 * 4/1000 = 4000.

Step 4

(Optional)
service-policy priority_policy_map_name

Configures hierarchical priority queuing, where the
priority_policy_map_name is the policy map you created for
prioritized traffic in the “(Optional) Configuring the Hierarchical
Priority Queuing Policy” section on page 54-12.

Example:
hostname(config-pmap-c)# service-policy
priority-sub-policy

Step 5

service-policy policymap_name interface
interface_name

Activates the shaping policy map on an interface.

Example:
hostname(config)# service-policy
shape-policy interface inside

Examples
The following example enables traffic shaping on the outside interface, and limits traffic to 2 Mbps;
priority queuing is enabled for VoIP traffic that is tagged with DSCP EF and AF13 and for IKE traffic:
hostname(config)# access-list ike permit udp any any eq 500
hostname(config)# class-map ike
hostname(config-cmap)# match access-list ike
hostname(config-cmap)# class-map voice_traffic
hostname(config-cmap)# match dscp EF AF13
hostname(config-cmap)# policy-map qos_class_policy

Cisco ASA 5500 Series Configuration Guide using the CLI

54-14

Chapter 54

Configuring QoS
Monitoring QoS

hostname(config-pmap)# class voice_traffic
hostname(config-pmap-c)# priority
hostname(config-pmap-c)# class ike
hostname(config-pmap-c)# priority
hostname(config-pmap-c)# policy-map qos_outside_policy
hostname(config-pmap)# class class-default
hostname(config-pmap-c)# shape average 2000000 16000
hostname(config-pmap-c)# service-policy qos_class_policy
hostname(config-pmap-c)# service-policy qos_outside_policy interface outside

Monitoring QoS
This section includes the following topics:
•

Viewing QoS Police Statistics, page 54-15

•

Viewing QoS Standard Priority Statistics, page 54-16

•

Viewing QoS Shaping Statistics, page 54-16

•

Viewing QoS Standard Priority Queue Statistics, page 54-17

Viewing QoS Police Statistics
To view the QoS statistics for traffic policing, use the show service-policy command with the police
keyword:
hostname# show service-policy police

The following is sample output for the show service-policy police command:
hostname# show service-policy police
Global policy:
Service-policy: global_fw_policy
Interface outside:
Service-policy: qos
Class-map: browse
police Interface outside:
cir 56000 bps, bc 10500 bytes
conformed 10065 packets, 12621510 bytes; actions: transmit
exceeded 499 packets, 625146 bytes; actions: drop
conformed 5600 bps, exceed 5016 bps
Class-map: cmap2
police Interface outside:
cir 200000 bps, bc 37500 bytes
conformed 17179 packets, 20614800 bytes; actions: transmit
exceeded 617 packets, 770718 bytes; actions: drop
conformed 198785 bps, exceed 2303 bps

Cisco ASA 5500 Series Configuration Guide using the CLI

54-15

Chapter 54

Configuring QoS

Monitoring QoS

Viewing QoS Standard Priority Statistics
To view statistics for service policies implementing the priority command, use the show service-policy
command with the priority keyword:
hostname# show service-policy priority

The following is sample output for the show service-policy priority command:
hostname# show service-policy priority
Global policy:
Service-policy: global_fw_policy
Interface outside:
Service-policy: qos
Class-map: TG1-voice
Priority:
Interface outside: aggregate drop 0, aggregate transmit 9383

Note

“Aggregate drop” denotes the aggregated drop in this interface; “aggregate transmit” denotes the
aggregated number of transmitted packets in this interface.

Viewing QoS Shaping Statistics
To view statistics for service policies implementing the shape command, use the show service-policy
command with the shape keyword:
hostname# show service-policy shape

The following is sample output for the show service-policy shape command:
hostname# show service-policy shape
Interface outside
Service-policy: shape
Class-map: class-default
Queueing
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0
shape (average) cir 2000000, bc 8000, be 8000

The following is sample output of the show service policy shape command, which includes service
policies that include the shape command and the service-policy command that calls the hierarchical
priority policy and the related statistics:
hostname# show service-policy shape
Interface outside:
Service-policy: shape
Class-map: class-default
Queueing
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0
shape (average) cir 2000000, bc 16000, be 16000

Cisco ASA 5500 Series Configuration Guide using the CLI

54-16

Chapter 54

Configuring QoS
Monitoring QoS

Service-policy: voip
Class-map: voip
Queueing
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0
Class-map: class-default
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0

Viewing QoS Standard Priority Queue Statistics
To display the priority-queue statistics for an interface, use the show priority-queue statistics command
in privileged EXEC mode. The results show the statistics for both the best-effort (BE) queue and the
low-latency queue (LLQ). The following example shows the use of the show priority-queue statistics
command for the interface named test, and the command output.
hostname# show priority-queue statistics test
Priority-Queue Statistics interface test
Queue Type
Packets Dropped
Packets Transmit
Packets Enqueued
Current Q Length
Max Q Length

=
=
=
=
=
=

BE
0
0
0
0
0

Queue Type
Packets Dropped
Packets Transmit
Packets Enqueued
Current Q Length
Max Q Length
hostname#

=
=
=
=
=
=

LLQ
0
0
0
0
0

In this statistical report, the meaning of the line items is as follows:
•

“Packets Dropped” denotes the overall number of packets that have been dropped in this queue.

•

“Packets Transmit” denotes the overall number of packets that have been transmitted in this queue.

•

“Packets Enqueued” denotes the overall number of packets that have been queued in this queue.

•

“Current Q Length” denotes the current depth of this queue.

•

“Max Q Length” denotes the maximum depth that ever occurred in this queue.

Cisco ASA 5500 Series Configuration Guide using the CLI

54-17

Chapter 54

Configuring QoS

Feature History for QoS

Feature History for QoS
Table 54-3 lists each feature change and the platform release in which it was implemented.
Table 54-3

Feature History for QoS

Feature Name

Platform
Releases

Feature Information

Priority queuing and policing

7.0(1)

We introduced QoS priority queuing and policing.
We introduced the following commands: priority-queue,
queue-limit, tx-ring-limit, priority, police, show
priority-queue statistics, show service-policy police,
show service-policy priority, show running-config
priority-queue, clear configure priority-queue .

Shaping and hierarchical priority queuing

7.2(4)/8.0(4)

We introduced QoS shaping and hierarchical priority
queuing.
We introduced the following commands: shape, show
service-policy shape.

Ten Gigabit Ethernet support for a standard
priority queue on the ASA 5585-X

8.2(3)/8.4(1)

Cisco ASA 5500 Series Configuration Guide using the CLI

54-18

We added support for a standard priority queue on Ten
Gigabit Ethernet interfaces for the ASA 5585-X.

PA R T

13

Configuring Advanced Network Protection

CH A P T E R

55

Configuring the Botnet Traffic Filter
Malware is malicious software that is installed on an unknowing host. Malware that attempts network
activity such as sending private data (passwords, credit card numbers, key strokes, or proprietary data)
can be detected by the Botnet Traffic Filter when the malware starts a connection to a known bad IP
address. The Botnet Traffic Filter checks incoming and outgoing connections against a dynamic database
of known bad domain names and IP addresses (the blacklist), and then logs or blocks any suspicious
activity.
You can also supplement the Cisco dynamic database with blacklisted addresses of your choosing by
adding them to a static blacklist; if the dynamic database includes blacklisted addresses that you think
should not be blacklisted, you can manually enter them into a static whitelist. Whitelisted addresses still
generate syslog messages, but because you are only targeting blacklist syslog messages, they are
informational.

Note

If you do not want to use the Cisco dynamic database at all, because of internal requirements, you can
use the static blacklist alone if you can identify all the malware sites that you want to target.
This chapter describes how to configure the Botnet Traffic Filter and includes the following sections:
•

Information About the Botnet Traffic Filter, page 55-1

•

Licensing Requirements for the Botnet Traffic Filter, page 55-6

•

Guidelines and Limitations, page 55-6

•

Default Settings, page 55-6

•

Configuring the Botnet Traffic Filter, page 55-6

•

Monitoring the Botnet Traffic Filter, page 55-17

•

Configuration Examples for the Botnet Traffic Filter, page 55-19

•

Where to Go Next, page 55-21

•

Feature History for the Botnet Traffic Filter, page 55-22

Information About the Botnet Traffic Filter
This section includes information about the Botnet Traffic Filter and includes the following topics:
•

Botnet Traffic Filter Address Types, page 55-2

•

Botnet Traffic Filter Actions for Known Addresses, page 55-2

Cisco ASA 5500 Series Configuration Guide using the CLI

55-1

Chapter 55

Configuring the Botnet Traffic Filter

Information About the Botnet Traffic Filter

•

Botnet Traffic Filter Databases, page 55-2

•

How the Botnet Traffic Filter Works, page 55-5

Botnet Traffic Filter Address Types
Addresses monitored by the Botnet Traffic Filter include:
•

Known malware addresses—These addresses are on the blacklist identified by the dynamic database
and the static blacklist.

•

Known allowed addresses—These addresses are on the whitelist. The whitelist is useful when an
address is blacklisted by the dynamic database and also identified by the static whitelist.

•

Ambiguous addresses—These addresses are associated with multiple domain names, but not all of
these domain names are on the blacklist. These addresses are on the greylist.

•

Unlisted addresses—These addresses are unknown, and not included on any list.

Botnet Traffic Filter Actions for Known Addresses
You can configure the Botnet Traffic Filter to log suspicious activity, and you can optionally configure
it to block suspicious traffic automatically.
Unlisted addresses do not generate any syslog messages, but addresses on the blacklist, whitelist, and
greylist generate syslog messages differentiated by type. See the “Botnet Traffic Filter Syslog
Messaging” section on page 55-17 for more information.

Botnet Traffic Filter Databases
The Botnet Traffic Filter uses two databases for known addresses. You can use both databases together,
or you can disable use of the dynamic database and use the static database alone. This section includes
the following topics:
•

Information About the Dynamic Database, page 55-2

•

Information About the Static Database, page 55-3

•

Information About the DNS Reverse Lookup Cache and DNS Host Cache, page 55-4

Information About the Dynamic Database
The Botnet Traffic Filter can receive periodic updates for the dynamic database from the Cisco update
server. This database lists thousands of known bad domain names and IP addresses.

How the ASA Uses the Dynamic Database
The ASA uses the dynamic database as follows:
1.

When the domain name in a DNS reply matches a name in the dynamic database, the Botnet Traffic
Filter adds the name and IP address to the DNS reverse lookup cache.

2.

When the infected host starts a connection to the IP address of the malware site, then the ASA sends
a syslog message informing you of the suspicious activity and optionally drops the traffic if you
configured the ASA to do so.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-2

Chapter 55

Configuring the Botnet Traffic Filter
Information About the Botnet Traffic Filter

3.

In some cases, the IP address itself is supplied in the dynamic database, and the Botnet Traffic Filter
logs or drops any traffic to that IP address without having to inspect DNS requests.

Database Files
The database files are stored in running memory; they are not stored in flash memory. If you need to
delete the database, use the dynamic-filter database purge command instead. Be sure to first disable
use of the database by entering the no dynamic-filter use-database command.

Note

To use the database, be sure to configure a domain name server for the ASA so that it can access the URL.
To use the domain names in the dynamic database, you need to enable DNS packet inspection with
Botnet Traffic Filter snooping; the ASA looks inside the DNS packets for the domain name and
associated IP address.

Database Traffic Types
The dynamic database includes the following types of addresses:
•

Ads—Advertising networks that deliver banner ads, interstitials, rich media ads, pop-ups, and
pop-unders for websites, spyware and adware. Some of these networks send ad-oriented HTML
emails and email verification services.

•

Data Tracking—Sources associated with companies and websites that offer data tracking and
metrics services to websites and other online entities. Some of these also run small advertising
networks.

•

Spyware—Sources that distribute spyware, adware, greyware, and other potentially unwanted
advertising software. Some of these also run exploits to install such software.

•

Malware (higher threat level)—Sources that use various exploits to deliver adware, spyware and
other malware to victim computers. Some of these are associated with rogue online vendors and
distributors of dialers which deceptively call premium-rate phone numbers.

•

Malware (lower threat level)—Sources that deliver deceptive or malicious anti-spyware,
anti-malware, registry cleaning, and system cleaning software.

•

Adult—Sources associated with adult networks/services offering web hosting for adult content,
advertising, content aggregation, registration and billing, and age verification. These may be tied to
distribution of adware, spyware, and dialers.

•

Bot and Threat Networks—Rogue systems that control infected computers. They are either systems
hosted on threat networks or systems that are part of the botnet itself."

•

(Conficker) Bot and Threat Networks—Command-and-control servers or botnet-masters of
conficker botnets.

•

(ZeusBotnet) Bot and Threat Networks—Command-and-control servers or botnet-masters of Zeus
botnets.

Information About the Static Database
You can manually enter domain names or IP addresses (host or subnet) that you want to tag as bad names
in a blacklist. Static blacklist entries are always designated with a Very High threat level. You can also
enter names or IP addresses in a whitelist, so that names or addresses that appear on both the dynamic

Cisco ASA 5500 Series Configuration Guide using the CLI

55-3

Chapter 55

Configuring the Botnet Traffic Filter

Information About the Botnet Traffic Filter

blacklist and the whitelist are identified only as whitelist addresses in syslog messages and reports. Note
that you see syslog messages for whitelisted addresses even if the address is not also in the dynamic
blacklist.
When you add a domain name to the static database, the ASA waits 1 minute, and then sends a DNS
request for that domain name and adds the domain name/IP address pairing to the DNS host cache. (This
action is a background process, and does not affect your ability to continue configuring the ASA). We
recommend also enabling DNS packet inspection with Botnet Traffic Filter snooping. The ASA uses
Botnet Traffic Filter snooping instead of the regular DNS lookup to resolve static blacklist domain names
in the following circumstances:
•

The ASA DNS server is unavailable.

•

A connection is initiated during the 1 minute waiting period before the ASA sends the regular DNS
request.

If DNS snooping is used, when an infected host sends a DNS request for a name on the static database,
the ASA looks inside the DNS packets for the domain name and associated IP address and adds the name
and IP address to the DNS reverse lookup cache.
If you do not enable Botnet Traffic Filter snooping, and one of the above circumstances occurs, then that
traffic will not be monitored by the Botnet Traffic Filter.

Information About the DNS Reverse Lookup Cache and DNS Host Cache
When you use the dynamic database with DNS snooping, entries are added to the DNS reverse lookup
cache. If you use the static database, entries are added to the DNS host cache (see the “Information
About the Static Database” section on page 55-3 about using the static database with DNS snooping and
the DNS reverse lookup cache).
Entries in the DNS reverse lookup cache and the DNS host cache have a time to live (TTL) value
provided by the DNS server. The largest TTL value allowed is 1 day (24 hours); if the DNS server
provides a larger TTL, it is truncated to 1 day maximum.
For the DNS reverse lookup cache, after an entry times out, the ASA renews the entry when an infected
host initiates a connection to a known address, and DNS snooping occurs.
For the DNS host cache, after an entry times out, the ASA periodically requests a refresh for the entry.
For the DNS host cache, the maximum number of blacklist entries and whitelist entries is 1000 each.
Table 55-1 lists the maximum number of entries in the DNS reverse lookup cache per model.
Table 55-1

DNS Reverse Lookup Cache Entries per Model

ASA Model

Maximum Entries

ASA 5505

5000

ASA 5510

10,000

ASA 5520

20,000

ASA 5540

40,000

ASA 5550

40,000

ASA 5580

100,000

Cisco ASA 5500 Series Configuration Guide using the CLI

55-4

Chapter 55

Configuring the Botnet Traffic Filter
Information About the Botnet Traffic Filter

How the Botnet Traffic Filter Works
Figure 55-1 shows how the Botnet Traffic Filter works with the dynamic database plus DNS inspection
with Botnet Traffic Filter snooping.
Figure 55-1

How the Botnet Traffic Filter Works with the Dynamic Database

Security Appliance
DNS
Reverse
Lookup Cache

Infected
Host

3

DNS Server

1a. Match?

DNS Snoop

3a. Match?

2

DNS Reply:
209.165.201.3

Internet

Connection to:
209.165.201.3

Syslog Server

2a. Add

Botnet Traffic
Filter
3b. Send
Syslog Message/Drop Traffic

248631

DNS Request:
1
bad.example.com

Dynamic
Database

Malware Home Site
209.165.201.3

Figure 55-2 shows how the Botnet Traffic Filter works with the static database.
Figure 55-2

How the Botnet Traffic Filter Works with the Static Database

Security Appliance
DNS
Host Cache
3a. Match?
Connection to:
3
209.165.201.3
Infected
Host

Add entry:
Static 1 bad.example.com
Database
DNS Server

2a. Add

1a. DNS Request:
bad.example.com

2
Internet

DNS Reply:
209.165.201.3

Syslog Server

3b. Send
Syslog Message/Drop Traffic

248632

Botnet Traffic
Filter

Malware Home Site
209.165.201.3

Cisco ASA 5500 Series Configuration Guide using the CLI

55-5

Chapter 55

Configuring the Botnet Traffic Filter

Licensing Requirements for the Botnet Traffic Filter

Licensing Requirements for the Botnet Traffic Filter
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

You need the following licenses:
•

Botnet Traffic Filter License.

•

Strong Encryption (3DES/AES) License to download the dynamic database.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Failover Guidelines

Does not support replication of the DNS reverse lookup cache, DNS host cache, or the dynamic database
in Stateful Failover.
IPv6 Guidelines

Does not support IPv6.
Additional Guidelines and Limitations
•

TCP DNS traffic is not supported.

•

You can add up to 1000 blacklist entries and 1000 whitelist entries in the static database.

Default Settings
By default, the Botnet Traffic Filter is disabled, as is use of the dynamic database.
For DNS inspection, which is enabled by default, Botnet Traffic Filter snooping is disabled by default.

Configuring the Botnet Traffic Filter
This section includes the following topics:
•

Task Flow for Configuring the Botnet Traffic Filter, page 55-7

•

Configuring the Dynamic Database, page 55-7

Cisco ASA 5500 Series Configuration Guide using the CLI

55-6

Chapter 55

Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter

•

Enabling DNS Snooping, page 55-10

•

Adding Entries to the Static Database, page 55-9

•

Enabling Traffic Classification and Actions for the Botnet Traffic Filter, page 55-12

•

Blocking Botnet Traffic Manually, page 55-15

•

Searching the Dynamic Database, page 55-16

Task Flow for Configuring the Botnet Traffic Filter
To configure the Botnet Traffic Filter, perform the following steps:
Step 1

Enable use of the dynamic database. See the “Configuring the Dynamic Database” section on page 55-7.
This procedure enables database updates from the Cisco update server, and also enables use of the
downloaded dynamic database by the ASA. Disallowing use of the downloaded database is useful in
multiple context mode so you can configure use of the database on a per-context basis.

Step 2

(Optional) Add static entries to the database. See the “Adding Entries to the Static Database” section on
page 55-9.
This procedure lets you augment the dynamic database with domain names or IP addresses that you want
to blacklist or whitelist. You might want to use the static database instead of the dynamic database if you
do not want to download the dynamic database over the Internet.

Step 3

Enable DNS snooping. See the “Enabling DNS Snooping” section on page 55-10.
This procedure enables inspection of DNS packets, compares the domain name with those in the
dynamic database or the static database (when a DNS server for the ASA is unavailable), and adds the
name and IP address to the DNS reverse lookup cache. This cache is then used by the Botnet Traffic
Filter when connections are made to the suspicious address.

Step 4

Enable traffic classification and actions for the Botnet Traffic Filter. See the “Enabling Traffic
Classification and Actions for the Botnet Traffic Filter” section on page 55-12.
This procedure enables the Botnet Traffic Filter, which compares the source and destination IP address
in each initial connection packet to the IP addresses in the dynamic database, static database, DNS
reverse lookup cache, and DNS host cache, and sends a syslog message or drops any matching traffic.

Step 5

(Optional) Block traffic manually based on syslog message information. See the “Blocking Botnet
Traffic Manually” section on page 55-15.
If you choose not to block malware traffic automatically, you can block traffic manually by configuring
an access list to deny traffic, or by using the shun command to block all traffic to and from a host.

Configuring the Dynamic Database
This procedure enables database updates, and also enables use of the downloaded dynamic database by
the ASA. Disabling use of the downloaded database is useful in multiple context mode so you can
configure use of the database on a per-context basis.
By default, downloading and using the dynamic database is disabled.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-7

Chapter 55

Configuring the Botnet Traffic Filter

Configuring the Botnet Traffic Filter

Prerequisites
Enable ASA use of a DNS server according to the “Configuring the DNS Server” section on page 10-11.

Detailed Steps

Step 1

Command

Purpose

dynamic-filter updater-client enable

Enables downloading of the dynamic database from the Cisco
update server. In multiple context mode, enter this command in
the system execution space. If you do not have a database already
installed on the ASA, it downloads the database after
approximately 2 minutes. The update server determines how often
the ASA polls the server for future updates, typically every hour.

Example:
hostname(config)# dynamic-filter
updater-client enable

Step 2

(Multiple context mode only)
changeto context context_name

Changes to the context so that you can configure use of the
database on a per-context basis.

Example:
hostname# changeto context admin
hostname/admin#

Step 3

dynamic-filter use-database

Enables use of the dynamic database. In multiple context mode,
enter this command in the context execution space.

Example:
hostname(config)# dynamic-filter
use-database

Examples
The following multiple mode example enables downloading of the dynamic database, and enables use
of the database in context1 and context2:
hostname(config)# dynamic-filter updater-client enable
hostname(config)# changeto context context1
hostname/context1(config)# dynamic-filter use-database
hostname/context1(config)# changeto context context2
hostname/context2(config)# dynamic-filter use-database

The following single mode example enables downloading of the dynamic database, and enables use of
the database:
hostname(config)# dynamic-filter updater-client enable
hostname(config)# dynamic-filter use-database

What to Do Next
See the “Adding Entries to the Static Database” section on page 55-9.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-8

Chapter 55

Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter

Adding Entries to the Static Database
The static database lets you augment the dynamic database with domain names or IP addresses that you
want to blacklist or whitelist. Static blacklist entries are always designated with a Very High threat level.
See the “Information About the Static Database” section on page 55-3 for more information.

Prerequisites
•

In multiple context mode, perform this procedure in the context execution space.

•

Enable ASA use of a DNS server according to the “Configuring the DNS Server” section on
page 10-11.

Detailed Steps

Step 1

Command

Purpose

dynamic-filter blacklist

Edits the Botnet Traffic Filter blacklist.

Example:
hostname(config)# dynamic-filter blacklist

Step 2

Enter one or both of the following:
name domain_name

Adds a name to the blacklist. You can enter this
command multiple times for multiple entries. You can
add up to 1000 blacklist entries.

Example:
hostname(config-llist)# name bad.example.com
address ip_address mask

Adds an IP address to the blacklist. You can enter this
command multiple times for multiple entries. The
mask can be for a single host or for a subnet.

Example:
hostname(config-llist)# address 10.1.1.1
255.255.255.255

Step 3

dynamic-filter whitelist

Edits the Botnet Traffic Filter whitelist.

Example:
hostname(config)# dynamic-filter whitelist

Step 4

Enter one or both of the following:

Cisco ASA 5500 Series Configuration Guide using the CLI

55-9

Chapter 55

Configuring the Botnet Traffic Filter

Configuring the Botnet Traffic Filter

Command

Purpose

name domain_name

Adds a name to the whitelist. You can enter this
command multiple times for multiple entries. You can
add up to 1000 whitelist entries.

Example:
hostname(config-llist)# name good.example.com
address ip_address mask

Adds an IP address to the whitelist. You can enter this
command multiple times for multiple entries. The
mask can be for a single host or for a subnet.

Example:
hostname(config-llist)# address 10.1.1.2
255.255.255.255

Examples
The following example creates entries for the blacklist and whitelist:
hostname(config)# dynamic-filter blacklist
hostname(config-llist)# name bad1.example.com
hostname(config-llist)# name bad2.example.com
hostname(config-llist)# address 10.1.1.1 255.255.255.0
hostname(config-llist)# dynamic-filter whitelist
hostname(config-llist)# name good.example.com
hostname(config-llist)# name great.example.com
hostname(config-llist)# name awesome.example.com
hostname(config-llist)# address 10.1.1.2 255.255.255.255

What to Do Next
See the “Enabling DNS Snooping” section on page 55-10.

Enabling DNS Snooping
This procedure enables inspection of DNS packets and enables Botnet Traffic Filter snooping, which
compares the domain name with those on the dynamic database or static database, and adds the name
and IP address to the Botnet Traffic Filter DNS reverse lookup cache. This cache is then used by the
Botnet Traffic Filter when connections are made to the suspicious address.
The following procedure creates an interface-specific service policy for DNS inspection. See the “DNS
Inspection” section on page 43-1 and Chapter 32, “Configuring a Service Policy Using the Modular
Policy Framework,” for detailed information about configuring advanced DNS inspection options using
the Modular Policy Framework.

Prerequisites
In multiple context mode, perform this procedure in the context execution space.

Restrictions
TCP DNS traffic is not supported.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-10

Chapter 55

Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter

Default DNS Inspection Configuration and Recommended Configuration
The default configuration for DNS inspection inspects all UDP DNS traffic on all interfaces, and does
not have DNS snooping enabled.
We suggest that you enable DNS snooping only on interfaces where external DNS requests are going.
Enabling DNS snooping on all UDP DNS traffic, including that going to an internal DNS server, creates
unnecessary load on the ASA.
For example, if the DNS server is on the outside interface, you should enable DNS inspection with
snooping for all UDP DNS traffic on the outside interface. See the “Examples” section for the
recommended commands for this configuration.

Detailed Steps

Step 1

Command

Purpose

class-map name

Creates a class map to identify the traffic for which you want to
inspect DNS.

Example:
hostname(config)# class-map
dynamic-filter_snoop_class

Step 2

match parameters

Example:
hostname(config-cmap)# match port udp eq
domain

Step 3

policy-map name

Specifies traffic for the class map. See the “Identifying Traffic
(Layer 3/4 Class Maps)” section on page 32-12 for more
information about available parameters. For example, you can
specify an access list for DNS traffic to and from certain
addresses, or you can specify all UDP DNS traffic.
Adds or edits a policy map so you can set the actions to take with
the class map traffic.

Example:
hostname(config)# policy-map
dynamic-filter_snoop_policy

Step 4

class name

Identifies the class map you created in Step 1.

Example:
hostname(config-pmap)# class
dynamic-filter_snoop_class

Cisco ASA 5500 Series Configuration Guide using the CLI

55-11

Chapter 55

Configuring the Botnet Traffic Filter

Configuring the Botnet Traffic Filter

Step 5

Command

Purpose

inspect dns [map_name]
dynamic-filter-snoop

Enables DNS inspection with Botnet Traffic Filter snooping. To
use the default DNS inspection policy map for the map_name,
specify preset_dns_map for the map name. See the “DNS
Inspection” section on page 43-1 for more information about
creating a DNS inspection policy map.

Example:
hostname(config-pmap-c)# inspect dns
preset_dns_map dynamic-filter-snoop

Step 6

service-policy policymap_name interface
interface_name

Activates the policy map on an interface. The interface-specific
policy overrides the global policy. You can only apply one policy
map to each interface.

Example:
hostname(config)# service-policy
dynamic-filter_snoop_policy interface
outside

Examples
The following recommended configuration creates a class map for all UDP DNS traffic, enables DNS
inspection and Botnet Traffic Filter snooping with the default DNS inspection policy map, and applies
it to the outside interface:
hostname(config)# class-map dynamic-filter_snoop_class
hostname(config-cmap)# match port udp eq domain
hostname(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname(config-pmap)# class dynamic-filter_snoop_class
hostname(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface outside

What to Do Next
See the “Enabling Traffic Classification and Actions for the Botnet Traffic Filter” section on page 55-12.

Enabling Traffic Classification and Actions for the Botnet Traffic Filter
This procedure enables the Botnet Traffic Filter. The Botnet Traffic Filter compares the source and
destination IP address in each initial connection packet to the following:
•

Dynamic database IP addresses

•

Static database IP addresses

•

DNS reverse lookup cache (for dynamic database domain names)

•

DNS host cache (for static database domain names)

When an address matches, the ASA sends a syslog message. The only additional action currently
available is to drop the connection.

Prerequisites
In multiple context mode, perform this procedure in the context execution space.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-12

Chapter 55

Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter

Recommended Configuration
Although DNS snooping is not required, we recommend configuring DNS snooping for maximum use
of the Botnet Traffic Filter (see the “Enabling DNS Snooping” section on page 55-10). Without DNS
snooping for the dynamic database, the Botnet Traffic Filter uses only the static database entries, plus
any IP addresses in the dynamic database; domain names in the dynamic database are not used.
We recommend enabling the Botnet Traffic Filter on all traffic on the Internet-facing interface, and
enabling dropping of traffic with a severity of moderate and higher. See the “Examples” section for the
recommended commands used for this configuration.

Detailed Steps

Step 1

Command

Purpose

(Optional)

Identifies the traffic that you want to monitor or drop. If you do
not create an access list for monitoring, by default you monitor all
traffic. You can optionally use an access list to identify a subset of
monitored traffic that you want to drop; be sure the access list is
a subset of the monitoring access list. See Chapter 15, “Adding an
Extended Access List,” for more information about creating an
access list.

access-list access_list_name extended
{deny | permit} protocol source_address
mask [operator port] dest_address mask
[operator port]

Example:
hostname(config)# access-list
dynamic-filter_acl extended permit tcp any
any eq 80
hostname(config)# access-list
dynamic-filter_acl_subset extended permit
tcp 10.1.1.0 255.255.255.0 any eq 80

Step 2

dynamic-filter enable [interface name]
[classify-list access_list]

Example:
hostname(config)# dynamic-filter enable
interface outside classify-list
dynamic-filter_acl

Enables the Botnet Traffic Filter; without any options, this
command monitors all traffic.
We recommend enabling the Botnet Traffic Filter on all traffic on
the Internet-facing interface using the interface keyword.
You can optionally limit monitoring to specific traffic by using the
classify-list keyword with an access list.
You can enter this command one time for each interface and one
time for the global policy (where you do not specify the interface
keyword). Each interface and global command can have an
optional classify-list keyword. Any interface-specific commands
take precedence over the global command.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-13

Chapter 55

Configuring the Botnet Traffic Filter

Configuring the Botnet Traffic Filter

Step 3

Command

Purpose

(Optional)

Automatically drops malware traffic. To manually drop traffic,
see the “Blocking Botnet Traffic Manually” section on
page 55-15.

dynamic-filter drop blacklist [interface
name] [action-classify-list
subset_access_list] [threat-level {eq
level | range min max}]

Example:
hostname(config)# dynamic-filter drop
blacklist interface outside
action-classify-list
dynamic-filter_acl_subset threat-level
range moderate very-high

Be sure to first configure a dynamic-filter enable command to
monitor any traffic you also want to drop.
You can set an interface policy using the interface keyword, or a
global policy (where you do not specify the interface keyword).
Any interface-specific commands take precedence over the global
command. You can enter this command multiple times for each
interface and global policy.
The action-classify-list keyword limits the traffic dropped to a
subset of monitored traffic. The dropped traffic must always be
equal to or a subset of the monitored traffic. For example, if you
specify an access list for the dynamic-filter enable command,
and you specify the action-classify-list for this command, then it
must be a subset of the dynamic-filter enable access list.
Make sure you do not specify overlapping traffic in multiple
commands for a given interface/global policy. Because you
cannot control the exact order that commands are matched,
overlapping traffic means you do not know which command will
be matched. For example, do not specify both a command that
matches all traffic (without the action-classify-list keyword) as
well as a command with the action-classify-list keyword for a
given interface. In this case, the traffic might never match the
command with the action-classify-list keyword. Similarly, if you
specify multiple commands with the action-classify-list
keyword, make sure each access list is unique, and that the
networks do not overlap.
You can additionally limit the traffic dropped by setting the threat
level. If you do not explicitly set a threat level, the level used is
threat-level range moderate very-high.
Note

We highly recommend using the default setting unless you
have strong reasons for changing the setting.

The level and min and max options are:
•

very-low

•

low

•

moderate

•

high

•

very-high

Note

Cisco ASA 5500 Series Configuration Guide using the CLI

55-14

Static blacklist entries are always designated with a Very
High threat level.

Chapter 55

Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter

Step 4

Command

Purpose

(Optional)

If you configured the dynamic-filter drop blacklist command,
then this command treats greylisted traffic as blacklisted traffic
for dropping purposes. If you do not enable this command,
greylisted traffic will not be dropped. See the “Botnet Traffic
Filter Address Types” section on page 55-2 for more information
about the greylist.

dynamic-filter ambiguous-is-black

Example:
hostname(config)# dynamic-filter
ambiguous-is-black

Examples
The following recommended configuration monitors all traffic on the outside interface and drops all
traffic at a threat level of moderate or higher:
hostname(config)# dynamic-filter enable interface outside
hostname(config)# dynamic-filter drop blacklist interface outside

If you decide not to monitor all traffic, you can limit the traffic using an access list. The following
example monitors only port 80 traffic on the outside interface, and drops traffic threat level very-high
only:
hostname(config)# access-list dynamic-filter_acl extended permit tcp any any eq 80
hostname(config)# dynamic-filter enable interface outside classify-list dynamic-filter_acl
hostname(config)# dynamic-filter drop blacklist interface outside threat-level eq
very-high

Blocking Botnet Traffic Manually
If you choose not to block malware traffic automatically (see the “Enabling Traffic Classification and
Actions for the Botnet Traffic Filter” section on page 55-12), you can block traffic manually by
configuring an access list to deny traffic, or by using the shun command tool to block all traffic to and
from a host.
For example, you receive the following syslog message:
ASA-4-338002: Dynamic Filter permitted black listed TCP traffic from inside:10.1.1.45/6798
(209.165.201.1/7890) to outside:209.165.202.129/80 (209.165.202.129/80), destination
209.165.202.129 resolved from dynamic list: bad.example.com

You can then perform one of the following actions:
•

Create an access list to deny traffic.
For example, using the syslog message above, you might want to deny traffic from the infected host
at 10.1.1.45 to the malware site at 209.165.202.129. Or, if there are many connections to different
blacklisted addresses, you can create an access list to deny all traffic from 10.1.1.45 until you
resolve the infection on the host computer. For example, the following commands deny all traffic
from 10.1.1.5 to 209.165.202.129, but permits all other traffic on the inside interface:
hostname(config)# access-list BLOCK_OUT extended deny ip host 10.1.1.45 host
209.165.202.129
hostname(config)# access-list BLOCK_OUT extended permit ip any any
hostname(config)# access-group BLOCK_OUT in interface inside

Cisco ASA 5500 Series Configuration Guide using the CLI

55-15

Chapter 55

Configuring the Botnet Traffic Filter

Configuring the Botnet Traffic Filter

See Chapter 15, “Adding an Extended Access List,” for more information about creating an access
list, and see Chapter 34, “Configuring Access Rules,” for information about applying the access list
to the interface.

Note

•

Access lists block all future connections. To block the current connection, if it is still active,
enter the clear conn command. For example, to clear only the connection listed in the syslog
message, enter the clear conn address 10.1.1.45 address 209.165.202.129 command. See
the command reference for more information.

Shun the infected host.
Shunning blocks all connections from the host, so you should use an access list if you want to block
connections to certain destination addresses and ports. To shun a host, enter the following command.
To drop the current connection as well as blocking all future connections, enter the destination
address, source port, destination port, and optional protocol.
hostname(config)# shun src_ip [dst_ip src_port dest_port [protocol]]

For example, to block future connections from 10.1.1.45, and also drop the current connection to the
malware site in the syslog message, enter:
hostname(config)# shun 10.1.1.45 209.165.202.129 6798 80

See “Blocking Unwanted Connections” section on page 57-2 for more information about shunning.
After you resolve the infection, be sure to remove the access list or the shun. To remove the shun, enter
no shun src_ip.

Searching the Dynamic Database
If you want to check if a domain name or IP address is included in the dynamic database, you can search
the database for a string.

Detailed Steps

Command

Purpose

dynamic-filter database find string

Searches the dynamic database for a domain name or IP address. The
string can be the complete domain name or IP address, or you can enter
part of the name or address, with a minimum search string of 3 characters.
If there are multiple matches, the first two matches are shown. To refine
your search for a more specific match, enter a longer string.

Example:
hostname# dynamic-filter database find

Note

Regular expressions are not supported for the database search.

Examples
The following example searches on the string “example.com”, and finds 1 match:
hostname# dynamic-filter database find bad.example.com
bad.example.com
Found 1 matches

The following example searches on the string “bad”, and finds more than 2 matches:

Cisco ASA 5500 Series Configuration Guide using the CLI

55-16

Chapter 55

Configuring the Botnet Traffic Filter
Monitoring the Botnet Traffic Filter

hostname# dynamic-filter database find bad
bad.example.com
bad.example.net
Found more than 2 matches, enter a more specific string to find an exact
match

Monitoring the Botnet Traffic Filter
Whenever a known address is classified by the Botnet Traffic Filter, then a syslog message is generated.
You can also monitor Botnet Traffic Filter statistics and other parameters by entering commands on the
ASA. This section includes the following topics:
•

Botnet Traffic Filter Syslog Messaging, page 55-17

•

Botnet Traffic Filter Commands, page 55-17

Botnet Traffic Filter Syslog Messaging
The Botnet Traffic Filter generates detailed syslog messages numbered 338nnn. Messages differentiate
between incoming and outgoing connections, blacklist, whitelist, or greylist addresses, and many other
variables. (The greylist includes addresses that are associated with multiple domain names, but not all
of these domain names are on the blacklist.)
See the syslog message guide for detailed information about syslog messages.

Botnet Traffic Filter Commands
To monitor the Botnet Traffic Filter, enter one of the following commands:
Command

Purpose

show dynamic-filter statistics [interface
name] [detail]

Shows how many connections were classified as whitelist, blacklist, and
greylist connections, and how many connections were dropped. (The
greylist includes addresses that are associated with multiple domain
names, but not all of these domain names are on the blacklist.) The detail
keyword shows how many packets at each threat level were classified or
dropped.
To clear the statistics, enter the clear dynamic-filter statistics [interface
name] command.

show dynamic-filter reports top
[malware-sites | malware-ports |
infected-hosts]

Generates reports of the top 10 malware sites, ports, and infected hosts
monitored. The top 10 malware-sites report includes the number of
connections dropped, and the threat level and category of each site. This
report is a snapshot of the data, and may not match the top 10 items since
the statistics started to be collected.
To clear the report data, enter the clear dynamic-filter reports top
command.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-17

Chapter 55

Configuring the Botnet Traffic Filter

Monitoring the Botnet Traffic Filter

Command

Purpose

show dynamic-filter reports infected-hosts
{max-connections | latest-active |
highest-threat | subnet ip_address netmask
| all}

Generates reports about infected hosts. These reports contain detailed
history about infected hosts, showing the correlation between infected
hosts, visited malware sites, and malware ports. The max-connections
keyword shows the 20 infected hosts with the most number of
connections. The latest-active keyword shows the 20 hosts with the most
recent activity. The highest-threat keyword shows the 20 hosts that
connected to the malware sites with the highest threat level. The subnet
keyword shows up to 20 hosts within the specified subnet. The all
keyword shows all buffered infected-hosts information. This display
might include thousands of entries. You might want to use ASDM to
generate a PDF file instead of using the CLI.
To clear the report data, enter the clear dynamic-filter reports
infected-hosts command.

show dynamic-filter updater-client

Shows information about the updater server, including the server IP
address, the next time the ASA will connect with the server, and the
database version last installed.

show dynamic-filter dns-snoop [detail]

Shows the Botnet Traffic Filter DNS snooping summary, or with the
detail keyword, the actual IP addresses and names. All inspected DNS
data is included in this output, and not just matching names in the
blacklist. DNS data from static entries are not included.
To clear the DNS snooping data, enter the clear dynamic-filter
dns-snoop command.

show dynamic-filter data

Shows information about the dynamic database, including when the
dynamic database was last downloaded, the version of the database, how
many entries the database contains, and 10 sample entries.

show asp table dynamic-filter [hits]

Shows the Botnet Traffic Filter rules that are installed in the accelerated
security path.

Examples
The following is sample output from the show dynamic-filter statistics command:
hostname# show dynamic-filter statistics
Enabled on interface outside
Total conns classified 11, ingress 11, egress 0
Total whitelist classified 0, ingress 0, egress 0
Total greylist classified 0, dropped 0, ingress 0, egress 0
Total blacklist classified 11, dropped 5, ingress 11, egress 0
Enabled on interface inside
Total conns classified 1182, ingress 1182, egress 0
Total whitelist classified 3, ingress 3, egress 0
Total greylist classified 0, dropped 0, ingress 0, egress 0
Total blacklist classified 1179, dropped 1000, ingress 1179, egress 0

The following is sample output from the show dynamic-filter reports top malware-sites command:
hostname# show dynamic-filter reports top malware-sites
Site
Connections logged dropped Threat Level Category
-------------------------------------------------------------------------------------bad1.example.com (10.67.22.34)
11
0
2
Botnet
bad2.example.com (209.165.200.225)
8
8
3
Virus
bad1.cisco.example(10.131.36.158)
6
6
3
Virus
bad2.cisco.example(209.165.201.1)
2
2
3
Trojan

Cisco ASA 5500 Series Configuration Guide using the CLI

55-18

Chapter 55

Configuring the Botnet Traffic Filter
Configuration Examples for the Botnet Traffic Filter

horrible.example.net(10.232.224.2)
nono.example.org(209.165.202.130)

2
1

2
1

3
3

Botnet
Virus

Last clearing of the top sites report: at 13:41:06 UTC Jul 15 2009

The following is sample output from the show dynamic-filter reports top malware-ports command:
hostname# show dynamic-filter reports top malware-ports
Port
Connections logged
---------------------------------------------------------------------tcp 1000
617
tcp 2001
472
tcp 23
22
tcp 1001
19
udp 2000
17
udp 2001
17
tcp 8080
9
tcp 80
3
tcp >8192
2
Last clearing of the top sites report: at 13:41:06 UTC Jul 15 2009

The following is sample output from the show dynamic-filter reports top infected-hosts command:
hostname# show dynamic-filter reports top infected-hosts
Host
Connections logged
---------------------------------------------------------------------10.10.10.51(inside)
1190
10.12.10.10(inside)
10
10.10.11.10(inside)
5
Last clearing of the top infected-hosts report: at 13:41:06 UTC Jul 15 2009

Configuration Examples for the Botnet Traffic Filter
This section includes the recommended configuration for single and multiple context mode, as well as
other possible configurations. This section includes the following topics:
•

Recommended Configuration Example, page 55-19

•

Other Configuration Examples, page 55-20

Recommended Configuration Example
The following recommended example configuration for single context mode enables downloading of the
dynamic database, and enables use of the database. It creates a class map for all UDP DNS traffic,
enables DNS inspection and Botnet Traffic Filter snooping with the default DNS inspection policy map,
and applies it to the outside interface, the Internet-facing interface.
Example 55-1 Single Mode Botnet Traffic Filter Recommended Example
hostname(config)# dynamic-filter updater-client enable
hostname(config)# dynamic-filter use-database
hostname(config)# class-map dynamic-filter_snoop_class
hostname(config-cmap)# match port udp eq domain
hostname(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname(config-pmap)# class dynamic-filter_snoop_class

Cisco ASA 5500 Series Configuration Guide using the CLI

55-19

Chapter 55

Configuring the Botnet Traffic Filter

Configuration Examples for the Botnet Traffic Filter

hostname(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface outside
hostname(config)# dynamic-filter enable interface outside
hostname(config)# dynamic-filter drop blacklist interface outside

The following recommended example configuration for multiple context mode enables the Botnet
Traffic Filter for two contexts:
Example 55-2 Multiple Mode Botnet Traffic Filter Recommended Example
hostname(config)# dynamic-filter updater-client enable
hostname(config)# changeto context context1
hostname/context1(config)# dynamic-filter use-database
hostname/context1(config)# class-map dynamic-filter_snoop_class
hostname/context1(config-cmap)# match port udp eq domain
hostname/context1(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context1(config-pmap)# class dynamic-filter_snoop_class
hostname/context1(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context1(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context1(config)# dynamic-filter enable interface outside
hostname/context1(config)# dynamic-filter drop blacklist interface outside
hostname/context1(config)# changeto context context2
hostname/context2(config)# dynamic-filter use-database
hostname/context2(config)# class-map dynamic-filter_snoop_class
hostname/context2(config-cmap)# match port udp eq domain
hostname/context2(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context2(config-pmap)# class dynamic-filter_snoop_class
hostname/context2(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context2(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context2(config)# dynamic-filter enable interface outside
hostname/context2(config)# dynamic-filter drop blacklist interface outside

Other Configuration Examples
The following sample configuration adds static entries are to the blacklist and to the whitelist. Then, it
monitors all port 80 traffic on the outside interface, and drops blacklisted traffic. It also treats greylist
addresses as blacklisted addresses.
hostname(config)# dynamic-filter updater-client enable
hostname(config)# changeto context context1
hostname/context1(config)# dynamic-filter use-database
hostname/context1(config)# class-map dynamic-filter_snoop_class
hostname/context1(config-cmap)# match port udp eq domain
hostname/context1(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context1(config-pmap)# class dynamic-filter_snoop_class
hostname/context1(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context1(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context1(config-pmap-c)# dynamic-filter blacklist
hostname/context1(config-llist)# name bad1.example.com
hostname/context1(config-llist)# name bad2.example.com

Cisco ASA 5500 Series Configuration Guide using the CLI

55-20

Chapter 55

Configuring the Botnet Traffic Filter
Where to Go Next

hostname/context1(config-llist)# address 10.1.1.1 255.255.255.0
hostname/context1(config-llist)# dynamic-filter whitelist
hostname/context1(config-llist)# name good.example.com
hostname/context1(config-llist)# name great.example.com
hostname/context1(config-llist)# name awesome.example.com
hostname/context1(config-llist)# address 10.1.1.2 255.255.255.255
hostname/context1(config-llist)# access-list dynamic-filter_acl extended permit tcp any
any eq 80
hostname/context1(config)# dynamic-filter enable interface outside classify-list
dynamic-filter_acl
hostname/context1(config)# dynamic-filter drop blacklist interface outside
hostname/context1(config)# dynamic-filter ambiguous-is-black
hostname/context1(config)# changeto context context2
hostname/context2(config)# dynamic-filter use-database
hostname/context2(config)# class-map dynamic-filter_snoop_class
hostname/context2(config-cmap)# match port udp eq domain
hostname/context2(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context2(config-pmap)# class dynamic-filter_snoop_class
hostname/context2(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context2(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context2(config-pmap-c)# dynamic-filter blacklist
hostname/context2(config-llist)# name bad1.example.com
hostname/context2(config-llist)# name bad2.example.com
hostname/context2(config-llist)# address 10.1.1.1 255.255.255.0
hostname/context2(config-llist)# dynamic-filter whitelist
hostname/context2(config-llist)# name good.example.com
hostname/context2(config-llist)# name great.example.com
hostname/context2(config-llist)# name awesome.example.com
hostname/context2(config-llist)# address 10.1.1.2 255.255.255.255
hostname/context2(config-llist)# access-list dynamic-filter_acl extended permit tcp any
any eq 80
hostname/context2(config)# dynamic-filter enable interface outside classify-list
dynamic-filter_acl
hostname/context2(config)# dynamic-filter drop blacklist interface outside
hostname/context2(config)# dynamic-filter ambiguous-is-black

Where to Go Next
•

To configure the syslog server, see Chapter 77, “Configuring Logging.”

•

To configure an access list to block traffic, see Chapter 15, “Adding an Extended Access List,” and
also see Chapter 34, “Configuring Access Rules,” for information about applying the access list to
the interface.

•

To shun connections, see the “Blocking Unwanted Connections” section on page 57-2.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-21

Chapter 55

Configuring the Botnet Traffic Filter

Feature History for the Botnet Traffic Filter

Feature History for the Botnet Traffic Filter
Table 55-2 lists each feature change and the platform release in which it was implemented.
Table 55-2

Feature History for the Botnet Traffic Filter

Feature Name

Platform
Releases

Feature Information

Botnet Traffic Filter

8.2(1)

This feature was introduced.

Automatic blocking, and blacklist category and 8.2(2)
threat level reporting.

The Botnet Traffic Filter now supports automatic blocking
of blacklisted traffic based on the threat level. You can also
view the category and threat level of malware sites in
statistics and reports.
The 1 hour timeout for reports for top hosts was removed;
there is now no timeout.
The following commands were introduced or modified:
dynamic-filter ambiguous-is-black, dynamic-filter drop
blacklist, show dynamic-filter statistics, show
dynamic-filter reports infected-hosts, and show
dynamic-filter reports top.

Cisco ASA 5500 Series Configuration Guide using the CLI

55-22

CH A P T E R

56

Configuring Threat Detection
This chapter describes how to configure threat detection statistics and scanning threat detection and
includes the following sections:
•

Information About Threat Detection, page 56-1

•

Licensing Requirements for Threat Detection, page 56-1

•

Configuring Basic Threat Detection Statistics, page 56-2

•

Configuring Advanced Threat Detection Statistics, page 56-6

•

Configuring Scanning Threat Detection, page 56-15

•

Configuration Examples for Threat Detection, page 56-19

Information About Threat Detection
The threat detection feature consists of the following elements:
•

Different levels of statistics gathering for various threats.
Threat detection statistics can help you manage threats to your ASA; for example, if you enable
scanning threat detection, then viewing statistics can help you analyze the threat. You can configure
two types of threat detection statistics:
– Basic threat detection statistics—Includes information about attack activity for the system as a

whole. Basic threat detection statistics are enabled by default and have no performance impact.
– Advanced threat detection statistics—Tracks activity at an object level, so the ASA can report

activity for individual hosts, ports, protocols, or access lists. Advanced threat detection statistics
can have a major performance impact, depending on the statistics gathered, so only the access
list statistics are enabled by default.
•

Scanning threat detection, which determines when a host is performing a scan.
You can optionally shun any hosts determined to be a scanning threat.

Licensing Requirements for Threat Detection
The following table shows the licensing requirements for this feature:

Cisco ASA 5500 Series Configuration Guide using the CLI

56-1

Chapter 56

Configuring Threat Detection

Configuring Basic Threat Detection Statistics

Model

License Requirement

All models

Base License.

Configuring Basic Threat Detection Statistics
Basic threat detection statistics include activity that might be related to an attack, such as a DoS attack.
This section includes the following topics:
•

Information About Basic Threat Detection Statistics, page 56-2

•

Guidelines and Limitations, page 56-3

•

Default Settings, page 56-3

•

Configuring Basic Threat Detection Statistics, page 56-4

•

Monitoring Basic Threat Detection Statistics, page 56-5

•

Feature History for Basic Threat Detection Statistics, page 56-6

Information About Basic Threat Detection Statistics
Using basic threat detection statistics, the ASA monitors the rate of dropped packets and security events
due to the following reasons:
•

Denial by access lists

•

Bad packet format (such as invalid-ip-header or invalid-tcp-hdr-length)

•

Connection limits exceeded (both system-wide resource limits, and limits set in the configuration)

•

DoS attack detected (such as an invalid SPI, Stateful Firewall check failure)

•

Basic firewall checks failed (This option is a combined rate that includes all firewall-related packet
drops in this bulleted list. It does not include non-firewall-related drops such as interface overload,
packets failed at application inspection, and scanning attack detected.)

•

Suspicious ICMP packets detected

•

Packets failed application inspection

•

Interface overload

•

Scanning attack detected (This option monitors scanning attacks; for example, the first TCP packet
is not a SYN packet, or the TCP connection failed the 3-way handshake. Full scanning threat
detection (see the “Configuring Scanning Threat Detection” section on page 56-15) takes this
scanning attack rate information and acts on it by classifying hosts as attackers and automatically
shunning them, for example.)

•

Incomplete session detection such as TCP SYN attack detected or no data UDP session attack
detected

When the ASA detects a threat, it immediately sends a system log message (733100). The ASA tracks
two types of rates: the average event rate over an interval, and the burst event rate over a shorter burst
interval. The burst rate interval is 1/30th of the average rate interval or 10 seconds, whichever is higher.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-2

Chapter 56

Configuring Threat Detection
Configuring Basic Threat Detection Statistics

For each received event, the ASA checks the average and burst rate limits; if both rates are exceeded,
then the ASA sends two separate system messages, with a maximum of one message for each rate type
per burst period.
Basic threat detection affects performance only when there are drops or potential threats; even in this
scenario, the performance impact is insignificant.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature:
Security Context Guidelines

Supported in single mode only. Multiple mode is not supported.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Types of Traffic Monitored

Only through-the-box traffic is monitored; to-the-box traffic is not included in threat detection.

Default Settings
Basic threat detection statistics are enabled by default.
Table 56-1 lists the default settings. You can view all these default settings using the show
running-config all threat-detection command.
Table 56-1

Basic Threat Detection Default Settings

Trigger Settings
Packet Drop Reason
•

DoS attack detected

•

Bad packet format

•

Connection limits exceeded

•

Suspicious ICMP packets
detected

Scanning attack detected

Incomplete session detected such as
TCP SYN attack detected or no data
UDP session attack detected
(combined)

Average Rate

Burst Rate

100 drops/sec over the last 600 400 drops/sec over the last 20
seconds.
second period.
80 drops/sec over the last 3600 320 drops/sec over the last 120
seconds.
second period.

5 drops/sec over the last 600
seconds.

10 drops/sec over the last 20
second period.

4 drops/sec over the last 3600
seconds.

8 drops/sec over the last 120
second period.

100 drops/sec over the last 600 200 drops/sec over the last 20
seconds.
second period.
80 drops/sec over the last 3600 160 drops/sec over the last 120
seconds.
second period.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-3

Chapter 56

Configuring Threat Detection

Configuring Basic Threat Detection Statistics

Table 56-1

Basic Threat Detection Default Settings (continued)

Trigger Settings
Packet Drop Reason

Average Rate

Denial by access lists

400 drops/sec over the last 600 800 drops/sec over the last 20
seconds.
second period.
320 drops/sec over the last
3600 seconds.

•

Basic firewall checks failed

•

Packets failed application
inspection

Interface overload

Burst Rate

640 drops/sec over the last 120
second period.

400 drops/sec over the last 600 1600 drops/sec over the last 20
seconds.
second period.
320 drops/sec over the last
3600 seconds.

1280 drops/sec over the last 120
second period.

2000 drops/sec over the last
600 seconds.

8000 drops/sec over the last 20
second period.

1600 drops/sec over the last
3600 seconds.

6400 drops/sec over the last 120
second period.

Configuring Basic Threat Detection Statistics
This section describes how to configure basic threat detection statistics, including enabling or disabling
it and changing the default limits.

Detailed Steps

Step 1

Command

Purpose

threat-detection basic-threat

Enables basic threat detection statistics (if you previously
disabled it). Basic threat detection is enabled by default.

Example:
hostname(config)# threat-detection
basic-threat

Step 2

threat-detection rate {acl-drop |
bad-packet-drop | conn-limit-drop |
dos-drop | fw-drop | icmp-drop |
inspect-drop | interface-drop |
scanning-threat | syn-attack}
rate-interval rate_interval average-rate
av_rate burst-rate burst_rate

Example:
hostname(config)# threat-detection rate
dos-drop rate-interval 600 average-rate 60
burst-rate 100

Cisco ASA 5500 Series Configuration Guide using the CLI

56-4

(Optional) Changes the default settings for one or more type of
event.
For a description of each event type, see the “Information About
Basic Threat Detection Statistics” section on page 56-2.
When you use this command with the scanning-threat keyword,
it is also used in the scanning threat detection feature (see the
“Configuring Scanning Threat Detection” section). If you do not
configure basic threat detection, you can still use this command
with the scanning-threat keyword to configure the rate limits for
scanning threat detection.
You can configure up to three different rate intervals for each
event type.

Chapter 56

Configuring Threat Detection
Configuring Basic Threat Detection Statistics

Monitoring Basic Threat Detection Statistics
To monitor basic threat detection statistics, perform one of the following tasks:
Command

Purpose

show threat-detection rate
[min-display-rate min_display_rate]
[acl-drop | bad-packet-drop |
conn-limit-drop | dos-drop | fw-drop |
icmp-drop | inspect-drop | interface-drop |
scanning-threat | syn-attack]

Displays basic threat detection statistics.
where the min-display-rate min_display_rate argument limits the
display to statistics that exceed the minimum display rate in events per
second. You can set the min_display_rate between 0 and 2147483647.
For a description of each event type, see the “Information About Basic
Threat Detection Statistics” section on page 56-2.
The output shows the average rate in events/sec over two fixed time
periods: the last 10 minutes and the last 1 hour. It also shows: the current
burst rate in events/sec over the last completed burst interval, which is
1/30th of the average rate interval or 10 seconds, whichever is larger; the
number of times the rates were exceeded (triggered); and the total number
of events over the time periods.
The ASA stores the count at the end of each burst period, for a total of 30
completed burst intervals. The unfinished burst interval presently
occurring is not included in the average rate. For example, if the average
rate interval is 20 minutes, then the burst interval is 20 seconds. If the last
burst interval was from 3:00:00 to 3:00:20, and you use the show
command at 3:00:25, then the last 5 seconds are not included in the
output.
The only exception to this rule is if the number of events in the unfinished
burst interval already exceeds the number of events in the oldest burst
interval (#1 of 30) when calculating the total events. In that case, the ASA
calculates the total events as the last 29 complete intervals, plus the events
so far in the unfinished burst interval. This exception lets you monitor a
large increase in events in real time.
Clears basic threat statistics.

clear threat-detection rate

Examples
The following is sample output from the show threat-detection rate command:
hostname# show threat-detection rate

10-min
1-hour
1-hour
10-min
1-hour
1-hour
10-min
1-hour
10-min
1-hour
10-min
1-hour

ACL drop:
ACL drop:
SYN attck:
Scanning:
Scanning:
Bad pkts:
Firewall:
Firewall:
DoS attck:
DoS attck:
Interface:
Interface:

Average(eps)
0
0
5
0
106
76
0
76
0
0
0
88

Current(eps) Trigger
0
0
0
0
0
2
0
29
0
10
0
2
0
3
0
2
0
0
0
0
0
0
0
0

Total events
16
112
21438
193
384776
274690
22
274844
6
42
204
318225

Cisco ASA 5500 Series Configuration Guide using the CLI

56-5

Chapter 56

Configuring Threat Detection

Configuring Advanced Threat Detection Statistics

Feature History for Basic Threat Detection Statistics
Table 56-2 lists each feature change and the platform release in which it was implemented.
Table 56-2

Feature History for Basic Threat Detection Statistics

Feature Name

Platform
Releases

Feature Information

Basic threat detection statistics

8.0(2)

Basic threat detection statistics was introduced.
The following commands were introduced:
threat-detection basic-threat, threat-detection rate,
show threat-detection rate, clear threat-detection rate.

Burst rate interval changed to 1/30th of the
average rate.

8.2(1)

In earlier releases, the burst rate interval was 1/60th of the
average rate. To maximize memory usage, the sampling
interval was reduced to 30 times during the average rate.

Improved memory usage

8.3(1)

The memory usage for threat detection was improved.

Configuring Advanced Threat Detection Statistics
You can configure the ASA to collect extensive statistics. This section includes the following topics:
•

Information About Advanced Threat Detection Statistics, page 56-6

•

Guidelines and Limitations, page 56-6

•

Default Settings, page 56-7

•

Configuring Advanced Threat Detection Statistics, page 56-7

•

Monitoring Advanced Threat Detection Statistics, page 56-9

•

Feature History for Advanced Threat Detection Statistics, page 56-14

Information About Advanced Threat Detection Statistics
Advanced threat detection statistics show both allowed and dropped traffic rates for individual objects
such as hosts, ports, protocols, or access lists.

Caution

Enabling advanced statistics can affect the ASA performance, depending on the type of statistics
enabled. The threat-detection statistics host command affects performance in a significant way; if you
have a high traffic load, you might consider enabling this type of statistics temporarily. The
threat-detection statistics port command, however, has modest impact.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature:

Cisco ASA 5500 Series Configuration Guide using the CLI

56-6

Chapter 56

Configuring Threat Detection
Configuring Advanced Threat Detection Statistics

Security Context Guidelines

Only TCP Intercept statistics are available in multiple mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Types of Traffic Monitored

Only through-the-box traffic is monitored; to-the-box traffic is not included in threat detection.

Default Settings
By default, statistics for access lists are enabled.

Configuring Advanced Threat Detection Statistics
By default, statistics for access lists are enabled. To enable other statistics, perform the following steps.

Detailed Steps

Step 1

Command

Purpose

threat-detection statistics

(Optional) Enables all statistics.

Example:
hostname(config)# threat-detection statistics

To enable only certain statistics, enter this command
for each statistic type (shown in this table), and do
not also enter the command without any options.
You can enter threat-detection statistics (without
any options) and then customize certain statistics by
entering the command with statistics-specific
options (for example, threat-detection statistics
host number-of-rate 2). If you enter
threat-detection statistics (without any options)
and then enter a command for specific statistics, but
without any statistic-specific options, then that
command has no effect because it is already enabled.
If you enter the no form of this command, it removes
all threat-detection statistics commands, including
the threat-detection statistics access-list
command, which is enabled by default.

Step 2

threat-detection statistics access-list

Example:
hostname(config)# threat-detection statistics
access-list

(Optional) Enables statistics for access lists (if they
were disabled previously). Statistics for access lists
are enabled by default. Access list statistics are only
displayed using the show threat-detection top
access-list command. This command is enabled by
default.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-7

Chapter 56

Configuring Threat Detection

Configuring Advanced Threat Detection Statistics

Step 3

Command

Purpose

threat-detection statistics host [number-of-rate {1 |
2 | 3}]

(Optional) Enables statistics for hosts.

Example:
hostname(config)# threat-detection statistics host
number-of-rate 2

The number-of-rate keyword sets the number of
rate intervals maintained for host statistics. The
default number of rate intervals is 1, which keeps the
memory usage low. To view more rate intervals, set
the value to 2 or 3. For example, if you set the value
to 3, then you view data for the last 1 hour, 8 hours,
and 24 hours. If you set this keyword to 1 (the
default), then only the shortest rate interval statistics
are maintained. If you set the value to 2, then the two
shortest intervals are maintained.
The host statistics accumulate for as long as the host
is active and in the scanning threat host database.
The host is deleted from the database (and the
statistics cleared) after 10 minutes of inactivity.

Step 4

threat-detection statistics port [number-of-rate {1 |
2 | 3}]

Example:
hostname(config)# threat-detection statistics port
number-of-rate 2

Cisco ASA 5500 Series Configuration Guide using the CLI

56-8

(Optional) Enables statistics for TCP and UDP
ports.
The number-of-rate keyword sets the number of
rate intervals maintained for port statistics. The
default number of rate intervals is 1, which keeps the
memory usage low. To view more rate intervals, set
the value to 2 or 3. For example, if you set the value
to 3, then you view data for the last 1 hour, 8 hours,
and 24 hours. If you set this keyword to 1 (the
default), then only the shortest rate interval statistics
are maintained. If you set the value to 2, then the two
shortest intervals are maintained.

Chapter 56

Configuring Threat Detection
Configuring Advanced Threat Detection Statistics

Step 5

Command

Purpose

threat-detection statistics protocol [number-of-rate
{1 | 2 | 3}]

(Optional) Enables statistics for non-TCP/UDP IP
protocols.
The number-of-rate keyword sets the number of
rate intervals maintained for protocol statistics. The
default number of rate intervals is 1, which keeps the
memory usage low. To view more rate intervals, set
the value to 2 or 3. For example, if you set the value
to 3, then you view data for the last 1 hour, 8 hours,
and 24 hours. If you set this keyword to 1 (the
default), then only the shortest rate interval statistics
are maintained. If you set the value to 2, then the two
shortest intervals are maintained.

Example:
hostname(config)# threat-detection statistics
protocol number-of-rate 3

Step 6

threat-detection statistics tcp-intercept
[rate-interval minutes] [burst-rate attacks_per_sec]
[average-rate attacks_per_sec]

Example:
hostname(config)# threat-detection statistics
tcp-intercept rate-interval 60 burst-rate 800
average-rate 600

(Optional) Enables statistics for attacks intercepted
by TCP Intercept (see the Chapter 53, “Configuring
Connection Settings,” to enable TCP Intercept).
The rate-interval keyword sets the size of the
history monitoring window, between 1 and 1440
minutes. The default is 30 minutes. During this
interval, the ASA samples the number of attacks 30
times.
The burst-rate keyword sets the threshold for
syslog message generation, between 25 and
2147483647. The default is 400 per second. When
the burst rate is exceeded, syslog message 733104 is
generated.
The average-rate keyword sets the average rate
threshold for syslog message generation, between
25 and 2147483647. The default is 200 per second.
When the average rate is exceeded, syslog message
733105 is generated.
Note

This command is available in multiple
context mode.

Monitoring Advanced Threat Detection Statistics
The display output shows the following:
•

The average rate in events/sec over fixed time periods.

•

The current burst rate in events/sec over the last completed burst interval, which is 1/30th of the
average rate interval or 10 seconds, whichever is larger

•

The number of times the rates were exceeded (for dropped traffic statistics only)

•

The total number of events over the fixed time periods.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-9

Chapter 56

Configuring Threat Detection

Configuring Advanced Threat Detection Statistics

The ASA stores the count at the end of each burst period, for a total of 30 completed burst intervals. The
unfinished burst interval presently occurring is not included in the average rate. For example, if the
average rate interval is 20 minutes, then the burst interval is 20 seconds. If the last burst interval was
from 3:00:00 to 3:00:20, and you use the show command at 3:00:25, then the last 5 seconds are not
included in the output.
The only exception to this rule is if the number of events in the unfinished burst interval already exceeds
the number of events in the oldest burst interval (#1 of 30) when calculating the total events. In that case,
the ASA calculates the total events as the last 29 complete intervals, plus the events so far in the
unfinished burst interval. This exception lets you monitor a large increase in events in real time.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-10

Chapter 56

Configuring Threat Detection
Configuring Advanced Threat Detection Statistics

To monitor advanced threat detection statistics, perform one of the following tasks:
Command

Purpose

show threat-detection statistics
[min-display-rate min_display_rate] top
[[access-list | host | port-protocol]
[rate-1 | rate-2 | rate-3] |
tcp-intercept [all] detail]]

Displays the top 10 statistics.
The min-display-rate min_display_rate argument limits the display to
statistics that exceed the minimum display rate in events per second. You
can set the min_display_rate between 0 and 2147483647.
If you do not enter any options, the top 10 statistics are shown for all
categories.
To view the top 10 ACEs that match packets, including both permit and
deny ACEs, use the access-list keyword. Permitted and denied traffic are
not differentiated in this display. If you enable basic threat detection using
the threat-detection basic-threat command, you can track access list
denies using the show threat-detection rate acl-drop command.
To view only host statistics, use the host keyword. Note: Due to the threat
detction algorithm, an interface used as a combination failover and state
link could appear in the top 10 hosts; this is expected behavior, and you
can ignore this IP address in the display.
To view statistics for ports and protocols, use the port-protocol keyword.
The port-protocol keyword shows statistics for both ports and protocols
(both must be enabled for the display), and shows the combined statistics
of TCP/UDP port and IP protocol types. TCP (protocol 6) and UDP
(protocol 17) are not included in the display for IP protocols; TCP and
UDP ports are, however, included in the display for ports. If you only
enable statistics for one of these types, port or protocol, then you will only
view the enabled statistics.
To view TCP Intercept statistics, use the tcp-intercept keyword. The
display includes the top 10 protected servers under attack. The all
keyword shows the history data of all the traced servers. The detail
keyword shows history sampling data. The ASA samples the number of
attacks 30 times during the rate interval, so for the default 30 minute
period, statistics are collected every 60 seconds.
The rate-1 keyword shows the statistics for the smallest fixed rate
intervals available in the display; rate-2 shows the next largest rate
interval; and rate-3, if you have three intervals defined, shows the largest
rate interval. For example, the display shows statistics for the last 1 hour,
8 hours, and 24 hours. If you set the rate-1 keyword, the ASA shows only
the 1 hour time interval.

show threat-detection statistics
[min-display-rate min_display_rate] host
[ip_address [mask]]

Displays statistics for all hosts or for a specific host or subnet.

show threat-detection statistics
[min-display-rate min_display_rate] port
[start_port[-end_port]]

Displays statistics for all ports or for a specific port or range of ports.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-11

Chapter 56

Configuring Threat Detection

Configuring Advanced Threat Detection Statistics

Command

Purpose

show threat-detection statistics
[min-display-rate min_display_rate]
protocol [protocol_number | ah | eigrp |
esp | gre | icmp | igmp | igrp | ip |
ipinip | ipsec | nos | ospf | pcp | pim |
pptp | snp | tcp | udp]

Displays statistics for all IP protocols or for a specific protocol.

show threat-detection memory

Displays how much memory is used by advanced threat detection
statistics.

The protocol_number argument is an integer between 0 and 255.

Examples
The following is sample output from the show threat-detection statistics host command:
hostname# show threat-detection statistics host
Average(eps)
Current(eps) Trigger
Total events
Host:10.0.0.1: tot-ses:289235 act-ses:22571 fw-drop:0 insp-drop:0 null-ses:21438 bad-acc:0
1-hour Sent byte:
2938
0
0
10580308
8-hour Sent byte:
367
0
0
10580308
24-hour Sent byte:
122
0
0
10580308
1-hour Sent pkts:
28
0
0
104043
8-hour Sent pkts:
3
0
0
104043
24-hour Sent pkts:
1
0
0
104043
20-min Sent drop:
9
0
1
10851
1-hour Sent drop:
3
0
1
10851
1-hour Recv byte:
2697
0
0
9712670
8-hour Recv byte:
337
0
0
9712670
24-hour Recv byte:
112
0
0
9712670
1-hour Recv pkts:
29
0
0
104846
8-hour Recv pkts:
3
0
0
104846
24-hour Recv pkts:
1
0
0
104846
20-min Recv drop:
42
0
3
50567
1-hour Recv drop:
14
0
1
50567
Host:10.0.0.0: tot-ses:1 act-ses:0 fw-drop:0 insp-drop:0 null-ses:0 bad-acc:0
1-hour Sent byte:
0
0
0
614
8-hour Sent byte:
0
0
0
614
24-hour Sent byte:
0
0
0
614
1-hour Sent pkts:
0
0
0
6
8-hour Sent pkts:
0
0
0
6
24-hour Sent pkts:
0
0
0
6
20-min Sent drop:
0
0
0
4
1-hour Sent drop:
0
0
0
4
1-hour Recv byte:
0
0
0
706
8-hour Recv byte:
0
0
0
706
24-hour Recv byte:
0
0
0
706
1-hour Recv pkts:
0
0
0
7

Table 56-3 shows each field description.
Table 56-3

show threat-detection statistics host Command Fields

Field

Description

Host

Shows the host IP address.

tot-ses

Shows the total number of sessions for this host since it was added to the
database.

act-ses

Shows the total number of active sessions that the host is currently involved in.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-12

Chapter 56

Configuring Threat Detection
Configuring Advanced Threat Detection Statistics

Table 56-3

show threat-detection statistics host Command Fields (continued)

Field

Description

fw-drop

Shows the number of firewall drops. Firewall drops is a combined rate that
includes all firewall-related packet drops tracked in basic threat detection,
including access list denials, bad packets, exceeded connection limits, DoS
attack packets, suspicious ICMP packets, TCP SYN attack packets, and no
data UDP attack packets. It does not include non-firewall-related drops such
as interface overload, packets failed at application inspection, and scanning
attack detected.

insp-drop

Shows the number of packets dropped because they failed application
inspection.

null-ses

Shows the number of null sessions, which are TCP SYN sessions that did not
complete within the 3-second timeout, and UDP sessions that did not have any
data sent by its server 3 seconds after the session starts.

bad-acc

Shows the number of bad access attempts to host ports that are in a closed
state. When a port is determined to be in a null session (see the null-ses field
description), the port state of the host is set to HOST_PORT_CLOSE. Any
client accessing the port of the host is immediately classified as a bad access
without the need to wait for a timeout.

Average(eps)

Shows the average rate in events/sec over each time period.
The ASA stores the count at the end of each burst period, for a total of 30
completed burst intervals. The unfinished burst interval presently occurring is
not included in the average rate. For example, if the average rate interval is 20
minutes, then the burst interval is 20 seconds. If the last burst interval was
from 3:00:00 to 3:00:20, and you use the show command at 3:00:25, then the
last 5 seconds are not included in the output.
The only exception to this rule is if the number of events in the unfinished
burst interval already exceeds the number of events in the oldest burst interval
(#1 of 30) when calculating the total events. In that case, the ASA calculates
the total events as the last 29 complete intervals, plus the events so far in the
unfinished burst interval. This exception lets you monitor a large increase in
events in real time.

Current(eps)

Shows the current burst rate in events/sec over the last completed burst
interval, which is 1/30th of the average rate interval or 10 seconds, whichever
is larger. For the example specified in the Average(eps) description, the
current rate is the rate from 3:19:30 to 3:20:00

Trigger

Shows the number of times the dropped packet rate limits were exceeded. For
valid traffic identified in the sent and received bytes and packets rows, this
value is always 0, because there are no rate limits to trigger for valid traffic.

Total events

Shows the total number of events over each rate interval. The unfinished burst
interval presently occurring is not included in the total events. The only
exception to this rule is if the number of events in the unfinished burst interval
already exceeds the number of events in the oldest burst interval (#1 of 30)
when calculating the total events. In that case, the ASA calculates the total
events as the last 29 complete intervals, plus the events so far in the unfinished
burst interval. This exception lets you monitor a large increase in events in real
time.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-13

Chapter 56

Configuring Threat Detection

Configuring Advanced Threat Detection Statistics

Table 56-3

show threat-detection statistics host Command Fields (continued)

Field

Description

20-min, 1-hour,
8-hour, and 24-hour

Shows statistics for these fixed rate intervals.

Sent byte

Shows the number of successful bytes sent from the host.

Sent pkts

Shows the number of successful packets sent from the host.

Sent drop

Shows the number of packets sent from the host that were dropped because
they were part of a scanning attack.

Recv byte

Shows the number of successful bytes received by the host.

Recv pkts

Shows the number of successful packets received by the host.

Recv drop

Shows the number of packets received by the host that were dropped because
they were part of a scanning attack.

Feature History for Advanced Threat Detection Statistics
Table 56-4 lists each feature change and the platform release in which it was implemented.
Table 56-4

Feature History for Advanced Threat Detection Statistics

Feature Name

Platform
Releases

Feature Information

Advanced threat detection statistics

8.0(2)

Advanced threat detection statistics was introduced.
The following commands were introduced:
threat-detection statistics, show threat-detection
statistics.

TCP Intercept statistics

8.0(4)/8.1(2)

TCP Intercept statistics were introduced.
The following commands were modified or introduced:
threat-detection statistics tcp-intercept, show
threat-detection statistics top tcp-intercept, clear
threat-detection statistics.

Customize host statistics rate intervals

8.1(2)

You can now customize the number of rate intervals for
which statistics are collected. The default number of rates
was changed from 3 to 1.
The following command was modified: threat-detection
statistics host number-of-rates.

Burst rate interval changed to 1/30th of the
average rate.

8.2(1)

Cisco ASA 5500 Series Configuration Guide using the CLI

56-14

In earlier releases, the burst rate interval was 1/60th of the
average rate. To maximize memory usage, the sampling
interval was reduced to 30 times during the average rate.

Chapter 56

Configuring Threat Detection
Configuring Scanning Threat Detection

Table 56-4

Feature History for Advanced Threat Detection Statistics (continued)

Platform
Releases

Feature Name
Customize port and protocol statistics rate
intervals

8.3(1)

Feature Information
You can now customize the number of rate intervals for
which statistics are collected. The default number of rates
was changed from 3 to 1.
The following commands were modified: threat-detection
statistics port number-of-rates, threat-detection
statistics protocol number-of-rates.

Improved memory usage

8.3(1)

The memory usage for threat detection was improved.
The following command was introduced: show
threat-detection memory.

Configuring Scanning Threat Detection
This section includes the following topics:
•

Information About Scanning Threat Detection, page 56-15

•

Guidelines and Limitations, page 56-16

•

Default Settings, page 56-16

•

Configuring Scanning Threat Detection, page 56-17

•

Monitoring Shunned Hosts, Attackers, and Targets, page 56-17

Information About Scanning Threat Detection
A typical scanning attack consists of a host that tests the accessibility of every IP address in a subnet (by
scanning through many hosts in the subnet or sweeping through many ports in a host or subnet). The
scanning threat detection feature determines when a host is performing a scan. Unlike IPS scan detection
that is based on traffic signatures, the ASA scanning threat detection feature maintains an extensive
database that contains host statistics that can be analyzed for scanning activity.
The host database tracks suspicious activity such as connections with no return activity, access of closed
service ports, vulnerable TCP behaviors such as non-random IPID, and many more behaviors.
If the scanning threat rate is exceeded, then the ASA sends a syslog message (733101), and optionally
shuns the attacker. The ASA tracks two types of rates: the average event rate over an interval, and the
burst event rate over a shorter burst interval. The burst event rate is 1/30th of the average rate interval or
10 seconds, whichever is higher. For each event detected that is considered to be part of a scanning
attack, the ASA checks the average and burst rate limits. If either rate is exceeded for traffic sent from
a host, then that host is considered to be an attacker. If either rate is exceeded for traffic received by a
host, then that host is considered to be a target.

Caution

The scanning threat detection feature can affect the ASA performance and memory significantly while
it creates and gathers host- and subnet-based data structure and information.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-15

Chapter 56

Configuring Threat Detection

Configuring Scanning Threat Detection

Guidelines and Limitations
This section includes the guidelines and limitations for this feature:
Security Context Guidelines

Supported in single mode only. Multiple mode is not supported.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Types of Traffic Monitored
•

Only through-the-box traffic is monitored; to-the-box traffic is not included in threat detection.

•

Traffic that is denied by an access list does not trigger scanning threat detection; only traffic that is
allowed through the ASA and that creates a flow is affected by scanning threat detection.

Default Settings
Table 56-5 lists the default rate limits for scanning threat detection.
Table 56-5

Default Rate Limits for Scanning Threat Detection

Average Rate

Burst Rate

5 drops/sec over the last 600 seconds.

10 drops/sec over the last 20 second period.

5 drops/sec over the last 3600 seconds.

10 drops/sec over the last 120 second period.

The burst rate is calculated as the average rate every N seconds, where N is the burst rate interval. The
burst rate interval is 1/30th of the rate interval or 10 seconds, whichever is larger.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-16

Chapter 56

Configuring Threat Detection
Configuring Scanning Threat Detection

Configuring Scanning Threat Detection
Detailed Steps

Step 1

Command

Purpose

threat-detection scanning-threat [shun
[except {ip-address ip_address mask |
object-group network_object_group_id}]]

Enables scanning threat detection. By default, the system log
message 733101 is generated when a host is identified as an
attacker. Enter this command multiple times to identify multiple
IP addresses or network object groups to exempt from shunning.

Example:
hostname(config)# threat-detection
scanning-threat shun except ip-address
10.1.1.0 255.255.255.0

Step 2

threat-detection scanning-threat shun
duration seconds

(Optional) Sets the duration of the shun for attacking hosts.

Example:
hostname(config)# threat-detection
scanning-threat shun duration 2000

Step 3

threat-detection rate scanning-threat
rate-interval rate_interval average-rate
av_rate burst-rate burst_rate

Example:
hostname(config)# threat-detection rate
scanning-threat rate-interval 1200
average-rate 10 burst-rate 20
hostname(config)# threat-detection rate
scanning-threat rate-interval 2400
average-rate 10 burst-rate 20

(Optional) Changes the default event limit for when the ASA
identifies a host as an attacker or as a target. If you already
configured this command as part of the basic threat detection
configuration (see the “Configuring Basic Threat Detection
Statistics” section on page 56-2), then those settings are shared
with the scanning threat detection feature; you cannot configure
separate rates for basic and scanning threat detection. If you do
not set the rates using this command, the default values are used
for both the scanning threat detection feature and the basic threat
detection feature. You can configure up to three different rate
intervals, by entering separate commands.

Monitoring Shunned Hosts, Attackers, and Targets
To monitor shunned hosts and attackers and targets, perform one of the following tasks:
Command

Purpose

show threat-detection shun

Displays the hosts that are currently shunned.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-17

Chapter 56

Configuring Threat Detection

Configuring Scanning Threat Detection

Command

Purpose

clear threat-detection shun [ip_address
[mask]]

Releases a host from being shunned. If you do not
specify an IP address, all hosts are cleared from
the shun list.

show threat-detection scanning-threat
[attacker | target]

Displays hosts that the ASA decides are attackers
(including hosts on the shun list), and displays the
hosts that are the target of an attack. If you do not
enter an option, both attackers and target hosts are
displayed.

Examples
The following is sample output from the show threat-detection shun command:
hostname# show threat-detection shun
Shunned Host List:
10.1.1.6
192.168.6.7

To release the host at 10.1.1.6, enter the following command:
hostname# clear threat-detection shun 10.1.1.6

The following is sample output from the show threat-detection scanning-threat attacker command:
hostname# show threat-detection scanning-threat attacker
10.1.2.3
10.8.3.6
209.165.200.225

Feature History for Scanning Threat Detection
Table 56-6 lists each feature change and the platform release in which it was implemented.
Table 56-6

Feature History for Scanning Threat Detection

Feature Name

Platform
Releases

Feature Information

Scanning threat detection

8.0(2)

Scanning threat detection was introduced.
The following commands were introduced:
threat-detection scanning-threat, threat-detection rate
scanning-threat, show threat-detection scanning-threat,
show threat-detection shun, clear threat-detection shun.

Shun duration

8.0(4)/8.1(2)

You can now set the shun duration,
The following command was introduced: threat-detection
scanning-threat shun duration.

Cisco ASA 5500 Series Configuration Guide using the CLI

56-18

Chapter 56

Configuring Threat Detection
Configuration Examples for Threat Detection

Table 56-6

Feature History for Scanning Threat Detection (continued)

Platform
Releases

Feature Name

Feature Information

Burst rate interval changed to 1/30th of the
average rate.

8.2(1)

In earlier releases, the burst rate interval was 1/60th of the
average rate. To maximize memory usage, the sampling
interval was reduced to 30 times during the average rate.

Improved memory usage

8.3(1)

The memory usage for threat detection was improved.

Configuration Examples for Threat Detection
The following example configures basic threat detection statistics, and changes the DoS attack rate
settings. All advanced threat detection statistics are enabled, with the host statistics number of rate
intervals lowered to 2. The TCP Intercept rate interval is also customized. Scanning threat detection is
enabled with automatic shunning for all addresses except 10.1.1.0/24. The scanning threat rate intervals
are customized.
threat-detection
threat-detection
threat-detection
threat-detection
threat-detection
threat-detection
threat-detection

basic-threat
rate dos-drop rate-interval 600 average-rate 60 burst-rate 100
statistics
statistics host number-of-rate 2
statistics tcp-intercept rate-interval 60 burst-rate 800 average-rate 600
scanning-threat shun except ip-address 10.1.1.0 255.255.255.0
rate scanning-threat rate-interval 1200 average-rate 10 burst-rate 20

threat-detection rate scanning-threat rate-interval 2400 average-rate 10 burst-rate 20

Cisco ASA 5500 Series Configuration Guide using the CLI

56-19

Chapter 56
Configuration Examples for Threat Detection

Cisco ASA 5500 Series Configuration Guide using the CLI

56-20

Configuring Threat Detection

CH A P T E R

57

Using Protection Tools
This chapter describes some of the many tools available to protect your network and includes the
following sections:
•

Preventing IP Spoofing, page 57-1

•

Configuring the Fragment Size, page 57-2

•

Blocking Unwanted Connections, page 57-2

•

Configuring IP Audit for Basic IPS Support, page 57-3

Preventing IP Spoofing
This section lets you enable Unicast Reverse Path Forwarding on an interface. Unicast RPF guards
against IP spoofing (a packet uses an incorrect source IP address to obscure its true source) by ensuring
that all packets have a source IP address that matches the correct source interface according to the
routing table.
Normally, the ASA only looks at the destination address when determining where to forward the packet.
Unicast RPF instructs the ASA to also look at the source address; this is why it is called Reverse Path
Forwarding. For any traffic that you want to allow through the ASA, the ASA routing table must include
a route back to the source address. See RFC 2267 for more information.
For outside traffic, for example, the ASA can use the default route to satisfy the Unicast RPF protection.
If traffic enters from an outside interface, and the source address is not known to the routing table, the
ASA uses the default route to correctly identify the outside interface as the source interface.
If traffic enters the outside interface from an address that is known to the routing table, but is associated
with the inside interface, then the ASA drops the packet. Similarly, if traffic enters the inside interface
from an unknown source address, the ASA drops the packet because the matching route (the default
route) indicates the outside interface.
Unicast RPF is implemented as follows:
•

ICMP packets have no session, so each packet is checked.

•

UDP and TCP have sessions, so the initial packet requires a reverse route lookup. Subsequent
packets arriving during the session are checked using an existing state maintained as part of the
session. Non-initial packets are checked to ensure they arrived on the same interface used by the
initial packet.

To enable Unicast RPF, enter the following command:
hostname(config)# ip verify reverse-path interface interface_name

Cisco ASA 5500 Series Configuration Guide using the CLI

57-1

Chapter 57

Using Protection Tools

Configuring the Fragment Size

Configuring the Fragment Size
By default, the ASA allows up to 24 fragments per IP packet, and up to 200 fragments awaiting
reassembly. You might need to let fragments on your network if you have an application that routinely
fragments packets, such as NFS over UDP. However, if you do not have an application that fragments
traffic, we recommend that you do not allow fragments through the ASA. Fragmented packets are often
used as DoS attacks.
To set disallow fragments, enter the following command:
hostname(config)# fragment chain 1 [interface_name]

Enter an interface name if you want to prevent fragmentation on a specific interface. By default, this
command applies to all interfaces.

Blocking Unwanted Connections
If you know that a host is attempting to attack your network (for example, syslog messages show an
attack), then you can block (or shun) connections based on the source IP address. All existing
connections and new connections are blocked until you remove the shun.

Note

If you have an IPS that monitors traffic, such as an AIP SSM, then the IPS can shun connections
automatically.
To shun a connection manually, perform the following steps:

Step 1

If necessary, view information about the connection by entering the following command:
hostname# show conn

The ASA shows information about each connection, such as the following:
TCP out 64.101.68.161:4300 in 10.86.194.60:23 idle 0:00:00 bytes 1297 flags UIO

Step 2

To shun connections from the source IP address, enter the following command:
hostname(config)# shun src_ip [dst_ip src_port dest_port [protocol]] [vlan vlan_id]

If you enter only the source IP address, then all future connections are shunned; existing connections
remain active.
To drop an existing connection, as well as blocking future connections from the source IP address, enter
the destination IP address, source and destination ports, and the protocol. By default, the protocol is 0
for IP. Note that specifying the additional parameters is a convenient way to also drop a specific current
connection; the shun, however, remains in place for all future connections from the source IP address,
regardless of destination parameters.
For multiple context mode, you can enter this command in the admin context, and by specifying a
VLAN ID that is assigned to an interface in other contexts, you can shun the connection in other
contexts.
Step 3

To remove the shun, enter the following command:
hostname(config)# no shun src_ip [vlan vlan_id]

Cisco ASA 5500 Series Configuration Guide using the CLI

57-2

Chapter 57

Using Protection Tools
Configuring IP Audit for Basic IPS Support

Configuring IP Audit for Basic IPS Support
The IP audit feature provides basic IPS support for the ASA that does not have an AIP SSM. It supports
a basic list of signatures, and you can configure the ASA to perform one or more actions on traffic that
matches a signature.
This section includes the following topics:
•

Configuring IP Audit, page 57-3

•

IP Audit Signature List, page 57-4

Configuring IP Audit
To enable IP audit, perform the following steps:
Step 1

To define an IP audit policy for informational signatures, enter the following command:
hostname(config)# ip audit name name info [action [alarm] [drop] [reset]]

Where alarm generates a system message showing that a packet matched a signature, drop drops the
packet, and reset drops the packet and closes the connection. If you do not define an action, then the
default action is to generate an alarm.
Step 2

To define an IP audit policy for attack signatures, enter the following command:
hostname(config)# ip audit name name attack [action [alarm] [drop] [reset]]

Where alarm generates a system message showing that a packet matched a signature, drop drops the
packet, and reset drops the packet and closes the connection. If you do not define an action, then the
default action is to generate an alarm.
Step 3

To assign the policy to an interface, enter the following command:
ip audit interface interface_name policy_name

Step 4

To disable signatures, or for more information about signatures, see the ip audit signature command in
the command reference.

•

Cisco ASA 5500 Series Configuration Guide using the CLI

57-3

Chapter 57

Using Protection Tools

Configuring IP Audit for Basic IPS Support

IP Audit Signature List
Table 57-1 lists supported signatures and system message numbers.
Table 57-1

Signature IDs and System Message Numbers

Signature Message
ID
Number Signature Title

Signature Type Description

1000

400000

IP options-Bad Option List

Informational

Triggers on receipt of an IP datagram where
the list of IP options in the IP datagram header
is incomplete or malformed. The IP options
list contains one or more options that perform
various network management or debugging
tasks.

1001

400001

IP options-Record Packet Route

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 7 (Record Packet Route).

1002

400002

IP options-Timestamp

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 4 (Timestamp).

1003

400003

IP options-Security

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 2 (Security options).

1004

400004

IP options-Loose Source Route

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 3 (Loose Source Route).

1005

400005

IP options-SATNET ID

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 8 (SATNET stream identifier).

1006

400006

IP options-Strict Source Route

Informational

Triggers on receipt of an IP datagram in
which the IP option list for the datagram
includes option 2 (Strict Source Routing).

1100

400007

IP Fragment Attack

Attack

Triggers when any IP datagram is received
with an offset value less than 5 but greater
than 0 indicated in the offset field.

1102

400008

IP Impossible Packet

Attack

Triggers when an IP packet arrives with
source equal to destination address. This
signature will catch the so-called Land
Attack.

Cisco ASA 5500 Series Configuration Guide using the CLI

57-4

Chapter 57

Using Protection Tools
Configuring IP Audit for Basic IPS Support

Table 57-1

Signature IDs and System Message Numbers (continued)

Signature Message
ID
Number Signature Title

Signature Type Description

1103

400009

IP Overlapping Fragments (Teardrop) Attack

Triggers when two fragments contained
within the same IP datagram have offsets that
indicate that they share positioning within the
datagram. This could mean that fragment A is
being completely overwritten by fragment B,
or that fragment A is partially being
overwritten by fragment B. Some operating
systems do not properly handle fragments that
overlap in this manner and may throw
exceptions or behave in other undesirable
ways upon receipt of overlapping fragments,
which is how the Teardrop attack works to
create a DoS.

2000

400010

ICMP Echo Reply

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 0 (Echo Reply).

2001

400011

ICMP Host Unreachable

Informational

Triggers when an IP datagram is received
with the protocol field of the IP header set to
1 (ICMP) and the type field in the ICMP
header set to 3 (Host Unreachable).

2002

400012

ICMP Source Quench

Informational

Triggers when an IP datagram is received
with the protocol field of the IP header set to
1 (ICMP) and the type field in the ICMP
header set to 4 (Source Quench).

2003

400013

ICMP Redirect

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 5 (Redirect).

2004

400014

ICMP Echo Request

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 8 (Echo Request).

2005

400015

ICMP Time Exceeded for a Datagram Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 11(Time Exceeded for a Datagram).

2006

400016

ICMP Parameter Problem on
Datagram

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 12 (Parameter Problem on Datagram).

2007

400017

ICMP Timestamp Request

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 13 (Timestamp Request).

Cisco ASA 5500 Series Configuration Guide using the CLI

57-5

Chapter 57

Using Protection Tools

Configuring IP Audit for Basic IPS Support

Table 57-1

Signature IDs and System Message Numbers (continued)

Signature Message
ID
Number Signature Title

Signature Type Description

2008

400018

ICMP Timestamp Reply

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 14 (Timestamp Reply).

2009

400019

ICMP Information Request

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 15 (Information Request).

2010

400020

ICMP Information Reply

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 16 (ICMP Information Reply).

2011

400021

ICMP Address Mask Request

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 17 (Address Mask Request).

2012

400022

ICMP Address Mask Reply

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 18 (Address Mask Reply).

2150

400023

Fragmented ICMP Traffic

Attack

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and either the more fragments flag is
set to 1 (ICMP) or there is an offset indicated
in the offset field.

2151

400024

Large ICMP Traffic

Attack

Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP) and the IP length > 1024.

2154

400025

Ping of Death Attack

Attack

Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP), the Last Fragment bit is set, and (IP
offset * 8) + (IP data length) > 65535 that is
to say, the IP offset (which represents the
starting position of this fragment in the
original packet, and which is in 8 byte units)
plus the rest of the packet is greater than the
maximum size for an IP packet.

3040

400026

TCP NULL flags

Attack

Triggers when a single TCP packet with none
of the SYN, FIN, ACK, or RST flags set has
been sent to a specific host.

3041

400027

TCP SYN+FIN flags

Attack

Triggers when a single TCP packet with the
SYN and FIN flags are set and is sent to a
specific host.

Cisco ASA 5500 Series Configuration Guide using the CLI

57-6

Chapter 57

Using Protection Tools
Configuring IP Audit for Basic IPS Support

1002

400002

IP options-Timestamp

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 4 (Timestamp).

1003

400003

IP options-Security

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 2 (Security options).

1004

400004

IP options-Loose Source Route

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 3 (Loose Source Route).

1005

400005

IP options-SATNET ID

Informational

Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 8 (SATNET stream identifier).

1006

400006

IP options-Strict Source Route

Informational

Triggers on receipt of an IP datagram in
which the IP option list for the datagram
includes option 2 (Strict Source Routing).

1100

400007

IP Fragment Attack

Attack

Triggers when any IP datagram is received
with an offset value less than 5 but greater
than 0 indicated in the offset field.

1102

400008

IP Impossible Packet

Attack

Triggers when an IP packet arrives with
source equal to destination address. This
signature will catch the so-called Land
Attack.

Cisco ASA 5500 Series Configuration Guide using the CLI

57-7

Chapter 57

Using Protection Tools

Configuring IP Audit for Basic IPS Support

2002

400012

ICMP Source Quench

Informational

Triggers when an IP datagram is received
with the protocol field of the IP header set to
1 (ICMP) and the type field in the ICMP
header set to 4 (Source Quench).

2003

400013

ICMP Redirect

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 5 (Redirect).

2004

400014

ICMP Echo Request

Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 8 (Echo Request).

2005

400015

ICMP Time Exceeded for a Datagram Informational

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 11(Time Exceeded for a Datagram).

2006

400016

ICMP Parameter Problem on
Datagram

Table 57-1

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
Signature IDs and System Message Numbers (continued) set to 12 (Parameter Problem on Datagram).

2007
ICMP Timestamp Request
Signature400017
Message
ID
Number Signature Title

Cisco ASA 5500 Series Configuration Guide using the CLI

57-8

Informational

Informational

Triggers when a IP datagram is received with
the Description
protocol field of the IP header set to 1
Signature Type
(ICMP) and the type field in the ICMP header
set to 13 (Timestamp Request).

Chapter 57

Using Protection Tools
Configuring IP Audit for Basic IPS Support

2150

400023

Fragmented ICMP Traffic

Attack

Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and either the more fragments flag is
set to 1 (ICMP) or there is an offset indicated
in the offset field.

2151

400024

Large ICMP Traffic

Attack

Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP) and the IP length > 1024.

2154

400025

Ping of Death Attack

Attack

Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP), the Last Fragment bit is set, and (IP
offset * 8) + (IP data length) > 65535 that is
to say, the IP offset (which represents the
starting position of this fragment in the
original packet, and which is in 8 byte units)
plus the rest of the packet is greater than the
maximum size for an IP packet.

3040

400026

TCP NULL flags

Attack

Triggers when a single TCP packet with none
of the SYN, FIN, ACK, or RST flags set has
been sent to a specific host.

3041

400027
TCP SYN+FIN flags
Attack
Signature IDs and System Message Numbers (continued)

Table 57-1

Signature Message
ID
Number Signature Title

Triggers when a single TCP packet with the
SYN and FIN flags are set and is sent to a
specific host.

Signature Type Description

Cisco ASA 5500 Series Configuration Guide using the CLI

57-9

Chapter 57

Using Protection Tools

Configuring IP Audit for Basic IPS Support

Table 57-1

Signature IDs and System Message Numbers (continued)

Signature Message
ID
Number Signature Title

Signature Type Description

6051

400035

DNS Zone Transfer

Informational

Triggers on normal DNS zone transfers, in
which the source port is 53.

6052

400036

DNS Zone Transfer from High Port

Informational

Triggers on an illegitimate DNS zone transfer,
in which the source port is not equal to 53.

6053

400037

DNS Request for All Records

Informational

Triggers on a DNS request for all records.

6100

400038

RPC Port Registration

Informational

Triggers when attempts are made to register
new RPC services on a target host.

6101

400039

RPC Port Unregistration

Informational

Triggers when attempts are made to
unregister existing RPC services on a target
host.

6102

400040

RPC Dump

Informational

Triggers when an RPC dump request is issued
to a target host.

6103

400041

Proxied RPC Request

Attack

Triggers when a proxied RPC request is sent
to the portmapper of a target host.

6150

400042

ypserv (YP server daemon) Portmap
Request

Informational

Triggers when a request is made to the
portmapper for the YP server daemon
(ypserv) port.

6151

400043

ypbind (YP bind daemon) Portmap
Request

Informational

Triggers when a request is made to the
portmapper for the YP bind daemon (ypbind)
port.

6152

400044

yppasswdd (YP password daemon)
Portmap Request

Informational

Triggers when a request is made to the
portmapper for the YP password daemon
(yppasswdd) port.

6153

400045

ypupdated (YP update daemon)
Portmap Request

Informational

Triggers when a request is made to the
portmapper for the YP update daemon
(ypupdated) port.

6154

400046

ypxfrd (YP transfer daemon) Portmap Informational
Request

Triggers when a request is made to the
portmapper for the YP transfer daemon
(ypxfrd) port.

6155

400047

mountd (mount daemon) Portmap
Request

Informational

Triggers when a request is made to the
portmapper for the mount daemon (mountd)
port.

6175

400048

rexd (remote execution daemon)
Portmap Request

Informational

Triggers when a request is made to the
portmapper for the remote execution daemon
(rexd) port.

Cisco ASA 5500 Series Configuration Guide using the CLI

57-10

Chapter 57

Using Protection Tools
Configuring IP Audit for Basic IPS Support

Table 57-1

Signature IDs and System Message Numbers (continued)

Signature Message
ID
Number Signature Title

Signature Type Description

6180

400049

rexd (remote execution daemon)
Attempt

Informational

Triggers when a call to the rexd program is
made. The remote execution daemon is the
server responsible for remote program
execution. This may be indicative of an
attempt to gain unauthorized access to system
resources.

6190

400050

statd Buffer Overflow

Attack

Triggers when a large statd request is sent.
This could be an attempt to overflow a buffer
and gain access to system resources.

Cisco ASA 5500 Series Configuration Guide using the CLI

57-11

Chapter 57
Configuring IP Audit for Basic IPS Support

Cisco ASA 5500 Series Configuration Guide using the CLI

57-12

Using Protection Tools

PA R T

14

Configuring Modules

CH A P T E R

58

Configuring the ASA IPS Module
This chapter describes how to configure the ASA IPS module. The ASA IPS module might be a physical
module or a software module, depending on your ASA model. For a list of supported ASA IPS modules
per ASA model, see the Cisco ASA Compatibility Matrix:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asamatrx.html
This chapter includes the following sections:
•

Information About the ASA IPS module, page 58-1

•

Licensing Requirements for the ASA IPS module, page 58-5

•

Guidelines and Limitations, page 58-5

•

Default Settings, page 58-6

•

Configuring the ASA IPS module, page 58-6

•

Monitoring the ASA IPS module, page 58-20

•

Troubleshooting the ASA IPS module, page 58-21

•

Configuration Examples for the ASA IPS module, page 58-25

•

Feature History for the ASA IPS module, page 58-25

Information About the ASA IPS module
The ASA IPS module runs advanced IPS software that provides proactive, full-featured intrusion
prevention services to stop malicious traffic, including worms and network viruses, before they can
affect your network. This section includes the following topics:
•

How the ASA IPS module Works with the ASA, page 58-2

•

Operating Modes, page 58-2

•

Using Virtual Sensors (ASA 5510 and Higher), page 58-3

•

Information About Management Access, page 58-4

Cisco ASA 5500 Series Configuration Guide using the CLI

58-1

Chapter 58

Configuring the ASA IPS Module

Information About the ASA IPS module

How the ASA IPS module Works with the ASA
The ASA IPS module runs a separate application from the ASA. The ASA IPS module might include an
external management interface so you can connect to the ASA IPS module directly; if it does not have a
management interface, you can connect to the ASA IPS module through the ASA interface. Any other
interfaces on the ASA IPS module, if available for your model, are used for ASA traffic only.
Traffic goes through the firewall checks before being forwarded to the ASA IPS module. When you
identify traffic for IPS inspection on the ASA, traffic flows through the ASA and the ASA IPS module
as follows. Note: This example is for “inline mode.” See the “Operating Modes” section on page 58-2
for information about “promiscuous mode,” where the ASA only sends a copy of the traffic to the ASA
IPS module.
1.

Traffic enters the ASA.

2.

Incoming VPN traffic is decrypted.

3.

Firewall policies are applied.

4.

Traffic is sent to the ASA IPS module.

5.

The ASA IPS module applies its security policy to the traffic, and takes appropriate actions.

6.

Valid traffic is sent back to the ASA; the ASA IPS module might block some traffic according to its
security policy, and that traffic is not passed on.

7.

Outgoing VPN traffic is encrypted.

8.

Traffic exits the ASA.

Figure 58-1 shows the traffic flow when running the ASA IPS module in inline mode. In this example,
the ASA IPS module automatically blocks traffic that it identified as an attack. All other traffic is
forwarded through the ASA.
Figure 58-1

ASA IPS module Traffic Flow in the ASA: Inline Mode

ASA
Main System
Firewall
Policy

inside

VPN
Decryption

outside

Block
IPS inspection
IPS

251157

Diverted Traffic

Operating Modes
You can send traffic to the ASA IPS module using one of the following modes:
•

Inline mode—This mode places the ASA IPS module directly in the traffic flow (see Figure 58-1).
No traffic that you identified for IPS inspection can continue through the ASA without first passing
through, and being inspected by, the ASA IPS module. This mode is the most secure because every

Cisco ASA 5500 Series Configuration Guide using the CLI

58-2

Chapter 58

Configuring the ASA IPS Module
Information About the ASA IPS module

packet that you identify for inspection is analyzed before being allowed through. Also, the ASA IPS
module can implement a blocking policy on a packet-by-packet basis. This mode, however, can
affect throughput.
•

Promiscuous mode—This mode sends a duplicate stream of traffic to the ASA IPS module. This
mode is less secure, but has little impact on traffic throughput. Unlike inline mode, in promiscuous
mode the ASA IPS module can only block traffic by instructing the ASA to shun the traffic or by
resetting a connection on the ASA. Also, while the ASA IPS module is analyzing the traffic, a small
amount of traffic might pass through the ASA before the ASA IPS module can shun it. Figure 58-2
shows the ASA IPS module in promiscuous mode. In this example, the ASA IPS module sends a
shun message to the ASA for traffic it identified as a threat.

Figure 58-2

ASA IPS module Traffic Flow in the ASA: Promiscuous Mode

ASA
Main System
Firewall
Policy

inside

Shun
message
Copied Traffic

VPN
Decryption outside

251158

IPS inspection
IPS

Using Virtual Sensors (ASA 5510 and Higher)
The ASA IPS module running IPS software Version 6.0 and later can run multiple virtual sensors, which
means you can configure multiple security policies on the ASA IPS module. You can assign each ASA
security context or single mode ASA to one or more virtual sensors, or you can assign multiple security
contexts to the same virtual sensor. See the IPS documentation for more information about virtual
sensors, including the maximum number of sensors supported.
Figure 58-3 shows one security context paired with one virtual sensor (in inline mode), while two
security contexts share the same virtual sensor.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-3

Chapter 58

Configuring the ASA IPS Module

Information About the ASA IPS module

Figure 58-3

Security Contexts and Virtual Sensors

ASA
Context
1

Main System
Context
2
Context
3

Sensor
1

251160

Sensor
2

IPS

Figure 58-4 shows a single mode ASA paired with multiple virtual sensors (in inline mode); each defined
traffic flow goes to a different sensor.
Figure 58-4

Single Mode ASA with Multiple Virtual Sensors

ASA
Main System
Traffic 1
Traffic 2

Sensor
1

Sensor
2

IPS

Sensor
3

251159

Traffic 3

Information About Management Access
You can manage the IPS application using the following methods:
•

Sessioning to the module from the ASA—If you have CLI access to the ASA, then you can session
to the module and access the module CLI. See the “Sessioning to the Module from the ASA” section
on page 58-9.

•

Connecting to the IPS management interface using ASDM or SSH—After you launch ASDM on the
ASA, ASDM connects to the module management interface to configure the IPS application. For
SSH, you can access the module CLI directly on the module management interface. (Telnet access
requires additional configuration in the module application). The module management interface can
also be used for sending syslog messages or allowing updates for the module application, such as
signature database updates. See the “Connecting Management Interface Cables” section on
page 58-7.
See the following information about the management interface:

Cisco ASA 5500 Series Configuration Guide using the CLI

58-4

Chapter 58

Configuring the ASA IPS Module
Licensing Requirements for the ASA IPS module

– ASA 5510, ASA 5520, ASA 5540, ASA 5580, ASA 5585-X—The IPS management interface

is a separate external Gigabit Ethernet interface. If you cannot use the default address (see the
“Default Settings” section on page 58-6), you can change the interface IP address and other
network parameters. See the “Configuring Basic IPS Module Network Settings” section on
page 58-10. The IPS management IP address can be on the same network as the ASA (connected
through a switch), or on a different network (through a router). If you use a different network,
be sure to set the IPS gateway as appropriate.
– ASA 5512-X, ASA 5515-X, ASA 5525-X, ASA 5545-X, ASA 5555-X—These models run the

ASA IPS module as a software module. The IPS management interface shares the
Management 0/0 interface with the ASA. Separate MAC addresses and IP addresses are
supported for the ASA and ASA IPS module. You must perform configuration of the IPS IP
address within the IPS operating system (using the CLI or ASDM). However, physical
characteristics (such as enabling the interface) are configured on the ASA. You can change the
interface IP address and other network parameters. You should set the default gateway to be an
upstream router instead of the ASA management interface. Because the ASA management
interface does not allow through-traffic, traffic destined to another network is not allowed
through the ASA. See the “Configuring Basic IPS Module Network Settings” section on
page 58-10.
– ASA 5505—You can use an ASA VLAN to allow access to an internal management IP address

over the backplane. See the “(ASA 5505) Configuring Basic Network Settings” section on
page 58-11 to change the network settings.

Licensing Requirements for the ASA IPS module
The following table shows the licensing requirements for this feature:
Model

License Requirement

ASA 5512-X,
ASA 5515-X,
ASA 5525-X,
ASA 5545-X,
ASA 5555-X

IPS Module License.1

All other models

Base License.

1. For failover pairs, both units require the IPS module license.

The ASA IPS module requires a separate Cisco Services for IPS license in order to support signature
updates. All other updates are available without a license.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

The ASA 5505 does not support multiple context mode, so multiple context features, such as virtual
sensors, are not supported on the AIP SSC.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-5

Chapter 58

Configuring the ASA IPS Module

Default Settings

Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
Model Guidelines
•

See the Cisco ASA Compatibility Matrix for information about which models support which
modules:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asamatrx.html

•

The ASA 5505 does not support multiple context mode, so multiple context features, such as virtual
sensors, are not supported on the AIP SSC.

•

The ASA IPS module for the ASA 5510 and higher supports higher performance requirements,
while the ASA IPS module for the ASA 5505 is designed for a small office installation. The
following features are not supported for the ASA 5505:
– Virtual sensors
– Anomaly detection
– Unretirement of default retired signatures

Additional Guidelines

You cannot change the software type installed on the module; if you purchase an ASA IPS module, you
cannot later install other software on it.

Default Settings
Table 58-1 lists the default settings for the ASA IPS module.
Table 58-1

Note

Default Network Parameters

Parameters

Default

Management VLAN (ASA 5505 only)

VLAN 1

Management IP address

192.168.1.2/24

Management hosts (ASA 5505 only)

192.168.1.5 through 192.168.1.254

Gateway

192.168.1.1/24 (the default ASA management IP address)

Username

cisco

Password

cisco

The default management IP address on the ASA is 192.168.1.1/24.

Configuring the ASA IPS module
This section describes how to configure the ASA IPS module and includes the following topics:
•

Task Flow for the ASA IPS Module, page 58-7

•

Connecting Management Interface Cables, page 58-7

Cisco ASA 5500 Series Configuration Guide using the CLI

58-6

Chapter 58

Configuring the ASA IPS Module
Configuring the ASA IPS module

•

Configuring Basic IPS Module Network Settings, page 58-10

•

(ASA 5512-X through ASA 5555-X) Installing the Software Module, page 58-14

•

Configuring the Security Policy on the ASA IPS module, page 58-14

•

Assigning Virtual Sensors to a Security Context (ASA 5510 and Higher), page 58-15

•

Diverting Traffic to the ASA IPS module, page 58-17

Task Flow for the ASA IPS Module
Configuring the ASA IPS module is a process that includes configuration of the IPS security policy on
the ASA IPS module and then configuration of the ASA to send traffic to the ASA IPS module. To
configure the ASA IPS module, perform the following steps:
Step 1

Cable the ASA and IPS management interfaces. See the “Connecting Management Interface Cables”
section on page 58-7.

Step 2

Depending on your ASA model:
•

(ASA 5510 and higher) Configure basic network settings for the IPS module. See the “(ASA 5510
and Higher) Configuring Basic Network Settings” section on page 58-10.

•

(ASA 5505) Configure the management VLAN and IP address for the IPS module. See the “(ASA
5505) Configuring Basic Network Settings” section on page 58-11.

Step 3

(ASA 5512-X through ASA 5555-X; may be required) Install the software module. See the “(ASA
5512-X through ASA 5555-X) Installing the Software Module” section on page 58-14.

Step 4

On the module, configure the inspection and protection policy, which determines how to inspect traffic
and what to do when an intrusion is detected. See the “Configuring the Security Policy on the ASA IPS
module” section on page 58-14.

Step 5

(ASA 5510 and higher, optional) On the ASA in multiple context mode, specify which IPS virtual
sensors are available for each context (if you configured virtual sensors). See the “Assigning Virtual
Sensors to a Security Context (ASA 5510 and Higher)” section on page 58-15.

Step 6

On the ASA, identify traffic to divert to the ASA IPS module. See the “Diverting Traffic to the ASA IPS
module” section on page 58-17.

Connecting Management Interface Cables
Connect the management PC to the ASA management interface and the ASA IPS module management
interface.

Guidelines
•

Your cabling might differ depending on your network.

•

See the “Information About Management Access” section on page 58-4.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-7

Chapter 58

Configuring the ASA IPS Module

Configuring the ASA IPS module

Detailed Steps
ASA 5505

The ASA 5505 does not have a dedicated management interface. You must use an ASA VLAN to access
an internal management IP address over the backplane. For a factory default configuration, connect the
management PC to one of the following ports: Ethernet 0/1 through 0/7, which are assigned to VLAN 1.

Ports 1 − 7 VLAN 1
Default ASA IP: 192.168.1.1/IPS IP: 192.168.1.2
Default IPS Gateway: 192.168.1.1 (ASA)

ASA 5505

Security
Services
Card Slot

Console

STATUS

Cisco ASA SSC-05

2

POWER
48VDC

RESET

1

7 POWER over ETHERNET 6

5

4

3

2

1

0

Management PC
(IP Address from DHCP)

ASA 5512-X through ASA 5555-X (Software Module)

These models run the ASA IPS module as a software module, and the IPS management interface shares
the Management 0/0 interface with the ASA.

ASA 5545-X

IPS Management 0/0
192.168.1.2
ASA Management 0/0
192.168.1.1

331181

PC (IP Address
from DHCP)

Cisco ASA 5500 Series Configuration Guide using the CLI

58-8

Chapter 58

Configuring the ASA IPS Module
Configuring the ASA IPS module

ASA 5510, ASA 5520, ASA 5540, ASA 5580, ASA 5585-X (Physical Module)

Connect to the ASA Management 0/0 interface and the IPS Management 1/0 interface.

ASA 5585-X IPS SSP

IPS Management 1/0
192.168.1.2
0
1

SFP1

SFP0

7

6

5

4

3

2

1

0

1

MGMT

0

USB

SFP1

SFP0

7

6

5

4

3

2

1

0

1

MGMT

0

USB

R
PW

OT
BO

A
AL

RM

AC

T

AC

T

N

1
PS

0
PS

D
HD

N
VP

1
PS

0
PS

HD

VP

1

D
HD

RESET

0

AUX

CONSOLE

AUX

CONSOLE

0
1
PW

R

O
BO

T

A
AL

RM

D1

D0
HD

RESET

Switch

PC (IP Address
from DHCP)

331182

ASA Management 0/0
192.168.1.1

SSP

What to Do Next
•

(ASA 5510 and higher) Configure basic network settings. See the “(ASA 5510 and Higher)
Configuring Basic Network Settings” section on page 58-10.

•

(ASA 5505) Configure management interface settings. See the “(ASA 5505) Configuring Basic
Network Settings” section on page 58-11.

Sessioning to the Module from the ASA
To access the IPS module CLI from the ASA, you can session from the ASA. For software modules, you
can either session to the module (using Telnet) or create a virtual console session. A console session
might be useful if the control plane is down and you cannot establish a Telnet session.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-9

Chapter 58

Configuring the ASA IPS Module

Configuring the ASA IPS module

Detailed Steps

Command

Purpose

Telnet session.

Accesses the module using Telnet. You are prompted for the username and
password. The default username is cisco, and the default password is cisco.

For a physical module (for example, the
ASA 5585-X):

Note

session 1

The first time you log in to the module, you are prompted to change
the default password. Passwords must be at least eight characters
long and cannot be a word in the dictionary.

For a software module (for example, the
ASA 5545-X):
session ips

Example:
hostname# session 1
Opening command session with slot 1.
Connected to slot 1. Escape character
sequence is 'CTRL-^X'.
sensor login: cisco
Password: cisco

Console session (software module only).
session ips console

Accesses the module console. You are prompted for the username and
password. The default username is cisco, and the default password is cisco.

Example:
hostname# session ips console
Establishing console session with slot 1
Opening console session with module ips.
Connected to module ips. Escape character
sequence is 'CTRL-SHIFT-6 then x'.
sensor login: cisco
Password: cisco

Configuring Basic IPS Module Network Settings
•

(ASA 5510 and Higher) Configuring Basic Network Settings, page 58-10

•

(ASA 5505) Configuring Basic Network Settings, page 58-11

(ASA 5510 and Higher) Configuring Basic Network Settings
Session to the module from the ASA and configure basic settings using the setup command.

Note

(ASA 5512-X through ASA 5555-X) If you cannot session to the module, then the IPS module is not
running. See the “(ASA 5512-X through ASA 5555-X) Installing the Software Module” section on
page 58-14, and then repeat this procedure after you install the module.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-10

Chapter 58

Configuring the ASA IPS Module
Configuring the ASA IPS module

Detailed Steps

Command

Purpose

Step 1

Session to the IPS module according to the
“Sessioning to the Module from the ASA”
section on page 58-9.

Step 2

setup

Runs the setup utility for initial configuration of the ASA IPS
module. You are prompted for basic settings.

Example:
sensor# setup

(ASA 5505) Configuring Basic Network Settings
An ASA IPS module on the ASA 5505 does not have any external interfaces. You can configure a VLAN
to allow access to an internal IPS management IP address over the backplane. By default, VLAN 1 is
enabled for IPS management. You can only assign one VLAN as the management VLAN. This section
describes how to change the management VLAN and IP address if you do not want to use the default. It
also describes how to change the allowed hosts and gateway. See the “Default Settings” section on
page 58-6 for more information about defaults.

Note

Perform this configuration on the ASA 5505, not on the ASA IPS module.

Prerequisites
When you change the IPS VLAN and management address from the default, be sure to also configure
the matching ASA VLAN and switch port(s) according to the procedures listed in Chapter 7, “Starting
Interface Configuration (ASA 5505).” You must define and configure the VLAN for the ASA so the IPS
management interface is accessible on the network.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-11

Chapter 58

Configuring the ASA IPS Module

Configuring the ASA IPS module

Restrictions
Do not configure NAT for the management address if you intend to access it using ASDM. For initial
setup with ASDM, you need to access the real address. After initial setup (where you set the password
on the ASA IPS module), you can configure NAT and supply ASDM with the translated address for
accessing the ASA IPS module.

Detailed Steps

Step 1

Command

Purpose

interface vlan number

Specifies the current management VLAN for which you want to
disable IPS management. By default, this is VLAN 1.

Example:
hostname(config)# interface vlan 1

Step 2

no allow-ssc-mgmt

Disables IPS management for the old VLAN so that you can
enable it for a different VLAN.

Example:
hostname(config-if)# no allow-ssc-mgmt

Step 3

interface vlan number

Specifies the VLAN you want to use as the new IPS management
VLAN.

Example:
hostname(config)# interface vlan 20

Step 4

allow-ssc-mgmt

Example:
hostname(config-if)# allow-ssc-mgmt

Cisco ASA 5500 Series Configuration Guide using the CLI

58-12

Sets this interface as the IPS management interface.

Chapter 58

Configuring the ASA IPS Module
Configuring the ASA IPS module

Step 5

Command

Purpose

hw-module module 1 ip ip_address netmask
gateway

Configures the management IP address for the ASA IPS module.
Make sure this address is on the same subnet as the ASA VLAN
IP address. For example, if you assigned 10.1.1.1 to the VLAN for
the ASA, then assign another address on that network, such as
10.1.1.2, for the IPS management address.

Example:
hostname# hw-module module 1 ip 10.1.1.2
255.255.255.0 10.1.1.1

If the management station is on a directly-connected ASA
network, then set the gateway to be the ASA IP address assigned
to the IPS management VLAN. In the above example, set the
gateway to 10.1.1.1. If the management station is on a remote
network, then set the gateway to be the address of an upstream
router on the IPS management VLAN.
Note

These settings are written to the IPS application
configuration, not the ASA configuration. You can view
these settings from the ASA using the show module
details command.
You can alternatively use the IPS application setup
command to configure this setting from the IPS CLI.

Step 6

hw-module module 1 allow-ip ip_address
netmask

Sets the hosts that are allowed to access the management IP
address.
Note

Example:
hostname# hw-module module 1 allow-ip
10.1.1.30 255.255.255.0

These settings are written to the IPS application
configuration, not the ASA configuration. You can view
these settings from the ASA using the show module
details command.
You can alternatively use the IPS application setup
command to configure this setting from the IPS CLI.

Examples
The following example configures VLAN 20 as the IPS management VLAN. This VLAN is restricted
to management traffic only. Only the host at 10.1.1.30 can access the IPS management IP address. VLAN
20 is assigned to switch port Ethernet 0/0. When you connect to ASDM on ASA interface 10.1.1.1,
ASDM then accesses the IPS on 10.1.1.2.
hostname(config)# interface vlan 1
hostname(config-if)# no allow-ssc-mgmt
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#
hostname(config-if)#

interface vlan 20
nameif inside
ip address 10.1.1.1 255.255.255.0
security-level 100
allow-ssc-mgmt
no shutdown
management-only

hostname(config-if)# hw-module module 1 ip 10.1.1.2 255.255.255.0 10.1.1.1
hostname(config)# hw-module module 1 allow-ip 10.1.1.30 255.255.255.255
hostname(config)# interface ethernet 0/0
hostname(config-if)# switchport access vlan 20
hostname(config-if)# no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

58-13

Chapter 58

Configuring the ASA IPS Module

Configuring the ASA IPS module

(ASA 5512-X through ASA 5555-X) Installing the Software Module
Your ASA typically ships with IPS module software present on Disk0. If the module is not running,
however, you need to install the module.

Detailed Steps
Step 1

To view the IPS module software filename in flash memory, enter:.
hostname# dir disk0:

For example, look for a filename like IPS-SSP_5512-K9-sys-1.1-a-7.1-4-E4.aip. Note the filename; you
will need this filename later in the procedure.
Step 2

If you need to copy a new image to disk0, download the image from Cisco.com to a TFTP server, and
then enter:
hostname# copy tftp://server/file_path disk0:/file_path

For other server types, see the “Downloading a File to a Specific Location” section on page 81-3.
Step 3

To identify the IPS module software location in disk0, enter the following command:
hostname# sw-module module ips recover configure image disk0:file_path

For example, using the filename in the example in Step 1, enter:
hostname# sw-module module ips recover configure image
disk0:IPS-SSP_5512-K9-sys-1.1-a-7.1-4-E4.aip

Step 4

To install and load the IPS module software, enter the following command:
hostname# sw-module module ips recover boot

Step 5

To check the progress of the image transfer and module restart process, enter the following command:
hostname# show module ips details

The Status field in the output indicates the operational status of the module. A module operating
normally shows a status of “Up.” While the ASA transfers an application image to the module, the Status
field in the output reads “Recover.” When the ASA completes the image transfer and restarts the module,
the newly transferred image is running.

Configuring the Security Policy on the ASA IPS module
This section describes how to configure the ASA IPS module application.

Detailed Steps
Step 1

Access the ASA IPS module CLI using one of the following methods:
•

Session from the ASA to the ASA IPS module. See the “Sessioning to the Module from the ASA”
section on page 58-9.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-14

Chapter 58

Configuring the ASA IPS Module
Configuring the ASA IPS module

•

Step 2

Connect to the IPS management interface using SSH. If you did not change it, the default
management IP address is 192.168.1.2. The default username is cisco, and the default password is
cisco. See the “Information About Management Access” section on page 58-4 for more information
about the management interface.

Configure the IPS security policy according to the IPS documentation.
To access all documents related to IPS, go to:
http://www.cisco.com/en/US/products/hw/vpndevc/ps4077/products_documentation_roadmaps_list.ht
ml

Step 3

(ASA 5510 and higher) If you configure virtual sensors, you identify one of the sensors as the default.
If the ASA does not specify a virtual sensor name in its configuration, the default sensor is used.

Step 4

When you are done configuring the ASA IPS module, exit the IPS software by entering the following
command:
sensor# exit

If you sessioned to the ASA IPS module from the ASA, you return to the ASA prompt.

What to Do Next
•

For the ASA in multiple context mode, see the “Assigning Virtual Sensors to a Security Context
(ASA 5510 and Higher)” section on page 58-15.

•

For the ASA in single context mode, see the “Diverting Traffic to the ASA IPS module” section on
page 58-17.

Assigning Virtual Sensors to a Security Context (ASA 5510 and Higher)
If the ASA is in multiple context mode, then you can assign one or more IPS virtual sensors to each
context. Then, when you configure the context to send traffic to the ASA IPS module, you can specify a
sensor that is assigned to the context; you cannot specify a sensor that you did not assign to the context.
If you do not assign any sensors to a context, then the default sensor configured on the ASA IPS module
is used. You can assign the same sensor to multiple contexts.

Note

You do not need to be in multiple context mode to use virtual sensors; you can be in single mode and use
different sensors for different traffic flows.

Prerequisites
For more information about configuring contexts, see the “Configuring Multiple Contexts” section on
page 5-14.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-15

Chapter 58

Configuring the ASA IPS Module

Configuring the ASA IPS module

Detailed Steps

Step 1

Command

Purpose

context name

Identifies the context you want to configure. Enter this command in
the system execution space.

Example:
hostname(config)# context admin
hostname(config-ctx)#

Step 2

allocate-ips sensor_name [mapped_name]
[default]

Example:
hostname(config-ctx)# allocate-ips
sensor1 highsec

Enter this command for each sensor you want to assign to the context.
The sensor _name argument is the sensor name configured on the
ASA IPS module. To view the sensors that are configured on the ASA
IPS module, enter allocate-ips ?. All available sensors are listed. You
can also enter the show ips command. In the system execution space,
the show ips command lists all available sensors; if you enter it in the
context, it shows the sensors you already assigned to the context. If
you specify a sensor name that does not yet exist on the ASA IPS
module, you get an error, but the allocate-ips command is entered as
is. Until you create a sensor of that name on the ASA IPS module, the
context assumes the sensor is down.
Use the mapped_name argument as an alias for the sensor name that
can be used within the context instead of the actual sensor name. If
you do not specify a mapped name, the sensor name is used within
the context. For security purposes, you might not want the context
administrator to know which sensors are being used by the context.
Or you might want to genericize the context configuration. For
example, if you want all contexts to use sensors called “sensor1” and
“sensor2,” then you can map the “highsec” and “lowsec” sensors to
sensor1 and sensor2 in context A, but map the “medsec” and
“lowsec” sensors to sensor1 and sensor2 in context B.
The default keyword sets one sensor per context as the default
sensor; if the context configuration does not specify a sensor name,
the context uses this default sensor. You can only configure one
default sensor per context. If you want to change the default sensor,
enter the no allocate-ips sensor_name command to remove the
current default sensor before you allocate a new default sensor. If you
do not specify a sensor as the default, and the context configuration
does not include a sensor name, then traffic uses the default sensor as
specified on the ASA IPS module.

Step 3

changeto context context_name

Changes to the context so you can configure the IPS security policy
as described in “Diverting Traffic to the ASA IPS module” section on
page 58-17.

Example:
hostname# changeto context customer1
hostname/customer1#

Cisco ASA 5500 Series Configuration Guide using the CLI

58-16

Chapter 58

Configuring the ASA IPS Module
Configuring the ASA IPS module

Examples
The following example assigns sensor1 and sensor2 to context A, and sensor1 and sensor3 to context B.
Both contexts map the sensor names to “ips1” and “ips2.” In context A, sensor1 is set as the default
sensor, but in context B, no default is set so the default that is configured on the ASA IPS module is used.
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
int3-int8
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#

context A
allocate-interface gigabitethernet0/0.100 int1
allocate-interface gigabitethernet0/0.102 int2
allocate-interface gigabitethernet0/0.110-gigabitethernet0/0.115

hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
int3-int8
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#
hostname(config-ctx)#

context sample
allocate-interface gigabitethernet0/1.200 int1
allocate-interface gigabitethernet0/1.212 int2
allocate-interface gigabitethernet0/1.230-gigabitethernet0/1.235

allocate-ips sensor1 ips1 default
allocate-ips sensor2 ips2
config-url ftp://user1:passw0rd@10.1.1.1/configlets/test.cfg
member gold

allocate-ips sensor1 ips1
allocate-ips sensor3 ips2
config-url ftp://user1:passw0rd@10.1.1.1/configlets/sample.cfg
member silver

hostname(config-ctx)# changeto context A
...

What to Do Next
Change to each context to configure the IPS security policy as described in “Diverting Traffic to the ASA
IPS module” section on page 58-17.

Diverting Traffic to the ASA IPS module
This section identifies traffic to divert from the ASA to the ASA IPS module.

Prerequisites
In multiple context mode, perform these steps in each context execution space. To change to a context,
enter the changeto context context_name command.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-17

Chapter 58

Configuring the ASA IPS Module

Configuring the ASA IPS module

Detailed Steps

Step 1

Command

Purpose

class-map name

Creates a class map to identify the traffic for which you want to
send to the ASA IPS module.

Example:
hostname(config)# class-map ips_class

Step 2

match parameter

If you want to send multiple traffic classes to the ASA IPS
module, you can create multiple class maps for use in the security
policy.
Specifies the traffic in the class map. See the “Identifying Traffic
(Layer 3/4 Class Maps)” section on page 32-12 for more
information.

Example:
hostname(config-cmap)# match access-list
ips_traffic

Step 3

policy-map name

Adds or edits a policy map that sets the actions to take with the
class map traffic.

Example:
hostname(config)# policy-map ips_policy

Step 4

class name

Example:
hostname(config-pmap)# class ips_class

Cisco ASA 5500 Series Configuration Guide using the CLI

58-18

Identifies the class map you created in Step 1.

Chapter 58

Configuring the ASA IPS Module
Configuring the ASA IPS module

Step 5

Command

Purpose

ips {inline | promiscuous} {fail-close |
fail-open} [sensor {sensor_name |
mapped_name}]

Specifies that the traffic should be sent to the ASA IPS module.

Example:

The fail-close keyword sets the ASA to block all traffic if the ASA
IPS module is unavailable.

hostname(config-pmap-c)# ips promiscuous
fail-close

The inline and promiscuous keywords control the operating
mode of the ASA IPS module. See the “Operating Modes” section
on page 58-2 for more details.

The fail-open keyword sets the ASA to allow all traffic through,
uninspected, if the ASA IPS module is unavailable.
(ASA 5510 and higher) If you use virtual sensors, you can specify
a sensor name using the sensor sensor_name argument. To see
available sensor names, enter the ips {inline | promiscuous}
{fail-close | fail-open} sensor ? command. Available sensors are
listed. You can also use the show ips command. If you use
multiple context mode on the ASA, you can only specify sensors
that you assigned to the context (see the “Assigning Virtual
Sensors to a Security Context (ASA 5510 and Higher)” section on
page 58-15). Use the mapped_name if configured in the context.
If you do not specify a sensor name, then the traffic uses the
default sensor. In multiple context mode, you can specify a default
sensor for the context. In single mode or if you do not specify a
default sensor in multiple mode, the traffic uses the default sensor
that is set on the ASA IPS module. If you enter a name that does
not yet exist on the ASA IPS module, you get an error, and the
command is rejected.

Step 6

(Optional)
class name2

Example:
hostname(config-pmap)# class ips_class2

If you created multiple class maps for IPS traffic, you can specify
another class for the policy.
See the “Feature Matching Within a Service Policy” section on
page 32-3 for detailed information about how the order of classes
matters within a policy map. Traffic cannot match more than one
class map for the same action type; so if you want network A to
go to sensorA, but want all other traffic to go to sensorB, then you
need to enter the class command for network A before you enter
the class command for all traffic; otherwise all traffic (including
network A) will match the first class command, and will be sent
to sensorB.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-19

Chapter 58

Configuring the ASA IPS Module

Monitoring the ASA IPS module

Step 7

Command

Purpose

(Optional)

Specifies that the second class of traffic should be sent to the ASA
IPS module.

ips {inline | promiscuous} {fail-close |
fail-open} [sensor {sensor_name |
mapped_name}]

Add as many classes as desired by repeating these steps.

Example:
hostname(config-pmap-c)# ips promiscuous
fail-close

Step 8

service-policy policymap_name {global |
interface interface_name}

Example:
hostname(config)# service-policy
tcp_bypass_policy outside

Activates the policy map on one or more interfaces. global 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.

Monitoring the ASA IPS module
To check the status of a module, enter one of the following commands:
Command

Purpose

show module

Displays the status.

show module {1 | ips} details

Displays additional status information. Specify 1 for a physical module
and ips for a software module.

show module {1 | ips} recover

Displays the network parameters for transferring an image to the module.
Specify 1 for a physical module and ips for a software module.

Examples
The following is sample output from the show module details command, which provides additional
information for an ASA with an SSC installed:
hostname# show module 1 details
Getting details from the Service Module, please wait...
ASA 5500 Series Security Services Card-5
Hardware version: 0.1
Serial Number: JAB11370240
Firmware version: 1.0(14)3
Software version: 6.2(1)E2
MAC Address Range: 001d.45c2.e832 to 001d.45c2.e832
App. Name: IPS
App. Status: Up
App. Status Desc: Not Applicable
App. Version: 6.2(1)E2
Data plane Status: Up
Status: Up
Mgmt IP Addr: 209.165.201.29
Mgmt Network Mask: 255.255.224.0
Mgmt Gateway: 209.165.201.30
Mgmt Access List: 209.165.201.31/32

Cisco ASA 5500 Series Configuration Guide using the CLI

58-20

Chapter 58

Configuring the ASA IPS Module
Troubleshooting the ASA IPS module

209.165.202.158/32
209.165.200.254/24
Mgmt Vlan: 20

Troubleshooting the ASA IPS module
This section includes procedures that help you recover or troubleshoot the module and includes the
following topics:
•

Installing an Image on the Module, page 58-21

•

Uninstalling a Software Module Image, page 58-23

•

Resetting the Password, page 58-23

•

Reloading or Resetting the Module, page 58-24

•

Shutting Down the Module, page 58-24

Installing an Image on the Module
If the module suffers a failure, and the module application image cannot run, you can reinstall a new
image on the module from a TFTP server (for a physical module), or from the local disk (software
module).

Note

Do not use the upgrade command within the module software to install the image.

Prerequisites
•

Physical module—Be sure the TFTP server that you specify can transfer files up to 60 MB in size.

Note

•

This process can take approximately 15 minutes to complete, depending on your network
and the size of the image.

Software module—Copy the image to the ASA internal flash (disk0) before completing this
procedure.

Note

Before you download the IPS software to disk0, make sure at least 50% of the flash memory
is free. When you install IPS, IPS reserves 50% of the internal flash memory for its file
system.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-21

Chapter 58

Configuring the ASA IPS Module

Troubleshooting the ASA IPS module

Detailed Steps

Step 1

Command

Purpose

For a physical module (for example, the ASA
5585-X):

Specifies the location of the new image.

sw-module module ips recover configure
image disk0:file_path

For a physical module—This command prompts you for the URL
for the TFTP server, the management interface IP address and
netmask, gateway address, and VLAN ID (ASA 5505 only).
These network parameters are configured in ROMMON; the
network parameters you configured in the module application
configuration are not available to ROMMON, so you must set
them separately here.

Example:

For a software module—Specify the location of the image on the
local disk.

hw-module module 1 recover configure

For a software module (for example, the ASA
5545-X):

hostname# hw-module module 1 recover
configure
Image URL [tftp://127.0.0.1/myimage]:
tftp://10.1.1.1/ids-newimg
Port IP Address [127.0.0.2]: 10.1.2.10
Port Mask [255.255.255.254]: 255.255.255.0
Gateway IP Address [1.1.2.10]: 10.1.2.254
VLAN ID [0]: 100

Step 2

For a physical module:

You can view the recovery configuration using the show module
{1 | ips} recover command.
In multiple context mode, enter this command in the system
execution space.

Installs and loads the IPS module software.

hw-module module 1 recover boot

For a software module:
sw-module module ips recover boot

Example:
hostname# hw-module module 1 recover boot

Step 3

For a physical module:
show module 1 details

For a software module:
show module ips details

Example:
hostname# show module 1 details

Cisco ASA 5500 Series Configuration Guide using the CLI

58-22

Checks the progress of the image transfer and module restart
process.
The Status field in the output indicates the operational status of
the module. A module operating normally shows a status of “Up.”
While the ASA transfers an application image to the module, the
Status field in the output reads “Recover.” When the ASA
completes the image transfer and restarts the module, the newly
transferred image is running.

Chapter 58

Configuring the ASA IPS Module
Troubleshooting the ASA IPS module

Uninstalling a Software Module Image
To uninstall a software module image and associated configuration, perform the following steps.

Detailed Steps

Command

Purpose

sw-module module ips uninstall

Permanently uninstalls the software module image and associated
configuration.

Example:
hostname# sw-module module ips uninstall
Module ips will be uninstalled. This will
completely remove the
disk image associated with the sw-module including
any configuration
that existed within it.
Uninstall module ? [confirm]

Resetting the Password
You can reset the module password to the default. The default password is cisco. After resetting the
password, you should change it to a unique value using the module application.
Resetting the module password causes the module to reboot. Services are not available while the module
is rebooting.
To reset the module password to the default of cisco, perform the following steps.

Detailed Steps

Command

Purpose

For a physical module (for example, the ASA 5585-X):

Resets the module password to cisco.

hw-module module 1 password-reset

For a software module (for example, the ASA 5545-X):
sw-module module ips password-reset

Example:
hostname# hw-module module 1 password-reset

Cisco ASA 5500 Series Configuration Guide using the CLI

58-23

Chapter 58

Configuring the ASA IPS Module

Troubleshooting the ASA IPS module

Reloading or Resetting the Module
To reload or reset the module, enter one of the following commands at the ASA CLI.

Detailed Steps

Command

Purpose

For a physical module (for example, the ASA
5585-X):

Reloads the module software.

hw-module module 1 reload

For a software module (for example, the ASA
5545-X):
sw-module module ips reload

Example:
hostname# hw-module module 1 reload

For a physical module:

Performs a reset, and then reloads the module.

hw-module module 1 reset

For a software module:
sw-module module ips reset

Example:
hostname# hw-module module 1 reset

Shutting Down the Module
If you restart the ASA, the module is not automatically restarted. To shut down the module, perform the
following steps at the ASA CLI.

Detailed Steps

Command

Purpose

For a physical module (for example, the ASA
5585-X):

Shuts down the module.

hw-module module 1 shutdown

For a software module (for example, the ASA
5545-X):
sw-module module ips shutdown

Example:
hostname# hw-module module 1 shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

58-24

Chapter 58

Configuring the ASA IPS Module
Configuration Examples for the ASA IPS module

Configuration Examples for the ASA IPS module
The following example diverts all IP traffic to the ASA IPS module in promiscuous mode, and blocks
all IP traffic if the ASA IPS module card fails for any reason:
hostname(config)# access-list IPS permit ip any any
hostname(config)# class-map my-ips-class
hostname(config-cmap)# match access-list IPS
hostname(config-cmap)# policy-map my-ips-policy
hostname(config-pmap)# class my-ips-class
hostname(config-pmap-c)# ips promiscuous fail-close
hostname(config-pmap-c)# service-policy my-ips-policy global

The following example diverts all IP traffic destined for the 10.1.1.0 network and the 10.2.1.0 network
to the AIP SSM in inline mode, and allows all traffic through if the AIP SSM fails for any reason. For
the my-ips-class traffic, sensor1 is used; for the my-ips-class2 traffic, sensor2 is used.
hostname(config)# access-list my-ips-acl permit ip any 10.1.1.0 255.255.255.0
hostname(config)# access-list my-ips-acl2 permit ip any 10.2.1.0 255.255.255.0
hostname(config)# class-map my-ips-class
hostname(config-cmap)# match access-list my-ips-acl
hostname(config)# class-map my-ips-class2
hostname(config-cmap)# match access-list my-ips-acl2
hostname(config-cmap)# policy-map my-ips-policy
hostname(config-pmap)# class my-ips-class
hostname(config-pmap-c)# ips inline fail-open sensor sensor1
hostname(config-pmap)# class my-ips-class2
hostname(config-pmap-c)# ips inline fail-open sensor sensor2
hostname(config-pmap-c)# service-policy my-ips-policy interface outside

Feature History for the ASA IPS module
Table 58-2 lists each feature change and the platform release in which it was implemented.
Table 58-2

Feature History for the ASA IPS module

Feature Name

Platform
Releases

AIP SSM

7.0(1)

Feature Information
We introduced support for the AIP SSM for the ASA 5510,
5520, and 5540.
The following command was introduced: ips.

Virtual sensors (ASA 5510 and higher)

8.0(2)

Virtual sensor support was introduced. Virtual sensors let
you configure multiple security policies on the ASA IPS
module.
The following command was introduced: allocate-ips.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-25

Chapter 58

Configuring the ASA IPS Module

Feature History for the ASA IPS module

Table 58-2

Feature History for the ASA IPS module (continued)

Feature Name

Platform
Releases

Feature Information

AIP SSC for the ASA 5505

8.2(1)

We introduced support for the AIP SSC for the ASA 5505.
The following commands were introduced:
allow-ssc-mgmt, hw-module module ip, and hw-module
module allow-ip.

Support for the ASA IPS SSP-10, -20, -40, and 8.2(5)/
-60 for the ASA 5585-X
8.4(2)

We introduced support for the ASA IPS SSP-10, -20, -40,
and -60 for the ASA 5585-X. You can only install the ASA
IPS SSP with a matching-level SSP; for example, SSP-10
and ASA IPS SSP-10.
Note

Support for Dual SSPs for SSP-40 and SSP-60

8.4(2)

The ASA 5585-X is not supported in Version 8.3.

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.
Note

When using two SSPs in the chassis, VPN is not
supported; note, however, that VPN has not been
disabled.

We modified the following commands: show module, show
inventory, show environment.
Support for the ASA IPS SSP for the ASA
5512-X through ASA 5555-X

8.6(1)

We introduced support for the ASA IPS SSP software
module for the ASA 5512-X, ASA 5515-X, ASA 5525-X,
ASA 5545-X, and ASA 5555-X.
We introduced or modified the following commands:
session, show module, sw-module.

Cisco ASA 5500 Series Configuration Guide using the CLI

58-26

CH A P T E R

59

Configuring the ASA CX Module
This chapter describes how to configure the ASA CX module that runs on the ASA. This chapter includes
the following sections:
•

Information About the ASA CX Module, page 59-1

•

Licensing Requirements for the ASA CX Module, page 59-4

•

Guidelines and Limitations, page 59-4

•

Default Settings, page 59-5

•

Configuring the ASA CX Module, page 59-5

•

Monitoring the ASA CX Module, page 59-12

•

Troubleshooting the ASA CX Module, page 59-17

•

Configuration Examples for the ASA CX Module, page 59-21

•

Feature History for the ASA CX Module, page 59-22

Information About the ASA CX Module
The ASA CX module lets you enforce security based on the complete context of a situation. This context
includes the identity of the user (who), the application or website that the user is trying to access (what),
the origin of the access attempt (where), the time of the attempted access (when), and the properties of
the device used for the access (how). With the ASA CX module, you can extract the full context of a
flow and enforce granular policies such as permitting access to Facebook but denying access to games
on Facebook or permitting finance employees access to a sensitive enterprise database but denying the
same to other employees.
This section includes the following topics:
•

How the ASA CX Module Works with the ASA, page 59-2

•

Information About ASA CX Management, page 59-2

•

Information About Authentication Proxy, page 59-3

•

Information About VPN and the ASA CX Module, page 59-4

•

Compatibility with ASA Features, page 59-4

Cisco ASA 5500 Series Configuration Guide using the CLI

59-1

Chapter 59

Configuring the ASA CX Module

Information About the ASA CX Module

How the ASA CX Module Works with the ASA
The ASA CX module runs a separate application from the ASA. The ASA CX module includes external
management interface(s) so you can connect to the ASA CX module directly. Any data interfaces on the
ASA CX module are used for ASA traffic only.
Traffic goes through the firewall checks before being forwarded to the ASA CX module. When you
identify traffic for ASA CX inspection on the ASA, traffic flows through the ASA and the ASA CX
module as follows:
1.

Traffic enters the ASA.

2.

Incoming VPN traffic is decrypted.

3.

Firewall policies are applied.

4.

Traffic is sent to the ASA CX module.

5.

The ASA CX module applies its security policy to the traffic, and takes appropriate actions.

6.

Valid traffic is sent back to the ASA; the ASA CX module might block some traffic according to its
security policy, and that traffic is not passed on.

7.

Outgoing VPN traffic is encrypted.

8.

Traffic exits the ASA.

Figure 59-1 shows the traffic flow when using the ASA CX module. In this example, the ASA CX
module automatically blocks traffic that is not allowed for a certain application. All other traffic is
forwarded through the ASA.
Figure 59-1

ASA CX Module Traffic Flow in the ASA

ASA
Main System
Firewall
Policy

inside

VPN
Decryption

outside

Block
ASA CX inspection
ASA CX

Note

If you have a connection between hosts on two ASA interfaces, and the ASA CX service policy is only
configured for one of the interfaces, then all traffic between these hosts is sent to the ASA CX module,
including traffic orginiating on the non-ASA CX interface (the feature is bidirectional). However, the
ASA only performs the authentication proxy on the interface to which the service policy is applied,
because this feature is ingress-only.

Information About ASA CX Management
•

Initial Configuration, page 59-3

Cisco ASA 5500 Series Configuration Guide using the CLI

59-2

333470

Diverted Traffic

Chapter 59

Configuring the ASA CX Module
Information About the ASA CX Module

•

Policy Configuration and Management, page 59-3

Initial Configuration
For initial configuration, you must use the CLI on the ASA CX module to run the setup command and
configure other optional settings.
To access the CLI, you can use the following methods:

Note

•

ASA CX console port.

•

ASA CX Management 1/0 interface using SSH—You can connect to the default IP address
(192.168.8.8.), or you can use ASDM to change the management IP address and then connect using
SSH.

You cannot access the ASA CX module CLI over the ASA backplane using the session command.

Policy Configuration and Management
After you perform initial configuration, configure the ASA CX policy using Cisco Prime Security
Manager (PRSM). Then configure the ASA policy for sending traffic to the ASA CX module using
ASDM or the ASA CLI.

Note

When using PRSM in multiple device mode, you can configure the ASA policy for sending traffic to the
ASA CX module within PRSM, instead of using ASDM or the ASA CLI. Using PRSM lets you
consolodate management to a single management system. However, PRSM has some limitations when
configuring the ASA service policy; see the ASA CX user guide for more information.

Information About Authentication Proxy
When the ASA CX needs to authenticate an HTTP user (to take advantage of identity policies), you must
configure the ASA to act as an authentication proxy: the ASA CX module redirects authentication
requests to the ASA interface IP address/proxy port. By default, the port is 885 (user configurable).
Configure this feature as part of the service policy to divert traffic from the ASA to the ASA CX module.
If you do not enable the authentication proxy, only passive authentication is available.

Note

If you have a connection between hosts on two ASA interfaces, and the ASA CX service policy is only
configured for one of the interfaces, then all traffic between these hosts is sent to the ASA CX module,
including traffic orginiating on the non-ASA CX interface (the feature is bidirectional). However, the
ASA only performs the authentication proxy on the interface to which the service policy is applied,
because this feature is ingress-only.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-3

Chapter 59

Configuring the ASA CX Module

Licensing Requirements for the ASA CX Module

Information About VPN and the ASA CX Module
The ASA includes VPN client and user authentication metadata when forwarding traffic to the ASA CX
module, which allows the ASA CX module to include this information as part of its policy lookup
criteria. The VPN metadata is sent only at VPN tunnel establishment time along with a type-length-value
(TLV) containing the session ID. The ASA CX module caches the VPN metadata for each session. Each
tunneled connection sends the session ID so the ASA CX module can look up that session’s metadata.

Compatibility with ASA Features
The ASA includes many advanced application inspection features, including HTTP inspection.
However, the ASA CX module provides more advanced HTTP inspection than the ASA provides, as well
as additional features for other applications, including monitoring and controlling application usage.
To take full advantage of the ASA CX module features, see the following guidelines for traffic that you
send to the ASA CX module:
•

Do not configure ASA inspection on HTTP traffic.

•

Other application inspections on the ASA are compatible with the ASA CX module, including the
default inspections.

•

Do not enable the Mobile User Security (MUS) server; it is not compatible with the ASA CX
module.

•

If you enable failover, when the ASA fails over, any existing ASA CX flows are transferred to the
new ASA, but the traffic is allowed through the ASA without being acted upon by the ASA CX
module. Only new flows recieved by the new ASA are acted upon by the ASA CX module.

Licensing Requirements for the ASA CX Module
The following table shows the licensing requirements for this feature:
Model

License Requirement

All models

Base License.
The ASA CX module and PRSM require additional licenses. See the ASA CX documentation for more
information.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode only. Does not support multiple context mode.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-4

Chapter 59

Configuring the ASA CX Module
Default Settings

Failover Guidelines

Does not support failover directly; when the ASA fails over, any existing ASA CX flows are transferred
to the new ASA, but the traffic is allowed through the ASA without being inspected by the ASA CX.
IPv6 Guidelines

Supports IPv6.
Model Guidelines

Supported only on the ASA 5585-X. See the Cisco ASA Compatibility Matrix for more information:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asamatrx.html
Additional Guidelines and Limitations
•

See the “Compatibility with ASA Features” section on page 59-4.

•

You cannot change the software type installed on the module; if you purchase an ASA CX module,
you cannot later install other software on it.

Default Settings
Table 59-1 lists the default settings for the ASA CX module.
Table 59-1

Default Network Parameters

Parameters

Default

Management 1/0 IP address

192.168.8.8/24

Gateway

192.168.8.1/24

SSH Username

admin

Password

Admin123

Configuring the ASA CX Module
This section describes how to configure the ASA CX module and includes the following topics:
•

Task Flow for the ASA CX Module, page 59-6

•

Connecting Management Interface Cables, page 59-6

•

Configuring the ASA CX Management IP Address, page 59-7

•

Configuring Basic ASA CX Settings at the ASA CX CLI, page 59-7

•

Configuring the Security Policy on the ASA CX Module Using PRSM, page 59-9

•

Redirecting Traffic to the ASA CX Module, page 59-11

Cisco ASA 5500 Series Configuration Guide using the CLI

59-5

Chapter 59

Configuring the ASA CX Module

Configuring the ASA CX Module

Task Flow for the ASA CX Module
Configuring the ASA CX module is a process that includes configuration of the ASA CX security policy
on the ASA CX module and then configuration of the ASA to send traffic to the ASA CX module. To
configure the ASA CX module, perform the following steps:
Step 1

Cable the ASA and ASA CX management interfaces and optionally, the console interface. See the
“Connecting Management Interface Cables” section on page 59-6.

Step 2

(Optional) On the ASA, configure the ASA CX module management IP address for initial SSH access.
See the “Configuring the ASA CX Management IP Address” section on page 59-7.

Step 3

On the ASA CX module, configure basic settings. See the “Configuring Basic ASA CX Settings at the
ASA CX CLI” section on page 59-7.

Step 4

On the ASA CX module, configure the security policy using PRSM. See the “Configuring the Security
Policy on the ASA CX Module Using PRSM” section on page 59-9.

Step 5

(Optional) On the ASA, configure the authentication proxy port. See the “(Optional) Configuring the
Authentication Proxy Port” section on page 59-10.

Step 6

On the ASA, identify traffic to divert to the ASA CX module. See the “Redirecting Traffic to the ASA
CX Module” section on page 59-11.

Note

When using PRSM in multiple device mode, you can configure the ASA policy for sending
traffic to the ASA CX module within PRSM, instead of using ASDM or the ASA CLI. However,
PRSM has some limitations when configuring the ASA service policy; see the ASA CX user
guide for more information.

Connecting Management Interface Cables
Connect the management PC to the ASA and the ASA CX module management interfaces, as well as to
the ASA CX console port.

Guidelines
For initial setup, you can connect with SSH to the ASA CX Management 1/0 interface using the default
IP address (192.168.8.8/24). If you cannot use the default IP address, you can either use the console port
or use ASDM to change the management IP address so you can use SSH.

Detailed Steps
Connect to the ASA Management 0/0 interface and the ASA CX Management 1/0 interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-6

Chapter 59

Configuring the ASA CX Module
Configuring the ASA CX Module

ASA 5585-X ASA CX SSP

ASA CX
Management 1/0

ASA CX
Console

0
1
SFP1

SFP0

7

6

5

4

3

2

1

0

1

MGMT

0

USB

SFP1

SFP0

7

6

5

4

3

2

1

0

1

MGMT

0

USB

OT

R
PW

BO

R
PW

BO

M

AR

AL

T
AC

VP

T
AC

VP

D1

1

0
PS

HD

1

PS

0

HD

N

PS

N

PS

D0

HD

RESET
AUX

CONSOLE

AUX

CONSOLE

0
1
OT

M

AR

AL

D1

D0

HD

RESET

Switch

PC (IP Address
from DHCP)

333469

ASA Management 0/0

SSP

What to Do Next
•

(Optional) Configure the ASA CX management IP address. See the “Configuring the ASA CX
Management IP Address” section on page 59-7.

•

Configure basic ASA CX settings. See the “Configuring Basic ASA CX Settings at the ASA CX
CLI” section on page 59-7.

Configuring the ASA CX Management IP Address
If you cannot use the default management IP address (192.168.8.8), then you can set the management IP
address from the ASA. After you set the management IP address, you can access the ASA CX module
using SSH to perform initial setup.

Detailed Steps

Command

Purpose

session 1 do setup host ip
ip_address/mask,gateway_ip

Sets the ASA CX management IP address, mask, and gateway.

Example:
hostname# session 1 do setup host ip
10.1.1.2/24,10.1.1.1

Configuring Basic ASA CX Settings at the ASA CX CLI
You must configure basic network settings and other parameters on the ASA CX module before you can
configure your security policy.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-7

Chapter 59

Configuring the ASA CX Module

Configuring the ASA CX Module

Detailed Steps
Step 1

Step 2

Connect to the ASA CX CLI:
•

Using SSH to the ASA CX Management 1/0 interface—Log in with the username admin and the
password Admin123. You will change the password as part of this procedure.

•

Using the ASA CX console port.

Enter the following command:
asacx> setup

Example:
asacx> setup
Welcome to Cisco Prime Security Manager Setup
[hit Ctrl-C to abort]
Default values are inside [ ]

You are prompted through the setup wizard. The following example shows a typical path through the
wizard; if you enter Y instead of N at a prompt, you will be able to configure some additional settings.
This example shows how to configure both IPv4 and IPv6 static addresses. You can configure IPv6
stateless auto configuration by answering N when asked if you want to configure a static IPv6 address.
Enter a hostname [asacx]: asa-cx-host
Do you want to configure IPv4 address on management interface?(y/n) [Y]: Y
Do you want to enable DHCP for IPv4 address assignment on management interface?(y/n)[N]: N
Enter an IPv4 address [192.168.8.8]: 10.89.31.65
Enter the netmask [255.255.255.0]: 255.255.255.0
Enter the gateway [192.168.8.1]: 10.89.31.1
Do you want to configure static IPv6 address on management interface?(y/n) [N]: Y
Enter an IPv6 address: 2001:DB8:0:CD30::1234/64
Enter the gateway: 2001:DB8:0:CD30::1
Enter the primary DNS server IP address [ ]: 10.89.47.11
Do you want to configure Secondary DNS Server? (y/n) [N]: N
Do you want to configure Local Domain Name? (y/n) [N] Y
Enter the local domain name: example.com
Do you want to configure Search domains? (y/n) [N] Y
Enter the comma separated list for search domains: example.com
Do you want to enable the NTP service?(y/n) [N]: Y
Enter the NTP servers separated by commas: 1.ntp.example.com, 2.ntp.example.com

Step 3

After you complete the final prompt, you are presented with a summary of the settings. Look over the
summary to verify that the values are correct, and enter Y to apply your changed configuration. Enter N
to cancel your changes.
Example:
Apply the changes?(y,n) [Y]: Y
Configuration saved successfully!
Applying...
Done.
Generating self-signed certificate, the web server will be restarted after that
...
Done.
Press ENTER to continue...
asacx>

Cisco ASA 5500 Series Configuration Guide using the CLI

59-8

Chapter 59

Configuring the ASA CX Module
Configuring the ASA CX Module

Note

Step 4

If you change the host name, the prompt does not show the new name until you log out and log
back in.

If you do not use NTP, configure the time settings. The default time zone is the UTC time zone. Use the
show time command to see the current settings. You can use the following commands to change time
settings:
asacx> config timezone
asacx> config time

Step 5

Change the admin password by entering the following command:
asacx> config passwd

Example:
asacx> config passwd
The password must be at least 8 characters long and must contain
at least one uppercase letter (A-Z), at least one lowercase letter
(a-z) and at least one digit (0-9).
Enter password: Farscape1
Confirm password: Farscape1
SUCCESS: Password changed for user admin

Step 6

Enter the exit command to log out.

Configuring the Security Policy on the ASA CX Module Using PRSM
This section describes how to launch PRSM to configure the ASA CX module application. For details
on using PRSM to configure your ASA CX security policy, see the ASA CX user guide.

Detailed Steps
You can launch PRSM from your web browser, or you can launch it from ASDM.
•

Launch PRSM from a web browser by enter the following URL:
https://ASA_CX_management_IP

Where the ASA CX management IP address is the one you set in the “Configuring Basic ASA CX
Settings at the ASA CX CLI” section on page 59-7.
•

Launch PRSM from ASDM by choosing Home > ASA CX Status, and clicking the Connect to the
ASA CX application link.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-9

Chapter 59

Configuring the ASA CX Module

Configuring the ASA CX Module

What to Do Next
•

(Optional) Configure the authentication proxy port. See the “(Optional) Configuring the
Authentication Proxy Port” section on page 59-10.

•

Divert traffic to the ASA CX module. See the “Redirecting Traffic to the ASA CX Module” section
on page 59-11.

(Optional) Configuring the Authentication Proxy Port
The default authentication port is 885. To change the authentication proxy port, perform the following
steps. For more information about the authentication proxy, see the “Information About Authentication
Proxy” section on page 59-3.

Note

You can also set the port as part of the ASDM startup wizard. See the “Configuring Basic ASA CX
Settings at the ASA CX CLI” section on page 59-7.

Detailed Steps

Command

Purpose

cxsc auth-proxy port port

Sets the authentication proxy port greater than 1024. The default
is 885.

Example:
hostname(config)# cxsc auth-proxy port 5000

Cisco ASA 5500 Series Configuration Guide using the CLI

59-10

Chapter 59

Configuring the ASA CX Module
Configuring the ASA CX Module

Redirecting Traffic to the ASA CX Module
This section identifies traffic to redirect from the ASA to the ASA CX module. Configure this policy on
the ASA.

Note

When using PRSM in multiple device mode, you can configure the ASA policy for sending traffic to the
ASA CX module within PRSM, instead of using ASDM or the ASA CLI. However, PRSM has some
limitations when configuring the ASA service policy; see the ASA CX user guide for more information.

Prerequisites
If you enable the authentication proxy on the ASA using this procedure, be sure to also configure a
directory realm for authentication on the ASA CX module. See the ASA CX user guide for more
information.

Detailed Steps

Step 1

Command

Purpose

class-map name

Creates a class map to identify the traffic for which you want to
send to the ASA CX module.

Example:
hostname(config)# class-map cx_class

Step 2

match parameter

If you want to send multiple traffic classes to the ASA CX
module, you can create multiple class maps for use in the security
policy.
Specifies the traffic in the class map. See the “Identifying Traffic
(Layer 3/4 Class Maps)” section on page 32-12 for more
information.

Example:
hostname(config-cmap)# match access-list
cx_traffic

Step 3

policy-map name

Adds or edits a policy map that sets the actions to take with the
class map traffic.

Example:
hostname(config)# policy-map cx_policy

Step 4

class name

Identifies the class map you created in Step 1.

Example:
hostname(config-pmap)# class cx_class

Step 5

cxsc {fail-close | fail-open} [auth-proxy]

Specifies that the traffic should be sent to the ASA CX module.

Example:

The fail-close keyword sets the ASA to block all traffic if the ASA
CX module is unavailable.

hostname(config-pmap-c)# cxsc fail-close
auth-proxy

The fail-open keyword sets the ASA to allow all traffic through,
uninspected, if the ASA CX module is unavailable.
The auth-proxy keyword enables the authentication proxy, which
is required for active authentication.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-11

Chapter 59

Configuring the ASA CX Module

Monitoring the ASA CX Module

Step 6

Command

Purpose

(Optional)

If you created multiple class maps for ASA CX traffic, you can
specify another class for the policy.

class name2

Example:
hostname(config-pmap)# class cx_class2

Step 7

See the “Feature Matching Within a Service Policy” section on
page 32-3 for detailed information about how the order of classes
matters within a policy map. Traffic cannot match more than one
class map for the same action type.

(Optional)

Specifies that the second class of traffic should be sent to the ASA
cxsc {fail-close | fail-open} [auth-proxy] CX module.
Add as many classes as desired by repeating these steps.
Example:
hostname(config-pmap-c)# cxsc fail-close
auth-proxy

Step 8

service-policy policymap_name {global |
interface interface_name}

Example:
hostname(config)# service-policy cx_policy
interface outside

Activates the policy map on one or more interfaces. global 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.

Monitoring the ASA CX Module

Note

•

Showing Module Status, page 59-12

•

Showing Module Statistics, page 59-13

•

Monitoring Module Connections, page 59-14

•

Capturing Module Traffic, page 59-17

•

Debugging the Module, page 59-19

For ASA CX-related syslog messages, see the syslog message guide. ASA CX syslog messages start
with message number 429001.

Showing Module Status
To check the status of a module, enter one of the following commands:
Command

Purpose

show module

Displays the status.

show module 1 details

Displays additional status information.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-12

Chapter 59

Configuring the ASA CX Module
Monitoring the ASA CX Module

Examples
The following is sample output from the show module command for an ASA with an ASA CX SSP
installed:
hostname# show module
Mod Card Type
--- -------------------------------------------0 ASA 5585-X Security Services Processor-10 wi
1 ASA 5585-X CX Security Services Processor-10
Mod
--0
1

MAC Address Range
--------------------------------5475.d05b.1100 to 5475.d05b.110b
5475.d05b.2450 to 5475.d05b.245b

Model
-----------------ASA5585-SSP-10
ASA5585-SSP-CX10

Hw Version
-----------1.0
1.0

Fw Version
-----------2.0(7)0
2.0(13)0

Serial No.
----------JAF1507AMKE
JAF1510BLSA

Sw Version
--------------100.7(6)78
0.6.1

Mod SSM Application Name
Status
SSM Application Version
--- ------------------------------ ---------------- -------------------------1 ASA CX Security Module
Up
0.6.1
Mod
--0
1

Status
-----------------Up Sys
Up

Data Plane Status
Compatibility
--------------------- ------------Not Applicable
Up

Showing Module Statistics
To show module statistics, enter the following command:
Command

Purpose

show service-policy cxsc

Displays the ASA CX statistics and status per service policy.

Examples
The following is sample output from the show service-policy command showing the ASA CX policy
and the current statistics as well as the module status when the authentication proxy is disabled:
hostname# show service-policy cxsc
Global policy:
Service-policy: global_policy
Class-map: bypass
CXSC: card status Up, mode fail-open, auth-proxy disabled
packet input 2626422041, packet output 2626877967, drop 0, reset-drop 0, proxied 0

The following is sample output from the show service-policy command showing the ASA CX policy
and the current statistics as well as the module status when the authentication proxy is enabled; in this
case, the proxied counters also increment:
hostname# show service-policy cxsc
Global policy:
Service-policy: pmap
Class-map: class-default
Default Queueing
Set connection policy: random-sequence-number disable
drop 0
CXSC: card status Up, mode fail-open, auth-proxy enabled
packet input 7724, packet output 7701, drop 0, reset-drop 0, proxied 10

Cisco ASA 5500 Series Configuration Guide using the CLI

59-13

Chapter 59

Configuring the ASA CX Module

Monitoring the ASA CX Module

Monitoring Module Connections
To show connections through the ASA CX module, enter the one of the following commands:
Command

Purpose

show asp table classify domain cxsc

Shows the NP rules created to send traffic to the ASA CX module.

show asp table classify domain
cxsc-auth-proxy

Shows the NP rules created for the authentication proxy for the ASA CX
module.

show asp drop

Shows dropped packets. The following drop types are used:
Frame Drops:
•

cxsc-bad-tlv-received—This occurs when ASA receives a packet
from CXSC without a Policy ID TLV. This TLV must be present in
non-control packets if it does not have the Standy Active bit set in the
actions field.

•

cxsc-request—The frame was requested to be dropped by CXSC due
a policy on CXSC whereby CXSC would set the actions to Deny
Source, Deny Destination, or Deny Pkt.

•

cxsc-fail-close—The packet is dropped because the card is not up and
the policy configured was 'fail-close' (rather than 'fail-open' which
allows packets through even if the card was down).

•

cxsc-fail—The CXSC configuration was removed for an existing
flow and we are not able to process it through CXSC it will be
dropped. This should be very unlikely.

•

cxsc-malformed-packet—The packet from CXSC contains an invalid
header. For instance, the header length may not be correct.

Flow Drops:
•

cxsc-request—The CXSC requested to terminate the flow. The
actions bit 0 is set.

•

reset-by-cxsc—The CXSC requested to terminate and reset the flow.
The actions bit 1 is set.

•

cxsc-fail-close—The flow was terminated because the card is down
and the configured policy was 'fail-close'.

show asp event dp-cp cxsc-msg

This output shows how many ASA CX module messages are on the dp-cp
queue. Currently, only VPN queries from the ASA CX module are sent to
dp-cp.

show conn

This command already shows if a connection is being forwarded to an
module by displaying the ‘X - inspected by service module’ flag.
Connections being forwarded to the ASA CX module will also display the
‘X’ flag.

Examples
The following is sample output from the show asp table classify domain cxsc command:
hostname# show asp table classify domain cxsc
Input Table

Cisco ASA 5500 Series Configuration Guide using the CLI

59-14

Chapter 59

Configuring the ASA CX Module
Monitoring the ASA CX Module

in

id=0x7ffedb4acf40, priority=50, domain=cxsc, deny=false
hits=15485658, user_data=0x7ffedb4ac840, cs_id=0x0, use_real_addr, flags=0x0,
protocol=0
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=0.0.0.0, mask=0.0.0.0, port=0, dscp=0x0
input_ifc=outside, output_ifc=any
in id=0x7ffedb4ad4a0, priority=50, domain=cxsc, deny=false
hits=992053, user_data=0x7ffedb4ac840, cs_id=0x0, use_real_addr, flags=0x0, protocol=0
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=0.0.0.0, mask=0.0.0.0, port=0, dscp=0x0
input_ifc=inside, output_ifc=any
in id=0x7ffedb4ada00, priority=50, domain=cxsc, deny=false
hits=0, user_data=0x7ffedb4ac840, cs_id=0x0, use_real_addr, flags=0x0, protocol=0
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=0.0.0.0, mask=0.0.0.0, port=0, dscp=0x0
input_ifc=m, output_ifc=any
Output Table:
L2 - Output Table:
L2 - Input Table:
Last clearing of hits counters: Never

The following is sample output from the show asp table classify domain cxsc-auth-proxy command.
For the first rule in the output below, the destination “port=2000” is the auth-proxy port configured by
the cxsc auth-proxy port 2000 command, and the destination “ip/id=192.168.0.100” is the ASA
interface IP address.
hostname# show asp table classify domain cxsc-auth-proxy
Input Table
in id=0x7ffed86cc470, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=192.168.0.100, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=inside, output_ifc=identity
in id=0x7ffed86cce20, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=2.2.2.2, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=new2, output_ifc=identity
in id=0x7ffed86cd7d0, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=172.23.58.52, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=mgmt, output_ifc=identity
in id=0x7ffed86caa80, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=192.168.5.172, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=outside, output_ifc=identity
in id=0x7ffed86cb3c0, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=::/0, port=0
dst ip/id=fe80::5675:d0ff:fe5b:1102/128, port=2000
input_ifc=outside, output_ifc=identity
in id=0x7ffed742be10, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=::/0, port=0
dst ip/id=1:1:1:1::10/128, port=2000
input_ifc=outside, output_ifc=identity

Cisco ASA 5500 Series Configuration Guide using the CLI

59-15

Chapter 59

Configuring the ASA CX Module

Monitoring the ASA CX Module

Output Table:
L2 - Output Table:
L2 - Input Table:
Last clearing of hits counters: Never

The following is sample output from the show asp drop command. This output is just an example and
lists all the possible reasons for a dropped frame or flow from the ASA CX module:
hostname# show asp drop
Frame drop:
CXSC Module received packet with bad TLV's (cxsc-bad-tlv-received)
CXSC Module requested drop (cxsc-request)
CXSC card is down (cxsc-fail-close)
CXSC config removed for flow (cxsc-fail)
CXSC Module received malformed packet (cxsc-malformed-packet)

2
1
1
3
1

Last clearing: 18:12:58 UTC May 11 2012 by enable_15
Flow drop:
Flow terminated by CXSC (cxsc-request)
Flow reset by CXSC (reset-by-cxsc)
CXSC fail-close (cxsc-fail-close)

2
1
1

Last clearing: 18:12:58 UTC May 11 2012 by enable_15

The following is sample output from the show asp event dp-cp cxsc-msg command:
hostname# show asp event dp-cp cxsc-msg
DP-CP EVENT QUEUE
QUEUE-LEN HIGH-WATER
Punt Event Queue
0
5
Identity-Traffic Event Queue
0
0
General Event Queue
0
4
Syslog Event Queue
4
90
Non-Blocking Event Queue
0
2
Midpath High Event Queue
0
53
Midpath Norm Event Queue
8074
8288
SRTP Event Queue
0
0
HA Event Queue
0
0
Threat-Detection Event Queue
0
3
ARP Event Queue
0
2048
IDFW Event Queue
0
0
CXSC Event Queue
0
1
EVENT-TYPE
ALLOC ALLOC-FAIL ENQUEUED ENQ-FAIL RETIRED 15SEC-RATE
cxsc-msg
1
0
1
0
1
0

The following is sample output from the show conn detail command:
hostname# show conn detail
0 in use, 105 most used
Flags: A - awaiting inside ACK to SYN, a - awaiting outside ACK to SYN,
B - initial SYN from outside, b - TCP state-bypass or nailed, C - CTIQBE media,
D - DNS, d - dump, E - outside back connection, F - outside FIN, f - inside FIN,
G - group, g - MGCP, H - H.323, h - H.225.0, I - inbound data,
i - incomplete, J - GTP, j - GTP data, K - GTP t3-response
k - Skinny media, M - SMTP data, m - SIP media, n - GUP
O - outbound data, P - inside back connection, p - Phone-proxy TFTP connection,
q - SQL*Net data, R - outside acknowledged FIN,
R - UDP SUNRPC, r - inside acknowledged FIN, S - awaiting inside SYN,
s - awaiting outside SYN, T - SIP, t - SIP transient, U - up,
V - VPN orphan, W - WAAS,
X - inspected by service module

Cisco ASA 5500 Series Configuration Guide using the CLI

59-16

Chapter 59

Configuring the ASA CX Module
Troubleshooting the ASA CX Module

TCP outside 208.80.152.2:80 inside 192.168.1.20:59928, idle 0:00:10, bytes 79174, flags
XUIO

Capturing Module Traffic
To configure and view packet captures for the ASA CX module, enter one of the following commands:
Command

Purpose

capture name interface asa_dataplane

Captures packets between ASA CX module and the ASA on the
backplane.

copy capture

Copies the capture file to a server.

show capture

Shows the capture at the ASA console.

Note

Captured packets contain an additional AFBP header that your PCAP viewer might not understand; be
sure to use the appropriate plugin to view these packets.

Troubleshooting the ASA CX Module
•

General Recovery Procedures, page 59-17

•

Debugging the Module, page 59-19

•

Problems with the Authentication Proxy, page 59-20

General Recovery Procedures
This section includes procedures that help you recover or troubleshoot the module and includes the
following topics:

Note

•

Resetting the Password, page 59-17

•

Reloading or Resetting the Module, page 59-18

•

Shutting Down the Module, page 59-19

You can install or upgrade your image from within the ASA CX module. See the ASA CX module
documentaiton for more information.

Resetting the Password
You can reset the module password to the default. For the user admin, the default password is
Admin123. After resetting the password, you should change it to a unique value using the module
application.
Resetting the module password causes the module to reboot. Services are not available while the module
is rebooting.

Cisco ASA 5500 Series Configuration Guide using the CLI

59-17

Chapter 59

Configuring the ASA CX Module

Troubleshooting the ASA CX Module

To reset the module password to the default of Admin123, perform the following steps.

Detailed Steps

Command

Purpose

hw-module module 1 password-reset

Resets the module password to Admin123 for user admin.

Example:
hostname# hw-module module 1 password-reset

Reloading or Resetting the Module
To reload or reset the module, enter one of the following commands at the ASA CLI.

Detailed Steps

Command

Purpose

hw-module module 1 reload

Reloads the module software.

Example:
hostname# hw-module module 1 reload
hw-module module 1 reset

Performs a reset, and then reloads the module.

Example:
hostname# hw-module module 1 reset

Cisco ASA 5500 Series Configuration Guide using the CLI

59-18

Chapter 59

Configuring the ASA CX Module
Troubleshooting the ASA CX Module

Shutting Down the Module
If you restart the ASA, the module is not automatically restarted. To shut down the module, perform the
following steps at the ASA CLI.

Detailed Steps

Command

Purpose

hw-module module 1 shutdown

Shuts down the module.

Example:
hostname# hw-module module 1 shutdown

Debugging the Module
To enable ASA CX debugging, enter the following command:
Command

Purpose

debug cxsc [error | event | message]

Enables debugs at error, event, or message level.

When you enable the authentication proxy, the ASA generates a debug messge when it sends an
authentication proxy TLV to the ASA CX module, giving details of IP and port:
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: inside4.
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: cx_inside.
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: cx_outside.

When the interface IP address is changed, auth-proxy tlv updates are sent to CXSC:
DP CXSC Event: Sent Auth proxy tlv for removing Auth Proxy for interface inside.
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: inside.

When a flow is freed on the ASA, the ASA CX module is notified so it can clean up the flow:
DP CXSC Msg: Notifying CXSC that flow (handle:275233990) is being freed
192.168.18.5:2213 -> 10.166.255.18:80.

for

When the ASA CX module sends a redirect to a client to authenticate, and that redirect is sent to the
ASA, the ASA sends it to the ASA CX module. In this example, 192.168.18.3 is the interface address
and port 8888 is the authentication proxy port reserved on that interface for the authentication proxy
feature:
DP CXSC Msg: rcvd authentication proxy data from 192.168.18.5:2214 -> 192.168.18.3:8888,
forwarding to cx

When a VPN connection is established on the ASA, and the ASA sends connection information to the
ASA CX module:
CXSC Event:
CXSC Event:
CXSC Event:

Dumping attributes from the vpn session record
tunnel->Protocol:
17
tunnel->ClientVendor:
SSL VPN Client

Cisco ASA 5500 Series Configuration Guide using the CLI

59-19

Chapter 59

Configuring the ASA CX Module

Troubleshooting the ASA CX Module

CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC
CXSC

Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:
Event:

tunnel->ClientVersion:
Cisco AnyConnect VPN Agent for Windows 2.4.1012
Sending VPN RA session data to CXSC
sess index:
0x3000
sess type id:
3
username:
devuser
domain:
CN=Users,DC=test,DC=priv
directory type: 1
login time:
1337124762
nac result:
0
posture token:
public IP:
172.23.34.108
assigned IP:
192.168.17.200
client OS id:
1
client OS:
client type:
Cisco AnyConnect VPN Agent for Windows 2.4.1012
anyconnect data: , len: 0

Problems with the Authentication Proxy
If you are having a problem using the authentication proxy feature, follow these steps to troubleshoot
your configuration and connections:

Note

1.

Check your configurations.

•

On the ASA, check the output of the show asp table classify domain cxsc-auth-proxy command
and make sure there are rules installed and that they are correct.

•

In PRSM, ensure the directory realm is created with the correct credentials and test the connection
to make sure you can reach the authentication server; also ensure that a policy object or objects are
configured for authentication.

2.

Check the output of the show service-policy cxsc command to see if any packets were proxied.

3.

Perform a packet capture on the backplane, and check to see if traffic is being redirected on the
correct configured port. See the “Capturing Module Traffic” section on page 59-17. You can check
the configured port using the show running-config cxsc command or the show asp table classify
domain cxsc-auth-proxy command.

If you have a connection between hosts on two ASA interfaces, and the ASA CX service policy is only
configured for one of the interfaces, then all traffic between these hosts is sent to the ASA CX module,
including traffic orginiating on the non-ASA CX interface (the feature is bidirectional). However, the
ASA only performs the authentication proxy on the interface to which the service policy is applied,
because this feature is ingress-only.
Example 59-1 Make sure port 2000 is used consistently:
1.

Check the authentication proxy port:

hostname# show running-config cxsc
cxsc auth-proxy port 2000

2.

Check the authentication proxy rules:

hostname# show asp table classify domain cxsc-auth-proxy
Input Table
in id=0x7ffed86cc470, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6

Cisco ASA 5500 Series Configuration Guide using the CLI

59-20

Chapter 59

Configuring the ASA CX Module
Configuration Examples for the ASA CX Module

src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=192.168.0.100, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=inside, output_ifc=identity

3.

In the packet captures, the redirect request should be going to destination port 2000.

Configuration Examples for the ASA CX Module
The following example diverts all HTTP traffic to the ASA CX module, and blocks all HTTP traffic if
the ASA CX module card fails for any reason:
hostname(config)# access-list ASACX permit tcp any any eq port 80
hostname(config)# class-map my-cx-class
hostname(config-cmap)# match access-list ASACX
hostname(config-cmap)# policy-map my-cx-policy
hostname(config-pmap)# class my-cx-class
hostname(config-pmap-c)# cxsc fail-close auth-proxy
hostname(config-pmap-c)# service-policy my-cx-policy global

The following example diverts all IP traffic destined for the 10.1.1.0 network and the 10.2.1.0 network
to the ASA CX module, and allows all traffic through if the ASA CX module fails for any reason.
hostname(config)# access-list my-cx-acl permit ip any 10.1.1.0 255.255.255.0
hostname(config)# access-list my-cx-acl2 permit ip any 10.2.1.0 255.255.255.0
hostname(config)# class-map my-cx-class
hostname(config-cmap)# match access-list my-cx-acl
hostname(config)# class-map my-cx-class2
hostname(config-cmap)# match access-list my-cx-acl2
hostname(config-cmap)# policy-map my-cx-policy
hostname(config-pmap)# class my-cx-class
hostname(config-pmap-c)# cxsc fail-open auth-proxy
hostname(config-pmap)# class my-cx-class2
hostname(config-pmap-c)# cxsc fail-open auth-proxy
hostname(config-pmap-c)# service-policy my-cx-policy interface outside

Cisco ASA 5500 Series Configuration Guide using the CLI

59-21

Chapter 59

Configuring the ASA CX Module

Feature History for the ASA CX Module

Feature History for the ASA CX Module
Table 59-2 lists each feature change and the platform release in which it was implemented.
Table 59-2

Feature History for the ASA CX Module

Feature Name

Platform
Releases

ASA 5585-X support for the ASA CX SSP

8.4(4.1)

Feature Information
ASA CX module lets you enforce security based on the
complete context of a situation. This context includes the
identity of the user (who), the application or website that the
user is trying to access (what), the origin of the access
attempt (where), the time of the attempted access (when),
and the properties of the device used for the access (how).
With the ASA CX module, you can extract the full context
of a flow and enforce granular policies such as permitting
access to Facebook but denying access to games on
Facebook or permitting finance employees access to a
sensitive enterprise database but denying the same to other
employees.
We introduced or modified the following commands:
capture, cxsc, cxsc auth-proxy, debug cxsc, hw-module
module password-reset, hw-module module reload,
hw-module module reset, hw-module module shutdown,
session do setup host ip, session do get-config, session do
password-reset, show asp table classify domain cxsc,
show asp table classify domain cxsc-auth-proxy, show
capture, show conn, show module, show service-policy.
This feature is not available in Version 8.6(1).

Cisco ASA 5500 Series Configuration Guide using the CLI

59-22

CH A P T E R

60

Configuring the ASA CSC Module
This chapter describes how to configure the Content Security and Control (CSC) application that is
installed in a CSC SSM in the ASA.
This chapter includes the following sections:
•

Information About the CSC SSM, page 60-1

•

Licensing Requirements for the CSC SSM, page 60-5

•

Prerequisites for the CSC SSM, page 60-5

•

Guidelines and Limitations, page 60-6

•

Default Settings, page 60-6

•

Configuring the CSC SSM, page 60-7

•

Monitoring the CSC SSM, page 60-13

•

Troubleshooting the CSC Module, page 60-14

•

Configuration Examples for the CSC SSM, page 60-16

•

Where to Go Next, page 60-18

•

Additional References, page 60-18

•

Feature History for the CSC SSM, page 60-18

Information About the CSC SSM
Some ASA models support the CSC SSM, which runs Content Security and Control software. The CSC
SSM provides protection against viruses, spyware, spam, and other unwanted traffic by scanning the
FTP, HTTP/HTTPS, POP3, and SMTP packets that you configure the ASA to send to it.
For more information about the CSC SSM, see the following URL:
http://www.cisco.com/en/US/products/ps6823/index.html
Figure 60-1 shows the flow of traffic through an ASA that has the following:
•

A CSC SSM installed and configured.

•

A service policy that determines what traffic is diverted to the CSC SSM for scanning.

In this example, the client could be a network user who is accessing a website, downloading files from
an FTP server, or retrieving mail from a POP3 server. SMTP scans differ in that you should configure
the ASA to scan traffic sent from the outside to SMTP servers protected by the ASA.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-1

Chapter 60

Configuring the ASA CSC Module

Information About the CSC SSM

Figure 60-1

Flow of Scanned Traffic with the CSC SSM

ASA
Main System
modular
service
policy
Request sent

Request forwarded

inside

outside

Reply forwarded

Reply sent
Diverted Traffic

Server

content security scan
CSC SSM

148386

Client

You use ASDM for system setup and monitoring of the CSC SSM. For advanced configuration of content
security policies in the CSC SSM software, you access the web-based GUI for the CSC SSM by clicking
links within ASDM. The CSC SSM GUI appears in a separate web browser window. To access the CSC
SSM, you must enter the CSC SSM password. To use the CSC SSM GUI, see the Cisco Content Security
and Control (CSC) SSM Administrator Guide.

Note

ASDM and the CSC SSM maintain separate passwords. You can configure their passwords to be
identical; however, changing one of these two passwords does not affect the other password.
The connection between the host running ASDM and the ASA is made through a management port on
the ASA. The connection to the CSC SSM GUI is made through the SSM management port. Because
these two connections are required to manage the CSC SSM, any host running ASDM must be able to
reach the IP address of both the ASA management port and the SSM management port.
Figure 60-2 shows an ASA with a CSC SSM that is connected to a dedicated management network.
While use of a dedicated management network is not required, we recommend it. In this configuration,
the following items are of particular interest:
•

An HTTP proxy server is connected to the inside network and to the management network. This
HTTP proxy server enables the CSC SSM to contact the Trend Micro Systems update server.

•

The management port of the ASA is connected to the management network. To allow management
of the ASA and the CSC SSM, hosts running ASDM must be connected to the management network.

•

The management network includes an SMTP server for e-mail notifications for the CSC SSM and a
syslog server to which the CSC SSM can send syslog messages.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-2

Chapter 60

Configuring the ASA CSC Module
Information About the CSC SSM

Figure 60-2

CSC SSM Deployment with a Management Network

ASA
Trend Micro
Update Server

inside
192.168.100.1
Main System
management port
192.168.50.1

Internet

CSC SSM

ASDM

Syslog

outside
10.6.13.67

192.168.50.38 SSM
management
port

148387

HTTP
Proxy

Notifications
SMTP Server

Determining What Traffic to Scan
The CSC SSM can scan FTP, HTTP/HTTPS, POP3, and SMTP traffic only when the destination port of
the packet requesting the connection is the well-known port for the specified protocol. The CSC SSM
can scan only the following connections:
•

FTP connections opened to TCP port 21.

•

HTTP connections opened to TCP port 80.

•

HTTPS connections opened to TCP port 443.

•

POP3 connections opened to TCP port 110.

•

SMTP connections opened to TCP port 25.

You can choose to scan traffic for all of these protocols or any combination of them. For example, if you
do not allow network users to receive POP3 e-mail, do not configure the ASA to divert POP3 traffic to
the CSC SSM. Instead, block this traffic.
To maximize performance of the ASA and the CSC SSM, divert only the traffic to the CSC SSM that
you want the CSC SSM to scan. Diverting traffic that you do not want scanned, such as traffic between
a trusted source and destination, can adversely affect network performance.

Note

When traffic is first classified for CSC inspection, it is flow-based. If traffic is part of a pre-existing
connection, the traffic goes directly to the service policy set for that connection.
You can apply service policies that include CSC scanning globally or to specific interfaces; therefore,
you can choose to enable CSC scans globally or for specific interfaces.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-3

Chapter 60

Configuring the ASA CSC Module

Information About the CSC SSM

Based on the configuration shown in Figure 60-3, configure the ASA to divert to the CSC SSM only
requests from clients on the inside network for HTTP, FTP, and POP3 connections to the outside
network, and incoming SMTP connections from outside hosts to the mail server on the DMZ network.
Exclude from scanning HTTP requests from the inside network to the web server on the DMZ network.
Figure 60-3

Common Network Configuration for CSC SSM Scanning

ASA
192.168.10.0

inside

outside

192.168.30.0

Internet

143800

192.168.20.0
(dmz)

Web server

Mail server

There are many ways you could configure the ASA to identify the traffic that you want to scan. One
approach is to define two service policies: one on the inside interface and the other on the outside
interface, each with access lists that match traffic to be scanned.
Figure 60-4 shows service policy rules that select only the traffic that the ASA should scan.
Figure 60-4

Optimized Traffic Selection for CSC Scans

In the inside-policy, the first class, inside-class1, ensures that the ASA does not scan HTTP traffic
between the inside network and the DMZ network. The Match column indicates this setting by
displaying the “Do not match” icon. This setting does not mean the ASA blocks traffic sent from the
192.168.10.0 network to TCP port 80 on the 192.168.20.0 network. Instead, this setting exempts the
traffic from being matched by the service policy applied to the inside interface, which prevents the ASA
from sending the traffic to the CSC SSM.
The second class of the inside-policy, inside-class matches FTP, HTTP, and POP3 traffic between the
inside network and any destination. HTTP connections to the DMZ network are exempted because of the
inside-class1 setting. As previously mentioned, policies that apply CSC scanning to a specific interface
affect both incoming and outgoing traffic, but by specifying 192.168.10.0 as the source network,
inside-class1 matches only connections initiated by the hosts on the inside network.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-4

Chapter 60

Configuring the ASA CSC Module
Licensing Requirements for the CSC SSM

In the outside-policy, outside-class matches SMTP traffic from any outside source to the DMZ network.
This setting protects the SMTP server and inside users who download e-mail from the SMTP server on
the DMZ network, without having to scan connections from SMTP clients to the server.
If the web server on the DMZ network receives files uploaded by HTTP from external hosts, you can add
a rule to the outside policy that matches HTTP traffic from any source to the DMZ network. Because the
policy is applied to the outside interface, the rule would only match connections from HTTP clients
outside the ASA.

Licensing Requirements for the CSC SSM
Model

License Requirement

ASA 5510

•

Base License—Supports SMTP virus scanning, POP3 virus scanning and content filtering, web
mail virus scanning, HTTP file blocking, FTP virus scanning and file blocking, logging, and
automatic updates. Supports two contexts.
Optional licenses: 5 contexts.

•

Security Plus License—Supports the Base license features, plus SMTP anti-spam, SMTP content
filtering, POP3 anti-spam, URL blocking, and URL filtering. Supports two contexts.
Optional license: 5 contexts.

ASA 5520

Base License—Supports all features. Supports two contexts.
Optional licenses: 5, 10, or 20 contexts.

ASA 5540

Base License—Supports all features. Supports two contexts.
Optional licenses: 5, 10, 20, or 50 contexts.

All other models

No support.

Prerequisites for the CSC SSM
The CSC SSM has the following prerequisites:
•

A CSC SSM card must be installed in the ASA.

•

A Product Authorization Key (PAK) for use in registering the CSC SSM.

•

Activation keys that you receive by e-mail after you register the CSC SSM.

•

The management port of the CSC SSM must be connected to your network to allow management
and automatic updates of the CSC SSM software.

•

The CSC SSM management port IP address must be accessible by the hosts used to run ASDM.

•

You must obtain the following information to use in configuring the CSC SSM:
– The CSC SSM management port IP address, netmask, and gateway IP address.
– DNS server IP address.
– HTTP proxy server IP address (needed only if your security policies require the use of a proxy

server for HTTP access to the Internet).

Cisco ASA 5500 Series Configuration Guide using the CLI

60-5

Chapter 60

Configuring the ASA CSC Module

Guidelines and Limitations

– Domain name and hostname for the CSC SSM.
– An e-mail address and an SMTP server IP address and port number for e-mail notifications.
– E-mail address(es) for product license renewal notifications.
– IP addresses of hosts or networks that are allowed to manage the CSC SSM. The IP addresses

for the CSC SSM management port and the ASA management interface can be in different
subnets.
– Password for the CSC SSM.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single and multiple context modes.
Firewall Mode Guidelines

Supported in routed and transparent firewall modes.
Failover Guidelines

Does not support sessions in Stateful Failover. The CSC SSM does not maintain connection information,
and therefore cannot provide the failover unit with the required information. The connections that a CSC
SSM is scanning are dropped when the ASA in which the CSC SSM is installed fails. When the standby
ASA becomes active, it forwards the scanned traffic to the CSC SSM and the connections are reset.
IPv6 Guidelines

Does not support IPv6.
Model Guidelines

Supported on the ASA 5510, ASA 5520, and ASA 5540 only.
Additional Guidelines

You cannot change the software type installed on the module; if you purchase a CSC module, you cannot
later install IPS software on it.

Default Settings
Table 60-1 lists the default settings for the CSC SSM.
Table 60-1

Default CSC SSM Parameters

Parameter

Default

FTP inspection on the ASA

Enabled

All features included in the license(s) that you
have purchased

Enabled

Cisco ASA 5500 Series Configuration Guide using the CLI

60-6

Chapter 60

Configuring the ASA CSC Module
Configuring the CSC SSM

Configuring the CSC SSM
This section describes how to configure the CSC SSM and includes the following topics:
•

Before Configuring the CSC SSM, page 60-7

•

Connecting to the CSC SSM, page 60-8

•

Diverting Traffic to the CSC SSM, page 60-10

Before Configuring the CSC SSM
Before configuring the ASA and the CSC SSM, perform the following steps:
Step 1

If the CSC SSM did not come preinstalled in a Cisco ASA, install it and connect a network cable to the
management port of the SSM. For assistance with installation and connecting the SSM, see the Cisco
ASA 5500 Series Adaptive Security Appliance Getting Started Guide.
The management port of the CSC SSM must be connected to your network to allow management of and
automatic updates to the CSC SSM software. Additionally, the CSC SSM uses the management port for
e-mail notifications and syslog messages.

Step 2

You should have received a Product Authorization Key (PAK) with the CSC SSM. Use the PAK to
register the CSC SSM at the following URL.
http://www.cisco.com/go/license
After you register, you receive activation keys by e-mail. The activation keys are required before you can
complete Step 6.

Step 3

Step 4

Obtain the following information for use in Step 6:
•

Activation keys

•

CSC SSM management port IP address, netmask, and gateway IP address

•

DNS server IP address

•

HTTP proxy server IP address (needed only if your security policies require the use of a proxy server
for HTTP access to the Internet)

•

Domain name and hostname for the CSC SSM

•

An e-mail address, and SMTP server IP address and port number for e-mail notifications

•

E-mail address(es) for product license renewal notifications

•

IP addresses of hosts or networks that are allowed to manage the CSC SSM

•

Password for the CSC SSM

In a web browser, access ASDM for the ASA in which the CSC SSM is installed.

Note

If you are accessing ASDM for the first time, see the “Additional References” section on
page 60-18.

For more information about enabling ASDM access, see the “Configuring ASA Access for ASDM,
Telnet, or SSH” section on page 37-1.
Step 5

Verify time settings on the ASA. Time setting accuracy is important for logging of security events and
for automatic updates of CSC SSM software. Do one of the following:

Cisco ASA 5500 Series Configuration Guide using the CLI

60-7

Chapter 60

Configuring the ASA CSC Module

Configuring the CSC SSM

•

If you manually control time settings, verify the clock settings, including time zone. Choose
Configuration > Properties > Device Administration > Clock.

•

If you are using NTP, verify the NTP configuration. Choose Configuration > Properties > Device
Administration > NTP.

Step 6

Open ASDM.

Step 7

Connect to and log in to the CSC SSM. For instructions, see the “Connecting to the CSC SSM” section
on page 60-8.

Step 8

Configure service policies to divert traffic that you want scanned to the CSC SSM. For instructions, see
the “Diverting Traffic to the CSC SSM” section on page 60-10.

Step 9

Run the CSC Setup Wizard.
•

To access the CSC Setup Wizard, choose Configuration > Trend Micro Content Security > CSC
Setup > Wizard Setup > Launch Setup Wizard.

•

If you are rerunning the CSC Setup Wizard, perform the same step listed in the previous bullet.

The CSC Setup Wizard appears.
Step 10

Complete the CSC Setup Wizard.

Note

If you create a global service policy to divert traffic for CSC scans, all traffic (inbound and
outbound) for the supported protocols is scanned. To maximize performance of the ASA and the
CSC SSM, scan traffic only from untrusted sources.

Step 11

To reduce the load on the CSC SSM, configure the service policy rules that send packets to the CSC SSM
to support only HTTP/HTTPS, SMTP, POP3, or FTP traffic.

Step 12

(Optional) Review the default content security policies in the CSC SSM GUI, which are suitable for most
implementations. You review the content security policies by viewing the enabled features in the CSC
SSM GUI. For the availability of features, see the “Licensing Requirements for the CSC SSM” section
on page 60-5. For the default settings, see the “Default Settings” section on page 60-6.

What to Do Next
See the “Connecting to the CSC SSM” section on page 60-8.

Connecting to the CSC SSM
With each session you start in ASDM, the first time you access features related to the CSC SSM, you
must specify the management IP address and provide the password for the CSC SSM. After you
successfully connect to the CSC SSM, you are not prompted again for the management IP address and
password. If you start a new ASDM session, the connection to the CSC SSM is reset and you must
specify the IP address and the CSC SSM password again. The connection to the CSC SSM is also reset
if you change the time zone on the ASA.

Note

The CSC SSM has a password that is maintained separately from the ASDM password. You can
configure the two passwords to be identical, but changing the CSC SSM password does not affect the
ASDM password.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-8

Chapter 60

Configuring the ASA CSC Module
Configuring the CSC SSM

To connect to the CSC SSM, perform the following steps:
Step 1

In the ASDM main application window, click the Content Security tab.

Step 2

In the Connecting to CSC dialog box, click one of the following radio buttons:
•

To connect to the IP address of the management port on the SSM, click Management IP Address.
ASDM automatically detects the IP address for the SSM in the ASA. If this detection fails, you can
specify the management IP address manually.

•

To connect to an alternate IP address or hostname on the SSM, click Other IP Address or
Hostname.

Step 3

Enter the port number in the Port field, and then click Continue.

Step 4

In the CSC Password field, type your CSC password, and then click OK.

Note

If you have not completed the CSC Setup Wizard (choose Configuration > Trend Micro
Content Security > CSC Setup > Wizard Setup), complete the configuration in the CSC
Setup Wizard, which includes changing the default password, “cisco.”
For ten minutes after you have entered the password, you do not need to reenter the CSC SSM
password to access other parts of the CSC SSM GUI.

Step 5

To access the CSC SSM GUI, choose Configuration > Trend Micro Content Security, and then click
one of the following tabs: Web, Mail, File Transfer, or Updates.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-9

Chapter 60

Configuring the ASA CSC Module

Configuring the CSC SSM

What to Do Next
See the “Diverting Traffic to the CSC SSM” section on page 60-10.

Diverting Traffic to the CSC SSM
You use Modular Policy Framework commands to configure the ASA to divert traffic to the CSC SSM.

Prerequisites
Before configuring the ASA to divert traffic to the CSC SSM, see Chapter 32, “Configuring a Service
Policy Using the Modular Policy Framework,” which introduces Modular Policy Framework concepts
and common commands.
To configure the ASA to divert traffic to the CSC SSM, perform the following steps:

Detailed Steps

Step 1

Command

Purpose

access-list extended

Creates an access list that matches the traffic you
want scanned by the CSC SSM. Create as many
ACEs as are needed to match all the traffic. For
example, to specify FTP, HTTP/HTTPS, POP3, and
SMTP traffic, you need four ACEs. For guidance on
identifying the traffic that you want to scan, see the
“Determining What Traffic to Scan” section on
page 60-3.

Example:
hostname(config)# access-list extended

Step 2

class-map class_map_name

Example:
hostname(config)# class-map class_map_name

Step 3

match access-list acl-name

Example:

Creates a class map to identify the traffic that should
be diverted to the CSC SSM. The class_map_name
argument is the name of the traffic class. When you
enter the class-map command, the CLI enters class
map configuration mode.
Identifies the traffic to be scanned with the access list
that you created in Step 1. The acl-name argument is
the name of the access list.

hostname(config-cmap)# match access-list acl-name

Step 4

policy-map policy_map_name

Example:
hostname(config-cmap)# policy-map policy_map_name

Step 5

class class_map_name

Example:
hostname(config-pmap)# class class_map_name

Cisco ASA 5500 Series Configuration Guide using the CLI

60-10

Creates a policy map or modify an existing policy
map that you want to use to send traffic to the CSC
SSM. The policy_map_name argument is the name
of the policy map. When you enter the policy-map
command, the CLI enters policy map configuration
mode.
Specifies the class map, created in Step 2, that
identifies the traffic to be scanned. The
class_map_name argument is the name of the class
map that you created in Step 2. The CLI enters the
policy map class configuration mode.

Chapter 60

Configuring the ASA CSC Module
Configuring the CSC SSM

Step 6

Command

Purpose

set connection per-client-max n

Lets you configure limits to thwart DoS attacks. The
per-client-max parameter limits the maximum
number of connections that individual clients can
open. If a client uses more network resources
simultaneously than is desired, you can enforce a
per-client limit for simultaneous connections that the
ASA diverts to the CSC SSM. The n argument is the
maximum number of simultaneous connections that
the ASA allows per client. This command prevents a
single client from abusing the services of the CSC
SSM or any server protected by the SSM, including
prevention of attempts at DoS attacks on
HTTP/HTTPS, FTP, POP3, or SMTP servers that the
CSC SSM protects.

Example:
hostname(config-pmap-c)# set connection
per-client-max 5

Cisco ASA 5500 Series Configuration Guide using the CLI

60-11

Chapter 60

Configuring the ASA CSC Module

Configuring the CSC SSM

Step 7

Command

Purpose

csc {fail-close | fail-open}

Enables traffic scanning with the CSC SSM and
assigns the traffic identified by the class map as
traffic to be sent to the CSC SSM. Must be part of a
service policy, which can be applied globally or to
specific interfaces. Ensures that all unencrypted
connections through the ASA are scanned by the
CSC SSM; however, this setting may mean that
traffic from trusted sources is needlessly scanned. If
enabled in interface-specific service policies, this
command is bi-directional. Bi-directionality means
that when the ASA opens a new connection, if this
command is active on either the inbound or the
outbound interface of the connection and the class
map for the policy identifies traffic for scanning, the
ASA diverts this traffic to the CSC SSM. However,
bi-directionality also means that if you divert any of
the supported traffic types that cross a given interface
to the CSC SSM, it is probably performing
unnecessary scans on traffic from your trusted inside
networks. Therefore, to further limit the traffic
selected by the class maps of CSC SSM service
policies, we recommend using access lists that match
the following:

Example:
hostname(config-pmap-c)# csc {fail-close |
fail-open}

•

HTTP/HTTPS connections to outside networks.

•

FTP connections from clients inside the ASA to
servers outside the ASA.

•

POP3 connections from clients inside the ASA
to servers outside the ASA.

•

Incoming SMTP connections destined to inside
mail servers.

The fail-close and fail-open keywords control how
the ASA handles traffic when the CSC SSM is
unavailable. For more information about the
operating modes and failure behavior, see the
“Guidelines and Limitations” section on page 60-6.
Step 8

service-policy policy_map_name [global | interface
interface_ID]

Example:
hostname(config-pmap-c)# service-policy
policy_map_name [global | interface interface_ID]

Cisco ASA 5500 Series Configuration Guide using the CLI

60-12

Applies the policy map globally or to a specific
interface. The policy_map_name argument is the
policy map that you configured in Step 4. To apply
the policy map to traffic on all the interfaces, use the
global keyword. To apply the policy map to traffic on
a specific interface, use the interface interface_ID
keyword and argument pair, where interface_ID is
the name assigned to the interface with the nameif
command. 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.

Chapter 60

Configuring the ASA CSC Module
Monitoring the CSC SSM

What to Do Next
See the “Monitoring the CSC SSM” section on page 60-13.

Monitoring the CSC SSM
To check the status of a module, enter one of the following commands:
Command

Purpose

show module

Displays the status.

show module 1 details

Displays additional status information.

show module 1 recover

Displays the network parameters for transferring an image to the module.

Examples
The following is sample output from the show module command for an ASA with a CSC SSM installed:
hostname# show module
Mod Card Type
--- -------------------------------------------0 ASA 5520 Adaptive Security Appliance
1 ASA 5500 Series Content Security Services Mo

Model
-----------------ASA5520
ASA-SSM-CSC-10

Serial No.
----------JMX1241L05S
AF1234BQQL

Mod SSM Application Name
Status
SSM Application Version
--- ------------------------------ ---------------- -------------------------1 CSC SSM
Down
6.2.1599.0

The following is sample output from the show module details command, which provides additional
information about an ASA with a CSC SSM installed:
hostname# show module 1 details
Getting details from the Service Module, please wait...
ASA 5500 Series Security Services Module-20
Model: ASA-SSM-20
Hardware version: 1.0
Serial Number: JAF10333331
Firmware version: 1.0(10)0
Software version: Trend Micro InterScan Security Module Version 6.2
App. name: Trend Micro InterScan Security Module
App. version: Version 6.2
Data plane Status: Up
Status: Up
HTTP Service: Up
Mail Service: Up
FTP Service: Up
Activated: Yes
Mgmt IP addr: 209.165.200.225
Mgmt web port: 8443

The following is sample output from the show module recover command, which includes recovery
details for an ASA with a CSC SSM installed:
hostname# show module 1 recover
Module 1 recover parameters. . .
Boot Recovery Image: Yes
Image URL: tftp://10.21.18.1/ids-oldimg
Port IP Address: 209.165.200.230

Cisco ASA 5500 Series Configuration Guide using the CLI

60-13

Chapter 60

Configuring the ASA CSC Module

Troubleshooting the CSC Module

Port Mask: 255.255.224.0
Gateway IP Address: 209.165.200.254

Troubleshooting the CSC Module
This section includes procedures that help you recover or troubleshoot the module and includes the
following topics:

Note

•

Installing an Image on the Module, page 60-14

•

Resetting the Password, page 60-15

•

Reloading or Resetting the Module, page 60-16

•

Shutting Down the Module, page 60-16

This section covers all ASA module types; follow the steps appropriate for your module.

Installing an Image on the Module
If the module suffers a failure, and the module application image cannot run, you can reinstall a new
image on the module from a TFTP server.

Note

Do not use the upgrade command within the module software to install the image.

Prerequisites
Be sure the TFTP server that you specify can transfer files up to 60 MB in size.

Note

This process can take approximately 15 minutes to complete, depending on your network and the size
of the image.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-14

Chapter 60

Configuring the ASA CSC Module
Troubleshooting the CSC Module

Detailed Steps

Step 1

Command

Purpose

hw-module module 1 recover configure

Specifies the location of the new image. This command prompts
you for the URL for the TFTP server, the management interface
IP address and netmask, gateway address, and VLAN ID (ASA
5505 only). These network parameters are configured in
ROMMON; the network parameters you configured in the module
application configuration are not available to ROMMON, so you
must set them separately here.

Example:
hostname# hw-module module 1 recover
configure
Image URL [tftp://127.0.0.1/myimage]:
tftp://10.1.1.1/ids-newimg
Port IP Address [127.0.0.2]: 10.1.2.10
Port Mask [255.255.255.254]: 255.255.255.0
Gateway IP Address [1.1.2.10]: 10.1.2.254
VLAN ID [0]: 100

Step 2

hw-module module 1 recover boot

You can view the recovery configuration using the show module
1 recover command.
In multiple context mode, enter this command in the system
execution space.
Transfers the image from the TFTP server to the module and
restarts the module.

Example:
hostname# hw-module module 1 recover boot

Step 3

show module 1 details

Example:
hostname# show module 1 details

Checks the progress of the image transfer and module restart
process.
The Status field in the output indicates the operational status of
the module. A module operating normally shows a status of “Up.”
While the ASA transfers an application image to the module, the
Status field in the output reads “Recover.” When the ASA
completes the image transfer and restarts the module, the newly
transferred image is running.

Resetting the Password
You can reset the module password to the default. The default password is cisco. After resetting the
password, you should change it to a unique value using the module application.
Resetting the module password causes the module to reboot. Services are not available while the module
is rebooting.
To reset the module password to the default of cisco, perform the following steps.

Detailed Steps

Command

Purpose

hw-module module 1 password-reset

Resets the module password to cisco.

Example:
hostname# hw-module module 1 password-reset

Cisco ASA 5500 Series Configuration Guide using the CLI

60-15

Chapter 60

Configuring the ASA CSC Module

Configuration Examples for the CSC SSM

Reloading or Resetting the Module
To reload or reset the module, enter one of the following commands at the ASA CLI.

Detailed Steps

Command

Purpose

hw-module module 1 reload

Reloads the module software.

Example:
hostname# hw-module module 1 reload
hw-module module 1 reset

Performs a reset, and then reloads the module.

Example:
hostname# hw-module module 1 reset

Shutting Down the Module
If you restart the ASA, the module is not automatically restarted. To shut down the module, perform the
following steps at the ASA CLI.

Detailed Steps

Command

Purpose

hw-module module 1 shutdown

Shuts down the module.

Example:
hostname# hw-module module 1 shutdown

Configuration Examples for the CSC SSM
To identify the traffic that you want to scan, you can configure the ASA in different ways. One approach
is to define two service policies, one on the inside interface and one on the outside interface, each with
an access list that matches traffic to be scanned. The following example is based on the network shown
in Figure 60-3 and shows the creation of two service policies for a common CSC SSM scanning scenario:
•

The first policy, csc_out_policy, is applied to the inside interface and uses the csc_out access list to
ensure that all outbound requests for FTP and POP3 are scanned. The csc_out access list also
ensures that HTTP connections from inside to networks on the outside interface are scanned, but it
includes a deny ACE to exclude HTTP connections from inside to servers on the DMZ network.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-16

Chapter 60

Configuring the ASA CSC Module
Configuration Examples for the CSC SSM

•

The second policy, csc_in_policy, is applied to the outside interface and uses the csc_in access list
to ensure that requests for SMTP and HTTP originating on the outside interface and destined for the
DMZ network are scanned by the CSC SSM. Scanning HTTP requests protects the web server from
HTTP file uploads.

hostname(config)# access-list
hostname(config)# access-list
255.255.255.0 eq 80
hostname(config)# access-list
hostname(config)# access-list

csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 21
csc_out deny tcp 192.168.10.0 255.255.255.0 192.168.20.0
csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 80
csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 110

hostname(config)# class-map csc_outbound_class
hostname(config-cmap)# match access-list csc_out
hostname(config-cmap)# policy-map csc_out_policy
hostname(config-pmap)# class csc_outbound_class
hostname(config-pmap-c)# csc fail-close
hostname(config-pmap-c)# service-policy csc_out_policy interface inside
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 25
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 80
hostname(config)# class-map csc_inbound_class
hostname(config-cmap)# match access-list csc_in
hostname(config-cmap)# policy-map csc_in_policy
hostname(config-pmap)# class csc_inbound_class
hostname(config-pmap-c)# csc fail-close
hostname(config-pmap-c)# service-policy csc_in_policy interface outside

The following example shows how to use an access list to exempt the traffic from being matched by the
policy map and prevent the ASA from sending traffic to the CSC SSM:
hostname(config)# access-list
hostname(config)# access-list
255.255.255.0 eq 80
hostname(config)# access-list
hostname(config)# access-list

csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 21
csc_out deny tcp 192.168.10.0 255.255.255.0 192.168.20.0
csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 80
csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 110

The following example shows how to add an ACE to the csc_out access list to exclude HTTP connections
between the trusted external web server and inside hosts from being scanned by the CSC SSM:
hostname(config)# access-list csc_out deny tcp 192.168.10.0 255.255.255.0 209.165.201.7
255.255.255.255 eq 80

The following example shows how to use the access list on the service policy applied to the outside
interface:
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 25

The following example shows how to add an ACE to the csc_in access list to use the CSC SSM to protect
the web server on a DMZ network from infected files uploaded by HTTP from external hosts:
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 80

Cisco ASA 5500 Series Configuration Guide using the CLI

60-17

Chapter 60

Configuring the ASA CSC Module

Where to Go Next

Where to Go Next
For instructions about how to use the CSC SSM GUI, see the Cisco Content Security and Control (CSC)
SSM Administrator Guide.

Additional References
For additional information related to implementing the CSC SSM, see the following documents:
Related Topic

Document Title

Assistance with SSM hardware installation and
connection to the ASA.

hardware guide

Accessing ASDM for the first time and
assistance with the Startup Wizard.

Cisco ASA 5500 Series Adaptive Security Appliance Getting Started Guide

Cisco Content Security and Control (CSC) SSM Administrator Guide
Instructions on use of the CSC SSM GUI.
Additional licensing requirements of specific
windows available in the CSC SSM GUI.
Reviewing the default content security policies
in the CSC SSM GUI before modifying them or
entering advanced configuration settings.
Technical Documentation, Marketing, and
Support-related information.

See the following URL:
http://www.cisco.com/en/US/products/ps6823/index.html.

Feature History for the CSC SSM
Table 60-2 lists each feature change and the platform release in which it was implemented.
Table 60-2

Feature History for the CSC SSM

Feature Name

Platform Releases

Feature Information

CSC SSM

7.0(1)

The CSC SSM runs Content Security and Control software, which provides
protection against viruses, spyware, spam, and other unwanted traffic.
We introduced the following commands: csc {fail-close | fail-open}, hw-module
module 1 [recover | reload | reset | shutdown], session, show module [all | slot
[details | recover]].

Password reset

7.2(2)

We introduced the following command: hw-module module password-reset.

CSC SSM

8.1(1) and 8.1(2)

This feature is not supported on the ASA 5580.

CSC syslog format

8.3(1)

CSC syslog format is consistent with the ASA syslog format. Syslog message
explanations have been added to the Cisco Content Security and Control (CSC)
SSM Administrator Guide. All syslog messages include predefined syslog
priorities and cannot be configured through the CSC SSM GUI.

Cisco ASA 5500 Series Configuration Guide using the CLI

60-18

PA R T

15

Configuring High Availability

CH A P T E R

61

Information About High Availability
This chapter provides an overview of the failover features that enable you to achieve high availability on
the Cisco 5500 series ASAs. For information about configuring high availability, see Chapter 63,
“Configuring Active/Active Failover” or Chapter 62, “Configuring Active/Standby Failover.”
This chapter includes the following sections:
•

Introduction to Failover and High Availability, page 61-1

•

Failover System Requirements, page 61-2

•

Failover and Stateful Failover Links, page 61-3

•

Active/Active and Active/Standby Failover, page 61-8

•

Stateless (Regular) and Stateful Failover, page 61-9

•

Transparent Firewall Mode Requirements, page 61-11

•

Auto Update Server Support in Failover Configurations, page 61-12

•

Failover Health Monitoring, page 61-14

•

Failover Times, page 61-16

•

Failover Messages, page 61-16

Introduction to Failover and High Availability
Configuring high availability requires two identical ASAs connected to each other through a dedicated
failover link and, optionally, a Stateful Failover link. The health of the active interfaces and units is
monitored to determine if specific failover conditions are met. If those conditions are met, failover
occurs.
The ASA supports two failover configurations, Active/Active failover and Active/Standby failover. Each
failover configuration has its own method for determining and performing failover.
With Active/Active failover, both units can pass network traffic. This also lets you configure traffic
sharing on your network. Active/Active failover is available only on units running in multiple context
mode.
With Active/Standby failover, only one unit passes traffic while the other unit waits in a standby state.
Active/Standby failover is available on units running in either single or multiple context mode.
Both failover configurations support stateful or stateless (regular) failover.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-1

Chapter 61

Information About High Availability

Failover System Requirements

Note

When the security appliance is configured for Active/Active Stateful Failover, you cannot enable IPsec
or SSL VPN. Therefore, these features are unavailable. VPN failover is available for Active/Standby
failover configurations only.

Failover System Requirements
This section describes the hardware, software, and license requirements for ASAs in a failover
configuration.
This section includes the following topics:
•

Hardware Requirements, page 61-2

•

Software Requirements, page 61-2

•

License Requirements, page 61-2

Hardware Requirements
The two units in a failover configuration must be the same model, have the same number and types of
interfaces, the same SSMs installed (if any), and 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 operating modes (routed or transparent,
single or multiple context). They must have the same major (first number) and minor (second number)
software version. However, you can 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.
See the “Performing Zero Downtime Upgrades for Failover Pairs” section on page 81-6 for more
information about upgrading the software on a failover pair.

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. See the “Failover Licenses (8.3(1) and Later)” section on page 3-28 for
more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-2

Chapter 61

Information About High Availability
Failover and Stateful Failover Links

Failover and Stateful Failover Links
This section describes the failover and the Stateful Failover links, which are dedicated connections
between the two units in a failover configuration. This section includes the following topics:
•

Failover Link, page 61-3

•

Stateful Failover Link, page 61-4

•

Avoiding Interrupted Failover Links, page 61-5

Failover Link
The two units in a failover pair constantly communicate over a failover link to determine the operating
status of each unit. The following information is communicated over the failover link:

Caution

•

The unit state (active or standby)

•

Hello messages (keep-alives)

•

Network link status

•

MAC address exchange

•

Configuration replication and synchronization

All information sent over the failover and Stateful Failover links is sent in clear text unless you secure
the communication with 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 a failover key if you are using the ASA to terminate VPN tunnels.
You can use any unused interface on the device as the failover link; however, you cannot specify an
interface that is currently configured with a name. The failover link interface is not configured as a
normal networking interface; it exists for failover communication only. This interface should only be
used for the failover link (and optionally for the Stateful Failover link).
Connect the failover 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.

•

Using a crossover Ethernet cable to connect the appliances directly, without the need for an external
switch.

Note

When you use a crossover cable for the failover link, if the interface fails, the link is brought down on
both peers. This condition may hamper troubleshooting efforts because you cannot easily determine
which interface failed and caused the link to come down.

Note

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-3

Chapter 61

Information About High Availability

Failover and Stateful Failover Links

Although you can configure failover and failover state links on a port channel link, this port channel
cannot be shared with other firewall traffic.

Stateful Failover Link
To use Stateful Failover, you must configure a Stateful Failover link to pass all state information. You
have three options for configuring a Stateful Failover link:
•

You can use a dedicated Ethernet interface for the Stateful Failover link.

•

You can share the failover link.

•

You can share a regular data interface, such as the inside interface. However, this option is not
recommended.

Connect a dedicated state link in one of the following two ways:

Note

•

Using a switch, with no other device on the same network segment (broadcast domain or VLAN) as
the failover interfaces of the ASA.

•

Using a crossover Ethernet cable to connect the appliances directly, without the need for an external
switch.

When you use a crossover cable for the state link, if the interface fails, the link is brought down on both
peers. This condition may hamper troubleshooting efforts because you cannot easily determine which
interface failed 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.
Enable the PortFast option on Cisco switch ports that connect directly to the ASA.
If you use a data interface as the Stateful Failover link, you receive the following warning when you
specify that interface as the Stateful Failover link:
******* WARNING ***** WARNING ******* WARNING ****** WARNING *********
Sharing Stateful failover interface with regular data interface is not
a recommended configuration due to performance and security concerns.
******* WARNING ***** WARNING ******* WARNING ****** WARNING *********

Sharing a data interface with the Stateful Failover interface can leave you vulnerable to replay attacks.
Additionally, large amounts of Stateful Failover traffic may be sent on the interface, causing
performance problems on that network segment.

Note

Using a data interface as the Stateful Failover interface is supported in single context, routed mode only.
In multiple context mode, the Stateful Failover link resides in the system context. This interface and the
failover interface are the only interfaces in the system context. All other interfaces are allocated to and
configured from within security contexts.

Note

The IP address and MAC address for the Stateful Failover link does not change at failover unless the
Stateful Failover link is configured on a regular data interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-4

Chapter 61

Information About High Availability
Failover and Stateful Failover Links

Caution

All information sent over the failover and Stateful Failover links is sent in clear text unless you secure
the communication with 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 a failover key if you are using the ASA to terminate VPN tunnels.

Failover Interface Speed for Stateful Links
If you use the failover link as the Stateful Failover link, you should use the fastest Ethernet interface
available. If you experience performance problems on that interface, consider dedicating a separate
interface for the Stateful Failover interface.
Use the following failover interface speed guidelines for the ASAs:
•

Cisco ASA 5510
– Stateful link speed can be 100 Mbps, even though the data interface can operate at 1 Gigabit due

to the CPU speed limitation.
•

Cisco ASA 5520/5540/5550
– Stateful link speed should match the fastest data link.

•

Cisco ASA 5580/5585
– Use only non-management 1 Gigabit ports for the stateful link because management ports have

lower performance and cannot meet the performance requirement for Stateful Failover.
For optimum performance when using long distance failover, the latency for the failover link should be
less than 10 milliseconds and no more than 250 milliseconds. If latency is more than10 milliseconds,
some performance degradation occurs due to retransmission of failover messages.
The ASA supports sharing of failover heartbeat and stateful link, but we recommend using a separate
heartbeat link on systems with high Stateful Failover traffic.

Avoiding Interrupted Failover Links
Because the uses failover interfaces to transport messages between primary and secondary units, if a
failover interface is down (that is, the physical link is down or the switch used to connect the interface
is down), then the ASA failover operation is affected until the health of the failover interface is restored.
In the event that all communication is cut off between the units in a failover pair, both units go into the
active state, which is expected behavior. When communication is restored and the two active units
resume communication through the failover link or through any monitored interface, the primary unit
remains active, and the secondary unit immediately returns to the standby state. This relationship is
established regardless of the health of the primary unit.
Because of this behavior, stateful flows that were passed properly by the secondary active unit during
the network split are now interrupted. To avoid this interruption, failover links and data interfaces should
travel through different paths to decrease the chance that all links fail at the same time. In the event that
only one failover link is down, the ASA takes a sample of the interface health, exchanges this
information with its peer through the data interface, and performs a switchover if the active unit has a
greater number of down interfaces. Subsequently, the failover operation is suspended until the health of
the failover link is restored.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-5

Chapter 61

Information About High Availability

Failover and Stateful Failover Links

Depending upon their network topologies, several primary/secondary failure scenarios exist in ASA
failover pairs, as shown in the following scenarios.
Scenario 1—Not Recommended

If a single switch or a set of switches are used to connect both failover and data interfaces between two
ASAs, then when a switch or inter-switch-link is down, both ASAs become active. Therefore, the
following two connection methods shown in Figure 61-1 and Figure 61-2 are NOT recommended.
Connecting with a Single Switch—Not Recommended

outside

Figure 61-2

Primary ASA

Failover link
inside

Secondary ASA

Connecting with a Double Switch—Not Recommended

outside
Failover link
inside

Switch 1

Switch 2
ISL

outside
Failover link
inside

Secondary ASA

236370

Primary ASA

outside

Failover link
inside

236369

Figure 61-1

Scenario 2—Recommended

To make the ASA failover pair resistant to failover interface failure, we recommend that failover
interfaces NOT use the same switch as the data interfaces, as shown in the preceding connections.
Instead, use a different switch or use a direct cable to connect two ASA failover interfaces, as shown in
Figure 61-3 and Figure 61-4.
Figure 61-3

Connecting with a Different Switch

Switch 1
Primary ASA

outside

outside

inside

inside

Secondary ASA

Failover link

Figure 61-4

Failover link

236371

Switch 2

Connecting with a Cable

Switch 1
outside

inside

inside

Failover link
Failover link
Ethernet cable

Cisco ASA 5500 Series Configuration Guide using the CLI

61-6

Secondary ASA

236372

Primary ASA

outside

Information About High Availability
Failover and Stateful Failover Links

Scenario 3—Recommended

If the ASA data interfaces are connected to more than one set of switches, then a failover interface can
be connected to one of the switches, preferably the switch on the secure side of network, as shown in
Figure 61-5.
Connecting with a Secure Switch

Switch 1
Primary ASA

outside

Failover link

Switch 2
outside

ISL

Switch 3

Switch 4
ISL

inside

Secondary ASA

Failover link
236373

Figure 61-5

inside

Scenario 4—Recommended

The most reliable failover configurations use a redundant interface on the failover interface, as shown in
Figure 61-6 and Figure 61-7.
Figure 61-6

Connecting with Redundant Interfaces

Switch 1
outside

Switch 2
outside

ISL

Switch 3
Primary ASA

Active redundant
failover link

Active redundant
failover link

Secondary ASA

Switch 4
Standby redundant
failover link

Standby redundant
failover link

Switch 5
inside

Switch 6
ISL

inside

236375

Chapter 61

Cisco ASA 5500 Series Configuration Guide using the CLI

61-7

Chapter 61

Information About High Availability

Active/Active and Active/Standby Failover

Connecting with Inter-switch Links

Switch 1
outside

Switch 2

Switch 3
Primary
ASA

Active redundant
failover link

Switch 4
Active redundant
failover link

ISL

Switch 5
Standby redundant
failover link

Secondary
ASA

Switch 6
Standby redundant
failover link

ISL

Switch 7
inside

outside

ISL

Switch 8
ISL

inside

236376

Figure 61-7

Active/Active and Active/Standby Failover
Two types of failover configurations are supported by the ASA: Active/Standby and Active/Active.
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, although it is
most commonly used for ASAs in single context mode.
Active/Active failover is only available to ASAs in multiple context mode. In an Active/Active failover
configuration, both ASAs can pass network traffic. In Active/Active failover, you divide the security
contexts on the ASA into failover groups. A failover group is simply a logical group of one or more
security contexts. Each group is assigned to be active on a specific ASA in the failover pair. When a
failover occurs, it occurs at the failover group level.
For more detailed information about each type of failover, refer the following information:
•

Chapter 62, “Configuring Active/Standby Failover”

•

Chapter 63, “Configuring Active/Active Failover”

Determining Which Type of Failover to Use
The type of failover you choose depends upon your ASA configuration and how you plan to use the
ASAs.
If you are running the ASA in single mode, then you can use only Active/Standby failover. Active/Active
failover is only available to ASAs running in multiple context mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-8

Chapter 61

Information About High Availability
Stateless (Regular) and Stateful Failover

Note

The ASA 5505 does not support multiple context mode or Active/Active failover.
VPN is not supported in multiple context mode or Active/Active failover.
If you are running the ASA in multiple context mode, then you can configure either Active/Active
failover or Active/Standby failover.
•

To allow both members of the failover pair to share the traffic, use Active/Active failover. Do not
exceed 50% load on each device.

•

If you do not want to share the traffic in this way, use Active/Standby or Active/Active failover.

Table 61-1 provides a comparison of some of the features supported by each type of failover
configuration.
Table 61-1

Failover Configuration Feature Support

Feature

Active/Active

Active/Standby

Single Context Mode

No

Yes

Multiple Context Mode

Yes

Yes

Traffic Sharing Network Configurations

Yes

No

Unit Failover

Yes

Yes

Failover of Groups of Contexts

Yes

No

Failover of Individual Contexts

No

No

Stateless (Regular) and Stateful Failover
The ASA supports two types of failover, regular and stateful. This section includes the following topics:
•

Stateless (Regular) Failover, page 61-9

•

Stateful Failover, page 61-10

Stateless (Regular) Failover
When a failover occurs, all active connections are dropped. Clients need to reestablish connections when
the new active unit takes over.

Note

In Version 8.0 and later, 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-9

Chapter 61

Information About High Availability

Stateless (Regular) and Stateful Failover

Stateful Failover
When Stateful Failover is enabled, the active unit continually passes per-connection state information to
the standby unit. 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.
In Version 8.4 and later, 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.
Table 61-2 list the state information that is and is not passed to the standby unit when Stateful Failover
is enabled.
Table 61-2

State Information

State Information Passed to Standby Unit

State Information Not Passed to Standby Unit

NAT translation table

The HTTP connection table (unless HTTP
replication is enabled).

TCP connection states

The user authentication (uauth) table.
Inspected protocols are subject to advanced
TCP-state tracking, and 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.

UDP connection states

DHCP server address leases.

The ARP table

State information for modules.

The Layer 2 bridge table (when running in
transparent firewall mode)

Stateful Failover for phone proxy. 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.

The HTTP connection states (if HTTP replication —
is enabled)
The ISAKMP and IPsec SA table

—

GTP PDP connection database

—

SIP signalling sessions

—

ICMP connection state

By default, the ASA does not replicate the ICMP
connection state in failover. ICMP connection
replication is enabled only if the respective
interface is assigned to an asymmetric routing
group.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-10

Chapter 61

Information About High Availability
Transparent Firewall Mode Requirements

The following clientless SSL VPN features are not supported with Stateful Failover:

Note

•

Smart Tunnels

•

Port Forwarding

•

Plugins

•

Java Applets

•

IPv6 clientless or Anyconnect sessions

•

Citrix authentication (Citrix users must reauthenticate after failover)

If 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 CallManager. This 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 CallManager
unreachable and unregisters itself.
For VPN failover, VPN end-users should not have to reauthenticate or reconnect the VPN session in the
event of a failover. However, applications operating over the VPN connection could lose packets during
the failover process and not recover from the packet loss.

Transparent Firewall Mode Requirements
When the active unit fails over to the standby unit, the connected switch port running Spanning Tree
Protocol (STP) can go into a blocking state for 30 to 50 seconds when it senses the topology change. To
avoid traffic loss while the port is in a blocking state, you can configure one of the following
workarounds depending on the switch port mode:
•

Access mode—Enable the STP PortFast feature on the switch:
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:
access-list id ethertype deny bpdu
access-group id in interface inside_name
access-group id in interface outside_name

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 failover interface monitoring.

•

Increase failover 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 failover interface holdtime.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-11

Chapter 61

Information About High Availability

Auto Update Server Support in Failover Configurations

Auto Update Server Support in Failover Configurations
You can use the Auto Update Server to deploy software images and configuration files to ASAs in an
Active/Standby failover configuration. To enable Auto Update on an Active/Standby failover
configuration, enter the Auto Update Server configuration on the primary unit in the failover pair. See
the “Configuring Auto Update Support” section on page 81-16, for more information.
The following restrictions and behaviors apply to Auto Update Server support in failover configurations:
•

Only single mode, Active/Standby configurations are supported.

•

When loading a new platform software image, the failover pair stops passing traffic.

•

When using LAN-based failover, new configurations must not change the failover link
configuration. If they do, communication between the units will fail.

•

Only the primary unit will perform the call home to the Auto Update Server. The primary unit must
be in the active state to call home. If it is not, the ASA automatically fails over to the primary unit.

•

Only the primary unit downloads the software image or configuration file. The software image or
configuration is then copied to the secondary unit.

•

The interface MAC address and hardware-serial ID is from the primary unit.

•

The configuration file stored on the Auto Update Server or HTTP server is for the primary unit only.

Auto Update Process Overview
The following is an overview of the Auto Update process in failover configurations. This process
assumes that failover is enabled and operational. The Auto Update process cannot occur if the units are
synchronizing configurations, if the standby unit is in the failed state for any reason other than SSM card
failure, or if the failover link is down.
1.

Both units exchange the platform and ASDM software checksum and version information.

2.

The primary unit contacts the Auto Update Server. If the primary unit is not in the active state, the
ASA first fails over to the primary unit and then contacts the Auto Update Server.

3.

The Auto Update Server replies with software checksum and URL information.

4.

If the primary unit determines that the platform image file needs to be updated for either the active
or standby unit, the following occurs:
a. The primary unit retrieves the appropriate files from the HTTP server using the URL from the

Auto Update Server.
b. The primary unit copies the image to the standby unit and then updates the image on itself.
c. If both units have new image, the secondary (standby) unit is reloaded first.
– 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-12

Chapter 61

Information About High Availability
Auto Update Server Support in Failover Configurations

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.

Monitoring the Auto Update Process
You can use the debug auto-update client or debug fover cmd-exe commands to display the actions
performed during the Auto Update process. The following is sample output from the debug auto-update
client command.
Auto-update client: Sent DeviceDetails to /cgi-bin/dda.pl of server 192.168.0.21
Auto-update client: Processing UpdateInfo from server 192.168.0.21
Component: asdm, URL: http://192.168.0.21/asdm.bint, checksum:
0x94bced0261cc992ae710faf8d244cf32
Component: config, URL: http://192.168.0.21/config-rms.xml, checksum:
0x67358553572688a805a155af312f6898
Component: image, URL: http://192.168.0.21/cdisk73.bin, checksum:
0x6d091b43ce96243e29a62f2330139419
Auto-update client: need to update img, act: yes, stby yes
name
ciscoasa(config)# Auto-update client: update img on stby unit...
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 1, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 1001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 1501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 2001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 2501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 3001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 3501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 4001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 4501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 5001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 5501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 6001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 6501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 7001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 7501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 8001, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 8501, len = 1024
auto-update: Fover copyfile, seq = 4 type = 1, pseq = 9001, len = 1024
auto-update: Fover file copy waiting at clock tick 6129280
fover_parse: Rcvd file copy ack, ret = 0, seq = 4
auto-update: Fover filecopy returns value: 0 at clock tick 6150260, upd time 145980 msecs

Cisco ASA 5500 Series Configuration Guide using the CLI

61-13

Chapter 61

Information About High Availability

Failover Health Monitoring

Auto-update client: update img on active unit...
fover_parse: Rcvd image info from mate
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with
Beginning configuration replication: Sending to mate.
auto-update: HA safe reload: reload active waiting with
auto-update: HA safe reload: reload active waiting with

mate
mate
mate
mate
mate
mate
mate
mate
mate
mate
mate
mate
mate
mate
mate

state:
state:
state:
state:
state:
state:
state:
state:
state:
state:
state:
state:
state:
state:
state:

20
20
20
20
20
20
20
20
20
20
20
20
20
20
20

mate state: 50
mate state: 50

auto-update: HA safe reload: reload active waiting with mate state: 80
Sauto-update: HA safe reload: reload active unit at clock tick: 6266860
Auto-update client: Succeeded: Image, version: 0x6d091b43ce96243e29a62f2330139419

The following system log message is generated if the Auto Update process fails:
%ASA4-612002: Auto Update failed: file version: version reason: reason

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 the update failed.

Failover Health Monitoring
The ASA monitors each unit for overall health and for interface health. See the following sections for
more information about how the ASA performs tests to determine the state of each unit:
•

Unit Health Monitoring, page 61-14

•

Interface Monitoring, page 61-15

Unit Health Monitoring
The ASA determines the health of the other unit by monitoring the failover link. When a unit does not
receive three consecutive hello messages on the failover link, the unit sends interface hello messages on
each interface, including the failover interface, to validate whether or not the peer interface is responsive.
The action that the ASA takes depends upon the response from the other unit. See the following possible
actions:
•

If the ASA receives a response on the failover interface, then it does not fail over.

•

If the ASA does not receive a response on the failover link, but it does receive a response on another
interface, then the unit does not failover. The failover link is marked as failed. You should restore
the failover link as soon as possible because the unit cannot fail over to the standby while the failover
link is down.

•

If the ASA does not receive a response on any interface, then the standby unit switches to active
mode and classifies the other unit as failed.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-14

Chapter 61

Information About High Availability
Failover Health Monitoring

You can configure the frequency of the hello messages and the hold time before failover occurs. A faster
poll time and shorter hold time speed the detection of unit failures and make failover occur more quickly,
but it can also cause “false” failures due to network congestion delaying the keepalive packets.

Interface Monitoring
You can monitor up to 250 interfaces divided between all contexts. You should monitor important
interfaces. For example, 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 half of the configured hold
time, it runs the following tests:
1.

Link Up/Down test—A test of the interface status. If the Link Up/Down test indicates that the
interface is operational, then the ASA performs network tests. The purpose of these tests is to
generate network traffic to determine which (if either) unit has failed. At the start of each test, each
unit clears its received packet count for its interfaces. At the conclusion of each test, each unit looks
to see if it has received any traffic. If it has, the interface is considered operational. If one unit
receives traffic for a test and the other unit does not, the unit that received no traffic is considered
failed. If neither unit has received traffic, then the next test is used.

2.

Network Activity test—A received network activity test. The unit 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 ARP test begins.

3.

ARP test—A reading of the unit ARP cache for the 2 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 ping test begins.

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 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).
If all network tests fail for an interface, but this 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.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-15

Chapter 61

Information About High Availability

Failover Times

Failover Times
Table 61-3 shows the minimum, default, and maximum failover times.
Table 61-3

Cisco ASA 5500 Series ASA Failover Times

Failover Condition

Minimum

Default

Maximum

Active unit loses power or stops normal operation.

800 milliseconds

15 seconds

45 seconds

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

Active unit IPS or CSC module fails.

2 seconds

2 seconds

2 seconds

Active unit interface up, but connection problem
causes interface testing.

5 seconds

25 seconds

75 seconds

Failover Messages
When a failover occurs, both ASAs send out system messages. This section includes the following
topics:
•

Failover System Messages, page 61-16

•

Debug Messages, page 61-16

•

SNMP, page 61-17

Failover System Messages
The ASA issues a number of system messages related to failover at priority level 2, which indicates a
critical condition. To view these messages, see the syslog message guide guide. To enable logging, see
Chapter 77, “Configuring Logging.”

Note

During switchover, failover logically shuts down and then bring up interfaces, generating syslog
messages 411001 and 411002. This is normal activity.

Debug Messages
To see debug messages, enter the debug fover command. See the command reference for more
information.

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-16

Chapter 61

Information About High Availability
Failover Messages

SNMP
To receive SNMP syslog traps for failover, configure the SNMP agent to send SNMP traps to SNMP
management stations, define a syslog host, and compile the Cisco syslog MIB into your SNMP
management station. See Chapter 79, “Configuring SNMP” for more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

61-17

Chapter 61
Failover Messages

Cisco ASA 5500 Series Configuration Guide using the CLI

61-18

Information About High Availability

CH A P T E R

62

Configuring Active/Standby Failover
This chapter describes how to configure Active/Standby failover and includes the following sections:
•

Information About Active/Standby Failover, page 62-1

•

Licensing Requirements for Active/Standby Failover, page 62-6

•

Prerequisites for Active/Standby Failover, page 62-6

•

Guidelines and Limitations, page 62-6

•

Configuring Active/Standby Failover, page 62-7

•

Controlling Failover, page 62-16

•

Monitoring Active/Standby Failover, page 62-18

•

Feature History for Active/Standby Failover, page 62-18

Information About Active/Standby Failover
This section describes Active/Standby failover and includes the following topics:
•

Active/Standby Failover Overview, page 62-1

•

Primary/Secondary Status and Active/Standby Status, page 62-2

•

Device Initialization and Configuration Synchronization, page 62-2

•

Command Replication, page 62-3

•

Failover Triggers, page 62-4

•

Failover Actions, page 62-4

Active/Standby Failover Overview
Active/Standby failover enables you to use a standby ASA to take over the functionality of a failed unit.
When the active unit fails, it changes to the standby state while the standby unit changes to the active
state. The unit that becomes active assumes the IP addresses (or, for transparent firewall, the
management IP address) and MAC addresses of the failed unit and begins passing traffic. 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-1

Chapter 62

Configuring Active/Standby Failover

Information About Active/Standby Failover

Note

For multiple context mode, the ASA can fail over the entire unit (including all contexts) but cannot fail
over individual contexts separately.

Primary/Secondary Status and Active/Standby Status
The main differences between the two units in a failover pair are related to which unit is active and which
unit is standby, namely which IP addresses to use and which unit actively passes traffic.
However, a few differences exist between the units based on which unit is primary (as specified in the
configuration) and which unit is secondary:
•

The primary unit always becomes the active unit if both units start up at the same time (and are of
equal operational health).

•

The primary unit MAC addresses are always coupled with the active IP addresses. The exception to
this rule occurs when the secondary unit is active and cannot obtain the primary unit MAC addresses
over the failover link. In this case, the secondary unit MAC addresses are used.

Device Initialization and Configuration Synchronization
Configuration synchronization occurs when one or both devices in the failover pair boot. Configurations
are always synchronized from the active unit to the standby unit. When the standby unit completes its
initial startup, it clears its running configuration (except for the failover commands needed to
communicate with the active unit), and the active unit sends its entire configuration to the standby unit.
The active unit is determined by the following:

Note

•

If a unit boots and detects a peer already running as active, it becomes the standby unit.

•

If a unit boots and does not detect a peer, it becomes the active unit.

•

If both units boot simultaneously, then the primary unit becomes the active unit, and the secondary
unit becomes the standby unit.

If the secondary unit boots without detecting the primary unit, it becomes the active unit. It uses its own
MAC addresses for the active IP addresses. However, when the primary unit becomes available, the
secondary unit changes the MAC addresses to those of the primary unit, which can cause an interruption
in your network traffic. To avoid this, configure the failover pair with virtual MAC addresses. See the
“Configuring Virtual MAC Addresses” section on page 62-15 for more information.
When the replication starts, the ASA console on the active unit displays the message “Beginning
configuration replication: Sending to mate,” and when it is complete, the ASA displays the message
“End Configuration Replication to mate.” 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 in
the failover pair during the configuration replication process. Depending upon the size of the
configuration, replication can take from a few seconds to several minutes.

Note

The crypto ca server command and related sub commands are not synchronized to the failover peer.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-2

Chapter 62

Configuring Active/Standby Failover
Information About Active/Standby Failover

On the standby unit, the configuration exists only in running memory. To save the configuration to flash
memory after synchronization, do the following:

Note

•

For single context mode, enter the write memory command on the active unit. The command is
replicated to the standby unit, which proceeds to write its configuration to flash memory.

•

For multiple context mode, enter the write memory all command on the active unit from the system
execution space. The command is replicated to the standby unit, which proceeds to write its
configuration to flash memory. Using the all keyword with this command causes the system and all
context configurations to be saved.

Startup configurations saved on external servers are accessible from either unit over the network and do
not need to be saved separately for each unit. Alternatively, you can copy the contexts on disk from the
active unit to an external server, and then copy them to disk on the standby unit, where they become
available when the unit reloads.

Command Replication
Command replication always flows from the active unit to the standby unit. As commands are entered
on the active unit, they are sent across the failover link to the standby unit. You do not have to save the
active configuration to flash memory to replicate the commands.
Table 62-1 lists the commands that are and are not replicated to the standby unit.
Table 62-1

Note

Command Replication

Command Replicated to the Standby Unit

Commands Not Replicated to the Standby Unit

All configuration commands except for mode,
firewall, and failover lan unit

All forms of the copy command except for copy
running-config startup-config

copy running-config startup-config

all forms of the write command except for write
memory

delete

crypto ca server and associated sub commands

mkdir

debug

rename

failover lan unit

rmdir

firewall

write memory

mode

—

show

—

terminal pager and pager

Changes made on the standby unit are not replicated to the active unit. If you enter a command on the
standby unit, the ASA displays the message **** WARNING **** Configuration Replication is NOT
performed from Standby unit to Active unit. Configurations are no longer synchronized.

This message appears even when you enter many commands that do not affect the configuration.
If you enter the write standby command on the active unit, the standby unit clears its running
configuration (except for the failover commands used to communicate with the active unit), and the
active unit sends its entire configuration to the standby unit.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-3

Chapter 62

Configuring Active/Standby Failover

Information About Active/Standby Failover

For multiple context mode, when you enter the write standby command in the system execution space,
all contexts are replicated. If you enter the write standby command within a context, the command
replicates only the context configuration.
Replicated commands are stored in the running configuration.

Note

Standby Failover does not replicate the following files and configuration components:
•

AnyConnect images

•

CSD images

•

ASA images

•

AnyConnect profiles

•

Local Certificate Authorities (CAs)

•

ASDM images

To save the replicated commands to the flash memory on the standby unit, standby unit, do the following:
•

For single context mode, enter the copy running-config startup-config command on the active unit.
The command is replicated to the standby unit, which proceeds to write its configuration to flash
memory.

•

For multiple context mode, enter the copy running-config startup-config command on the active
unit from the system execution space and within each context on disk. The command is replicated
to the standby unit, which proceeds to write its configuration to flash memory. Contexts with startup
configurations on external servers are accessible from either unit over the network and do not need
to be saved separately for each unit. Alternatively, you can copy the contexts on disk from the active
unit to an external server, and then copy them to disk on the standby unit.

Failover Triggers
The unit can fail if one of the following events occurs:
•

The unit has a hardware failure or a power failure.

•

The unit has a software failure.

•

Too many monitored interfaces fail.

•

You force a failover. (See the “Forcing Failover” section on page 62-16.)

Failover Actions
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-4

Chapter 62

Configuring Active/Standby Failover
Information About Active/Standby Failover

Table 62-2 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.
Table 62-2

Failover Behavior

Failure Event

Policy

Active Action

Standby Action

Notes

Active unit failed (power or
hardware)

Failover

n/a

Become active

No hello messages are received on
any monitored interface or the
failover link.

Formerly active unit recovers

No failover

Become standby

No action

None.

Standby unit failed (power or
hardware)

No failover

Mark standby as
failed

n/a

When the standby unit is marked as
failed, then the active unit does not
attempt to fail over, even if the
interface failure threshold is
surpassed.

Failover link failed during
operation

No failover

Mark failover
interface as failed

Mark failover
interface 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.

Failover link failed at startup

No failover

Mark failover
interface as failed

Become active

If the failover link is down at
startup, both units become active.

Stateful Failover 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
above threshold

Mark active as
failed

Become active

None.

Interface failure on standby
unit above threshold

No action

Mark standby as
failed

When the standby unit is marked as
failed, then the active unit does not
attempt to fail over even if the
interface failure threshold is
surpassed.

Mark active as
failed

No failover

Cisco ASA 5500 Series Configuration Guide using the CLI

62-5

Chapter 62

Configuring Active/Standby Failover

Licensing Requirements for Active/Standby Failover

Optional Active/Standby Failover Settings
You can configure the following Active/Standby failover options when you initially configuring failover
or after failover has been configured:
•

HTTP replication with Stateful Failover—Allows connections to be included in the state
information replication.

•

Interface monitoring—Allows you to monitor up to 250 interfaces on a unit and control which
interfaces affect your failover.

•

Interface health monitoring—Enables the ASA to detect and respond to interface failures more
quickly.

•

Failover criteria setup—Allows you to specify a specific number of interfaces or a percentage of
monitored interfaces that must fail before failover occurs.

•

Virtual MAC address configuration—Ensures that the secondary unit uses the correct MAC
addresses when it is the active unit, even if it comes online before the primary unit.

Licensing Requirements for Active/Standby Failover
The following table shows the licensing requirements for this feature:
Model

License Requirement

ASA 5505

Security Plus License. (Stateful failover is not supported).

ASA 5510, ASA
5512-X

Security Plus License.

All other models

Base License.

Prerequisites for Active/Standby Failover
Active/Standby failover has the following prerequisites:
•

Both units must be identical ASAs that are connected to each other through a dedicated failover link
and, optionally, a Stateful Failover link.

•

Both units must have the same software configuration and the proper license.

•

Both units must be in the same mode (single or multiple, transparent or routed).

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
•

Supported in single and multiple context mode.

•

For multiple context mode, perform all steps in the system execution space unless otherwise noted.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-6

Chapter 62

Configuring Active/Standby Failover
Configuring Active/Standby Failover

Firewall Mode Guidelines
•

Supported in transparent and routed firewall mode.

IPv6 Guidelines
•

IPv6 failover is supported.

Model Guidelines
•

Stateful failover is not supported on the ASA 5505.

Additional Guidelines and Limitations

Configuring port security on the switch(es) connected to an ASA failover pair can cause communication
problems when a failover event occurs. This is because if 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.
ASA failover replication fails if you try to make a configuration change in two or more contexts at the
same time. The workaround is to make configuration changes on each unit sequentially.
The following guidelines and limitations apply for Active/Standby failover:
•

To receive packets from both units in a failover pair, standby IP addresses need to be configured on
all interfaces.

•

The standby IP addresses are used on the ASA that is currently the standby unit, and they must be
in the same subnet as the active IP address on the corresponding interface on the active unit.

•

If you change the console terminal pager settings on the active unit in a failover pair, the active
console terminal pager settings change, but the standby unit settings do not. A default configuration
issued on the active unit does affect behavior on the standby unit.

•

When you enable interface monitoring, you can monitor up to 250 interfaces on a unit.

•

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 failover replication http command enables the stateful
replication of HTTP sessions in a Stateful Failover environment, but it could have a negative impact
upon system performance.

•

AnyConnect images must be the same on both ASAs in a failover pair. If the failover pair has
mismatched images when a hitless upgrade is performed, then the WebVPN 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.”

Configuring Active/Standby Failover
This section describes how to configure Active/Standby failover. This section includes the following
topics:
•

Task Flow for Configuring Active/Standby Failover, page 62-8

•

Configuring the Primary Unit, page 62-8

•

Configuring the Secondary Unit, page 62-11

•

Configuring Optional Active/Standby Failover Settings, page 62-12

Cisco ASA 5500 Series Configuration Guide using the CLI

62-7

Chapter 62

Configuring Active/Standby Failover

Configuring Active/Standby Failover

Task Flow for Configuring Active/Standby Failover
To configure Active/Standby failover, perform the following steps:
Step 1

Configure the primary unit, as shown in the “Configuring the Primary Unit” section on page 62-8.

Step 2

Configure the secondary unit, as shown in the “Configuring the Secondary Unit” section on page 62-11.

Step 3

(Optional) Configure optional Active/Standby failover settings, as shown in the “Configuring Optional
Active/Standby Failover Settings” section on page 62-12.

Configuring the Primary Unit
Follow the steps in this section to configure the primary unit in a LAN-based, Active/Standby failover
configuration. These steps provide the minimum configuration needed to enable failover on the primary
unit.

Restrictions
Do not configure an IP address in interface configuration mode for the Stateful Failover link if you are
going to use a dedicated Stateful Failover interface. You use the failover interface ip command to
configure a dedicated Stateful Failover interface in a later step.

Prerequisites
•

Configure standby addresses for all IP addresses according to Chapter 8, “Completing Interface
Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

•

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-8

Chapter 62

Configuring Active/Standby Failover
Configuring Active/Standby Failover

Detailed Steps

Command

Purpose

Step 1

failover lan unit primary

Designates the unit as the primary unit.

Step 2

failover lan interface if_name
interface_id

Specifies the interface to be used as the failover interface. This
interface should not be used for any other purpose (except,
optionally, the Stateful Failover link).

Example:

The if_name argument assigns a name to the interface specified by
the interface_id argument.

hostname(config)# failover lan interface
folink GigabitEthernet0/3

The interface ID can be a physical interface or a redundant
interface. On the ASA 5505, the interface_id specifies a VLAN.
Note

Step 3

failover interface ip if_name [ip_address
mask standby ip_address |
ipv6_address/prefix standbyipv6_address]

Assigns the active and standby IP addresses to the failover link.
You can assign either an IPv4 or an IPv6 address to the interface.
You cannot assign both types of addresses to the failover link.

Example:

The standby IP address must be in the same subnet as the active
IP address. You do not need to identify the standby address
subnet mask.

hostname(config)# failover interface ip
folink 172.27.48.1 255.255.255.0 standby
172.27.48.2

Step 4

Although you can use an EtherChannel as a failover or
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.
You cannot alter the EtherChannel configuration while it
is in use as a failover link. To alter the configuration, you
need to either shut down the EtherChannel while you
make changes, or temporarily disable failover; either
action prevents failover from occurring for the duration.

hostname(config)# failover interface ip
folink 2001:a0a:b00::a0a:b70/64 standby
2001:a0a:b00::a0a:b71

The failover link IP address and MAC address do not change at
failover. The active IP address for the failover link always stays
with the primary unit, while the standby IP address stays with the
secondary unit.

interface interface_id

Enables the interface.

no shutdown

Example:
hostname(config)# interface vlan100
hostname(config-if)# no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

62-9

Chapter 62

Configuring Active/Standby Failover

Configuring Active/Standby Failover

Step 5

Command

Purpose

failover link if_name interface_id

(Optional) Specifies the interface to be used as the Stateful
Failover link. This interface should not be used for any other
purpose (except, optionally, the failover link).

Example:
hostname(config)# failover link statelink
GigabitEthernet0/2

Note

If the Stateful Failover link uses the failover link or a data
interface, then you only need to supply the if_name
argument.

The if_name argument assigns a logical name to the interface
specified by the interface_id argument. The interface_id
argument can be the physical port name, such as Ethernet1, or a
previously created subinterface, such as Ethernet0/2.3. This
interface can be a physical interface or a redundant interface.
Note

Step 6

Although you can use an EtherChannel as a failover or
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.
You cannot alter the EtherChannel configuration while it
is in use as a failover link. To alter the configuration, you
need to either shut down the EtherChannel while you
make changes, or temporarily disable failover; either
action prevents failover from occurring for the duration.

failover interface ip if_name [ip_address
mask standby ip_address |
ipv6_address/prefix standbyipv6_address]

(Optional) Assigns an active and standby IP address to the
Stateful Failover link. You can assign either an IPv4 or an IPv6
address to the interface. You cannot assign both types of addresses
to the Stateful Failover link.

Example:

Note

hostname(config)# failover interface ip
folink 172.27.48.1 255.255.255.0 standby
172.27.48.2
hostname(config)# failover interface ip
statelink 2001:a1a:b00::a0a:a70/64 standby
2001:a1a:b00::a0a:a71

If the stateful Failover link uses the failover link or data
interface, skip this step. You have already defined the
active and standby IP addresses for the interface.

The standby IP address must be in the same subnet as the active
IP address. You do not need to identify the standby address
subnet mask.
The Stateful Failover link IP address and MAC address do not
change at failover unless it uses a data interface. The active IP
address always stays with the primary unit, while the standby IP
address stays with the secondary unit.

Step 7

interface interface_id
no shutdown

(Optional) Enables the interface.
If the Stateful Failover link uses the failover link or a data
interface, skip this step. You have already enabled the interface.

Example:
hostname(config)# interface vlan100
hostname(config-if)# no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

62-10

Chapter 62

Configuring Active/Standby Failover
Configuring Active/Standby Failover

Step 8

Command

Purpose

failover

Enables failover.

Example:
hostname(config)# failover

Step 9

copy running-config startup-config

Saves the system configuration to flash memory.

Example:
hostname(config)# copy running-config
startup-config

Configuring the Secondary Unit
The only configuration required on the secondary unit is for the failover interface. The secondary unit
requires these commands to communicate initially with the primary unit. After the primary unit sends
its configuration to the secondary unit, the only permanent difference between the two configurations is
the failover lan unit command, which identifies each unit as primary or secondary.

Prerequisites
When configuring LAN-based failover, you must bootstrap the secondary device to recognize the
failover link before the secondary device can obtain the running configuration from the primary device.

Detailed Steps
To configure the secondary unit, perform the following steps:

Step 1

Command

Purpose

failover lan interface if_name
interface_id

Specifies the interface to be used as the failover interface. (Use
the same settings that you used for the primary unit.)

Example:
hostname(config)# failover lan interface
folink vlan100

Step 2

The if_name argument assigns a name to the interface specified by
the interface_id argument.
The interface ID can be a physical interface or a redundant
interface. EtherChannel interfaces are not supported.

failover interface ip if_name [ip_address
mask standby ip_address |
ipv6_address/prefix standbyipv6_address]

Assigns the active and standby IP addresses to the failover link.
You can assign either an IPv4 or an IPv6 address to the interface.
You cannot assign both types of addresses to the failover link.

Example:

To receive packets from both units in a failover pair, standby IP
addresses need to be configured on all interfaces.

hostname(config)# failover interface ip
folink 172.27.48.1 255.255.255.0 standby
172.27.48.2
hostname(config)# failover interface ip
folink 2001:a0a:b00::a0a:b70/64 standby
2001:a0a:b00::a0a:b71

Note

Enter this command exactly as you entered it on the
primary unit when you configured the failover interface
on the primary unit (including the same IP address).

Cisco ASA 5500 Series Configuration Guide using the CLI

62-11

Chapter 62

Configuring Active/Standby Failover

Configuring Active/Standby Failover

Step 3

Command

Purpose

interface interface_id

Enables the interface.

no shutdown

Example:
hostname(config)# interface vlan100
hostname(config-if)# no shutdown

Step 4

failover lan unit secondary

Example:
hostname(config)# failover lan unit
secondary

Step 5

Note

This step is optional because, by default, units are
designated as secondary unless previously configured.

Enables failover.

failover

hostname(config)# failover

After you enable failover, the active unit sends the configuration
in running memory to the standby unit. As the configuration
synchronizes, the messages “Beginning configuration replication:
Sending to mate” and “End Configuration Replication to mate”
appear on the active unit console.

copy running-config startup-config

Saves the configuration to flash memory.

Example:

Enter the command after the running configuration has completed
replication.

Example:

Step 6

(Optional) Designates this unit as the secondary unit:

hostname(config)# copy running-config
startup-config

Configuring Optional Active/Standby Failover Settings
This section includes the following topics:
•

Enabling HTTP Replication with Stateful Failover, page 62-13

•

Disabling and Enabling Interface Monitoring, page 62-13

•

Configuring Failover Criteria, page 62-14

•

Configuring the Unit and Interface Health Poll Times, page 62-14

•

Configuring Virtual MAC Addresses, page 62-15

You can configure the optional Active/Standby failover settings when initially configuring the primary
unit in a failover pair (see Configuring the Primary Unit, page 62-8) or on the active unit in the failover
pair after the initial configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-12

Chapter 62

Configuring Active/Standby Failover
Configuring Active/Standby Failover

Enabling HTTP Replication with Stateful Failover
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 THTTP clients typically
retry failed connection attempts, HTTP connections are not automatically included in the replicated state
information.
To enable HTTP state replication when Stateful Failover is enabled, enter the following command in
global configuration mode:
Command

Purpose

failover replication http

Enables HTTP state replication.

Example:
hostname (config)# failover replication
http

Disabling and Enabling Interface Monitoring
You can control which interfaces affect your failover policy by disabling the monitoring of specific
interfaces and enabling the monitoring of others. This feature enables you to exclude interfaces attached
to less critical networks from affecting your failover policy.
You can monitor up to 250 interfaces on a unit. By default, monitoring physical interfaces is enabled and
monitoring subinterfaces is disabled.
Hello messages are exchanged during every interface poll frequency time period between the ASA
failover pair. The failover interface poll time is 3 to 15 seconds. For example, if the poll time is set to 5
seconds, testing begins on an interface if 5 consecutive hellos are not heard on that interface (25
seconds).
Monitored failover 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.

To enable or disable health monitoring for specific interfaces on units in single configuration mode, enter
one of the following commands. Alternately, for units in multiple configuration mode, you must enter
the commands within each security context.
Do one of the following:

Cisco ASA 5500 Series Configuration Guide using the CLI

62-13

Chapter 62

Configuring Active/Standby Failover

Configuring Active/Standby Failover

Disables health monitoring for an interface.

no monitor-interface if_name

Example:
hostname(config)# no monitor-interface
lanlink

Enables health monitoring for an interface.

monitor-interface if_name

Example:
hostname(config)# monitor-interface
lanlink

Configuring Failover Criteria
You can specify a specific number of interface or a percentage of monitored interfaces that must fail
before failover occurs. By default, a single interface failure causes failover.
To the change the default failover criteria, enter the following command in global configuration mode:
Command

Purpose

failover interface-policy num[%]

Changes the default failover criteria.

Example:

When specifying a specific number of interfaces, the num argument can be
from 1 to 250.

hostname (config)# failover
interface-policy 20%

When specifying a percentage of interfaces, the num argument can be from
1 to 100.

Configuring the Unit and Interface Health Poll Times
The ASA sends hello packets out of each data interface to monitor interface health. The appliance sends
hello messages across the failover link to monitor unit health. If the ASA does not receive a hello packet
from the corresponding interface on the peer unit for over half of the hold time, then the additional
interface testing begins. If a hello packet or a successful test result is not received within the specified
hold time, the interface is marked as failed. Failover occurs if the number of failed interfaces meets the
failover criteria.
Decreasing the poll and hold times enables the ASA to detect and respond to interface failures more
quickly but may consume more system resources. Increasing the poll and hold times prevents the ASA
from failing over on networks with higher latency.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-14

Chapter 62

Configuring Active/Standby Failover
Configuring Active/Standby Failover

Command

Purpose

failover polltime interface [msec] time
[holdtime time]

Changes the interface poll and hold times.

Example:
hostname (config): failover polltime
interface msec 500 holdtime 5

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.

failover polltime [unit] [msec] poll_time
[holdtime [msec] time]

Example:
hostname(config)# failover polltime unit
msec 200 holdtime msec 800

Changes the unit poll and hold times.
You cannot enter a holdtime value that is less than 3 times the unit poll
time. With a faster poll time, the ASA can detect failure and trigger failover
faster. However, faster detection can cause unnecessary switchovers when
the network is temporarily congested.
If a unit does not hear hello packet on the failover communication interface
for one polling period, additional testing occurs through the remaining
interfaces. If there is still no response from the peer unit during the hold
time, the unit is considered failed and, if the failed unit is the active unit,
the standby unit takes over as the active unit.
You can include both failover polltime [unit] and failover polltime
interface commands in the configuration.

Configuring Virtual MAC Addresses
In Active/Standby failover, the MAC addresses for the primary unit are always associated with the active
IP addresses. If the secondary unit boots first and becomes active, it uses the burned-in MAC address for
its interfaces. When the primary unit comes online, the secondary unit obtains the MAC addresses from
the primary unit. The change can disrupt network traffic.
You can configure virtual MAC addresses for each interface to ensure that the secondary unit uses the
correct MAC addresses when it is the active unit, even if it comes online before the primary unit. If you
do not specify virtual MAC addresses the failover pair uses the burned-in NIC addresses as the MAC
addresses.

Note

You cannot configure a virtual MAC address for the failover or Stateful Failover links. The MAC and IP
addresses for those links do not change during failover.
To configure the virtual MAC addresses for an interface, enter the following command on the active unit:

Cisco ASA 5500 Series Configuration Guide using the CLI

62-15

Chapter 62

Configuring Active/Standby Failover

Controlling Failover

Command

Purpose

failover mac address phy_if active_mac
standby_mac

Configures the virtual MAC address for an interface.

Example:
hostname (config): failover mac address
Ethernet0/2 00a0.c969.87c8 00a0.c918.95d8

The phy_if argument is the physical name of the interface, such as
Ethernet1. 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.
There are multiple ways to configure virtual MAC addresses on the ASA.
When more than one method has been used to configure virtual MAC
addresses, the ASA uses the following order of preference to determine
which virtual MAC address is assigned to an interface:
1.

The mac-address command (in interface configuration mode) address.

2.

The mac-address auto command generated address.

3.

The failover mac address command address.

4.

The burned-in MAC address.

Use the show interface command to display the MAC address used by an
interface.

Controlling Failover
This sections describes how to control and monitor failover. This section includes the following topics:
•

Forcing Failover, page 62-16

•

Disabling Failover, page 62-17

•

Restoring a Failed Unit, page 62-17

Forcing Failover
To force the standby unit to become active, enter one of the following commands:

Command

Purpose

failover active

Forces a failover when entered on the standby unit in a failover pair. The
standby unit becomes the active unit.

Example:
hostname# failover active
no failover active

Forces a failover when entered on the active unit in a failover pair. The
active unit becomes the standby unit.

Example:
hostname# no failover active

Cisco ASA 5500 Series Configuration Guide using the CLI

62-16

Chapter 62

Configuring Active/Standby Failover
Controlling Failover

Disabling Failover
To disable failover, enter the following command:
Command

Purpose

no failover

Disables failover. Disabling failover on an Active/Standby pair causes the
active and standby state of each unit to be maintained until you restart. For
example, the standby unit remains in standby mode so that both units do
not start passing traffic. To make the standby unit active (even with failover
disabled), see the “Forcing Failover” section on page 62-16.

Example:
hostname(config)# no failover

Restoring a Failed Unit
To restore a failed unit to an unfailed state, enter the following command:
Command

Purpose

failover reset

Restores a failed unit to an unfailed state. 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).

Example:
hostname(config)# failover reset

Testing the Failover Functionality
To test failover functionality, perform the following steps:
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:
hostname(config)# no failover active

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:
hostname(config)# no failover active

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-17

Chapter 62

Configuring Active/Standby Failover

Monitoring Active/Standby Failover

Monitoring Active/Standby Failover
Note

After a failover event you should either re-launch ASDM or switch to another device in the Devices pane
and then come back to the original ASA to continue monitoring the device. This action is necessary
because the monitoring connection does not become re-established when ASDM is disconnected from
and then reconnected to the device.
To monitor Active/Standby failover, enter one of the following commands:

Command

Purpose

show failover

Displays information about the failover state of the unit.

show monitor-interface

Displays information about the monitored interface.

show running-config failover

Displays the failover commands in the running configuration.

For more information about the output of the monitoring commands, refer to the Cisco ASA 5500 Series
Command Reference.

Feature History for Active/Standby Failover
Table 62-3 lists each feature change and the platform release in which it was implemented.
Table 62-3

Feature History for Optional Active/Standby Failover Settings

Feature Name
This feature was introduced.

Releases

Feature Information

7.0

This feature was introduced.

IPv6 support for failover added.

8.2(2)

We modified the following commands: failover interface
ip, show failover, ipv6 address, show monitor-interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

62-18

CH A P T E R

63

Configuring Active/Active Failover
This chapter describes how to configure Active/Active failover and includes the following sections:
•

Information About Active/Active Failover, page 63-1

•

Licensing Requirements for Active/Active Failover, page 63-6

•

Prerequisites for Active/Active Failover, page 63-7

•

Guidelines and Limitations, page 63-7

•

Configuring Active/Active Failover, page 63-8

•

Remote Command Execution, page 63-21

•

Monitoring Active/Active Failover, page 63-25

•

Feature History for Active/Active Failover, page 63-25

Information About Active/Active Failover
This section describes Active/Active failover. This section includes the following topics:
•

Active/Active Failover Overview, page 63-1

•

Primary/Secondary Status and Active/Standby Status, page 63-2

•

Device Initialization and Configuration Synchronization, page 63-3

•

Command Replication, page 63-3

•

Failover Triggers, page 63-4

•

Failover Actions, page 63-5

Active/Active Failover Overview
Active/Active failover is only available to ASAs in multiple context mode. In an Active/Active failover
configuration, both ASAs can pass network traffic.
In Active/Active failover, you divide the security contexts on the ASA into failover groups. A failover
group is simply a logical group of one or more security contexts. You can create a maximum of two
failover groups. The admin context is always a member of failover group 1. Any unassigned security
contexts are also members of failover group 1 by default.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-1

Chapter 63

Configuring Active/Active Failover

Information About Active/Active Failover

The failover group forms the base unit for failover in Active/Active failover. Interface failure monitoring,
failover, and active/standby status are all attributes of a failover group rather than the unit. When an
active failover group fails, it changes to the standby state while the standby failover group becomes
active. The interfaces in the failover group that becomes active assume the MAC and IP addresses of the
interfaces in the failover group that failed. The interfaces in the failover group that is now in the standby
state take over the standby MAC and IP addresses.

Note

A failover group failing on a unit does not mean that the unit has failed. The unit may still have another
failover group passing traffic on it.
When creating the failover groups, you should create them on the unit that will have failover group 1 in
the active state.

Note

Active/Active failover generates virtual MAC addresses for the interfaces in each failover group. If you
have more than one Active/Active failover pair on the same network, it is possible to have the same
default virtual MAC addresses assigned to the interfaces on one pair as are assigned to the interfaces of
the other pairs because of the way the default virtual MAC addresses are determined. To avoid having
duplicate MAC addresses on your network, make sure you assign each physical interface a virtual active
and standby MAC address.

Primary/Secondary Status and Active/Standby Status
As in Active/Standby failover, one unit in an Active/Active failover pair is designated the primary unit,
and the other unit the secondary unit. Unlike Active/Standby failover, this designation does not indicate
which unit becomes active when both units start simultaneously. Instead, the primary/secondary
designation does two things:
•

Determines which unit provides the running configuration to the pair when they boot
simultaneously.

•

Determines on which unit each failover group appears in the active state when the units boot
simultaneously. Each failover group in the configuration is configured with a primary or secondary
unit preference. You can configure both failover groups be in the active state on a single unit in the
pair, with the other unit containing the failover groups in the standby state. However, a more typical
configuration is to assign each failover group a different role preference to make each one active on
a different unit, distributing the traffic across the devices.

Note

The ASA also provides load balancing, which is different from failover. Both failover and
load balancing can exist on the same configuration. For information about load balancing,
see the “Configuring Load Balancing” section on page 66-11.

Which unit each failover group becomes active on is determined as follows:
•

When a unit boots while the peer unit is not available, both failover groups become active on the
unit.

•

When a unit boots while the peer unit is active (with both failover groups in the active state), the
failover groups remain in the active state on the active unit regardless of the primary or secondary
preference of the failover group until one of the following occurs:
– A failover occurs.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-2

Chapter 63

Configuring Active/Active Failover
Information About Active/Active Failover

– 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.

Device Initialization and Configuration Synchronization
Configuration synchronization occurs when one or both units in a failover pair boot. The configurations
are synchronized as follows:
•

When a unit boots while the peer unit is active (with both failover groups active on it), the booting
unit contacts the active unit to obtain the running configuration regardless of the primary or
secondary designation of the booting unit.

•

When both units boot simultaneously, the secondary unit obtains the running configuration from the
primary unit.

When the replication starts, the ASA console on the unit sending the configuration displays the message
“Beginning configuration replication: Sending to mate,” and when it is complete, the ASA displays the
message “End Configuration Replication to mate.” During replication, commands entered on the unit
sending the configuration may not replicate properly to the peer unit, and commands entered on the unit
receiving the configuration may be overwritten by the configuration being received. Avoid entering
commands on either unit in the failover pair during the configuration replication process. Depending
upon the size of the configuration, replication can take from a few seconds to several minutes.
On the unit receiving the configuration, the configuration exists only in running memory. To save the
configuration to flash memory after synchronization enter the write memory all command in the system
execution space on the unit that has failover group 1 in the active state. The command is replicated to
the peer unit, which proceeds to write its configuration to flash memory. Using the all keyword with this
command causes the system and all context configurations to be saved.

Note

Startup configurations saved on external servers are accessible from either unit over the network and do
not need to be saved separately for each unit. Alternatively, you can copy the contexts configuration files
from the disk on the primary unit to an external server, and then copy them to disk on the secondary unit,
where they become available when the unit reloads.

Command Replication
After both units are running, commands are replicated from one unit to the other as follows:
•

Note

•

Commands entered within a security context are replicated from the unit on which the security
context appears in the active state to the peer unit.

A context is considered in the active state on a unit if the failover group to which it belongs is
in the active state on that unit.
Commands entered in the system execution space are replicated from the unit on which failover
group 1 is in the active state to the unit on which failover group 1 is in the standby state.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-3

Chapter 63

Configuring Active/Active Failover

Information About Active/Active Failover

•

Commands entered in the admin context are replicated from the unit on which failover group 1 is in
the active state to the unit on which failover group 1 is in the standby 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.
Table 63-1 lists the commands that are and are not replicated to the standby unit.
Table 63-1

Command Replication

Commands Replicated to the Standby Unit

Commands Not Replicated to the Standby Unit

All configuration commands except for mode,
firewall, and failover lan unit

All forms of the copy command except for copy
running-config startup-config

copy running-config startup-config

All forms of the write command except for write
memory

delete

debug

mkdir

failover lan unit

rename

firewall

rmdir

mode

write memory

show

You can use the write standby command to resynchronize configurations that have become out of sync.
For Active/Active failover, the write standby command behaves as follows:
•

If you enter the write standby command in the system execution space, the system configuration
and the configurations for all security contexts on the ASA are written to the peer unit. This includes
configuration information for security contexts that are in the standby state. You must enter the
command in the system execution space on the unit that has failover group 1 in the active state.

Note

•

If there are security contexts in the active state on the peer unit, the write standby command
causes active connections through those contexts to be terminated. Use the failover active
command on the unit providing the configuration to make sure all contexts are active on that
unit before entering the write standby command.

If you enter the write standby command in a security context, only the configuration for the security
context is written to the peer unit. You must enter the command in the security context on the unit
where the security context appears in the active state.

Replicated commands are not saved to the flash memory when replicated to the peer unit. They are added
to the running configuration. To save replicated commands to flash memory on both units, use the write
memory or copy running-config startup-config command on the unit that you made the changes on.
The command is replicated to the peer unit and cause the configuration to be saved to flash memory on
the peer unit.

Failover Triggers
In Active/Active failover, failover can be triggered at the unit level if one of the following events occurs:
•

The unit has a hardware failure.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-4

Chapter 63

Configuring Active/Active Failover
Information About Active/Active Failover

•

The unit has a power failure.

•

The unit has a software failure.

•

You force a failover. (See Forcing Failover, page 63-23.)

Failover is triggered at the failover group level when one of the following events occurs:
•

Too many monitored interfaces in the group fail.

•

You force a failover. (See Forcing Failover, page 63-23.)

You configure the failover threshold for each failover group by specifying the number or percentage of
interfaces within the failover group that must fail before the group fails. 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.
See the “Failover Health Monitoring” section on page 61-14 for more information about interface and
unit monitoring.

Failover Actions
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.

Note

When configuring Active/Active failover, make sure that the combined traffic for both units is within the
capacity of each unit.
Table 63-2 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.

Table 63-2

Failover Behavior for Active/Active Failover

Active Group
Action

Standby Group
Action

Failure Event

Policy

Notes

A unit experiences a power or
software failure

Failover

Become standby Become active
Mark as failed
Mark active as
failed

When a unit in a failover pair fails,
any active failover groups on that
unit are marked as failed and
become active on the peer unit.

Interface failure on active failover
group above threshold

Failover

Mark active
group as failed

Become active

None.

Interface failure on standby failover
group above threshold

No failover No action

Mark standby
group as failed

When the standby failover group is
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.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-5

Chapter 63

Configuring Active/Active Failover

Licensing Requirements for Active/Active Failover

Table 63-2

Failover Behavior for Active/Active Failover (continued)

Active Group
Action

Standby Group
Action

Failure Event

Policy

Notes

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.

Stateful Failover link failed

No failover No action

No action

State information becomes out of
date, and sessions are terminated if
a failover occurs.

Failover link failed during operation

No failover n/a

n/a

Each unit marks the failover
interface 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.

Optional Active/Active Failover Settings
You can configure the following Active/Standby failover options when you initially configuring failover
or after failover has been configured:
•

Failover Group Preemption—Assigns a primary or secondary priority to a failover group to specify
on which unit in the failover group becomes active when both units boot simultaneously.

•

HTTP replication with Stateful Failover—Allows connections to be included in the state
information replication.

•

Interface monitoring—Allows you to monitor up to 250 interfaces on a unit and control which
interfaces affect your failover.

•

Interface health monitoring—Enables the security appliance to detect and respond to interface
failures more quickly.

•

Failover criteria setup—Allows you to specify a specific number of interfaces or a percentage of
monitored interfaces that must fail before failover occurs.

•

Virtual MAC address configuration—Ensures that the secondary unit uses the correct MAC
addresses when it is the active unit, even if it comes online before the primary unit.

Licensing Requirements for Active/Active Failover
The following table shows the licensing requirements for this feature:
Model

License Requirement

ASA 5505

No support.

ASA 5510,
ASA 5512-X

Security Plus License.

All other models

Base License.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-6

Chapter 63

Configuring Active/Active Failover
Prerequisites for Active/Active Failover

Prerequisites for Active/Active Failover
In Active/Active failover, both units must have the following:
•

The same hardware model.

•

The same number of interfaces.

•

The same types of interfaces.

•

The same software version, with the same major (first number) and minor (second number) version
numbers. However you can use different versions of the software during an upgrade process; for
example you can upgrade one unit from Version 7.0(1) to Version 7.9(2) and have failover remain
active. We recommend upgrading both units to the same version to ensure long-term compatibility.

•

The same software configuration.

•

The same mode (multiple context mode).

•

The proper license.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in multiple context mode only.
Firewall Mode Guidelines

Supported in routed and transparent firewall mode.
IPv6 Guidelines

IPv6 failover is supported.
Model Guidelines

Active/Active failover is not available on the Cisco ASA 5505.
Additional Guidelines and Limitations

No two interfaces in the same context should be configured in the same ASR group.
ASA failover replication fails if you try to make a configuration change on two or more contexts at the
same time. The workaround is to make configuration changes on each unit sequentially.
The following features are not supported for Active/Active failover:
•

To receive packets from both units in a failover pair, standby IP addresses need to be configured on
all interfaces.

•

The standby IP address is used on the security appliance that is currently the standby unit, and it
must be in the same subnet as the active IP address.

•

You can define a maximum number of two failover groups.

•

Failover groups can only be added to the system context of devices that are configured for multiple
context mode.

•

You can create and remove failover groups only when failover is disabled.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-7

Chapter 63

Configuring Active/Active Failover

Configuring Active/Active Failover

•

Entering the failover group command puts you in the failover group command mode. The primary,
secondary, preempt, replication http, interface-policy, mac address, and polltime interface
commands are available in the failover group configuration mode. Use the exit command to return
to global configuration mode.

•

The failover polltime interface, failover interface-policy, failover replication http, and failover
mac address commands have no affect on Active/Active failover configurations. They are
overridden by the following failover group configuration mode commands: polltime interface,
interface-policy, replication http, and mac address.

•

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.

•

VPN failover is unavailable. (It is available in Active/Standby failover configurations only.)

Configuring Active/Active Failover
This section describes how to configure Active/Active failover using an Ethernet failover link. When
configuring LAN-based failover, you must bootstrap the secondary device to recognize the failover link
before the secondary device can obtain the running configuration from the primary device.
This section includes the following topics:
•

Task Flow for Configuring Active/Active Failover, page 63-8

•

Configuring the Primary Failover Unit, page 63-8

•

Configuring the Secondary Failover Unit, page 63-11

Task Flow for Configuring Active/Active Failover
To configure Active/Active Failover, perform the following steps:
Step 1

Configure the primary unit, as shown in the “Configuring the Primary Failover Unit” section on
page 63-8.

Step 2

Configure the secondary unit, as shown in the “Configuring the Secondary Failover Unit” section on
page 63-11.

Step 3

(Optional) Configure optional Active/Active failover settings, as shown in the “Optional Active/Active
Failover Settings” section on page 63-6.

Configuring the Primary Failover Unit
Follow the steps in this section to configure the primary unit in an Active/Active failover configuration.
These steps provide the minimum configuration needed to enable failover on the primary unit.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-8

Chapter 63

Configuring Active/Active Failover
Configuring Active/Active Failover

Restrictions
Do not configure an IP address for the Stateful Failover link if you are going to use a dedicated Stateful
Failover interface. You use the failover interface ip command to configure a dedicated Stateful Failover
interface in a later step.

Prerequisites
•

Configure standby addresses for all IP addresses according to Chapter 8, “Completing Interface
Configuration (Routed Mode),” or Chapter 9, “Completing Interface Configuration
(Transparent Mode).”

•

Complete this procedure in the system execution space. To change from the context to the system
execution space, enter the changeto system command.

Detailed Steps

Command

Purpose

Step 1

failover lan unit primary

Designates the unit as the primary unit.

Step 2

failover lan interface if_name phy_if

Specifies the interface to be used as the failover interface.

Example:

The if_name argument assigns a name to the interface specified by
the phy_if argument.

Step 3

hostname(config)# failover lan interface
folink GigabitEthernet0/3

The phy_if argument can be the physical port name, such as
Ethernet1, or a previously created subinterface, such as
Ethernet0/2.3. This interface should not be used for any other
purpose (except, optionally, the Stateful Failover link).

failover interface ip if_name [ip_address
mask standby ip_address |
ipv6_address/prefix standbyipv6_address]

Assigns the active and standby IP addresses to the failover link.
You can assign either an IPv4 or an IPv6 address to the interface.
You cannot assign both types of addresses to the failover link.

Example:

The standby IP address must be in the same subnet as the active
IP address. You do not need to identify the standby address
subnet mask.

hostname(config)# failover interface ip
folink 172.27.48.1 255.255.255.0 standby
172.27.48.2
hostname(config)# failover interface ip
folink 2001:a0a:b00::a0a:b70/64 standby
2001:a0a:b00::a0a:b71

Step 4

failover link if_name phy_if

The failover link IP address and MAC address do not change at
failover. The active IP address for the failover link always stays
with the primary unit, while the standby IP address stays with the
secondary unit.
(Optional) Specifies the interface to be used as the Stateful
Failover link.

Example:
hostname(config)# failover link folink
GigabitEthernet0/2

Note

If the Stateful Failover link uses the failover link or a data
interface, then you only need to supply the if_name
argument.

The if_name argument assigns a logical name to the interface
specified by the phy_if argument. The phy_if argument can be the
physical port name, such as Ethernet1, or a previously created
subinterface, such as Ethernet0/2.3. This interface should not be
used for any other purpose (except, optionally, the failover link).

Cisco ASA 5500 Series Configuration Guide using the CLI

63-9

Chapter 63

Configuring Active/Active Failover

Configuring Active/Active Failover

Step 5

Command

Purpose

failover interface ip if_name [ip_address
mask standby ip_address |
ipv6_address/prefix standbyipv6_address]

(Optional) Assigns an active and standby IP address to the
Stateful Failover link. You can assign either an IPv4 or an IPv6
address to the interface. You cannot assign both types of addresses
to the Stateful Failover link.

Example:
hostname(config)# failover interface ip
folink 172.27.48.1 255.255.255.0 standby
172.27.48.2
hostname(config)# failover interface ip
statelink 2001:a1a:b00::a0a:a70/64 standby
2001:a1a:b00::a0a:a71

Note

If the Stateful Failover link uses the failover link or data
interface, skip this step. You have already defined the
active and standby IP addresses for the interface.

The standby IP address must be in the same subnet as the active
IP address. You do not need to identify the standby address
subnet mask.
The Stateful Failover link IP address and MAC address do not
change at failover unless it uses a data interface. The active IP
address always stays with the primary unit, while the standby IP
address stays with the secondary unit.

Step 6

interface phy_if

Enables the interface.

no shutdown

Note

Example:
hostname(config)# interface
GigabitEthernet 0/3
hostname(config-if)# no shutdown

Step 7

failover group {1 | 2}
primary | secondary

Example:
hostname(config)# failover group 1
hostname(config-fover-group)# primary
hostname(config-fover-group)# exit
hostname(config)# failover group 2
hostname(config-fover-group)# secondary
hostname(config-fover-group)# exit

If the Stateful Failover link uses the failover link or
regular data interface, skip this step. You have already
enabled the interface.

Configures the failover groups.
You can have only two failover groups. The failover group
command creates the specified failover group if it does not exist
and enters the failover group configuration mode.
For each failover group, specify whether the failover group has
primary or secondary preference using the primary or secondary
commands. You can assign the same preference to both failover
groups. For traffic sharing configurations, you should assign each
failover group a different unit preference.
The exit command restores global configuration mode.
The example assigns failover group 1 as the primary preference
and failover group 2 as the secondary preference.

Step 8

context name
join-failover-group {1 | 2}

Example:
hostname(config)# context Eng
hostname(config-context)#
join-failover-group 1
hostname(config-context) exit

Cisco ASA 5500 Series Configuration Guide using the CLI

63-10

Assigns each user context to a failover group (in context
configuration mode).
Any unassigned contexts are automatically assigned to failover
group 1. The admin context is always a member of failover group
1.

Chapter 63

Configuring Active/Active Failover
Configuring Active/Active Failover

Step 9

Command

Purpose

failover

Enables failover.

Example:
hostname(config)# failover

Step 10

copy running-config startup-config

Saves the system configuration to flash memory.

Example:
hostname(config)# copy running-config
startup-config

Configuring the Secondary Failover Unit
Follow the steps in this section to configure the secondary unit in an Active/Active failover
configuration. These steps provide the minimum configuration needed to enable failover on the
secondary unit.

Detailed Steps
To configure the secondary failover unit, perform the following steps:

Step 1

Step 2

Command

Purpose

failover lan interface if_name phy_if

Specifies the interface to be used as the failover interface.

Example:

The if_name argument assigns a name to the interface specified by
the phy_if argument.

hostname(config)# failover lan interface
folink GigabitEthernet0/3

The phy_if argument can be the physical port name, such as
Ethernet1, or a previously created subinterface, such as
Ethernet0/2.3. This interface should not be used for any other
purpose (except, optionally, the Stateful Failover link).

failover interface ip if_name [ip_address
mask standby ip_address |
ipv6_address/prefix standbyipv6_address]

Assigns the active and standby IP addresses to the failover link.
You can assign either an IPv4 or an IPv6 address to the interface.
You cannot assign both types of addresses to the failover link.

Example:

The standby IP address must be in the same subnet as the active
IP address. You do not need to identify the standby address
subnet mask.

hostname(config)# failover interface ip
folink 172.27.48.1 255.255.255.0 standby
172.27.48.2

Step 3

hostname(config)# failover interface ip
folink 2001:a0a:b00::a0a:b70/64 standby
2001:a0a:b00::a0a:b71

The failover link IP address and MAC address do not change at
failover. The active IP address for the failover link always stays
with the primary unit, while the standby IP address stays with the
secondary unit.

interface phy_if

Enables the interface.

no shutdown

Example:
hostname(config-if)# interface
GigabitEthernet0/3

Cisco ASA 5500 Series Configuration Guide using the CLI

63-11

Chapter 63

Configuring Active/Active Failover

Configuring Active/Active Failover

Step 4

Command

Purpose

failover lan unit secondary

(Optional) Designates this unit as the secondary unit:

Example:
hostname(config)# failover lan unit
secondary

Step 5

This step is optional because, by default, units are
designated as secondary unless previously configured.

Enables failover.

failover

hostname(config)# failover

After you enable failover, the active unit sends the configuration
in running memory to the standby unit. As the configuration
synchronizes, the messages “Beginning configuration replication:
Sending to mate” and “End Configuration Replication to mate”
appear on the active unit console.

copy running-config startup-config

Saves the configuration to flash memory.

Example:

Enter the command after the running configuration has completed
replication.

Example:

Step 6

Note

hostname(config)# copy running-config
startup-config

Step 7

no failover active group group_id

Example:
hostname(config)# no failover active group
1

If necessary, force any failover group that is active on the primary
to the active state on the secondary unit. To force a failover group
to become active on the secondary unit, enter this command in the
system execution space on the primary unit.
The group_id argument specifies the group you want to become
active on the secondary unit.

Configuring Optional Active/Active Failover Settings
The following optional Active/Active failover settings can be configured when you are initially
configuring failover or after you have already established failover. Unless otherwise noted, the
commands should be entered on the unit that has failover group 1 in the active state.
This section includes the following topics:
•

Configuring Failover Group Preemption, page 63-12

•

Enabling HTTP Replication with Stateful Failover, page 63-14

•

Disabling and Enabling Interface Monitoring, page 63-14

•

Configuring Interface Health Monitoring, page 63-15

•

Configuring Failover Criteria, page 63-16

•

Configuring Virtual MAC Addresses, page 63-16

•

Configuring Support for Asymmetrically Routed Packets, page 63-18

Configuring Failover Group Preemption
Assigning a primary or secondary priority to a failover group specifies which unit the failover group
becomes active on when both units boot simultaneously. However, if one unit boots before the other, then
both failover groups become active on that unit. When the other unit comes online, any failover groups
that have the unit as a priority do not become active on that unit unless manually forced over, unless a

Cisco ASA 5500 Series Configuration Guide using the CLI

63-12

Chapter 63

Configuring Active/Active Failover
Configuring Active/Active Failover

failover occurs, or unless the failover group is configured with the preempt command. The preempt
command causes a failover group to become active on the designated unit automatically when that unit
becomes available.
To configure preemption for the specified failover group, enter the following commands:

Step 1

Command

Purpose

failover group {1 | 2}

Specifies the failover group.

Example:
hostname(config)# failover group 1

Step 2

preempt [delay]

Causes the failover group to become active on the designated unit.

You can enter an optional delay value, which specifies the number
of seconds the failover group remains active on the current unit
hostname(config-fover-group)# preempt 1200 before automatically becoming active on the designated unit.
Valid values are from 1 to 1200.
Example:

Note

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.

Example
The following example configures failover group 1 with the primary unit as the higher priority and
failover group 2 with the secondary unit as the higher priority. Both failover groups are configured with
the preempt command with a wait time of 100 seconds, so the groups will automatically become active
on their preferred unit 100 seconds after the units become available.
hostname(config)# failover group 1
hostname(config-fover-group)# primary
hostname(config-fover-group)# preempt 100
hostname(config-fover-group)# exit
hostname(config)# failover group 2
hostname(config-fover-group)# secondary
hostname(config-fover-group)# preempt 100
hostname(config-fover-group)# mac-address e1 0000.a000.a011 0000.a000.a012
hostname(config-fover-group)# exit
hostname(config)#

Cisco ASA 5500 Series Configuration Guide using the CLI

63-13

Chapter 63

Configuring Active/Active Failover

Configuring Active/Active Failover

Enabling HTTP Replication with Stateful Failover
To allow HTTP connections to be included in the state information, 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.
You can use the replication http command to cause a failover group to replicate HTTP state information
when Stateful Failover is enabled.

Step 1

Command

Purpose

failover group {1 | 2}

Specifies the failover group.

Example:
hostname(config)# failover group 1

Step 2

replication http

Example:
hostname(config-fover-group)# replication
http

Enables HTTP state replication for the specified failover group.
This command affects only the failover group in which it was
configured. To enable HTTP state replication for both failover
groups you must enter this command in each group. This
command should be entered in the system execution space.

Example
The following example shows a possible configuration for a failover group:
hostname(config)# failover group 1
hostname(config-fover-group)# primary
hostname(config-fover-group)# preempt 100
hostname(config-fover-group)# replication http
hostname(config-fover-group)# exit

Disabling and Enabling Interface Monitoring
You can control which interfaces affect your failover policy by disabling the monitoring of specific
interfaces and enabling the monitoring of others. This feature enables you to exclude interfaces attached
to less critical networks from affecting your failover policy.
You can monitor up to 250 interfaces on a unit. By default, monitoring physical interfaces is enabled and
monitoring subinterfaces is disabled.
Hello messages are exchanged during every interface poll frequency time period between the security
appliance failover pair. The failover interface poll time is 3 to 15 seconds. For example, if the poll time
is set to 5 seconds, testing begins on an interface if 5 consecutive hellos are not heard on that interface
(25 seconds).
Monitored failover 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.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-14

Chapter 63

Configuring Active/Active Failover
Configuring Active/Active Failover

•

Failed—No traffic is received on the interface, yet traffic is heard on the peer interface.

In Active/Active failover, this command is only valid within a context.
To enable or disable interface monitoring for specific interfaces, enter one of the following commands:
Do one of the following:
no monitor-interface if_name

Disables health monitoring for an interface.

Example:
hostname/context (config)#
no monitor-interface 1
monitor-interface if_name

Enables health monitoring for an interface.

Example:
hostname/context (config)#
monitor-interface 1

Example
The following example enables monitoring on an interface named “inside”:
hostname(config)# monitor-interface inside
hostname(config)#

Configuring Interface Health Monitoring
The ASA sends hello packets out of each data interface to monitor interface health. If the ASA does not
receive a hello packet from the corresponding interface on the peer unit for over half of the hold time,
then the additional interface testing begins. If a hello packet or a successful test result is not received
within the specified hold time, the interface is marked as failed. Failover occurs if the number of failed
interfaces meets the failover criteria.
Decreasing the poll and hold times enables the ASA to detect and respond to interface failures more
quickly but may consume more system resources.
To change the default interface poll time, perform the following steps:

Step 1

Command

Purpose

failover group {1 | 2}

Specifies the failover group.

Example:
hostname(config)# failover group 1

Step 2

polltime interface seconds

Specifies the data interface poll and hold times in the
Active/Active failover configuration.

Example:

Valid values for the 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.

hostname(config-fover-group)# polltime
interface seconds

Cisco ASA 5500 Series Configuration Guide using the CLI

63-15

Chapter 63

Configuring Active/Active Failover

Configuring Active/Active Failover

Example
The following partial example shows a possible configuration for a failover group. The interface poll
time is set to 500 milliseconds and the hold time to 5 seconds for data interfaces in failover group 1.
hostname(config)# failover group 1
hostname(config-fover-group)# primary
hostname(config-fover-group)# preempt 100
hostname(config-fover-group)# polltime interface msec 500 holdtime 5
hostname(config-fover-group)# exit
hostname(config)#

Configuring Failover Criteria
By default, if a single interface fails, failover occurs. You can specify a specific number of interfaces or
a percentage of monitored interfaces that must fail before a failover occurs. The failover criteria is
specified on a failover group basis.
To change the default failover criteria for the specified failover group, perform the following steps:

Step 1

Command

Purpose

failover group {1 | 2}

Specifies the failover group.

Example:
hostname(config)# failover group 1

Step 2

interface-policy num[%]

Specifies the policy for failover when monitoring detects an
interface failure.

Example:

When specifying a specific number of interfaces, the num
argument can be from 1 to 250. When specifying a percentage of
interfaces, the num argument can be from 1 to 100.

hostname(config-fover-group)#
interface-policy 225

The following partial example shows a possible configuration for a failover group:
hostname(config)# failover group 1
hostname(config-fover-group)# primary
hostname(config-fover-group)# preempt 100
hostname(config-fover-group)# interface-policy 25%
hostname(config-fover-group)# exit
hostname(config)#

Configuring Virtual MAC Addresses
Active/Active failover uses virtual MAC addresses on all interfaces. If you do not specify the virtual
MAC addresses, then they are computed as follows:
•

Active unit default MAC address: 00a0.c9physical_port_number.failover_group_id01

•

Standby unit default MAC address: 00a0.c9physical_port_number.failover_group_id02

Cisco ASA 5500 Series Configuration Guide using the CLI

63-16

Chapter 63

Configuring Active/Active Failover
Configuring Active/Active Failover

Note

If you have more than one Active/Active failover pair on the same network, it is possible to have the
same default virtual MAC addresses assigned to the interfaces on one pair as are assigned to the
interfaces of the other pairs because of the way the default virtual MAC addresses are determined. To
avoid having duplicate MAC addresses on your network, make sure you assign each physical interface
a virtual active and standby MAC address for all failover groups.
There are multiple ways to configure virtual MAC addresses on the ASA. When more than one method
has been used to configure virtual MAC addresses, the ASA uses the following order of preference to
determine which virtual MAC address is assigned to an interface:
1.

The mac-address command (in interface configuration mode) address

2.

The mac-address auto command generate address

3.

The failover mac address command or mac address command (in failover group configuration
mode) address (used in the following procedure)

4.

The automatically generated failover MAC address

Use the show interface command to display the MAC address used by an interface.
To configure specific active and standby MAC addresses for an interface, perform the following steps.

Detailed Steps

Step 1

Command

Purpose

failover group {1 | 2}

Specifies the failover group.

Example:
hostname(config)# failover group 1

Step 2

mac address phy_if active_mac standby_mac

Specifies the virtual MAC addresses for the active and standby
units.

Example:

The phy_if argument is the physical name of the interface, such as
GigabitEthernet1/0. 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.

hostname(config-fover-group)# mac address
gigabitethernet1/0 0000.a000.a011
0000.a000.a012

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.

Example
The following partial example shows a possible configuration for a failover group:
hostname(config)# failover group 1
hostname(config-fover-group)# primary
hostname(config-fover-group)# preempt 100
hostname(config-fover-group)# exit
hostname(config)# failover group 2
hostname(config-fover-group)# secondary
hostname(config-fover-group)# preempt 100
hostname(config-fover-group)# mac address gigabitethernet1/0 0000.a000.a011 0000.a000.a012
hostname(config-fover-group)# exit

Cisco ASA 5500 Series Configuration Guide using the CLI

63-17

Chapter 63

Configuring Active/Active Failover

Configuring Active/Active Failover

hostname(config)#

Configuring Support for Asymmetrically Routed Packets
When running in Active/Active failover, a unit may receive a return packet for a connection that
originated through its peer unit. Because the ASA that receives the packet does not have any connection
information for the packet, the packet is dropped. This most commonly occurs when the two ASAs in an
Active/Active failover pair are connected to different service providers and the outbound connection
does not use a NAT address.
You can prevent the return packets from being dropped using the asr-group command on interfaces
where this is likely to occur. When an interface configured with the asr-group command receives a
packet for which it has no session information, it checks the session information for the other interfaces
that are in the same group. If it does not find a match, the packet is dropped. If it finds a match, then one
of the following actions occurs:

Note

•

If the incoming traffic originated on a peer unit, some or all of the layer 2 header is rewritten and
the packet is redirected to the other unit. This redirection continues as long as the session is active.

•

If the incoming traffic originated on a different interface on the same unit, some or all of the layer
2 header is rewritten and the packet is reinjected into the stream.

Using the asr-group command to configure asymmetric routing support is more secure than using the
static command with the nailed option.
The asr-group command does not provide asymmetric routing; it restores asymmetrically routed packets
to the correct interface.

Prerequisites
You must have to following configured for asymmetric routing support to function properly:
•

Active/Active Failover

•

Stateful Failover—Passes state information for sessions on interfaces in the active failover group to
the standby failover group.

•

Replication HTTP—HTTP session state information is not passed to the standby failover group, and
therefore is not present on the standby interface. For the ASA to be able to re-route asymmetrically
routed HTTP packets, you need to replicate the HTTP state information.

You can configure the asr-group command on an interface without having failover configured, but it
does not have any effect until Stateful Failover is enabled.

Detailed Steps
To configure support for asymmetrically routed packets, perform the following steps:
Step 1

Configure Active/Active Stateful Failover for the failover pair. See the “Configuring Active/Active
Failover” section on page 63-8.

Step 2

For each interface that you want to participate in asymmetric routing support, enter the following
command. You must enter the command on the unit where the context is in the active state so that the
command is replicated to the standby failover group. For more information about command replication,
see Command Replication, page 63-3.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-18

Chapter 63

Configuring Active/Active Failover
Configuring Active/Active Failover

hostname/ctx(config)# interface phy_if
hostname/ctx(config-if)# asr-group num

Valid values for num range from 1 to 32. You need to enter the command for each interface that
participates in the asymmetric routing group. You can view the number of ASR packets transmitted,
received, or dropped by an interface using the show interface detail command. You can have more than
one ASR group configured on the ASA, but only one per interface. Only members of the same ASR
group are checked for session information.

Example
Figure 63-1 shows an example of using the asr-group command for asymmetric routing support.
Figure 63-1

ASR Example

ISP A

ISP B

192.168.1.1

192.168.2.2
192.168.2.1

192.168.1.2

SecAppA

SecAppB
Failover/State link

Return Traffic

250093

Outbound Traffic
Inside
network

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.
Example 63-1 Primary Unit System Configuration
hostname primary
interface GigabitEthernet0/1
description LAN/STATE Failover Interface
interface GigabitEthernet0/2
no shutdown
interface GigabitEthernet0/3
no shutdown
interface GigabitEthernet0/4
no shutdown

Cisco ASA 5500 Series Configuration Guide using the CLI

63-19

Chapter 63

Configuring Active/Active Failover

Configuring Active/Active Failover

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 admin
context admin
description admin
allocate-interface GigabitEthernet0/2
allocate-interface GigabitEthernet0/3
config-url flash:/admin.cfg
join-failover-group 1
context ctx1
description context 1
allocate-interface GigabitEthernet0/4
allocate-interface GigabitEthernet0/5
config-url flash:/ctx1.cfg
join-failover-group 2

Example 63-2 admin Context Configuration
hostname SecAppA
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

Example 63-3 ctx1 Context Configuration
hostname SecAppB
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

Figure 63-1 shows the ASR support working as follows:
1.

An outbound session passes through ASA SecAppA. It exits interface outsideISP-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 ASA SecAppB.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-20

Chapter 63

Configuring Active/Active Failover
Remote Command Execution

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 with the command 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 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.

Remote Command Execution
Remote command execution lets you send commands entered at the command line to a specific failover
peer.
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.
To send a command to a failover peer, perform the following steps:
Step 1

If you are in multiple context mode, use the changeto command to change to the context you want to
configure. You cannot change contexts on the failover peer with the failover exec command.
If you are in single context mode, skip to the next step.

Step 2

Use the following command to send commands to he specified failover unit:
hostname(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.
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 Changing Command Modes, page 63-22, for more information.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-21

Chapter 63

Configuring Active/Active Failover

Remote Command Execution

Changing Command Modes
The failover exec command maintains a command mode state that is separate from the command mode
of your terminal session. By default, the failover exec command mode starts in global configuration
mode for the specified device. You can change that command mode by sending the appropriate command
(such as the interface command) using the failover exec command. The session prompt does not change
when you change mode using failover exec.
For example, if you are logged in to global configuration mode of the active unit of a failover pair, and
you use the failover exec active command to change to interface configuration mode, the terminal
prompt remains in global configuration mode, but commands entered using failover exec are entered in
interface configuration mode.
The following examples shows the difference between the terminal session mode and the failover exec
command mode. In the example, the administrator changes the failover exec mode on the active unit to
interface configuration mode for the interface GigabitEthernet0/1. After that, all commands entered
using failover exec active are sent to interface configuration mode for interface GigabitEthernet0/1. The
administrator then uses failover exec active to assign an IP address to that interface. Although the prompt
indicates global configuration mode, the failover exec active mode is in interface configuration mode.
hostname(config)# failover exec active interface GigabitEthernet0/1
hostname(config)# failover exec active ip address 192.168.1.1 255.255.255.0 standby
192.168.1.2
hostname(config)# router rip
hostname(config-router)#

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.
hostname(config-if)# failover exec active router ospf 100
hostname(config-if)#

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:
hostname(config)# failover exec active interface GigabitEthernet0/1
hostname(config)# sh failover exec active
Active unit Failover EXEC is at interface sub-command mode
hostname(config)# sh failover exec standby
Standby unit Failover EXEC is at config mode
hostname(config)# sh failover exec mate
Active unit Failover EXEC is at interface sub-command mode

Cisco ASA 5500 Series Configuration Guide using the CLI

63-22

Chapter 63

Configuring Active/Active Failover
Controlling 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 use the failover key command to encrypt the failover
link to prevent eavesdropping or man-in-the-middle attacks.

Limitations of Remote Command Execution
When you use remote commands you face the following limitations:
•

If you upgrade one unit using the zero-downtime upgrade procedure and not the other, both units
must be running software that supports the failover exec command for the command to work.

•

Command completion and context help is not available for the commands in the cmd_string
argument.

•

In multiple context mode, you can only send commands to the peer context on the peer unit. To send
commands to a different context, you must first change to that context on the unit to which you are
logged in.

•

You cannot use the following commands with the failover exec command:
– changeto
– debug (undebug)

•

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.

Controlling Failover
This sections describes how to control and monitor failover. This section includes the following topics:
•

Forcing Failover, page 63-23

•

Disabling Failover, page 63-24

•

Restoring a Failed Unit or Failover Group, page 63-24

Forcing Failover
Enter the following command in the system execution space of the unit where the failover group is in the
standby state:

Cisco ASA 5500 Series Configuration Guide using the CLI

63-23

Chapter 63

Configuring Active/Active Failover

Controlling Failover

hostname# failover active group group_id

Or, enter the following command in the system execution space of the unit where the failover group is
in the active state:
hostname# no failover active group group_id

Entering the following command in the system execution space causes all failover groups to become
active:
hostname# failover active

Disabling Failover
Disabling failover on an Active/Active failover pair causes the failover groups to remain in the active
state on whichever unit they are active, no matter which unit they are configured to prefer. Enter the no
failover command in the system execution space.
To disable failover, enter the following command:
hostname(config)# no failover

Restoring a Failed Unit or Failover Group
Restoring a failed unit or failover group moves the unit or failover group from the failed state to the
standby state; it does not automatically make the failover group or unit active. Restored units or groups
remain in the standby state until made active by failover (forced or natural). An exception is a failover
group 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.
To restore a failed unit to an unfailed state, enter the following command:
hostname(config)# failover reset

To restore a failed Active/Active failover group to an unfailed state, enter the following command:
hostname(config)# failover reset group group_id

Testing the Failover Functionality
To test failover functionality, perform the following steps:
Step 1

Test that your active unit or failover group is passing traffic as expected by using FTP (for example) to
send a file between hosts on different interfaces.

Step 2

Force a failover to the standby unit by entering the following command on the unit where the failover
group containing the interface connecting your hosts is active:
hostname(config)# no failover active group group_id

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.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-24

Chapter 63

Configuring Active/Active Failover
Monitoring Active/Active Failover

Step 5

When you are finished, you can restore the unit or failover group to active status by enter the following
command on the unit where the failover group containing the interface connecting your hosts is active:
hostname(config)# failover active group group_id

Monitoring Active/Active Failover
To monitor Active/Active Failover, perform one of the following tasks. Commands are entered in the
system execution space unless otherwise noted.
Command

Purpose

show failover

Displays information about the failover state of
the unit.

show failover group

Displays information about the failover state of
the failover group. The information displayed is
similar to that of the show failover command but
limited to the specified group.

show monitor-interface

Displays information about the monitored
interface. Enter this command within a security
context.

show running-config failover

Displays the failover commands in the running
configuration.

For more information about the output of the monitoring commands, see the Cisco ASA 5500 Series
Command Reference.

Feature History for Active/Active Failover
Table 63-3 lists each feature change and the platform release in which it was implemented.
Table 63-3

Feature History for Active/Active Failover

Feature Name

Releases

Feature Information

Active/Active failover

7.0

In an Active/Active failover configuration, both ASAs can
pass network traffic.
We introduced this feature and the relevant commands.

IPv6 Support in failover

8.2(2)

We modified the following commands: failover interface
ip, show failover, ipv6 address, show monitor-interface.

Cisco ASA 5500 Series Configuration Guide using the CLI

63-25

Chapter 63
Feature History for Active/Active Failover

Cisco ASA 5500 Series Configuration Guide using the CLI

63-26

Configuring Active/Active Failover

PA R T

16

Configuring VPN

CH A P T E R

64

Configuring IPsec and ISAKMP
This chapter describes how to configure Internet Protocol Security (IPsec) and the Internet Security
Association and Key Management Protocol (ISAKMP) standards to build Virtual Private Networks
VPNs). It includes the following sections:
•

Information About Tunneling, IPsec, and ISAKMP, page 64-1

•

Licensing Requirements for Remote Access IPsec VPNs, page 64-3

•

Guidelines and Limitations, page 64-8

•

Configuring ISAKMP, page 64-8

•

Configuring Certificate Group Matching for IKEv1, page 64-17

•

Configuring IPsec, page 64-19

•

Clearing Security Associations, page 64-34

•

Clearing Crypto Map Configurations, page 64-35

•

Supporting the Nokia VPN Client, page 64-35

Information About Tunneling, IPsec, and ISAKMP
Tunneling makes it possible to use a public TCP/IP network, such as the Internet, to create secure
connections between remote users and a private corporate network. Each secure connection is called a
tunnel.
The ASA uses the ISAKMP and IPsec tunneling standards to build and manage tunnels. ISAKMP and
IPsec accomplish the following:
•

Negotiate tunnel parameters

•

Establish tunnels

•

Authenticate users and data

•

Manage security keys

•

Encrypt and decrypt data

•

Manage data transfer across the tunnel

•

Manage data transfer inbound and outbound as a tunnel endpoint or router

Cisco ASA 5500 Series Configuration Guide using the CLI

64-1

Chapter 64

Configuring IPsec and ISAKMP

Information About Tunneling, IPsec, and ISAKMP

The ASA functions as a bidirectional tunnel endpoint. It can receive plain packets from the private
network, encapsulate them, create a tunnel, and send them to the other end of the tunnel where they are
unencapsulated and sent to their final destination. It can also receive encapsulated packets from the
public network, unencapsulate them, and send them to their final destination on the private network.

IPsec Overview
The ASA uses IPsec for LAN-to-LAN VPN connections and provides the option of using IPsec for
client-to-LAN VPN connections. In IPsec terminology, a peer is a remote-access client or another secure
gateway. For both connection types, the ASA supports only Cisco peers. Because we adhere to VPN
industry standards, ASAs can work with other vendors' peers; however, we do not support them.
During tunnel establishment, the two peers negotiate security associations that govern authentication,
encryption, encapsulation, and key management. These negotiations involve two phases: first, to
establish the tunnel (the IKE SA) and second, to govern traffic within the tunnel (the IPsec SA).
A LAN-to-LAN VPN connects networks in different geographic locations. In IPsec LAN-to-LAN
connections, the ASA can function as initiator or responder. In IPsec client-to-LAN connections, the
ASA functions only as responder. Initiators propose SAs; responders accept, reject, or make
counter-proposals—all in accordance with configured SA parameters. To establish a connection, both
entities must agree on the SAs.

Note

When the ASA is configured for IPsec VPN, you cannot enable security contexts (also called firewall
multimode) or Active/Active stateful failover. Therefore, these features are unavailable.

ISAKMP and IKE Overview
ISAKMP is the negotiation protocol that lets two hosts agree on how to build an IPsec security
association (SA). It provides a common framework for agreeing on the format of SA attributes. This
security association includes negotiating with the peer about the SA and modifying or deleting the SA.
ISAKMP separates negotiation into two phases: Phase 1 and Phase 2. Phase 1 creates the first tunnel,
which protects later ISAKMP negotiation messages. Phase 2 creates the tunnel that protects data.
IKE uses ISAKMP to set up the SA for IPsec to use. IKE creates the cryptographic keys used to
authenticate peers.
The ASA supports IKEv1 for connections from the legacy Cisco VPN client, and IKEv2 for the
AnyConnect VPN client.
To set the terms of the ISAKMP negotiations, you create an IKE policy, which includes the following:
•

The authentication type required of the IKEv1 peer, either RSA signature using certificates or
preshared key (PSK).

•

An encryption method to protect the data and ensure privacy.

•

A Hashed Message Authentication Codes (HMAC) method to ensure the identity of the sender, and
to ensure that the message has not been modified in transit.

•

A Diffie-Hellman group to determine the strength of the encryption-key-determination algorithm.
The ASA uses this algorithm to derive the encryption and hash keys.

•

For IKEv2, a separate pseudo-random function (PRF) used as the algorithm to derive keying
material and hashing operations required for the IKEv2 tunnel encryption and so on.

•

A limit to the time the ASA uses an encryption key before replacing it.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-2

Chapter 64

Configuring IPsec and ISAKMP
Licensing Requirements for Remote Access IPsec VPNs

With IKEv1 policies, you set one value for each parameter. For IKEv2, you can configure multiple
encryption and authentication types, and multiple integrity algorithms for a single policy. The ASA
orders the settings from the most secure to the least secure and negotiates with the peer using that order.
This ordering allows you to potentially send a single proposal to convey all the allowed transforms
instead of sending each allowed combination as with IKEv1.

Licensing Requirements for Remote Access IPsec VPNs
The following table shows the licensing requirements for this feature:

Note

Model
ASA 5505

This feature is not available on No Payload Encryption models.

License Requirement1
•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license and Security Plus license: 2 sessions.
Optional permanent or time-based licenses: 10 or 25 sessions.
Shared licenses are not supported.2
– AnyConnect Essentials license3: 25 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
– Base license: 10 sessions.
– Security Plus license: 25 sessions.

ASA 5510

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base and Security Plus license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 250 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license and Security Plus license: 250 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-3

Chapter 64

Configuring IPsec and ISAKMP

Licensing Requirements for Remote Access IPsec VPNs

Model
ASA 5520

License Requirement1
•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, or 750 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 750 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 750 sessions.

ASA 5540

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, or 2500
sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 2500 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 2500 sessions.

ASA 5550

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 5000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 5000 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-4

Chapter 64

Configuring IPsec and ISAKMP
Licensing Requirements for Remote Access IPsec VPNs

Model
ASA 5580

License Requirement1
•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, 5000,
or 10000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 10000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 10000 sessions.

ASA 5512-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 250 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 250 sessions.

ASA 5515-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 250 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 250 sessions.

ASA 5525-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, or 750 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 750 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 750 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-5

Chapter 64

Configuring IPsec and ISAKMP

Licensing Requirements for Remote Access IPsec VPNs

License Requirement1

Model
ASA 5545-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, or 2500
sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 2500 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 2500 sessions.

ASA 5555-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 5000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 5000 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-6

Chapter 64

Configuring IPsec and ISAKMP
Licensing Requirements for Remote Access IPsec VPNs

Model
ASA 5585-X with
SSP-10

License Requirement1
•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 5000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 5000 sessions.

ASA 5585-X with
SSP-20, -40, and -60

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, 5000,
or 10000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 10000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 10000 sessions.

1. The maximum combined VPN sessions of all types cannot exceed the maximum sessions shown in this table. For the ASA 5505, the maximum combined
sessions is 10 for the Base license, and 25 for the Security Plus license.
2. A shared license lets the ASA act as a shared license server for multiple client ASAs. The shared license pool is large, but the maximum number of sessions
used by each individual ASA cannot exceed the maximum number listed for permanent licenses.
3. The AnyConnect Essentials 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 SSL VPN Edition
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 no anyconnect-essentials command.
For a detailed list of the features supported by the AnyConnect Essentials license and AnyConnect Premium license, see AnyConnect Secure Mobility
Client Features, Licenses, and OSs:
http://www.cisco.com/en/US/products/ps10884/products_feature_guides_list.html

Cisco ASA 5500 Series Configuration Guide using the CLI

64-7

Chapter 64

Configuring IPsec and ISAKMP

Guidelines and Limitations

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode only. Does not support multiple context mode.
Firewall Mode Guidelines

Supported in routed firewall mode only. Does not support transparent firewall mode.
Failover Guidelines

IPsec VPN sessions are replicated in Active/Standby failover configurations only. Active/Active failover
configurations are not supported.
IPv6 Guidelines

Does not support IPv6.

Configuring ISAKMP
This section describes the Internet Security Association and Key Management Protocol (ISAKMP) and
the Internet Key Exchange (IKE) protocol.
This section includes the following topics:
•

Configuring IKEv1 and IKEv2 Policies, page 64-9

•

Enabling IKE on the Outside Interface, page 64-13

•

Disabling IKEv1 Aggressive Mode, page 64-13

•

Determining an ID Method for IKEv1 and IKEv2 ISAKMP Peers, page 64-13

•

Enabling IPsec over NAT-T, page 64-14

•

Enabling IPsec with IKEv1 over TCP, page 64-15

•

Waiting for Active Sessions to Terminate Before Rebooting, page 64-16

•

Alerting Peers Before Disconnecting, page 64-16

Cisco ASA 5500 Series Configuration Guide using the CLI

64-8

Chapter 64

Configuring IPsec and ISAKMP
Configuring ISAKMP

Configuring IKEv1 and IKEv2 Policies
To create an IKE policy, enter the crypto ikev1 | ikev2 policy command from global configuration mode.
The prompt displays IKE policy configuration mode. For example:
hostname(config)# crypto ikev1 policy 1
hostname(config-ikev1-policy)#

After creating the policy, you can specify the settings for the policy.
Table 64-1 and Table 64-2 provide information about the IKEv1 and IKEv2 policy keywords and their
values.
Table 64-1

IKEv1 Policy Keywords for CLI Commands

Command

Keyword

Meaning

authentication

rsa-sig

A digital certificate with Specifies the authentication method the ASA uses to
keys generated by the
establish the identity of each IPsec peer.
RSA signatures algorithm

crack

Challenge/Response for
Authenticated
Cryptographic Keys

CRACK provides strong mutual authentication when the
client authenticates using a legacy method such as
RADIUS, and the server uses public key authentication.

pre-share
(default)

Preshared keys

Preshared keys do not scale well with a growing network
but are easier to set up in a small network.

des

56-bit DES-CBC

3des (default)

168-bit Triple DES

Specifies the symmetric encryption algorithm that protects
data transmitted between two IPsec peers. The default is
168-bit Triple DES.

encryption

The Advanced Encryption Standard supports key lengths of
128, 192, 256 bits.

aes
aes-192
aes-256
hash

Description

sha (default)

SHA-1 (HMAC variant)

Specifies the hash algorithm used to ensure data integrity. It
ensures that a packet comes from where it says it comes
from and that it has not been modified in transit.

md5

MD5 (HMAC variant)

The default is SHA-1. MD5 has a smaller digest and is
considered to be slightly faster than SHA-1. A successful
(but extremely difficult) attack against MD5 has occurred;
however, the HMAC variant IKE uses prevents this attack.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-9

Chapter 64

Configuring IPsec and ISAKMP

Configuring ISAKMP

Table 64-1

IKEv1 Policy Keywords for CLI Commands (continued)

Command

Keyword

Meaning

Description

group

1

Group 1 (768-bit)

2 (default)

Group 2 (1024-bit)

5

Group 5 (1536-bit)

Specifies the Diffie-Hellman group identifier, which the
two IPsec peers use to derive a shared secret without
transmitting it to each other.
The lower the Diffie-Hellman group number, the less CPU
time it requires to execute. The higher the Diffie-Hellman
group number, the greater the security.
Cisco VPN Client Version 3.x or higher requires a minimum
of Group 2. (If you configure DH Group 1, the Cisco VPN
Client cannot connect.)
AES support is available on security appliances licensed for
VPN-3DES only. To support the large key sizes required by
AES, ISAKMP negotiation should use Diffie-Hellman
(DH) Group 5.

lifetime

integer value
(86400 =
default)

Table 64-2

120 to 2147483647
seconds

Specifies the SA lifetime. The default is 86,400 seconds or
24 hours. As a general rule, a shorter lifetime provides more
secure ISAKMP negotiations (up to a point). However, with
shorter lifetimes, the ASA sets up future IPsec SAs more
quickly.

IKEv2 Policy Keywords for CLI Commands

Command

Keyword

Meaning

Description

integrity

sha (default)

SHA-1 (HMAC variant)

Specifies the hash algorithm used to ensure data integrity. It
ensures that a packet comes from where it says it comes
from and that it has not been modified in transit.

md5

MD5 (HMAC variant)

The default is SHA-1. MD5 has a smaller digest and is
considered to be slightly faster than SHA-1. A successful
(but extremely difficult) attack against MD5 has occurred;
however, the HMAC variant IKE user prevents this attack.

sha256

SHA 2, 256-bit digest

Specifies the Secure Hash Algorithm SHA 2 with the
256-bit digest.

sha384

SHA 2, 384-bit digest

Specifies the Secure Hash Algorithm SHA 2 with the
384-bit digest.

sha512

SHA 2, 512-bit digest

Specifies the Secure Hash Algorithm SHA 2 with the
512-bit digest.

des

56-bit DES-CBC

3des (default)

168-bit Triple DES

Specifies the symmetric encryption algorithm that protects
data transmitted between two IPsec peers. The default is
168-bit Triple DES.

encryption

aes
aes-192
aes-256

Cisco ASA 5500 Series Configuration Guide using the CLI

64-10

The Advanced Encryption Standard supports key lengths of
128, 192, 256 bits.

Chapter 64

Configuring IPsec and ISAKMP
Configuring ISAKMP

Table 64-2

IKEv2 Policy Keywords for CLI Commands (continued)

Command

Keyword

Meaning

Description

prf

sha (default)

SHA-1 (HMAC variant)

Specifies the pseudo random function (PRF)—the
algorithm used to generate keying material.

md5

MD5 (HMAC variant)

The default is SHA-1. MD5 has a smaller digest and is
considered to be slightly faster than SHA-1. A successful
(but extremely difficult) attack against MD5 has occurred;
however, the HMAC variant IKE uses prevents this attack.

sha256

SHA 2, 256-bit digest

Specifies the Secure Hash Algorithm SHA 2 with the
256-bit digest.

sha384

SHA 2, 384-bit digest

Specifies the Secure Hash Algorithm SHA 2 with the
384-bit digest.

sha512

SHA 2, 512-bit digest

Specifies the Secure Hash Algorithm SHA 2 with the
512-bit digest.

1

Group 1 (768-bit)

2 (default)

Group 2 (1024-bit)

5

Group 5 (1536-bit)

Specifies the Diffie-Hellman group identifier, which the
two IPsec peers use to derive a shared secret without
transmitting it to each other.

group

The lower the Diffie-Hellman group number, the less CPU
time it requires to execute. The higher the Diffie-Hellman
group number, the greater the security.
The AnyConnect client supports DH group 1, 2, and 5 in
non-FIPS mode, and groups 2 and only in FIPS mode.
AES support is available on security appliances licensed for
VPN-3DES only. To support the large key sizes required by
AES, ISAKMP negotiation should use Diffie-Hellman
(DH) Group 5.

lifetime

integer value
(86400 =
default)

120 to 2147483647
seconds

Specifies the SA lifetime. The default is 86,400 seconds or
24 hours. As a general rule, a shorter lifetime provides more
secure ISAKMP negotiations (up to a point). However, with
shorter lifetimes, the ASA sets up future IPsec SAs more
quickly.

IKEv1 and IKEv2 each support a maximum of 20 IKE policies, each with a different set of values.
Assign a unique priority to each policy that you create. The lower the priority number, the higher the
priority.
When IKE negotiations begin, the peer that initiates the negotiation sends all of its policies to the remote
peer, and the remote peer tries to find a match. The remote peer checks all of the peer's policies against
each of its configured policies in priority order (highest priority first) until it discovers a match.
A match exists when both policies from the two peers contain the same encryption, hash, authentication,
and Diffie-Hellman parameter values. For IKEv1, the remote peer policy must also specify a lifetime
less than or equal to the lifetime in the policy the initiator sent. If the lifetimes are not identical, the ASA
uses the shorter lifetime. For IKEv2 the lifetime is not negotiated but managed locally between each
peer, making it possible to configure lifetime independently on each peer. If no acceptable match exists,
IKE refuses negotiation and the SA is not established.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-11

Chapter 64

Configuring IPsec and ISAKMP

Configuring ISAKMP

There is an implicit trade-off between security and performance when you choose a specific value for
each parameter. The level of security the default values provide is adequate for the security requirements
of most organizations. If you are interoperating with a peer that supports only one of the values for a
parameter, your choice is limited to that value.

Note

New ASA configurations do not have a default IKEv1 or IKEv2 policy.
To configure IKE policies, in global configuration mode, use the crypto ikev1 | ikev2 policy command
to enter IKE policy configuration mode:
crypto ikev1 | ikev2 policy priority
You must include the priority in each of the ISAKMP commands. The priority number uniquely
identifies the policy and determines the priority of the policy in IKE negotiations.
To enable and configure IKE, complete the following steps, using the IKEv1 examples as a guide:

Note

Step 1

If you do not specify a value for a given policy parameter, the default value applies.
Enter IKEv1 policy configuration mode:
hostname(config)# crypto ikev1 policy 1
hostname(config-ikev1-policy)#

Step 2

Specify the encryption algorithm. The default is Triple DES. This example sets encryption to DES.
encryption [aes | aes-192 | aes-256 | des | 3des]

For example:
hostname(config-ikev1-policy)# encryption des

Step 3

Specify the hash algorithm. The default is SHA-1. This example configures MD5.
hash [md5 | sha]

For example:
hostname(config-ikev1-policy)# hash md5

Step 4

Specify the authentication method. The default is preshared keys. This example configures RSA
signatures.
authentication [pre-share | crack | rsa-sig]

For example:
hostname(config-ikev1-policy)# authentication rsa-sig

Step 5

Specify the Diffie-Hellman group identifier. The default is Group 2. This example configures Group 5.
group [1 | 2 | 5]

For example:
hostname(config-ikev1-policy)# group 5

Step 6

Specify the SA lifetime. This examples sets a lifetime of 4 hours (14400 seconds). The default is 86400
seconds (24 hours).
lifetime seconds

Cisco ASA 5500 Series Configuration Guide using the CLI

64-12

Chapter 64

Configuring IPsec and ISAKMP
Configuring ISAKMP

For example:
hostname(config-ikev1-policy)# lifetime 14400

Enabling IKE on the Outside Interface
You must enable IKE on the interface that terminates the VPN tunnel. Typically this is the outside, or
public interface. To enable IKEv1 or IKEv2, use the crypto ikev1 | ikev2 enable command from global
configuration mode:
crypto ikev1 | ikev2 enable interface-name
For example:
hostname(config)# crypto ikev1 enable outside

Disabling IKEv1 Aggressive Mode
Phase 1 IKEv1 negotiations can use either main mode or aggressive mode. Both provide the same
services, but aggressive mode requires only two exchanges between the peers totaling three messages,
rather than three exchanges totaling six messages. Aggressive mode is faster, but does not provide
identity protection for the communicating parties. Therefore, the peers must exchange identification
information before establishing a secure SA. Aggressive mode is enabled by default.
•

Main mode is slower, using more exchanges, but it protects the identities of the communicating
peers.

•

Aggressive mode is faster, but does not protect the identities of the peers.

To disable aggressive mode, enter the following command:
crypto ikev1 am-disable

For example:
hostname(config)# crypto ikev1 am-disable

If you have disabled aggressive mode, and want to revert to back to it, use the no form of the command.
For example:
hostname(config)# no crypto ikev1 am-disable

Note

Disabling aggressive mode prevents Cisco VPN clients from using preshared key authentication to
establish tunnels to the ASA. However, they may use certificate-based authentication (that is, ASA or
RSA) to establish tunnels.

Determining an ID Method for IKEv1 and IKEv2 ISAKMP Peers
During ISAKMP Phase I negotiations, either IKEv1 or IKEv2, the peers must identify themselves to
each other. You can choose the identification method from the following options:

Cisco ASA 5500 Series Configuration Guide using the CLI

64-13

Chapter 64

Configuring IPsec and ISAKMP

Configuring ISAKMP

Address

Uses the IP addresses of the hosts exchanging ISAKMP identity information.

Automatic

Determines ISAKMP negotiation by connection type:
•

IP address for preshared key.

•

Cert Distinguished Name for certificate authentication.

Hostname

Uses the fully qualified domain name of the hosts exchanging ISAKMP identity
information (default). This name comprises the hostname and the domain name.

Key ID

Uses the string the remote peer uses to look up the preshared key.

The ASA uses the Phase I ID to send to the peer. This is true for all VPN scenarios except LAN-to-LAN
IKEv1 connections in main mode that authenticate with preshared keys.
The default setting is auto.
To change the peer identification method, enter the following command:
crypto isakmp identity {address | hostname | key-id id-string | auto}

For example, the following command sets the peer identification method to hostname:
hostname(config)# crypto isakmp identity hostname

Enabling IPsec over NAT-T
NAT-T lets IPsec peers establish a connection through a NAT device. It does this by encapsulating IPsec
traffic in UDP datagrams, using port 4500, which provides NAT devices with port information. NAT-T
auto-detects any NAT devices and only encapsulates IPsec traffic when necessary. This feature is
disabled by default.

Note

Due to a limitation of the AnyConnect client, you must enable NAT-T for the AnyConnect client to
successfully connect using IKEv2. This requirement applies even if the client is not behind a NAT-T
device.
With the exception of the home zone on the Cisco ASA 5505, the ASA can simultaneously support
standard IPsec, IPsec over TCP, NAT-T, and IPsec over UDP, depending on the client with which it is
exchanging data.
The following breakdown shows the connections with each option enabled:
Options

Enabled Feature

Client Position

Feature Used

and client is behind NAT, then NAT-T is used
Option 1

If NAT-T is enabled

and no NAT exists, then

Native IPsec (ESP) is used

and client is behind NAT, then IPsec over UDP is used
Option 2

If IPsec over UDP is enabled and no NAT exists, then
If both NAT-T and

Option 3

Note

and client is behind NAT, then NAT-T is used

IPsec over UDP are enabled and no NAT exists, then

IPsec over UDP is used

When IPsec over TCP is enabled, it takes precedence over all other connection methods.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-14

IPsec over UDP is used

Chapter 64

Configuring IPsec and ISAKMP
Configuring ISAKMP

When you enable NAT-T, the ASA automatically opens port 4500 on all IPsec-enabled interfaces.
The ASA supports multiple IPsec peers behind a single NAT/PAT device operating in one of the
following networks, but not both:
•

LAN-to-LAN

•

Remote access

In a mixed environment, the remote access tunnels fail the negotiation because all peers appear to be
coming from the same public IP address, address of the NAT device. Also, remote access tunnels fail in
a mixed environment because they often use the same name as the LAN-to-LAN tunnel group (that is,
the IP address of the NAT device). This match can cause negotiation failures among multiple peers in a
mixed LAN-to-LAN and remote access network of peers behind the NAT device.

Using NAT-T
To use NAT-T, you must perform the following tasks:
Step 1

Enter the following command to enable IPsec over NAT-T globally on the ASA:
crypto isakmp nat-traversal natkeepalive

The range for the natkeepalive argument is 10 to 3600 seconds. The default is 20 seconds.
For example, enter the following command to enable NAT-T and set the keepalive value to one hour.
hostname(config)# crypto isakmp nat-traversal 3600

Step 2

Select the before-encryption option for the IPsec fragmentation policy by entering this command:
hostname(config)# crypto ipsec fragmentation before-encryption

This option lets traffic travel across NAT devices that do not support IP fragmentation. It does not impede
the operation of NAT devices that do support IP fragmentation.

Enabling IPsec with IKEv1 over TCP
IPsec/IKEv1 over TCP enables a Cisco VPN client to operate in an environment in which standard ESP
or IKEv1 cannot function or can function only with modification to existing firewall rules. IPsec over
TCP encapsulates both the IKEv1 and IPsec protocols within a TCP-like packet and enables secure
tunneling through both NAT and PAT devices and firewalls. This feature is disabled by default.

Note

This feature does not work with proxy-based firewalls.
IPsec over TCP works with remote access clients. You enable it globally, and it works on all
IKEv1-enabled interfaces. It is a client to the ASA feature only. It does not work for LAN-to-LAN
connections.
The ASA can simultaneously support standard IPsec, IPsec over TCP, NAT-Traversal, and IPsec over
UDP, depending on the client with which it is exchanging data. IPsec over TCP, if enabled, takes
precedence over all other connection methods.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-15

Chapter 64

Configuring IPsec and ISAKMP

Configuring ISAKMP

The VPN 3002 hardware client, which supports one tunnel at a time, can connect using standard IPsec,
IPsec over TCP, NAT-Traversal, or IPsec over UDP.
You enable IPsec over TCP on both the ASA and the client to which it connects.
You can enable IPsec over TCP for up to 10 ports that you specify. If you enter a well-known port, for
example port 80 (HTTP) or port 443 (HTTPS), the system displays a warning that the protocol associated
with that port no longer works on the public interface. The consequence is that you can no longer use a
browser to manage the ASA through the public interface. To solve this problem, reconfigure the
HTTP/HTTPS management to different ports.
The default port is 10000.
You must configure TCP port(s) on the client as well as on the ASA. The client configuration must
include at least one of the ports you set for the ASA.
To enable IPsec over TCP for IKEv1 globally on the ASA, enter the following command:
crypto ikev1 ipsec-over-tcp [port port 1...port0]

This example enables IPsec over TCP on port 45:
hostname(config)# crypto ikev1 ipsec-over-tcp port 45

Waiting for Active Sessions to Terminate Before Rebooting
You can schedule an ASA reboot to occur only when all active sessions have terminated voluntarily. This
feature is disabled by default.
To enable waiting for all active sessions to voluntarily terminate before the ASA reboots, enter the
following command:
crypto isakmp reload-wait

For example:
hostname(config)# crypto isakmp reload-wait

Use the reload command to reboot the ASA. If you set the reload-wait command, you can use the
reload quick command to override the reload-wait setting. The reload and reload-wait commands are
available in privileged EXEC mode; neither includes the isakmp prefix.

Alerting Peers Before Disconnecting
Remote access or LAN-to-LAN sessions can drop for several reasons, such as an ASA shutdown or
reboot, session idle timeout, maximum connection time exceeded, or administrator cut-off.
The ASA can notify qualified peers (in LAN-to-LAN configurations), Cisco VPN clients, and VPN 3002
hardware clients of sessions that are about to be disconnected. The peer or client receiving the alert
decodes the reason and displays it in the event log or in a pop-up pane. This feature is disabled by default.
Qualified clients and peers include the following:
•

Security appliances with Alerts enabled

•

Cisco VPN clients running version 4.0 or later software (no configuration required)

•

VPN 3002 hardware clients running version 4.0 or later software, with Alerts enabled

•

VPN 3000 series concentrators running version 4.0 or later software with Alerts enabled

To enable disconnect notification to IPsec peers, enter the crypto isakmp disconnect-notify command.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-16

Chapter 64

Configuring IPsec and ISAKMP
Configuring Certificate Group Matching for IKEv1

For example:
hostname(config)# crypto isakmp disconnect-notify

Configuring Certificate Group Matching for IKEv1
Tunnel groups define user connection terms and permissions. Certificate group matching lets you match
a user to a tunnel group using either the Subject DN or Issuer DN of the user certificate.

Note

Certificate group matching applies to IKEv1 and IKEv2 LAN-to-LAN connections only. IKEv2 remote
access connections support the pull-down group selection configured in the webvpn-attributes of the
tunnel-group and webvpn configuration mode for certificate-group-map, and so on.
To match users to tunnel groups based on these fields of the certificate, you must first create rules that
define a matching criteria, and then associate each rule with the desired tunnel group.
To create a certificate map, use the crypto ca certificate map command. To define a tunnel group, use
the tunnel-group command.
You must also configure a certificate group matching policy, specifying to match the group from the
rules, or from the organizational unit (OU) field, or to use a default group for all certificate users. You
can use any or all of these methods.
The following sections provide more information:
•

Creating a Certificate Group Matching Rule and Policy, page 64-17

•

Using the Tunnel-group-map default-group Command, page 64-19

Creating a Certificate Group Matching Rule and Policy
To configure the policy and rules by which certificate-based ISAKMP sessions map to tunnel groups,
and to associate the certificate map entries with tunnel groups, enter the tunnel-group-map command
in global configuration mode.
The syntax follows:
tunnel-group-map enable {rules | ou | ike-id | peer ip}
tunnel-group-map [rule-index] enable policy

Cisco ASA 5500 Series Configuration Guide using the CLI

64-17

Chapter 64

Configuring IPsec and ISAKMP

Configuring Certificate Group Matching for IKEv1

policy

Specifies the policy for deriving the tunnel group name from the certificate.
Policy can be one of the following:
ike-id—Indicates that if a tunnel group is not determined based on a rule
lookup or taken from the OU, then the certificate-based ISAKMP sessions are
mapped to a tunnel group based on the content of the phase1 ISAKMP ID.
ou—Indicates that if a tunnel-group is not determined based on a rule lookup,
then use the value of the OU in the subject distinguished name (DN).
peer-ip—Indicates that if a tunnel group is not determined based on a rule
lookup or taken from the OU or ike-id methods, then use the peer IP address.
rules—Indicates that the certificate-based ISAKMP sessions are mapped to a
tunnel group based on the certificate map associations configured by this
command.

rule index

(Optional) Refers to parameters specified by the crypto ca certificate map
command. The values are 1 to 65535.

Be aware of the following:
•

You can invoke this command multiple times as long as each invocation is unique and you do not
reference a map index more than once.

•

Rules cannot be longer than 255 characters.

•

You can assign multiple rules to the same group. To do that, you add the rule priority and group first.
Then you define as many criteria statements as you need for each group. When multiple rules are
assigned to the same group, a match results for the first rule that tests true.

•

By creating a single rule, you can require all criteria to match before assigning a user to a specific
tunnel group. Requiring all criteria to match is equivalent to a logical AND operation. Alternatively,
create one rule for each criterion if you want to require that only one match before assigning a user
to a specific tunnel group. Requiring only one criterion to match is equivalent to a logical OR
operation.

The following example enables mapping of certificate-based ISAKMP sessions to a tunnel group based
on the content of the phase1 ISAKMP ID:
hostname(config)# tunnel-group-map enable ike-id
hostname(config)#

The following example enables mapping of certificate-based ISAKMP sessions to a tunnel group based
on the IP address of the peer:
hostname(config)# tunnel-group-map enable peer-ip
hostname(config)#

The following example enables mapping of certificate-based ISAKMP sessions based on the
organizational unit (OU) in the subject distinguished name (DN):
hostname(config)# tunnel-group-map enable ou
hostname(config)#

The following example enables mapping of certificate-based ISAKMP sessions based on established
rules:
hostname(config)# tunnel-group-map enable rules
hostname(config)#

Cisco ASA 5500 Series Configuration Guide using the CLI

64-18

Chapter 64

Configuring IPsec and ISAKMP
Configuring IPsec

Using the Tunnel-group-map default-group Command
This command specifies a default tunnel group to use when the configuration does not specify a tunnel
group.
The syntax is tunnel-group-map [rule-index] default-group tunnel-group-name where rule-index is the
priority for the rule, and tunnel-group name must be for a tunnel group that already exists.

Configuring IPsec
This section provides background information about IPsec and describes the procedures required to
configure the ASA when using IPsec to implement a VPN. It contains the following topics:
•

Understanding IPsec Tunnels, page 64-19

•

Understanding IKEv1 Transform Sets and IKEv2 Proposals, page 64-19

•

Defining Crypto Maps, page 64-20

•

Applying Crypto Maps to Interfaces, page 64-26

•

Using Interface Access Lists, page 64-26

•

Changing IPsec SA Lifetimes, page 64-29

•

Creating a Basic IPsec Configuration, page 64-29

•

Using Dynamic Crypto Maps, page 64-31

•

Providing Site-to-Site Redundancy, page 64-34

•

Viewing an IPsec Configuration, page 64-34

Understanding IPsec Tunnels
IPsec tunnels are sets of SAs that the ASA establishes between peers. The SAs specify the protocols and
algorithms to apply to sensitive data and also specify the keying material that the peers use. IPsec SAs
control the actual transmission of user traffic. SAs are unidirectional, but are generally established in
pairs (inbound and outbound).
The peers negotiate the settings to use for each SA. Each SA consists of the following:
•

IKEv1 transform sets or IKEv2 proposals

•

Crypto maps

•

Access lists

•

Tunnel groups

•

Prefragmentation policies

Understanding IKEv1 Transform Sets and IKEv2 Proposals
An IKEv1 transform set or an IKEv2 proposal is a combination of security protocols and algorithms that
define how the ASA protects data. During IPsec SA negotiations, the peers must identify a transform set
or proposal that is the same at both peers. The ASA then applies the matching transform set or proposal
to create an SA that protects data flows in the access list for that crypto map.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-19

Chapter 64

Configuring IPsec and ISAKMP

Configuring IPsec

With IKEv1 transform sets, you set one value for each parameter. For IKEv2 proposals, you can
configure multiple encryption and authentication types and multiple integrity algorithms for a single
proposal. The ASA orders the settings from the most secure to the least secure and negotiates with the
peer using that order. This allows you to potentially send a single proposal to convey all the allowed
combinations instead of the need to send each allowed combination individually as with IKEv1.
The ASA tears down the tunnel if you change the definition of the transform set or proposal used to
create its SA. See “Clearing Security Associations” for further information.

Note

If you clear or delete the only element in a transform set or proposal, the ASA automatically removes
the crypto map references to it.

Defining Crypto Maps
Crypto maps define the IPsec policy to be negotiated in the IPsec SA. They include the following:
•

Access list to identify the packets that the IPsec connection permits and protects.

•

Peer identification.

•

Local address for the IPsec traffic. (See “Applying Crypto Maps to Interfaces” for more details.)

•

Up to 11 IKEv1 transform sets or IKEv2 proposals, with which to attempt to match the peer security
settings.

A crypto map set consists of one or more crypto maps that have the same map name. You create a crypto
map set when you create its first crypto map. The following command syntax creates or adds to a crypto
map:
crypto map map-name seq-num match address access-list-name

You can continue to enter this command to add crypto maps to the crypto map set. In the following
example, mymap is the name of the crypto map set to which you might want to add crypto maps:
crypto map mymap 10 match address 101

The sequence number (seq-num) shown in the syntax above distinguishes one crypto map from another
one with the same name. The sequence number assigned to a crypto map also determines its priority
among the other crypto maps within a crypto map set. The lower the sequence number, the higher the
priority. After you assign a crypto map set to an interface, the ASA evaluates all IP traffic passing
through the interface against the crypto maps in the set, beginning with the crypto map with the lowest
sequence number.
The ACL assigned to a crypto map consists of all of the ACEs that have the same access list name, as
shown in the following command syntax:
access-list access-list-name {deny | permit} ip source source-netmask destination
destination-netmask

Each ACL consists of one or more ACEs that have the same access list name. You create an ACL when
you create its first ACE. The following command syntax creates or adds to an ACL:
access-list access-list-name {deny | permit} ip source source-netmask destination
destination-netmask

In the following example, the ASA applies the IPsec protections assigned to the crypto map to all traffic
flowing from the 10.0.0.0 subnet to the 10.1.1.0 subnet:
access-list 101 permit ip 10.0.0.0 255.255.255.0 10.1.1.0 255.255.255.0

Cisco ASA 5500 Series Configuration Guide using the CLI

64-20

Chapter 64

Configuring IPsec and ISAKMP
Configuring IPsec

The crypto map that matches the packet determines the security settings used in the SA negotiations.
If the local ASA initiates the negotiation, it uses the policy specified in the static crypto map to create
the offer to send to the specified peer. If the peer initiates the negotiation, the ASA attempts to match the
policy to a static crypto map, and if that fails, then it attempts to match any dynamic crypto maps in the
crypto map set, to decide whether to accept or reject the peer offer.
For two peers to succeed in establishing an SA, they must have at least one compatible crypto map. To
be compatible, a crypto map must meet the following criteria:
•

The crypto map must contain compatible crypto ACLs (for example, mirror image ACLs). If the
responding peer uses dynamic crypto maps, so the ASA also must contain compatible crypto ACLs
as a requirement to apply IPsec.

•

Each crypto map identifies the other peer (unless the responding peer uses dynamic crypto maps).

•

The crypto maps have at least one transform set or proposal in common.

You can apply only one crypto map set to a single interface. Create more than one crypto map for a
particular interface on the ASA if any of the following conditions exist:
•

You want specific peers to handle different data flows.

•

You want different IPsec security to apply to different types of traffic.

For example, create a crypto map and assign an ACL to identify traffic between two subnets and assign
one IKEv1 transform set or IKEv2 proposal. Create another crypto map with a different ACL to identify
traffic between another two subnets and apply a transform set or proposal with different VPN
parameters.
If you create more than one crypto map for an interface, specify a sequence number (seq-num) for each
map entry to determine its priority within the crypto map set.
Each ACE contains a permit or deny statement. Table 64-3 explains the special meanings of permit and
deny ACEs in ACLs applied to crypto maps.
Table 64-3

Special Meanings of Permit and Deny in Crypto Access Lists Applied to Outbound
Traffic

Result of Crypto Map
Evaluation

Response

Match criterion in an ACE
Halt further evaluation of the packet against the remaining ACEs in the
containing a permit statement crypto map set, and evaluate the packet security settings against those in
the IKEv1 transform sets or IKEv2 proposals assigned to the crypto
map. After matching the security settings to those in a transform set or
proposal, the ASA applies the associated IPsec settings. Typically for
outbound traffic, this means that it decrypts, authenticates, and routes
the packet.
Match criterion in an ACE
containing a deny statement

Interrupt further evaluation of the packet against the remaining ACEs in
the crypto map under evaluation, and resume evaluation against the
ACEs in the next crypto map, as determined by the next seq-num
assigned to it.

Fail to match all tested permit Route the packet without encrypting it.
ACEs in the crypto map set

Cisco ASA 5500 Series Configuration Guide using the CLI

64-21

Chapter 64

Configuring IPsec and ISAKMP

Configuring IPsec

ACEs containing deny statements filter out outbound traffic that does not require IPsec protection
(for example, routing protocol traffic). Therefore, insert initial deny statements to filter outbound traffic
that should not be evaluated against permit statements in a crypto access list.
For an inbound, encrypted packet, the security appliance uses the source address and ESP SPI to
determine the decryption parameters. After the security appliance decrypts the packet, it compares the
inner header of the decrypted packet to the permit ACEs in the ACL associated with the packet SA. If the
inner header fails to match the proxy, the security appliance drops the packet. It the inner header matches
the proxy, the security appliance routes the packet.
When comparing the inner header of an inbound packet that was not encrypted, the security appliance
ignores all deny rules because they would prevent the establishment of a Phase 2 SA.

Note

To route inbound, unencrypted traffic as clear text, insert deny ACEs before permit ACEs.
Figure 64-1 shows an example LAN-to-LAN network of ASAs.

Effect of Permit and Deny ACEs on Traffic (Conceptual Addresses)

A.1

B.1

C.1

A.2
A.3
Human Resources

B.2

B.3

A

C.2

C.3

B

Internet

C

143514

Figure 64-1

The simple address notation shown in this figure and used in the following explanation is an abstraction.
An example with real IP addresses follows the explanation.
The objective in configuring Security Appliances A, B, and C in this example LAN-to-LAN network is
to permit tunneling of all traffic originating from one of the hosts shown in Figure 64-1 and destined for
one of the other hosts. However, because traffic from Host A.3 contains sensitive data from the Human
Resources department, it requires strong encryption and more frequent rekeying than the other traffic.
So you will want to assign a special transform set for traffic from Host A.3.
To configure Security Appliance A for outbound traffic, you create two crypto maps, one for traffic from
Host A.3 and the other for traffic from the other hosts in Network A, as shown in the following example:

Cisco ASA 5500 Series Configuration Guide using the CLI

64-22

Chapter 64

Configuring IPsec and ISAKMP
Configuring IPsec

Crypto Map Seq_No_1
deny packets from A.3 to B
deny packets from A.3 to C
permit packets from A to B
permit packets from A to C
Crypto Map Seq_No_2
permit packets from A.3 to B
permit packets from A.3 to C

After creating the ACLs, you assign a transform set to each crypto map to apply the required IPsec to
each matching packet.
Cascading ACLs involves the insertion of deny ACEs to bypass evaluation against an ACL and resume
evaluation against a subsequent ACL in the crypto map set. Because you can associate each crypto map
with different IPsec settings, you can use deny ACEs to exclude special traffic from further evaluation
in the corresponding crypto map, and match the special traffic to permit statements in another crypto
map to provide or require different security. The sequence number assigned to the crypto ACL
determines its position in the evaluation sequence within the crypto map set.
Figure 64-2 shows the cascading ACLs created from the conceptual ACEs above. The meaning of each
symbol in the figure follows.
Crypto map within a crypto map set.

(Gap in a straight line) Exit from a crypto map when a packet
matches an ACE.
Packet that fits the description of one ACE. Each size ball
represents a different packet matching the respective ACE in the
figure. The differences in size merely represent differences in the
source and destination of each packet.
Redirection to the next crypto map in the crypto map set.

Response when a packet either matches an ACE or fails to match
all of the permit ACEs in a crypto map set.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-23

Chapter 64

Configuring IPsec and ISAKMP

Configuring IPsec

Figure 64-2

Cascading ACLs in a Crypto Map Set

Crypto Map 1
Deny
A.3 B

Deny
A.3 C
Permit
AB
Permit
AC

Apply IPSec assigned to Crypto Map 1

Crypto Map 2
Permit
A.3 B

Apply IPSec
assigned to
Crypto Map 2

Route as clear text

143513

Permit
A.3 C

Security Appliance A evaluates a packet originating from Host A.3 until it matches a permit ACE and
attempts to assign the IPsec security associated with the crypto map. Whenever the packet matches a
deny ACE, the ASA ignores the remaining ACEs in the crypto map and resumes evaluation against the
next crypto map, as determined by the sequence number assigned to it. So in the example, if Security
Appliance A receives a packet from Host A.3, it matches the packet to a deny ACE in the first crypto
map and resumes evaluation of the packet against the next crypto map. When it matches the packet to
the permit ACE in that crypto map, it applies the associated IPsec security (strong encryption and
frequent rekeying).

Cisco ASA 5500 Series Configuration Guide using the CLI

64-24

Configuring IPsec and ISAKMP
Configuring IPsec

To complete the security appliance configuration in the example network, we assign mirror crypto maps
to Security Appliances B and C. However, because security appliances ignore deny ACEs when
evaluating inbound, encrypted traffic, we can omit the mirror equivalents of the deny A.3 B
and deny A.3 C ACEs, and therefore omit the mirror equivalents of Crypto Map 2. So the configuration
of cascading ACLs in Security Appliances B and C is unnecessary.
Table 64-4 shows the ACLs assigned to the crypto maps configured for all three ASAs in Figure 64-1.
Table 64-4

Example Permit and Deny Statements (Conceptual)

Security Appliance A

Security Appliance B

Security Appliance C

Crypto Map
Sequence
No.

ACE Pattern

Crypto Map
Sequence
No.

ACE Pattern

Crypto Map
Sequence
No.

ACE Pattern

1

deny A.3 B

1

permit B A

1

permit C A

deny A.3 C
permit A B
permit A C
2

permit B C

permit C B

permit A.3 B
permit A.3 C

Figure 64-3 maps the conceptual addresses shown in Figure 64-1 to real IP addresses.

Figure 64-3

Effect of Permit and Deny ACEs on Traffic (Real Addresses)

A.1
192.168.3.1

B.1
192.168.12.1
A.2
192.168.3.2

A.3
192.168.3.3
Human Resources

A
192.168.3.0/26

C.1
192.168.201.1
C.2
192.168.201.2

B.2
192.168.12.2
B.2
192.168.12.3

C.3
192.168.201.3

B
192.168.12.0/29

C
192.168.201.0/27

Internet

143514

Chapter 64

Cisco ASA 5500 Series Configuration Guide using the CLI

64-25

Chapter 64

Configuring IPsec and ISAKMP

Configuring IPsec

The tables that follow combine the IP addresses shown in Figure 64-3 to the concepts shown in
Table 64-4. The real ACEs shown in these tables ensure that all IPsec packets under evaluation within
this network receive the proper IPsec settings.
Table 64-5

Example Permit and Deny Statements for Security Appliance A

Security
Appliance

Crypto Map
Sequence
No.

ACE Pattern

Real ACEs

A

1

deny A.3 B

deny 192.168.3.3 255.255.255.192 192.168.12.0 255.255.255.248

deny A.3 C

deny 192.168.3.3 255.255.255.192 192.168.201.0 255.255.255.224

permit A B

permit 192.168.3.0 255.255.255.192 192.168.12.0 255.255.255.248

permit A C

permit 192.168.3.0 255.255.255.192 192.168.201.0 255.255.255.224

permit A.3 B

permit 192.168.3.3 255.255.255.192 192.168.12.0 255.255.255.248

permit A.3 C

permit 192.168.3.3 255.255.255.192 192.168.201.0 255.255.255.224

permit B A

permit 192.168.12.0 255.255.255.248 192.168.3.0 255.255.255.192

permit B C

permit 192.168.12.0 255.255.255.248 192.168.201.0 255.255.255.224

permit C A

permit 192.168.201.0 255.255.255.224 192.168.3.0 255.255.255.192

permit C B

permit 192.168.201.0 255.255.255.224 192.168.12.0 255.255.255.248

2
B
C

None needed
None needed

You can apply the same reasoning shown in the example network to use cascading ACLs to assign
different security settings to different hosts or subnets protected by a Cisco ASA.

Note

By default, the ASA does not support IPsec traffic destined for the same interface from which it enters.
Names for this type of traffic include U-turn, hub-and-spoke, and hairpinning. However, you can
configure IPsec to support U-turn traffic by inserting an ACE to permit traffic to and from the network.
For example, to support U-turn traffic on Security Appliance B, add a conceptual “permit B B” ACE to
ACL1. The actual ACE would be as follows:
permit 192.168.12.0 255.255.255.248 192.168.12.0 255.255.255.248

Applying Crypto Maps to Interfaces
You must assign a crypto map set to each interface through which IPsec traffic flows. The ASA supports
IPsec on all interfaces. Assigning the crypto map set to an interface instructs the ASA to evaluate all the
traffic against the crypto map set and to use the specified policy during connection or SA negotiation.
Assigning a crypto map to an interface also initializes run-time data structures, such as the SA database
and the security policy database. Reassigning a modified crypto map to the interface resynchronizes the
run-time data structures with the crypto map configuration. Also, adding new peers through the use of
new sequence numbers and reassigning the crypto map does not tear down existing connections.

Using Interface Access Lists
By default, the ASA lets IPsec packets bypass interface ACLs. If you want to apply interface access lists
to IPsec traffic, use the no form of the sysopt connection permit-vpn command.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-26

Chapter 64

Configuring IPsec and ISAKMP
Configuring IPsec

The crypto map access list bound to the outgoing interface either permits or denies IPsec packets through
the VPN tunnel. IPsec authenticates and deciphers packets that arrive from an IPsec tunnel, and subjects
them to evaluation against the ACL associated with the tunnel.
Access lists define which IP traffic to protect. For example, you can create access lists to protect all IP
traffic between two subnets or two hosts. (These access lists are similar to access lists used with the
access-group command. However, with the access-group command, the access list determines which
traffic to forward or block at an interface.)
Before the assignment to crypto maps, the access lists are not specific to IPsec. Each crypto map
references the access lists and determines the IPsec properties to apply to a packet if it matches a permit
in one of the access lists.
Access lists assigned to IPsec crypto maps have four primary functions:
•

Select outbound traffic to be protected by IPsec (permit = protect).

•

Trigger an ISAKMP negotiation for data travelling without an established SA.

•

Process inbound traffic to filter out and discard traffic that should have been protected by IPsec.

•

Determine whether to accept requests for IPsec SAs when processing IKE negotiation from the peer.
(Negotiation applies only to ipsec-isakmp crypto map entries.) The peer must permit a data flow
associated with an ipsec-isakmp crypto map command entry to ensure acceptance during
negotiation.

Regardless of whether the traffic is inbound or outbound, the ASA evaluates traffic against the access
lists assigned to an interface. You assign IPsec to an interface as follows:
Step 1

Create the access lists to be used for IPsec.

Step 2

Map the lists to one or more crypto maps, using the same crypto map name.

Step 3

Map the IKEv1 transform sets or IKEv2 proposals to the crypto maps to apply IPsec to the data flows.

Step 4

Apply the crypto maps collectively as a crypto map set by assigning the crypto map name they share to
the interface.

In Figure 64-4, IPsec protection applies to traffic between Host 10.0.0.1 and Host 10.2.2.2 as the data
exits the outside interface on Security Appliance A toward Host 10.2.2.2.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-27

Chapter 64

Configuring IPsec and ISAKMP

Configuring IPsec

Figure 64-4

How Crypto Access Lists Apply to IPsec
IPSec peers

Host
10.2.2.2

Internet
Host
10.0.0.1

outside

outside

Security
Appliance
Firewall A

Security
Appliance
Firewall B

IPSec Access List at "outside" interface:
access-list 101 permit ip host 10.0.0.1 host 10.2.2.2

Traffic exchanged between hosts 10.0.0.1 and 10.2.2.2 is protected between
Security Appliance Firewall A "outside" and Security Appliance Firewall B "outside"

92616

IPSec Access List at "outside" interface:
access-list 111 permit ip host 10.2.2.2 host 10.0.0.1

Security Appliance A evaluates traffic from Host 10.0.0.1 to Host 10.2.2.2, as follows:
•

source = host 10.0.0.1

•

dest = host 10.2.2.2

Security Appliance A also evaluates traffic from Host 10.2.2.2 to Host 10.0.0.1, as follows:
•

source = host 10.2.2.2

•

dest = host 10.0.0.1

The first permit statement that matches the packet under evaluation determines the scope of the
IPsec SA.

Note

If you delete the only element in an access list, the ASA also removes the associated crypto map.
If you modify an access list currently referenced by one or more crypto maps, use the crypto map
interface command to reinitialize the run-time SA database. See the crypto map command for more
information.
We recommend that for every crypto access list specified for a static crypto map that you define at the
local peer, you define a “mirror image” crypto access list at the remote peer. The crypto maps should
also support common transforms and refer to the other system as a peer. This ensures correct processing
of IPsec by both peers.

Note

Every static crypto map must define an access list and an IPsec peer. If either is missing, the crypto map
is incomplete and the ASA drops any traffic that it has not already matched to an earlier, complete crypto
map. Use the show conf command to ensure that every crypto map is complete. To fix an incomplete
crypto map, remove the crypto map, add the missing entries, and reapply it.
We discourage the use of the any keyword to specify source or destination addresses in crypto access
lists because they cause problems. We strongly discourage the permit any any command statement
because it does the following:
•

Protects all outbound traffic, including all protected traffic sent to the peer specified in the
corresponding crypto map.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-28

Chapter 64

Configuring IPsec and ISAKMP
Configuring IPsec

•

Requires protection for all inbound traffic.
In this scenario, the ASA silently drops all inbound packets that lack IPsec protection.

Be sure that you define which packets to protect. If you use the any keyword in a permit statement,
preface it with a series of deny statements to filter out traffic that would otherwise fall within that permit
statement that you do not want to protect.

Note

Decrypted through traffic is permitted from the client despite having an access group on the outside
interface, which calls a deny ip any any access-list, while no sysopt connection permit-vpn is
configured.
Users who want to control access to the protected network via site-to-site or remote access VPN using
the no sysopt permit command in conjunction with an access control list (ACL) on the outside interface
are not successful.
In this situation, when management-access inside is enabled, the ACL is not applied, and users can still
connect using SSH to the security appliance. Traffic to hosts on the inside network are blocked correctly
by the ACL, but cannot block decrypted through traffic to the inside interface.
The ssh and http commands are of a higher priority than the ACLs. In other words, to deny SSH, Telnet,
or ICMP traffic to the device from the VPN session, use ssh, telnet and icmp commands, which deny
the IP local pool should be added.

Changing IPsec SA Lifetimes
You can change the global lifetime values that the ASA uses when negotiating new IPsec SAs. You can
override these global lifetime values for a particular crypto map.
IPsec SAs use a derived, shared, secret key. The key is an integral part of the SA; the keys time out
together to require the key to refresh. Each SA has two lifetimes: timed and traffic-volume. An SA
expires after the respective lifetime and negotiations begin for a new one. The default lifetimes are
28,800 seconds (eight hours) and 4,608,000 kilobytes (10 megabytes per second for one hour).
If you change a global lifetime, the ASA drops the tunnel. It uses the new value in the negotiation of
subsequently established SAs.
When a crypto map does not have configured lifetime values and the ASA requests a new SA, it inserts
the global lifetime values used in the existing SA into the request sent to the peer. When a peer receives
a negotiation request, it uses the smaller of either the lifetime value the peer proposes or the locally
configured lifetime value as the lifetime of the new SA.
The peers negotiate a new SA before crossing the lifetime threshold of the existing SA to ensure that a
new SA is ready when the existing one expires. The peers negotiate a new SA when about 5 to 15 percent
of the lifetime of the existing SA remains.

Creating a Basic IPsec Configuration
You can create basic IPsec configurations with static or dynamic crypto maps.
To create a basic IPsec configuration using a static crypto map, perform the following steps:
Step 1

To create an access list to define the traffic to protect, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

64-29

Chapter 64

Configuring IPsec and ISAKMP

Configuring IPsec

access-list access-list-name {deny | permit} ip source source-netmask destination
destination-netmask

For example:
hostname(config)# access-list 101 permit ip 10.0.0.0 255.255.255.0 10.1.1.0 255.255.255.0

In this example, the permit keyword causes all traffic that matches the specified conditions to be
protected by crypto.
Step 2

To configure an IKEv1 transform set that defines how to protect the traffic, enter the following
command:
crypto ipsec ikev1 transform-set transform-set-name encryption [authentication]

For example:
hostname(config)# crypto ipsec ikev1 transform-set myset1 esp-des esp-sha-hmac
hostname(config)# crypto ipsec ikev1 transform-set myset2 esp-3des esp-sha-hmac
hostname(config)# crypto ipsec ikev1 transform-set aes_set esp-md5-hmac esp-aes-256

In this example, myset1 and myset2 and aes_set are the names of the transform sets.
To configure an IKEv2 proposal that also defines how to protect the traffic, enter the crypto ipsec ikev2
ipsec-proposal command to create the proposal and enter the ipsec proposal configuration mode where
you can specify multiple encryption and integrity types for the proposal:
crypto ipsec ikev2 ipsec-proposal [proposal tag]

For example:
hostname(config)# crypto ipsec ikev2 ipsec-proposal secure

In this example, secure is the name of the proposal. Enter a protocol and encryption types:
hostname(config-ipsec-proposal)# protocol esp encryption 3des aes des

Step 3

To create a crypto map, perform the following steps:
a.

Assign an access list to a crypto map:
crypto map map-name seq-num match address access-list-name

In the following example, mymap is the name of the crypto map set. The map set sequence number
10, which is used to rank multiple entries within one crypto map set. The lower the sequence
number, the higher the priority.
crypto map mymap 10 match address 101

In this example, the access list named 101 is assigned to crypto map mymap.
b.

Specify the peer to which the IPsec-protected traffic can be forwarded:
crypto map map-name seq-num set peer ip-address

For example:
crypto map mymap 10 set peer 192.168.1.100

The ASA sets up an SA with the peer assigned the IP address 192.168.1.100. Specify multiple peers
by repeating this command.
c.

Specify which IKEv1 transform sets or IKEv2 proposals are allowed for this crypto map. List
multiple transform sets or proposals in order of priority (highest priority first). You can specify up
to 11 transform sets or proposals in a crypto map using either of these two commands:

Cisco ASA 5500 Series Configuration Guide using the CLI

64-30

Chapter 64

Configuring IPsec and ISAKMP
Configuring IPsec

crypto map map-name seq-num set ikev1 transform-set transform-set-name1
[transform-set-name2, …transform-set-name11]
crypto map map-name seq-num set ikev2 ipsec-proposal proposal-name1
[proposal-name2, … proposal-name11]

For example (for IKEv1):
crypto map mymap 10 set ikev1 transform-set myset1 myset2

In this example, when traffic matches access list 101, the SA can use either myset1 (first priority)
or myset2 (second priority) depending on which transform set matches the transform set of the peer.
d.

(Optional) Specify an SA lifetime for the crypto map if you want to override the global lifetime.
crypto map map-name seq-num set security-association lifetime {seconds seconds |
kilobytes kilobytes}

For example:
crypto map mymap 10 set security-association lifetime seconds 2700

This example shortens the timed lifetime for the crypto map mymap 10 to 2700 seconds
(45 minutes). The traffic volume lifetime is not changed.
e.

(Optional) Specify that IPsec require perfect forward secrecy when requesting new SA for this
crypto map, or require PFS in requests received from the peer:
crypto map map-name seq-num set pfs [group1 | group2 | group5]

For example:
crypto map mymap 10 set pfs group2

This example requires PFS when negotiating a new SA for the crypto map mymap 10. The ASA uses
the 1024-bit Diffie-Hellman prime modulus group in the new SA.
Step 4

Apply a crypto map set to an interface for evaluating IPsec traffic:
crypto map map-name interface interface-name

For example:
crypto map mymap interface outside

In this example, the ASA evaluates the traffic going through the outside interface against the crypto map
mymap to determine whether it needs to be protected.

Using Dynamic Crypto Maps
A dynamic crypto map is a crypto map without all of the parameters configured. It acts as a policy
template where the missing parameters are later dynamically learned, as the result of an IPsec
negotiation, to match the peer requirements. The ASA applies a dynamic crypto map to let a peer
negotiate a tunnel if its IP address is not already identified in a static crypto map. This occurs with the
following types of peers:
•

Peers with dynamically assigned public IP addresses.
Both LAN-to-LAN and remote access peers can use DHCP to obtain a public IP address. The ASA
uses this address only to initiate the tunnel.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-31

Chapter 64

Configuring IPsec and ISAKMP

Configuring IPsec

•

Peers with dynamically assigned private IP addresses.
Peers requesting remote access tunnels typically have private IP addresses assigned by the headend.
Generally, LAN-to-LAN tunnels have a predetermined set of private networks that are used to
configure static maps and therefore used to establish IPsec SAs.

As an administrator configuring static crypto maps, you might not know the IP addresses that are
dynamically assigned (via DHCP or some other method), and you might not know the private IP
addresses of other clients, regardless of how they were assigned. VPN clients typically do not have static
IP addresses; they require a dynamic crypto map to allow IPsec negotiation to occur. For example, the
headend assigns the IP address to a Cisco VPN client during IKE negotiation, which the client then uses
to negotiate IPsec SAs.

Note

A dynamic crypto map requires only the transform-set parameter.
Dynamic crypto maps can ease IPsec configuration, and we recommend them for use in networks where
the peers are not always predetermined. Use dynamic crypto maps for Cisco VPN clients (such as mobile
users) and routers that obtain dynamically assigned IP addresses.

Tip

Use care when using the any keyword in permit entries in dynamic crypto maps. If the traffic covered
by such a permit entry could include multicast or broadcast traffic, insert deny entries for the
appropriate address range into the access list. Remember to insert deny entries for network and subnet
broadcast traffic, and for any other traffic that IPsec should not protect.
Dynamic crypto maps work only to negotiate SAs with remote peers that initiate the connection. The
ASA cannot use dynamic crypto maps to initiate connections to a remote peer. With a dynamic crypto
map, if outbound traffic matches a permit entry in an access list and the corresponding SA does not yet
exist, the ASA drops the traffic.
A crypto map set may include a dynamic crypto map. Dynamic crypto map sets should be the lowest
priority crypto maps in the crypto map set (that is, they should have the highest sequence numbers) so
that the ASA evaluates other crypto maps first. It examines the dynamic crypto map set only when the
other (static) map entries do not match.
Similar to static crypto map sets, a dynamic crypto map set consists of all of the dynamic crypto maps
with the same dynamic-map-name. The dynamic-seq-num differentiates the dynamic crypto maps in a
set. If you configure a dynamic crypto map, insert a permit ACL to identify the data flow of the IPsec
peer for the crypto access list. Otherwise the ASA accepts any data flow identity the peer proposes.

Caution

Do not assign module default routes for traffic to be tunneled to a ASA interface configured with a
dynamic crypto map set. To identify the traffic that should be tunneled, add the ACLs to the dynamic
crypto map. Use care to identify the proper address pools when configuring the ACLs associated with
remote access tunnels. Use Reverse Route Injection to install routes only after the tunnel is up.
The procedure for using a dynamic crypto map entry is the same as the basic configuration described in
“Creating a Basic IPsec Configuration,” except that instead of creating a static crypto map, you create a
dynamic crypto map entry. You can also combine static and dynamic map entries within a single crypto
map set.
Create a crypto dynamic map entry as follows:

Step 1

(Optional) Assign an access list to a dynamic crypto map:

Cisco ASA 5500 Series Configuration Guide using the CLI

64-32

Chapter 64

Configuring IPsec and ISAKMP
Configuring IPsec

crypto dynamic-map dynamic-map-name dynamic-seq-num match address access-list-name

This determines which traffic should be protected and not protected.
For example:
crypto dynamic-map dyn1 10 match address 101

In this example, access list 101 is assigned to dynamic crypto map dyn1. The map sequence number is
10.
Step 2

Specify which IKEv1 transform sets or IKEv2 proposals are allowed for this dynamic crypto map. List
multiple transform sets or proposals in order of priority (highest priority first) using the command for
IKEv1 transform sets or IKEv2 proposals:
crypto dynamic-map dynamic-map-name dynamic-seq-num set ikev1 transform-set
transform-set-name1, [transform-set-name2, …transform-set-name9]
crypto dynamic-map dynamic-map-name dynamic-seq-num set ikev2 ipsec-proposal
proposal-name1
[proposal-name2, … proposal-name11]

For example (for IKEv1):
crypto dynamic-map dyn 10 set ikev1 transform-set myset1 myset2

In this example, when traffic matches access list 101, the SA can use either myset1 (first priority) or
myset2 (second priority), depending on which transform set matches the transform sets of the peer.
Step 3

(Optional) Specify the SA lifetime for the crypto dynamic map entry if you want to override the global
lifetime value:
crypto dynamic-map dynamic-map-name dynamic-seq-num set security-association lifetime
{seconds seconds | kilobytes kilobytes}

For example:
crypto dynamic-map dyn1 10 set security-association lifetime seconds 2700

This example shortens the timed lifetime for dynamic crypto map dyn1 10 to 2700 seconds
(45 minutes). The time volume lifetime is not changed.
Step 4

(Optional) Specify that IPsec ask for PFS when requesting new SAs for this dynamic crypto map, or
should demand PFS in requests received from the peer:
crypto dynamic-map dynamic-map-name dynamic-seq-num set pfs [group1 | group2 | group5 |
group7]

For example:
crypto dynamic-map dyn1 10 set pfs group5

Step 5

Add the dynamic crypto map set into a static crypto map set.
Be sure to set the crypto maps referencing dynamic maps to be the lowest priority entries (highest
sequence numbers) in a crypto map set.
crypto map map-name seq-num ipsec-isakmp dynamic dynamic-map-name

For example:
crypto map mymap 200 ipsec-isakmp dynamic dyn1

Cisco ASA 5500 Series Configuration Guide using the CLI

64-33

Chapter 64

Configuring IPsec and ISAKMP

Clearing Security Associations

Providing Site-to-Site Redundancy
You can define multiple IKEv1 peers by using crypto maps to provide redundancy. This configuration is
useful for site-to-site VPNs. This feature is not supported with IKEv2.
If one peer fails, the ASA establishes a tunnel to the next peer associated with the crypto map. It sends
data to the peer that it has successfully negotiated with, and that peer becomes the active peer. The active
peer is the peer that the ASA keeps trying first for follow-on negotiations until a negotiation fails. At
that point the ASA goes on to the next peer. The ASA cycles back to the first peer when all peers
associated with the crypto map have failed.

Viewing an IPsec Configuration
Table 64-6 lists commands that you can enter to view information about your IPsec configuration.
Table 64-6

Commands to View IPsec Configuration Information

Command

Purpose

show running-configuration crypto

Displays the entire crypto configuration,
including IPsec, crypto maps, dynamic crypto
maps, and ISAKMP.

show running-config crypto ipsec

Displays the complete IPsec configuration.

show running-config crypto isakmp

Displays the complete ISAKMP configuration.

show running-config crypto map

Displays the complete crypto map configuration.

show running-config crypto dynamic-map

Displays the dynamic crypto map configuration.

show all crypto map

Displays all of the configuration parameters,
including those with default values.

Clearing Security Associations
Certain configuration changes take effect only during the negotiation of subsequent SAs. If you want the
new settings to take effect immediately, clear the existing SAs to reestablish them with the changed
configuration. If the ASA is actively processing IPsec traffic, clear only the portion of the SA database
that the configuration changes affect. Reserve clearing the full SA database for large-scale changes, or
when the ASA is processing a small amount of IPsec traffic.
Table 64-7 lists commands you can enter to clear and reinitialize IPsec SAs.
Table 64-7

Commands to Clear and Reinitialize IPsec SAs

Command

Purpose

clear configure crypto

Removes an entire crypto configuration, including IPsec,
crypto maps, dynamic crypto maps, and ISAKMP.

clear configure crypto ca trustpoint

Removes all trustpoints.

clear configure crypto dynamic-map

Removes all dynamic crypto maps. Includes keywords that
let you remove specific dynamic crypto maps.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-34

Chapter 64

Configuring IPsec and ISAKMP
Clearing Crypto Map Configurations

Table 64-7

Commands to Clear and Reinitialize IPsec SAs (continued)

Command

Purpose

clear configure crypto map

Removes all crypto maps. Includes keywords that let you
remove specific crypto maps.

clear configure crypto isakmp

Removes the entire ISAKMP configuration.

clear configure crypto isakmp policy

Removes all ISAKMP policies or a specific policy.

clear crypto isakmp sa

Removes the entire ISAKMP SA database.

Clearing Crypto Map Configurations
The clear configure crypto command includes arguments that let you remove elements of the crypto
configuration, including IPsec, crypto maps, dynamic crypto maps, CA trustpoints, all certificates,
certificate map configurations, and ISAKMP.
Be aware that if you enter the clear configure crypto command without arguments, you remove the
entire crypto configuration, including all certificates.
For more information, see the clear configure crypto command in the command reference.

Supporting the Nokia VPN Client
The ASA supports connections from Nokia VPN clients on Nokia 92xx Communicator series phones
using the Challenge/Response for Authenticated Cryptographic Keys (CRACK) protocol. CRACK is
ideal for mobile IPsec-enabled clients that use legacy authentication techniques instead of digital
certificates. It provides mutual authentication when the client uses a legacy-based secret-key
authentication technique such as RADIUS and the gateway uses public-key authentication.
The Nokia back-end services must be in place to support both Nokia clients and the CRACK protocol.
This requirement includes the Nokia Security Services Manager (NSSM) and Nokia databases as shown
in Figure 64-5.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-35

Chapter 64

Configuring IPsec and ISAKMP

Supporting the Nokia VPN Client

Nokia 92xx Communicator Service Requirement

Remote Access

DMZ
Firewall/
VPN
gateway

Internet

SSM server
and database

SSM
enrollment
gateway

Operator
mobile
network

SSM
management
station
Nokia SSM
Web server

Windows Clients/ Mobile Devices/
Mobile Devices
Laptop Policy
Policy
Telecommuters

RADIUS or
LDAP server
SAP
database
Corporate
E-mail
Corporate
Web services

132777

Figure 64-5

To support the Nokia VPN client, perform the following step on the ASA:
•

Enable CRACK authentication using the crypto isakmp policy priority authentication command
with the crack keyword in global configuration mode. For example:
hostname(config)# crypto isakmp policy 2
hostname(config-isakmp-policy)# authentication crack

If you are using digital certificates for client authentication, perform the following additional steps:
Step 1

Configure the trustpoint and remove the requirement for a fully qualified domain name. The trustpoint
might be NSSM or some other CA. In this example, the trustpoint is named CompanyVPNCA:
hostname(config)# crypto ca trustpoint CompanyVPNCA
hostname(config-ca-trustpoint)# fqdn none

Step 2

To configure the identity of the ISAKMP peer, perform one of the following steps:
•

Use the crypto isakmp identity command with the hostname keyword. For example:
hostname(config)# crypto isakmp identity hostname

•

Use the crypto isakmp identity command with the auto keyword to configure the identity to be
automatically determined from the connection type. For example:
hostname(config)# crypto isakmp identity auto

Note

If you use the crypto isakmp identity auto command, you must be sure that the DN attribute
order in the client certificate is CN, OU, O, C, St, L.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-36

Chapter 64

Configuring IPsec and ISAKMP
Supporting the Nokia VPN Client

To learn more about the Nokia services required to support the CRACK protocol on Nokia clients, and
to ensure they are installed and configured properly, contact your local Nokia representative.

Cisco ASA 5500 Series Configuration Guide using the CLI

64-37

Chapter 64
Supporting the Nokia VPN Client

Cisco ASA 5500 Series Configuration Guide using the CLI

64-38

Configuring IPsec and ISAKMP

CH A P T E R

65

Configuring L2TP over IPsec
This chapter describes how to configure L2TP over IPsec/IKEv1 on the ASA. This chapter includes the
following topics:
•

Information About L2TP over IPsec/IKEv1, page 65-1

•

Licensing Requirements for L2TP over IPsec, page 65-3

•

Guidelines and Limitations, page 65-7

•

Configuring L2TP over IPsec, page 65-8

•

Feature History for L2TP over IPsec, page 65-18

Information About L2TP over IPsec/IKEv1
Layer 2 Tunneling Protocol (L2TP) is a VPN tunneling protocol that allows remote clients to use the public
IP network to securely communicate with private corporate network servers. L2TP uses PPP over UDP (port
1701) to tunnel the data.
L2TP protocol is based on the client/server model. The function is divided between the L2TP Network
Server (LNS), and the L2TP Access Concentrator (LAC). The LNS typically runs on a network gateway
such as a router, while the LAC can be a dial-up Network Access Server (NAS) or an endpoint device with a
bundled L2TP client such as Microsoft Windows, Apple iPhone, or Android.
The primary benefit of configuring L2TP with IPsec/IKEv1 in a remote access scenario is that remote
users can access a VPN over a public IP network without a gateway or a dedicated line, which enables
remote access from virtually anyplace with POTS. An additional benefit is that no additional client
software, such as Cisco VPN client software, is required.

Note

L2TP over IPsec supports only IKEv1. IKEv2 is not supported.
The configuration of L2TP with IPsec/IKEv1 supports certificates using the preshared keys or RSA
signature methods, and the use of dynamic (as opposed to static) crypto maps. This summary of tasks
assumes completion of IKEv1, as well as pre-shared keys or RSA signature configuration. See
Chapter 41, “Configuring Digital Certificates,” for the steps to configure preshared keys, RSA, and
dynamic crypto maps.

Note

L2TP with IPsec on the ASA allows the LNS to interoperate with native VPN clients integrated in such
operating systems as Windows, MAC OS X, Android, and Cisco IOS. Only L2TP with IPsec is
supported, native L2TP itself is not supported on ASA.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-1

Chapter 65

Configuring L2TP over IPsec

Information About L2TP over IPsec/IKEv1

The minimum IPsec security association lifetime supported by the Windows client is 300 seconds. If the
lifetime on the ASA is set to less than 300 seconds, the Windows client ignores it and replaces it with a
300 second lifetime.

IPsec Transport and Tunnel Modes
By default, the ASA uses IPsec tunnel mode—the entire original IP datagram is encrypted, and it
becomes the payload in a new IP packet. This mode allows a network device, such as a router, to act as
an IPsec proxy. That is, the router performs encryption on behalf of the hosts. The source router encrypts
packets and forwards them along the IPsec tunnel. The destination router decrypts the original IP
datagram and forwards it on to the destination system. The major advantage of tunnel mode is that the
end systems do not need to be modified to receive the benefits of IPsec. Tunnel mode also protects
against traffic analysis; with tunnel mode, an attacker can only determine the tunnel endpoints and not
the true source and destination of the tunneled packets, even if they are the same as the tunnel endpoints.
However, the Windows L2TP/IPsec client uses IPsec transport mode—only the IP payload is encrypted,
and the original IP headers are left intact. This mode has the advantages of adding only a few bytes to
each packet and allowing devices on the public network to see the final source and destination of the
packet. Figure 65-1 illustrates the differences between IPsec tunnel and transport modes.
In order for Windows L2TP and IPsec clients to connect to the ASA, you must configure IPsec transport
mode for a transform set using the crypto ipsec transform-set trans_name mode transport command.
This command is used in the configuration procedure.
With this transport capability, you can enable special processing (for example, QoS) on the intermediate
network based on the information in the IP header. However, the Layer 4 header is encrypted, which
limits the examination of the packet. Unfortunately, if the IP header is transmitted in clear text, transport
mode allows an attacker to perform some traffic analysis.
Figure 65-1

IPsec in Tunnel and Transport Modes

IP HDR

Tunnel mode

Data

Encrypted

IP HDR

IP HDR

Data

23246

New IP HDR IPSec HDR

Data

Transport mode
IP HDR

IPSec HDR

Data
Encrypted

Cisco ASA 5500 Series Configuration Guide using the CLI

65-2

Chapter 65

Configuring L2TP over IPsec
Licensing Requirements for L2TP over IPsec

Licensing Requirements for L2TP over IPsec
The following table shows the licensing requirements for this feature:

Note

Model
ASA 5505

This feature is not available on No Payload Encryption models.

License Requirement1
•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license and Security Plus license: 2 sessions.
Optional permanent or time-based licenses: 10 or 25 sessions.
Shared licenses are not supported.2
– AnyConnect Essentials license3: 25 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
– Base license: 10 sessions.
– Security Plus license: 25 sessions.

ASA 5510

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base and Security Plus license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 250 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license and Security Plus license: 250 sessions.

ASA 5520

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, or 750 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 750 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 750 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-3

Chapter 65

Configuring L2TP over IPsec

Licensing Requirements for L2TP over IPsec

Model
ASA 5540

License Requirement1
•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, or 2500
sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 2500 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 2500 sessions.

ASA 5550

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 5000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 5000 sessions.

ASA 5580

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, 5000,
or 10000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 10000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 10000 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-4

Chapter 65

Configuring L2TP over IPsec
Licensing Requirements for L2TP over IPsec

Model
ASA 5512-X

License Requirement1
•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 250 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 250 sessions.

ASA 5515-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 250 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 250 sessions.

ASA 5525-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, or 750 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 750 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 750 sessions.

ASA 5545-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, or 2500
sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 2500 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 2500 sessions.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-5

Chapter 65

Configuring L2TP over IPsec

Licensing Requirements for L2TP over IPsec

License Requirement1

Model
ASA 5555-X

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 5000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 5000 sessions.

ASA 5585-X with
SSP-10

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 5000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 5000 sessions.

ASA 5585-X with
SSP-20, -40, and -60

•

IPsec remote access VPN using IKEv2 (use one of the following):
– AnyConnect Premium license:

Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, 5000,
or 10000 sessions.
Optional Shared licenses2: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
– AnyConnect Essentials license3: 10000 sessions.
•

IPsec remote access VPN using IKEv1 and IPsec site-to-site VPN using IKEv1 or IKEv2:
Base license: 10000 sessions.

1. The maximum combined VPN sessions of all types cannot exceed the maximum sessions shown in this table. For the ASA 5505, the maximum combined
sessions is 10 for the Base license, and 25 for the Security Plus license.
2. A shared license lets the ASA act as a shared license server for multiple client ASAs. The shared license pool is large, but the maximum number of sessions
used by each individual ASA cannot exceed the maximum number listed for permanent licenses.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-6

Chapter 65

Configuring L2TP over IPsec
Prerequisites for Configuring L2TP over IPsec

3. The AnyConnect Essentials 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 SSL VPN Edition
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 no anyconnect-essentials command.
For a detailed list of the features supported by the AnyConnect Essentials license and AnyConnect Premium license, see AnyConnect Secure Mobility
Client Features, Licenses, and OSs:
http://www.cisco.com/en/US/products/ps10884/products_feature_guides_list.html

Prerequisites for Configuring L2TP over IPsec
Configuring L2TP over IPsec has the following prerequisites:
•

You can configure the default group policy (DfltGrpPolicy) or a user-defined group policy for
L2TP/IPsec connections. In either case, the group policy must be configured to use the L2TP/IPsec
tunneling protocol. If the L2TP/IPsec tunning protocol is not configured for your user-defined group
policy, configure the DfltGrpPolicy for the L2TP/IPsec tunning protocol and allow your
user-defined group policy to inherit this attribute.

•

You need to configure the default connection proflie (tunnel group), DefaultRAGroup, if you are
performing “pre-shared key” authentication. If you are performing certificate-based authentication,
you can use a user-defined connection profile that can be chosen based on certificate identifiers.

•

IP connectivity needs to be established between the peers. To test connectivity, try to ping the IP
address of the ASA from your endpoint and try to ping the IP address of your endpoint from the
ASA.

•

Make sure that UDP port 1701 is not blocked anywhere along the path of the connection.

•

If a Windows 7 endpoint device authenticates using a certificate that specifies a SHA signature type,
the signature type must match that of the ASA, either SHA1 or SHA2.

Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines

Supported in single context mode. Multiple context mode is not supported.
Firewall Mode Guidelines

Supported only in routed firewall mode. Transparent mode is not supported.
Failover Guidelines

L2TP over IPsec sessions are not supported by stateful failover.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-7

Chapter 65

Configuring L2TP over IPsec

Configuring L2TP over IPsec

IPv6 Guidelines

There is no native IPv6 tunnel setup support for L2TP over IPsec.
Authentication Guidelines

The ASA only supports the PPP authentications PAP and Microsoft CHAP, Versions 1 and 2, on the local
database. EAP and CHAP are performed by proxy authentication servers. Therefore, if a remote user
belongs to a tunnel group configured with the authentication eap-proxy or authentication chap
commands, and the ASA is configured to use the local database, that user will not be able to connect.
Supported PPP Authentication Types

L2TP over IPsec connections on the ASA support only the PPP authentication types shown in
Table 65-1.
Table 65-1

AAA Server Support and PPP Authentication Types

AAA Server Type

Supported PPP Authentication Types

LOCAL

PAP, MSCHAPv1, MSCHAPv2

RADIUS

PAP, CHAP, MSCHAPv1, MSCHAPv2, EAP-Proxy

TACACS+

PAP, CHAP, MSCHAPv1

LDAP

PAP

NT

PAP

Kerberos

PAP

SDI

SDI

Table 65-1

PPP Authentication Type Characteristics

Keyword

Authentication Type Characteristics

chap

CHAP

In response to the server challenge, the client returns the encrypted
[challenge plus password] with a cleartext username. This protocol
is more secure than the PAP, but it does not encrypt data.

eap-proxy

EAP

Enables EAP which permits the security appliance to proxy the
PPP authentication process to an external RADIUS authentication
server.

ms-chap-v1
ms-chap-v2

Microsoft CHAP,
Version 1

Similar to CHAP but more secure in that the server stores and
compares only encrypted passwords rather than cleartext
passwords as in CHAP. This protocol also generates a key for data
encryption by MPPE.

Microsoft CHAP,
Version, 2
pap

PAP

Passes cleartext username and password during authentication and
is not secure.

Configuring L2TP over IPsec
This section provides the required ASA IKEv1 (ISAKMP) policy settings that allow native VPN clients,
integrated with the operating system on an endpoint, to make a VPN connection to the ASA using L2TP
over IPsec protocol.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-8

Chapter 65

Configuring L2TP over IPsec
Configuring L2TP over IPsec

•

IKEv1 phase 1—3DES encryption with SHA1 hash method.

•

IPsec phase 2—3DES or AES encryption with MD5 or SHA hash method.

•

PPP Authentication—PAP, MS-CHAPv1, or MSCHAPv2 (preferred).

•

Pre-shared key (only for iPhone).

Detailed CLI Configuration Steps

Step 1

Command

Purpose

crypto ipsec transform-set transform_name
ESP_Encryption_Type ESP_Authentication_Type

Creates a transform set with a specific ESP
encryption type and authentication type.

Example:
hostname(config)# crypto ipsec transform-set
my-transform-set esp-des esp-sha-hmac

Step 2

crypto ipsec transform-set trans_name mode transport

Instructs IPsec to use transport mode rather
than tunnel mode.

Example:
hostname(config)# crypto ipsec transform-set
my-transform-set mode transport

Step 3

Specifies L2TP/IPsec as the vpn tunneling
protocol.

vpn-tunnel-protocol tunneling_protocol

Example:
hostname(config)# group-policy DfltGrpPolicy attributes
hostname(config-group-policy)# vpn-tunnel-protocol
l2tp-ipsec

Step 4

(Optional) Instructs the adaptive security
appliance to send DNS server IP addresses
to the client for the group policy.

dns value [none | IP_primary [IP_secondary]

Example:
hostname(config)# group-policy DfltGrpPolicy attributes
hostname(config-group-policy)# dns value 209.165.201.1
209.165.201.2

Step 5

wins-server value [none | IP_primary [IP_secondary]]

Example:

(Optional) Instructs the adaptive security
appliance to send WINS server IP addresses
to the client for the group policy.

hostname(config)# group-policy DfltGrpPolicy attributes
hostname (config-group-policy)# wins-server value
209.165.201.3 209.165.201.4

Step 6

tunnel-group name type remote-access

Creates a connection profile (tunnel group).

Example:
hostname(config)# tunnel-group sales-tunnel type
remote-access

Cisco ASA 5500 Series Configuration Guide using the CLI

65-9

Chapter 65

Configuring L2TP over IPsec

Configuring L2TP over IPsec

Step 7

Command

Purpose

default-group-policy name

Links the name of a group policy to the
connection profile (tunnel group).

Example:
hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# default-group-policy
DfltGrpPolicy

Step 8

ip local pool pool_name starting_address-ending_address
mask subnet_mask

(Optional) Creates an IP address pool.

Example:
hostname(config)# ip local pool sales_addresses
10.4.5.10-10.4.5.20 mask 255.255.255.0

Step 9

address-pool pool_name

Example:

(Optional) Associates the pool of IP
addresses with the connection profile
(tunnel group).

hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# address-pool
sales_addresses

Step 10

authentication-server-group server_group

Example:
hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# authentication-server-group
sales_server LOCAL

Step 11

authentication auth_type

Example:
hostname(config)# tunnel-group name ppp-attributes
hostname(config-ppp)# authentication ms-chap-v1

Step 12

tunnel-group tunnel group name ipsec-attributes

Specifies a method to authenticate users
attempting L2TP over IPsec connections,
for the connection profile (tunnel group). If
you are not using the ASA to perform local
authentication, and you want to fallback to
local authentication, add LOCAL to the end
of the command.
Specifies the PPP authentication protocol
for the tunnel group. See Table 65-1 for the
types of PPP authencation and their
characteristics.
Sets the pre-shared key for your connection
profile (tunnel group).

Example:
hostname(config)# tunnel-group DefaultRAGroup
ipsec-attributes
hostname(config-tunnel-ipsec)# pre-shared-key cisco123

Step 13

accounting-server-group aaa_server_group

Example:
hostname(config)# tunnel-group sales_tunnel
general-attributes
hostname(config-tunnel-general)# accounting-server-group
sales_aaa_server

Cisco ASA 5500 Series Configuration Guide using the CLI

65-10

(Optional) Generates a AAA accounting
start and stop record for an L2TP session for
the connection profile (tunnel group).

Chapter 65

Configuring L2TP over IPsec
Configuring L2TP over IPsec

Step 14

Command

Purpose

l2tp tunnel hello seconds

Configures the interval (in seconds)
between hello messages. The range is 10
through 300 seconds. The default is 60
seconds.

Example:
hostname(config)# l2tp tunnel hello 100

Step 15

(Optional) Enables NAT traversal so that
ESP packets can pass through one or more
NAT devices.

crypto isakmp nat-traversal seconds

Example:

If you expect multiple L2TP clients behind
a NAT device to attempt L2TP over IPsec
connections to the adaptive security
appliance, you must enable NAT traversal.

hostname(config)# crypto isakmp enable
hostname(config)# crypto isakmp nat-traversal 1500

To enable NAT traversal globally, check that
ISAKMP is enabled (you can enable it with
the crypto isakmp enable command) in
global configuration mode, and then use the
crypto isakmp nat-traversal command.
Step 16

(Optional) Configures tunnel group
switching. The goal of tunnel group
switching is to give users a better chance at
establishing a VPN connection when they
authenticate using a proxy authentication
server. Tunnel group is synonymous with
connection profile.

strip-group
strip-realm

Example:
hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# strip-group
hostname(config-tunnel-general)# strip-realm

Step 17

username name password password mschap

Example:
hostname(config)# username jdoe password j!doe1 mschap

This example shows creating a user with the
username jdoe, the password j!doe1. The
mschap option specifies that the password is
converted to Unicode and hashed using
MD4 after you enter it.
This step is needed only if you are using a
local user database.

Step 18

crypto isakmp policy priority

Example:
hostname(config)# crypto isakmp policy 5

The crypto isakmp policy command creates
the IKE Policy for Phsase 1 and assigns it a
number. There are several different
configurable parameters of the IKE policy
that you can configure.
The isakamp policy is needed so the ASA
can complete the IKE negotiation.
See the “Creating IKE Policies to Respond
to Windows 7 Proposals” section on
page 65-12 for configuration examples for
Windows 7 native VPN clients.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-11

Chapter 65

Configuring L2TP over IPsec

Configuring L2TP over IPsec

Creating IKE Policies to Respond to Windows 7 Proposals
Windows 7 L2TP/IPsec clients send several IKE policy proposals to establish a VPN connection with
the ASA. Define one of the following IKE policies to facilitate connections from Windows 7 VPN native
clients.
Command

Purpose

Step 1

Detailed CLI Configuration Steps, page 65-9

Follow the Detailed CLI Configuration
Steps procedure through step Step 18. Add
the additional steps in this table to configure
the IKE policy for Windows 7 native VPN
clients.

Step 1

show run crypto isakmp

Displays the attributes and the number of
any existing IKE policies.

Example:
hostname(config)# show run crypto isakmp

Step 2

crypto isakmp policy number

Example:
hostname(config)# crypto isakmp policy number
hostname(config-isakmp-policy)#

Step 3

authentication

Example:

Allows you to configure an IKE policy. The
number argument specifies the number of
the IKE policy you are configuring. This
number was listed in the output of the show
run crypto isakmp command.
Sets the authentication method the ASA
uses to establish the identity of each IPsec
peer to use preshared keys.

hostname(config-isakmp-policy)# authentication pre-share

Step 4

encryption type

Example:
hostname(config-isakmp-policy)# encryption
{3des|aes|aes-256}

Step 5

hash

Example:

Choose a symmetric encryption method that
protects data transmitted between two IPsec
peers. For Windows 7 choose either 3des,
aes, for 128-bit AES, or aes-256.
Choose the hash algorithm that ensures data
integrity. For Windows 7, specify sha for the
SHA-1 algorithm.

hostname(config-isakmp-policy)# hash sha

Step 6

group

Example:

Choose the Diffie-Hellman group identifier.
For Windows 7, specify 5 for the 1536-bit
Diffie-Hellman group.

hostname(config-isakmp-policy)# group 5

Step 7

lifetime

Example:
hostname(config-isakmp-policy)# lifetime 86400

Cisco ASA 5500 Series Configuration Guide using the CLI

65-12

Specify the SA lifetime in seconds. For
Windows 7, specify 86400 seconds to
represent 24 hours.

Chapter 65

Configuring L2TP over IPsec
Configuring L2TP over IPsec

Detailed CLI Configuration Steps

Step 1

Command

Purpose

crypto ipsec ike_version transform-set transform_name
ESP_Encryption_Type ESP_Authentication_Type

Creates a transform set with a specific ESP
encryption type and authentication type.

Example:
crypto ipsec ikev1 transform-set my-transform-set-ikev1
esp-des esp-sha-hmac

Step 2

crypto ipsec ike_version transform-set trans_name mode
transport

Instructs IPsec to use transport mode rather
than tunnel mode.

Example:
crypto ipsec ikev1 transform-set my-transform-set-ikev1
mode transport

Step 3

Specifies L2TP/IPsec as the vpn tunneling
protocol.

vpn-tunnel-protocol tunneling_protocol

Example:
hostname(config)# group-policy DfltGrpPolicy attributes
hostname(config-group-policy)# vpn-tunnel-protocol
l2tp-ipsec

Step 4

(Optional) Instructs the adaptive security
appliance to send DNS server IP addresses
to the client for the group policy.

dns value [none | IP_primary [IP_secondary]

Example:
hostname(config)# group-policy DfltGrpPolicy attributes
hostname(config-group-policy)# dns value 209.165.201.1
209.165.201.2

Step 5

wins-server value [none | IP_primary [IP_secondary]]

Example:

(Optional) Instructs the adaptive security
appliance to send WINS server IP addresses
to the client for the group policy.

hostname(config)# group-policy DfltGrpPolicy attributes
hostname (config-group-policy)# wins-server value
209.165.201.3 209.165.201.4

Step 6

ip local pool pool_name starting_address-ending_address

(Optional) Creates an IP address pool.

mask subnet_mask

Example:
hostname(config)# ip local pool sales_addresses
10.4.5.10-10.4.5.20 mask 255.255.255.0

Step 7

address-pool pool_name

Example:

(Optional) Associates the pool of IP
addresses with the connection profile
(tunnel group).

hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# address-pool
sales_addresses

Cisco ASA 5500 Series Configuration Guide using the CLI

65-13

Chapter 65

Configuring L2TP over IPsec

Configuring L2TP over IPsec

Step 8

Command

Purpose

tunnel-group name type remote-access

Creates a connection profile (tunnel group).

Example:
hostname(config)# tunnel-group sales-tunnel type
remote-access

Step 9

default-group-policy name

Links the name of a group policy to the
connection profile (tunnel group).

Example:
hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# default-group-policy
DfltGrpPolicy

Step 10

authentication-server-group server_group [local]

Example:
hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# authentication-server-group
sales_server LOCAL

Step 11

authentication auth_type

Example:
hostname(config)# tunnel-group name ppp-attributes
hostname(config-ppp)# authentication ms-chap-v1

Step 12

tunnel-group tunnel group name ipsec-attributes

Specifies a method to authenticate users
attempting L2TP over IPsec connections,
for the connection profile (tunnel group). If
you are not using the ASA to perform local
authentication, and you want to fallback to
local authentication, add LOCAL to the end
of the command.
Specifies the PPP authentication protocol
for the tunnel group. See Table 65-1 for the
types of PPP authencation and their
characteristics.
Sets the pre-shared key for your connection
profile (tunnel group).

Example:
hostname(config)# tunnel-group DefaultRAGroup
ipsec-attributes
hostname(config-tunnel-ipsec)# ikev1 pre-shared-key cisco123

Step 13

accounting-server-group aaa_server_group

Example:

(Optional) Generates a AAA accounting
start and stop record for an L2TP session for
the connection profile (tunnel group).

hostname(config)# tunnel-group sales_tunnel
general-attributes
hostname(config-tunnel-general)# accounting-server-group
sales_aaa_server

Step 14

l2tp tunnel hello seconds

Example:
hostname(config)# l2tp tunnel hello 100

Cisco ASA 5500 Series Configuration Guide using the CLI

65-14

Configures the interval (in seconds)
between hello messages. The range is 10
through 300 seconds. The default interval is
60 seconds.

Chapter 65

Configuring L2TP over IPsec
Configuring L2TP over IPsec

Step 15

Command

Purpose

crypto isakmp nat-traversal seconds

(Optional) Enables NAT traversal so that
ESP packets can pass through one or more
NAT devices.

Example:

If you expect multiple L2TP clients behind
a NAT device to attempt L2TP over IPsec
connections to the adaptive security
appliance, you must enable NAT traversal.

hostname(config)# crypto isakmp enable
hostname(config)# crypto isakmp nat-traversal 1500

To enable NAT traversal globally, check that
ISAKMP is enabled (you can enable it with
the crypto isakmp enable command) in
global configuration mode, and then use the
crypto isakmp nat-traversal command.
Step 16

(Optional) Configures tunnel group
switching. The goal of tunnel group
switching is to give users a better chance at
establishing a VPN connection when they
authenticate using a proxy authentication
server. Tunnel group is synonymous with
connection profile.

strip-group
strip-realm

Example:
hostname(config)# tunnel-group DefaultRAGroup
general-attributes
hostname(config-tunnel-general)# strip-group
hostname(config-tunnel-general)# strip-realm

Step 17

username name password password mschap

Example:
asa2(config)# username jdoe password j!doe1 mschap

This example shows creating a user with the
username jdoe, the password j!doe1. The
mschap option specifies that the password is
converted to Unicode and hashed using
MD4 after you enter it.
This step is needed only if you are using a
local user database.

Step 18

crypto ikev1 policy priority
group Diffie-Hellman Group

Example:
hostname(config)# crypto ikev1 policy 5
hostname(config-ikev1-policy)# group 5

The crypto isakmp policy command creates
the IKE Policy for Phase 1 and assigns it a
number. There are several different
configurable parameters of the IKE policy
that you can configure.
You can also specify a Diffie-Hellman
Group for the policy.
The isakamp policy is needed so the ASA
can complete the IKE negotiation.
See the “Creating IKE Policies to Respond
to Windows 7 Proposals” section on
page 65-16 for configuration examples for
Windows 7 native VPN clients.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-15

Chapter 65

Configuring L2TP over IPsec

Configuring L2TP over IPsec

Creating IKE Policies to Respond to Windows 7 Proposals
Windows 7 L2TP/IPsec clients send several IKE policy proposals to establish a VPN connection with
the ASA. Define one of the following IKE policies to facilitate connections from Windows 7 VPN native
clients.
Command

Purpose

Step 1

Detailed CLI Configuration Steps, page 65-13

Follow the Detailed CLI Configuration
Steps procedure through step Step 18. Add
the additional steps in this table to configure
the IKE policy for Windows 7 native VPN
clients.

Step 1

show run crypto ikev1

Displays the attributes and the number of
any existing IKE policies.

Example:
hostname(config)# show run crypto ikev1

Step 2

crypto ikev1 policy number

Example:
hostname(config)# crypto ikev1 policy number
hostname(config-ikev1-policy)#

Step 3

authentication

Example:

Allows you to configure an IKE policy. The
number argument specifies the number of
the IKE policy you are configuring. This
number was listed in the output of the show
run crypto ikev1 command.
Sets the authentication method the ASA
uses to establish the identity of each IPsec
peer to use preshared keys.

hostname(config-ikev1-policy)# authentication pre-share

Step 4

encryption type

Example:
hostname(config-ikev1-policy)# encryption
{3des|aes|aes-256}

Step 5

hash

Example:

Choose a symmetric encryption method that
protects data transmitted between two IPsec
peers. For Windows 7 choose either 3des,
aes, for 128-bit AES, or aes-256.
Choose the hash algorithm that ensures data
integrity. For Windows 7, specify sha for the
SHA-1 algorithm.

hostname(config-ikev1-policy)# hash sha

Step 6

group

Example:
hostname(config-ikev1-policy)# group 5

Step 7

lifetime

Example:
hostname(config-ikev1-policy)# lifetime 86400

Cisco ASA 5500 Series Configuration Guide using the CLI

65-16

Choose the Diffie-Hellman group identifier.
You can specify 5 for aes, aes-256, or 3des
encryption types. You can specify 2 only for
3des encryption types.
Specify the SA lifetime in seconds. For
Windows 7, specify 86400 seconds to
represent 24 hours.

Chapter 65

Configuring L2TP over IPsec
Configuring L2TP over IPsec

Configuration Example for L2TP over IPsec Using ASA 8.2.5
The following example shows configuration file commands that ensure ASA compatibility with a native
VPN client on any operating system:
ip local pool sales_addresses 209.165.202.129-209.165.202.158
group-policy sales_policy internal
group-policy sales_policy attributes
wins-server value 209.165.201.3 209.165.201.4
dns-server value 209.165.201.1 209.165.201.2
vpn-tunnel-protocol l2tp-ipsec
tunnel-group DefaultRAGroup general-attributes
default-group-policy sales_policy
address-pool sales_addresses
tunnel-group DefaultRAGroup ipsec-attributes
pre-shared-key *
tunnel-group DefaultRAGroup ppp-attributes
no authentication pap
authentication chap
authentication ms-chap-v1
authentication ms-chap-v2
crypto ipsec transform-set trans esp-3des esp-sha-hmac
crypto ipsec transform-set trans mode transport
crypto dynamic-map dyno 10 set transform-set set trans
crypto map vpn 20 ipsec-isakmp dynamic dyno
crypto map vpn interface outside
crypto isakmp enable outside
crypto isakmp policy 10
authentication pre-share
encryption 3des
hash sha
group 2
lifetime 86400

Configuration Example for L2TP over IPsec Using ASA 8.4.1 and later
The following example shows configuration file commands that ensure ASA compatibility with a native
VPN client on any operating system:
ip local pool sales_addresses 209.165.202.129-209.165.202.158
group-policy sales_policy internal
group-policy sales_policy attributes
wins-server value 209.165.201.3 209.165.201.4
dns-server value 209.165.201.1 209.165.201.2
vpn-tunnel-protocol l2tp-ipsec
tunnel-group DefaultRAGroup general-attributes
default-group-policy sales_policy
address-pool sales_addresses
tunnel-group DefaultRAGroup ipsec-attributes
pre-shared-key *
tunnel-group DefaultRAGroup ppp-attributes
no authentication pap
authentication chap
authentication ms-chap-v1
authentication ms-chap-v2
crypto ipsec ikev1 transform-set my-transform-set-ikev1 esp-des esp-sha-hmac
crypto ipsec ikev1 transform-set my-transform-set-ikev1 mode transport
crypto dynamic-map dyno 10 set ikev1 transform-set trans
crypto map vpn 20 ipsec-isakmp dynamic dyno

Cisco ASA 5500 Series Configuration Guide using the CLI

65-17

Chapter 65

Configuring L2TP over IPsec

Feature History for L2TP over IPsec

crypto map vpn interface outside
crypto ikev1 enable outside
crypto ikev1 policy 10
authentication pre-share
encryption 3des
hash sha
group 2
lifetime 86400

Feature History for L2TP over IPsec
Table 65-2 lists the release history for this feature.
Table 65-2

Feature History for L2TP over IPsec

Feature Name
L2TP over IPsec

Releases

Feature Information

7.2(1)

L2TP over IPsec provides the capability to deploy and administer an L2TP
VPN solution alongside the IPsec VPN and firewall services in a single
platform.
The primary benefit of configuring L2TP over IPsec in a remote access
scenario is that remote users can access a VPN over a public IP network
without a gateway or a dedicated line, which enables remote access from
virtually anyplace with POTS. An additional benefit is that the only client
requirement for VPN access is the use of Windows with Microsoft Dial-Up
Networking (DUN). No additional client software, such as Cisco VPN client
software, is required.
The following commands were introduced or modified: authentication
eap-proxy, authentication ms-chap-v1, authentication ms-chap-v2,
authentication pap, l2tp tunnel hello, vpn-tunnel-protocol l2tp-ipsec.

Cisco ASA 5500 Series Configuration Guide using the CLI

65-18

CH A P T E R

66

Setting General VPN Parameters
The ASA implementation of virtual private networking includes useful features that do not fit neatly into
categories. This chapter describes some of these features. It includes the following sections:

Note

•

Configuring VPNs in Single, Routed Mode, page 66-1

•

Configuring IPsec to Bypass ACLs, page 66-1

•

Permitting Intra-Interface Traffic (Hairpinning), page 66-2

•

Setting Maximum Active IPsec or SSL VPN Sessions, page 66-3

•

Using Client Update to Ensure Acceptable IPsec Client Revision Levels, page 66-4

•

Understanding Load Balancing, page 66-6

•

Configuring Load Balancing, page 66-11

•

Configuring VPN Session Limits, page 66-16

SSL VPN in this chapter refers to the SSL VPN client (AnyConnect 2.x or its predecessor, SVC 1.x),
unless clientless (browser-based) SSL VPN is specified.

Configuring VPNs in Single, Routed Mode
VPNs work only in single, routed mode. VPN functionality is unavailable in configurations that include
either security contexts, also referred to as multimode firewall, or Active/Active stateful failover.
The exception to this caveat is that you can configure and use one connection for administrative purposes
to (not through) the ASA in transparent mode.

Configuring IPsec to Bypass ACLs
To permit any packets that come from an IPsec tunnel without checking ACLs for the source and
destination interfaces, enter the sysopt connection permit-vpn command in global configuration mode.
You might want to bypass interface ACLs for IPsec traffic if you use a separate VPN concentrator behind
the ASA and want to maximize the ASA performance. Typically, you create an ACL that permits IPsec
packets by using the access-list command and apply it to the source interface. Using an ACL is more
secure because you can specify the exact traffic you want to allow through the ASA.
The syntax is sysopt connection permit-vpn. The command has no keywords or arguments.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-1

Chapter 66

Setting General VPN Parameters

Permitting Intra-Interface Traffic (Hairpinning)

The following example enables IPsec traffic through the ASA without checking ACLs:
hostname(config)# sysopt connection permit-vpn

Note

Decrypted through-traffic is permitted from the client despite having an access group on the outside
interface, which calls a deny ip any any access list, while no sysopt connection permit-vpn is
configured.
Users who want to control access to the protected network via site-to-site or remote access VPN using
the no sysopt permit-vpn command in conjunction with an access control list (ACL) on the outside
interface are not successful.
In this situation, when management-access inside is enabled, the ACL is not applied, and users can still
connect to the ASA using SSH. Traffic to hosts on the inside network is blocked correctly by the ACL,
but decrypted through-traffic to the inside interface is not blocked.
The ssh and http commands are of a higher priority than the ACLs. In other words, to deny SSH, Telnet,
or ICMP traffic to the box from the VPN session, use ssh, telnet and icmp commands.

Permitting Intra-Interface Traffic (Hairpinning)
The ASA includes a feature that lets a VPN client send IPsec-protected traffic to another VPN user by
allowing such traffic in and out of the same interface. Also called “hairpinning”, this feature can be
thought of as VPN spokes (clients) connecting through a VPN hub (ASA).
In another application, hairpinning can redirect incoming VPN traffic back out through the same
interface as unencrypted traffic. This would be useful, for example, to a VPN client that does not have
split tunneling but needs to both access a VPN and browse the web.
Figure 66-1 shows VPN Client 1 sending secure IPsec traffic to VPN Client 2 while also sending
unencrypted traffic to a public web server.
Figure 66-1

VPN Client Using Intra-Interface Feature for Hairpinning

Public web
server

Security
appliance

Client VPN
laptop 2

192.168.0.0
192.168.0.11

143170

Client VPN
laptop 1
Unencrypted traffic
Ipsec/SSL encrypted traffic

Cisco ASA 5500 Series Configuration Guide using the CLI

66-2

192.168.0.10

Chapter 66

Setting General VPN Parameters
Setting Maximum Active IPsec or SSL VPN Sessions

To configure this feature, use the same-security-traffic command in global configuration mode with its
intra-interface argument.
The command syntax is same-security-traffic permit {inter-interface | intra-interface}.
The following example shows how to enable intra-interface traffic:
hostname(config)# same-security-traffic permit intra-interface
hostname(config)#

Note

You use the same-security-traffic command, but with the inter-interface argument, to permit
communication between interfaces that have the same security level. This feature is not specific to IPsec
connections. For more information, see the “Configuring Interface Parameters” chapter of this guide.
To use hairpinning, you must apply the proper NAT rules to the ASA interface, as discussed in the
following section.

NAT Considerations for Intra-Interface Traffic
For the ASA to send unencrypted traffic back out through the interface, you must enable NAT for the
interface so that publicly routable addresses replace your private IP addresses (unless you already use
public IP addresses in your local IP address pool). The following example applies an interface PAT rule
to traffic sourced from the client IP pool:
hostname(config)# ip local pool clientpool 192.168.0.10-192.168.0.100
hostname(config)# object network vpn_nat
hostname(config-network-object)# subnet 192.168.0.0 255.255.255.0
hostname(config-network-object)# nat (outside,outside) interface

When the ASA sends encrypted VPN traffic back out this same interface, however, NAT is optional. The
VPN-to-VPN hairpinning works with or without NAT. To apply NAT to all outgoing traffic, implement
only the commands above. To exempt the VPN-to-VPN traffic from NAT, add commands (to the example
above) that implement NAT exemption for VPN-to-VPN traffic, such as:
hostname(config)# nat (outside,outside) source static vpn_nat vpn_nat destination static
vpn_nat vpn_nat

For more information on NAT rules, see the “Applying NAT” chapter of this guide.

Setting Maximum Active IPsec or SSL VPN Sessions
To limit VPN sessions to a lower value than the ASA allows, enter the vpn-sessiondb command in global
configuration mode:
vpn-sessiondb {max-anyconnect-premium-or-essentials-limit  |
max-other-vpn-limit }
The max-anyconnect-premium-or-essentials-limit keyword specifies the maximum number of
AnyConnect sessions, from 1 to the maximum sessions allowed by the license.
The max-other-vpn-limit keyword specifies the maximum number of VPN sessions other than
AnyConnect client sessions, from 1 to the maximum sessions allowed by the license. This includes the
Cisco VPN client (IPsec IKEv1), Lan-to-Lan VPN, and clientless SSL VPN sessions.
This limit affects the calculated load percentage for VPN Load Balancing.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-3

Chapter 66

Setting General VPN Parameters

Using Client Update to Ensure Acceptable IPsec Client Revision Levels

The following example shows how to set a maximum Anyconnect VPN session limit of 450:
hostname(config)# vpn-sessiondb max-anyconnect-premium-or-essentials-limit 450
hostname(config)#

Using Client Update to Ensure Acceptable IPsec Client Revision
Levels
Note

The information in this section applies to IPsec connections only.
The client update feature lets administrators at a central location automatically notify VPN client users
that it is time to update the VPN client software and the VPN 3002 hardware client image.
Remote users might be using outdated VPN software or hardware client versions. You can use the
client-update command at any time to enable updating client revisions; specify the types and revision
numbers of clients to which the update applies; provide a URL or IP address from which to get the
update; and, in the case of Windows clients, optionally notify users that they should update their VPN
client version. For Windows clients, you can provide a mechanism for users to accomplish that update.
For VPN 3002 hardware client users, the update occurs automatically, with no notification. This
command applies only to the IPsec remote-access tunnel-group type.
To perform a client update, enter the client-update command in either general configuration mode or
tunnel-group ipsec-attributes configuration mode. If the client is already running a software version on
the list of revision numbers, it does not need to update its software. If the client is not running a software
version on the list, it should update. The following procedure explains how to perform a client update:

Step 1

In global configuration mode, enable client update by entering this command:
hostname(config)# client-update enable
hostname(config)#

Step 2

In global configuration mode, specify the parameters for the client update that you want to apply to all
clients of a particular type. That is, specify the type of client, the URL or IP address from which to get
the updated image, and the acceptable revision number or numbers for that client. You can specify up to
four revision numbers, separated by commas.
If the user’s client revision number matches one of the specified revision numbers, there is no need to
update the client. This command specifies the client update values for all clients of the specified type
across the entire ASA.
Use this syntax:
hostname(config)# client-update type type url url-string rev-nums rev-numbers
hostname(config)#

The available client types are win9X (includes Windows 95, Windows 98 and Windows ME platforms),
winnt (includes Windows NT 4.0, Windows 2000 and Windows XP platforms), windows (includes all
Windows based platforms), and vpn3002 (VPN 3002 hardware client).
If the client is already running a software version on the list of revision numbers, it does not need to
update its software. If the client is not running a software version on the list, it should update. You can
specify up to three of these client update entries. The keyword windows covers all of the allowable
Windows platforms. If you specify windows, do not specify the individual Windows client types.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-4

Chapter 66

Setting General VPN Parameters
Using Client Update to Ensure Acceptable IPsec Client Revision Levels

Note

For all Windows clients, you must use the protocol http:// or https:// as the prefix for the URL. For the
VPN 3002 hardware client, you must specify protocol tftp:// instead.
The following example configures client update parameters for the remote access tunnel group. It
designates the revision number 4.6.1 and the URL for retrieving the update, which is
https://support/updates.
hostname(config)# client-update type windows url https://support/updates/ rev-nums 4.6.1
hostname(config)#

Alternatively, you can configure client update just for individual tunnel groups, rather than for all clients
of a particular type. (See Step 3.)
VPN 3002 clients update without user intervention and users receive no notification message. The
following example applies only to VPN 3002 hardware clients. Entered in tunnel-group ipsec-attributes
configuration mode the command it configures client update parameters for the IPsec remote access
tunnel group salesgrp. This example designates the revision number, 4.7 and uses the TFTP protocol for
retrieving the updated software from the site with the IP address 192.168.1.1:
hostname(config)# tunnel-group salesgrp type ipsec-ra
hostname(config)# tunnel-group salesgrp ipsec-attributes
hostname(config-tunnel-ipsec)# client-update type vpn3002 url tftp:192.168.1.1 rev-nums
4.7
hostname(config-tunnel-ipsec)#

Note

Step 3

You can have the browser automatically start an application by including the application name at the end
of the URL; for example: https://support/updates/vpnclient.exe.
Define a set of client-update parameters for a particular ipsec-ra tunnel group.
In tunnel-group ipsec-attributes mode, specify the tunnel group name and its type, the URL or IP address
from which to get the updated image, and a revision number. If the user’s client’s revision number
matches one of the specified revision numbers, there is no need to update the client, for example, for a
Windows client enter this command:
hostname(config)# tunnel-group remotegrp type ipsec-ra
hostname(config)# tunnel-group remotegrp ipsec-attributes
hostname(config-tunnel-ipsec)# client-update type windows url https://support/updates/
rev-nums 4.6.1
hostname(config-tunnel-ipsec)#

Step 4

(Optional) Send a notice to active users with outdated Windows clients that their client needs updating.
For these users, a pop-up window appears, offering them the opportunity to launch a browser and
download the updated software from the site that you specified in the URL. The only part of this message
that you can configure is the URL. (See Step 2 or 3.) Users who are not active get a notification message
the next time they log on. You can send this notice to all active clients on all tunnel groups, or you can
send it to clients on a particular tunnel group. For example, to notify all active clients on all tunnel
groups, enter the following command in privileged EXEC mode:
hostname# client-update all
hostname#

Cisco ASA 5500 Series Configuration Guide using the CLI

66-5

Chapter 66

Setting General VPN Parameters

Understanding Load Balancing

If the user’s client’s revision number matches one of the specified revision numbers, there is no need to
update the client, and no notification message is sent to the user. VPN 3002 clients update without user
intervention and users receive no notification message.

Note

If you specify the client-update type as windows (specifying all Windows-based platforms) and later
want to enter a client-update type of win9x or winnt for the same entity, you must first remove the
windows client type with the no form of the command, then use new client-update commands to specify
the new client types.

Understanding Load Balancing
If you have a remote-access configuration in which you are using two or more ASAs or VPN
Concentrators connected on the same network, you can configure these devices to share their session
load. This feature is called load balancing. To implement load balancing, you group together logically
two or more devices on the same private LAN-to-LAN network, private subnet, and public subnet into a
virtual cluster.
All devices in the virtual cluster carry session loads. Load balancing directs session traffic to the
least-loaded device in the cluster, which distributes the load among all devices. It makes efficient use of
system resources and provides increased performance and high availability.
One device in the virtual cluster, the virtual cluster master, directs incoming traffic to the other devices,
called backup devices. The virtual cluster master monitors all devices in the cluster, keeps track of how
busy each is, and distributes the session load accordingly. The role of virtual cluster master is not tied to
a physical device; it can shift among devices. For example, if the current virtual cluster master fails, one
of the backup devices in the cluster takes over that role and immediately becomes the new virtual cluster
master.
The virtual cluster appears to outside clients as a single virtual cluster IP address. This IP address is not
tied to a specific physical device. This address belongs to the current virtual cluster master, which makes
it virtual. A VPN client attempting to establish a connection connects first to this virtual cluster IP
address. The virtual cluster master then sends back to the client the public IP address of the least-loaded
available host in the cluster. In a second transaction (transparent to the user), the client connects directly
to that host. In this way, the virtual cluster master directs traffic evenly and efficiently across resources.

Note

All clients other than the Cisco VPN client or the Cisco 3002 hardware client should connect directly to
the ASA as usual; they do not use the virtual cluster IP address.
If a machine in the cluster fails, the terminated sessions can immediately reconnect to the virtual cluster
IP address. The virtual cluster master then directs these connections to another active device in the
cluster. If the virtual cluster master itself fails, a backup device in the cluster immediately and
automatically takes over as the new virtual session master. Even if several devices in the cluster fail,
users can continue to connect to the cluster as long as any one device in the cluster is up and available.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-6

Chapter 66

Setting General VPN Parameters
Understanding Load Balancing

Comparing Load Balancing to Failover
Both load balancing and failover are high-availability features, but they function differently and have
different requirements. In some circumstances you can use both load balancing and failover. The
following sections describe the differences between these features.

Load Balancing
Load balancing is a mechanism for equitably distributing remote-access VPN traffic among the devices
in a virtual cluster. It is based on simple distribution of traffic without taking into account throughput or
other factors. A load-balancing cluster consists of two or more devices, one is the virtual master, and the
other devices are the backup. These devices do not need to be of the exact same type, or have identical
software versions or configurations.
All active devices in a virtual cluster carry session loads. Load balancing directs traffic to the
least-loaded device in the cluster, distributing the load among all devices. It makes efficient use of
system resources and provides increased performance and high availability.

Failover
A failover configuration requires two identical ASAs connected to each other through a dedicated
failover link and, optionally, a stateful failover link. The health of the active interfaces and units is
monitored to determine when specific failover conditions are met. If those conditions occur, failover
occurs. Failover supports both VPN and firewall configurations.
The ASA supports two failover configurations: Active/Active failover and Active/Standby failover. VPN
connections run only in Active/Standby, single routed mode. Active/Active failover requires a
multicontext mode, so does not support VPN connections.
With Active/Active failover, both units can pass network traffic. This is not true load balancing, although
it might appear to have the same effect. When failover occurs, the remaining active unit takes over
passing the combined traffic, based on the configured parameters. Therefore, when configuring
Active/Active failover, you must make sure that the combined traffic for both units is within the capacity
of each unit.
With Active/Standby failover, only one unit passes traffic, while the other unit waits in a standby state
and does not pass traffic. Active/Standby failover lets you use a second ASA to take over the functions
of a failed unit. When the active unit fails, it changes to the standby state, while the standby unit changes
to the active state. The unit that becomes active assumes the IP addresses (or, for transparent firewall,
the management IP address) and MAC addresses of the failed unit and begins passing traffic. The unit
that is now in standby state takes over the standby IP addresses of the active unit. If an active unit fails,
the standby takes over without any interruption to the client VPN tunnel.

Implementing Load Balancing
Enabling load balancing involves:
•

Configuring the load-balancing cluster by establishing a common virtual cluster IP address, UDP
port (if necessary), and IPsec shared secret for the cluster. You configure these values identically for
every device in the cluster.

•

Configuring the participating device by enabling load balancing on the device and defining
device-specific properties. These values vary from device to device.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-7

Chapter 66

Setting General VPN Parameters

Understanding Load Balancing

Note

VPN load balancing requires an active 3DES/AES license. The ASA checks for the existence of this
crypto license before enabling load balancing. If it does not detect an active 3DES or AES license, the
ASA prevents the enabling of load balancing and also prevents internal configuration of 3DES by the
load balancing system unless the license permits this usage.

Prerequisites
Load balancing is disabled by default. You must explicitly enable load balancing.
You must have first configured the public (outside) and private (inside) interfaces and also have
previously configured the interface to which the virtual cluster IP address refers. You can use the
interface and nameif commands to configure different names for these interfaces. Subsequent
references in this section use the names outside and inside.
All devices that participate in a cluster must share the same cluster-specific values: IP address,
encryption settings, encryption key, and port.

Eligible Platforms
A load-balancing cluster can include ASA models ASA 5510 (with a Plus license) and Model 5520 and
above. You can also include Cisco VPN 3000 series concentrators in the cluster. While mixed
configurations are possible, administration is generally simpler if the cluster is homogeneous.

Eligible Clients
Load balancing is effective only on remote sessions initiated with the following clients:
•

Cisco AnyConnect VPN client (Release 2.0 and later)

•

Cisco VPN Client (Release 3.0 and later)

•

Cisco ASA 5505 ASA (when acting as an Easy VPN client)

•

Cisco VPN 3002 hardware client (Release 3.5 or later)

•

Cisco PIX 501/506E when acting as an Easy VPN client

•

Cisco IOS EZVPN client devices supporting IKE-redirect (IOS 831/871)

•

Clientless SSL VPN (not a client)

Load balancing works with IPsec clients and SSL VPN client and clientless sessions. All other VPN
connection types (L2TP, PPTP, L2TP/IPsec), including LAN-to-LAN, can connect to an ASA on which
load balancing is enabled, but they cannot participate in load balancing.

VPN Load-Balancing Algorithm
The master device maintains a sorted list of backup cluster members in ascending IP address order. The
load of each backup cluster member is computed as an integer percentage (the number of active
sessions). AnyConnect inactive sessions do not count towards the SSL VPN load for load balancing. The

Cisco ASA 5500 Series Configuration Guide using the CLI

66-8

Chapter 66

Setting General VPN Parameters
Understanding Load Balancing

master device redirects the IPsec and SSL VPN tunnel to the device with the lowest load until it is 1%
higher than the rest. When all backup cluster members are 1% higher than the master, the master device
redirects to itself.
For example, if you have one master and two backup cluster members, the following cycle applies:

Note

All nodes start with 0%, and all percentages are rounded half-up.

1.

The master device take s the connection if all members have a load at 1% higher than the master.

2.

If the master does not take the connection, the session is taken by whichever backup device has the
least load percentage.

3.

If all members have the same percentage load, the backup device with the least number of sessions
gets the session.

4.

If all members have the same percentage load and the same number of sessions, the device with the
least IP addresses gets the session.

VPN Load-Balancing Cluster Configurations
A load-balancing cluster can consist of ASAs of the same release, of mixed releases, as well as VPN
3000 concentrators, or a mixture of these, subject to the following restrictions:
•

Load-balancing clusters that consist of same release ASAs or all VPN 3000 concentrators can run
load balancing for a mixture of IPsec, AnyConnect, and clientless SSL VPN sessions.

•

Load-balancing clusters that consist of both same release ASAs and VPN 3000 concentrators can
run load balancing for a mixture of IPsec, AnyConnect, and clientless SSL VPN client and clientless
sessions.

•

Load-balancing clusters that include mixed release ASAs or same release ASAs and VPN 3000
concentrators or both can support only IPsec sessions. In such a configuration, however, the ASAs
might not reach their full IPsec capacity. Scenario 1: Mixed Cluster with No SSL VPN Connections,
illustrates this situation.

Since Release 7.1(1), IPsec and SSL VPN sessions count or weigh equally in determining the load that
each device in the cluster carries. This is a change from the load-balancing calculation for the ASA
Release 7.0(x) software and the VPN 3000 concentrator. Both platforms use a weighting algorithm that
on some hardware platforms calculates the SSL VPN session load differently from the IPsec session
load.
The virtual master of the cluster assigns session requests to the members of the cluster. The ASA regards
all sessions, SSL VPN or IPsec, as equal and assigns them accordingly. You can configure the number
of IPsec and SSL VPN sessions to allow up to the maximum allowed by your configuration and license.
See Configuring VPN Session Limits for a description of how to set these limits.
We have tested up to ten nodes in a load-balancing cluster. Larger clusters might work, but we do not
officially support such topologies.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-9

Chapter 66

Setting General VPN Parameters

Understanding Load Balancing

Some Typical Mixed Cluster Scenarios
If you have a mixed configuration—that is, if your load-balancing cluster includes devices running a
mixture of ASA software releases or at least one ASA running ASA Release 7.1(1) or later and a VPN
3000 concentrator—the difference in weighting algorithms becomes an issue if the initial cluster master
fails and another device takes over as master.
The following scenarios illustrate the use of VPN load balancing in clusters consisting of a mixture of
ASAs running ASA Release 7.1(1) and ASA Release 7.0(x) software, as well as VPN 3000 series
concentrators.

Scenario 1: Mixed Cluster with No SSL VPN Connections
In this scenario, the cluster consists of a mixture of ASAs and VPN 3000 concentrators. Some of the
ASA cluster peers are running ASA Release 7.0(x), and some are running Release 7.1(1). The pre-7.1(1)
and VPN 3000 peers do not have any SSL VPN connections, and the 7.1(1) cluster peers have only the
base SSL VPN license, which allows two SSL VPN sessions, but there are no SSL VPN connections. In
this case, all the connections are IPsec, and load balancing works fine.
The two SSL VPN licenses have a very small effect on the user’s taking advantage of the maximum IPsec
session limit, and then only when a VPN 3000 concentrator is the cluster master. In general, the smaller
the number of SSL VPN licenses is on a ASA in a mixed cluster, the smaller the effect on the ASA 7.1(1)
device being able to reach its IPsec session limit in a scenario where there are only IPsec sessions.

Scenario 2: Mixed Cluster Handling SSL VPN Connections
Suppose, for example, an ASA running ASA Release 7.1(1) software is the initial cluster master and then
that device fails. Another device in the cluster takes over automatically as master and applies its own
load-balancing algorithm to determine processor loads within the cluster. A cluster master running ASA
Release 7.1(1) software cannot weight session loads in any way other than what that software provides.
Therefore, it cannot assign a combination of IPsec and SSL VPN session loads properly to ASA devices
running earlier versions nor to VPN 3000 concentrators. Conversely, a VPN 3000 concentrator acting as
the cluster master cannot assign loads properly to an ASA Release 7.1(1) ASA. The following scenario
illustrates this dilemma.
This scenario is similar to the previous one, in that the cluster consists of a mixture of ASAs and VPN
3000 concentrators. Some of the ASA cluster peers are running ASA Release 7.0,(x) and some are
running Release 7.1(1). In this case, however, the cluster is handling SSL VPN connections as well as
IPsec connections.
If a device that is running software earlier than ASA Release 7.1(1) is the cluster master, the master
applies the protocol and logic in effect prior to Release 7.1(1). That is, sessions might be directed to
load-balancing peers that have exceeded their session limit. In that case, the user is denied access.
If the cluster master is a device running ASA Release 7.0(x) software, the old session-weighting
algorithm applies only to the pre-7.1(1) peers in the cluster. No one should be denied access in this case.
Because the pre-7.1(1) peers use the session-weighting algorithm, they are more lightly loaded.
An issue arises, however, because you cannot guarantee that the 7.1(1) peer is always the cluster master.
If the cluster master fails, another peer assumes the role of master. The new master might be any of the
eligible peers. Because of the unpredictability of the results, we recommend that you avoid configuring
this type of cluster.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-10

Chapter 66

Setting General VPN Parameters
Configuring Load Balancing

Configuring Load Balancing
To use load balancing, configure the following elements for each device that participates in the cluster:
•

Public and private interfaces

•

VPN load-balancing cluster attributes

Note

All participants in the cluster must have an identical cluster configuration, except for the device priority
within the cluster.

Note

The Local CA feature is not supported if you use Active/Active stateful failover or VPN load-balancing.
The Local CA cannot be subordinate to another CA; it can act only as the Root CA.

Configuring the Public and Private Interfaces for Load Balancing
To configure the public (outside) and private (inside) interfaces for the load-balancing cluster devices,
do the following steps:
Step 1

Configure the public interface on the ASA by entering the interface command with the lbpublic
keyword in vpn-load-balancing configuration mode. This command specifies the name or IP address of
the public interface for load balancing for this device:
hostname(config)# vpn load-balancing
hostname(config-load-balancing)# interface lbpublic outside
hostname(config-load-balancing)#

Step 2

Configure the private interface on the ASA by entering the interface command with the lbprivate
keyword in vpn-load-balancing configuration mode. This command specifies the name or IP address of
the private interface for load balancing for this device:
hostname(config-load-balancing)# interface lbprivate inside
hostname(config-load-balancing)#

Step 3

Set the priority to assign to this device within the cluster. The range is from 1 to 10. The priority indicates
the likelihood of this device becoming the virtual cluster master, either at startup or when an existing
master fails. The higher you set the priority (for example, 10), the more likely it is that this device
becomes the virtual cluster master.
hostname(config-load-balancing)# priority number
hostname(config-load-balancing)#

For example, to assign this device a priority of 6 within the cluster, enter the following command:
hostname(config-load-balancing)# priority 6
hostname(config-load-balancing)#

Step 4

If you want to apply network address translation for this device, enter the nat command with the NAT
assigned address for the device:
hostname(config-load-balancing)# nat ip_address
hostname(config-load-balancing)#

For example, to assign this device a NAT address of 192.168.30.3, enter the following command:

Cisco ASA 5500 Series Configuration Guide using the CLI

66-11

Chapter 66

Setting General VPN Parameters

Configuring Load Balancing

hostname(config-load-balancing)# nat 192.168.30.3
hostname(config-load-balancing)#

Configuring the Load Balancing Cluster Attributes
To configure the load-balancing cluster attributes for each device in the cluster, do the following steps:
Step 1

Set up VPN load balancing by entering the vpn load-balancing command in global configuration mode:
hostname(config)# vpn load-balancing
hostname(config-load-balancing)#

This enters vpn-load-balancing configuration mode, in which you can configure the remaining
load-balancing attributes.
Step 2

Configure the IP address of the cluster to which this device belongs. This command specifies the single
IP address that represents the entire virtual cluster. Choose an IP address that is within the public subnet
address range shared by all the ASAs in the virtual cluster.
hostname(config-load-balancing)# cluster ip address ip_address
hostname(config-load-balancing)#

For example, to set the cluster IP address to 192.168.10.10, enter the following command:
hostname(config-load-balancing)# cluster ip address 192.168.10.10
hostname(config-load-balancing)#

Step 3

Configure the cluster port.This command specifies the UDP port for the virtual cluster in which this
device is participating. The default value is 9023. If another application is using this port, enter the UDP
destination port number that you want to use for load balancing.
hostname(config-load-balancing)# cluster port port_number
hostname(config-load-balancing)#

For example, to set the cluster port to 4444, enter the following command:
hostname(config-load-balancing)# cluster port 4444
hostname(config-load-balancing)#

Step 4

(Optional) Enable IPsec encryption for the cluster. The default is no encryption. This command enables
or disables IPsec encryption. If you configure this check attribute, you must first specify and verify a
shared secret.The ASAs in the virtual cluster communicate via LAN-to-LAN tunnels using IPsec. To
ensure that all load-balancing information communicated between the devices is encrypted, enable this
attribute.
hostname(config-load-balancing)# cluster encryption
hostname(config-load-balancing)#

Cisco ASA 5500 Series Configuration Guide using the CLI

66-12

Chapter 66

Setting General VPN Parameters
Configuring Load Balancing

Note

When using encryption, you must have previously configured the load-balancing inside
interface. If that interface is not enabled on the load-balancing inside interface, you get an error
message when you try to configure cluster encryption.
If the load-balancing inside interface was enabled when you configured cluster encryption, but
was disabled before you configured the participation of the device in the virtual cluster, you get
an error message when you enter the participate command (or, in ASDM, check the Participate
in Load Balancing Cluster check box), and encryption is not enabled for the cluster.
To use cluster encryption, you must enable ISAKMP on the inside interface, using the crypto
isakmp enable command with the inside interface specified.

Step 5

If you enable cluster encryption, you must also specify the IPsec shared secret by entering the cluster
key command. This command specifies the shared secret between IPsec peers when you have enabled
IPsec encryption. The value you enter in the box appears as consecutive asterisk characters
hostname(config-load-balancing)# cluster key shared_secret
hostname(config-load-balancing)#

For example, to set the shared secret to 123456789, enter the following command:
hostname(config-load-balancing)# cluster key 123456789
hostname(config-load-balancing)#

Step 6

Enable this device’s participation in the cluster by entering the participate command:
hostname(config-load-balancing)# participate
hostname(config-load-balancing)#

Enabling Redirection Using a Fully Qualified Domain Name
To enable or disable redirection using a fully qualified domain name in vpn load-balancing mode, use
the redirect-fqdn enable command in global configuration mode. This behavior is disabled by default.
By default, the ASA sends only IP addresses in load-balancing redirection to a client. If certificates are
in use that are based on DNS names, the certificates will be invalid when redirected to a backup device.
As a VPN cluster master, this ASA can send a fully qualified domain name (FQDN), using reverse DNS
lookup, of a cluster device (another ASA in the cluster) instead of its outside IP address when redirecting
VPN client connections to that cluster device.
All of the outside and inside network interfaces on the load-balancing devices in a cluster must be on the
same IP network.
To do VPN load balancing for SSL or IPsec/IKEv2 connections using FQDNs rather than IP addresses,
perform the following configuration steps:
Step 1

Enable the use of FQDNs for load balancing with the redirect-fqdn enable command:
redirect-fqdn {enable | disable}
no redirect-fqdn {enable | disable}

Cisco ASA 5500 Series Configuration Guide using the CLI

66-13

Chapter 66

Setting General VPN Parameters

Configuring Load Balancing

For example:
hostname(config)# vpn load-balancing
hostname(config-load-balancing)# redirect-fqdn enable
hostname(config-load-balancing)#

Step 2

Add an entry for each of your ASA outside interfaces into your DNS server if such entries are not already
present. Each ASA outside IP address should have a DNS entry associated with it for lookups. These
DNS entries must also be enabled for reverse lookup.

Step 3

Enable DNS lookups on your ASA with the dns domain-lookup inside command or whichever interface
has a route to your DNS server.

Step 4

Define your DNS server IP address on the ASA; for example: dns name-server 10.2.3.4 (IP address of
your DNS server).
The following is an example of a VPN load balancing command sequence that includes an interface
command that enables redirection for a fully qualified domain name, specifies the public interface of the
cluster as test and the private interface of the cluster as foo”
hostname(config)# interface GigabitEthernet 0/1
hostname(config-if)# ip address 209.165.202.159 255.255.255.0
hostname(config)# nameif test
hostname(config)# interface GigabitEthernet 0/2
hostname(config-if)# ip address 209.165.201.30 255.255.255.0
hostname(config)# nameif foo
hostname(config)# vpn load-balancing
hostname(config-load-balancing)# nat 192.168.10.10
hostname(config-load-balancing)# priority 9
hostname(config-load-balancing)# interface lbpublic test
hostname(config-load-balancing)# interface lbprivate foo
hostname(config-load-balancing)# cluster ip address 209.165.202.224
hostname(config-load-balancing)# cluster key 123456789
hostname(config-load-balancing)# cluster encryption
hostname(config-load-balancing)# cluster port 9023
hostname(config-load-balancing)# redirect-fqdn enable
hostname(config-load-balancing)# participate

Frequently Asked Questions About Load Balancing
IP Address Pool Exhaustion
Q: Does the ASA consider IP address pool exhaustion as part of its VPN load-balancing method?
A: No. If the remote access VPN session is directed to a device that has exhausted its IP address pools,
the session does not establish. The load-balancing algorithm is based on load, and is computed as an
integer percentage (number of active and maximum sessions) that each backup cluster member supplies.

Unique IP Address Pools
Q: To implement VPN load balancing, must the IP address pools for AnyConnect clients or IPsec clients
on different ASAs be unique?
A: Yes. IP address pools must be unique for each device.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-14

Chapter 66

Setting General VPN Parameters
Configuring Load Balancing

Using Load Balancing and Failover on the Same Device
Q: Can a single device use both load balancing and failover?
A: Yes. In this configuration, the client connects to the IP address of the cluster and is redirected to the
least-loaded ASA in the cluster. If that device fails, the standby unit takes over immediately, and there
is no impact to the VPN tunnel.

Load Balancing on Multiple Interfaces
Q: If we enable SSL VPN on multiple interfaces, is it possible to implement load balancing for both of
the interfaces?
A: You can define only one interface to participate in the cluster as the public interface. The idea is to
balance the CPU loads. Multiple interfaces converge on the same CPU, so the concept of load balancing
on multiple interfaces has no meaning.

Maximum Simultaneous Sessions for Load Balancing Clusters
Q: Consider a deployment of two ASA 5520s, each with a 100-user SSL VPN license. In a
load-balancing cluster, does the maximum total number of users allow 200 simultaneous sessions, or
only 100? If we add a third device later with a 100-user license, can we now support 300 simultaneous
sessions?
A: With VPN load balancing, all devices are active, so the maximum number of sessions that your cluster
can support is the total of the number of sessions for each of the devices in the cluster, in this case 300.

Viewing Load Balancing
The load-balancing cluster master receives a periodic message from each ASA in the cluster with the
number of active AnyConnect and clientless sessions, as well as the maximum allowed sessions based
on the configured or license limits. If an ASA in the cluster shows 100 percent full capacity, the cluster
master cannot redirect more connections to it. Although the ASA may show as full, some users may be
in inactive/wait-to-resume state, wasting the licenses. As a workaround, each ASA provides the total
number of sessions minus the sessions in inactive state, instead of the total number of sessions. (Refer
to the show vpn-sessiondb summary command in the command reference. In other words, the inactive
sessions are not reported to the cluster master. Even if the ASA is full (with some inactive sessions), the
cluster master still redirects connections to it if necessary. When the ASA receives the new connection,
the session that has been inactive the longest is logged off, allowing new connections to take its license.

Cisco ASA 5500 Series Configuration Guide using the CLI

66-15

Chapter 66

Setting General VPN Parameters

Configuring VPN Session Limits

The following example shows 100 SSL sessions (active only) and a 2 percent SSL load. These numbers
do not include the inactive sessions. In other words, inactive sessions do not count towards the load for
load balancing.
hostname# show vpn load-balancing
Status :
enabled
Role :
Master
Failover :
Active
Encryption :
enabled
Cluster IP :
192.168.1.100
Peers :
1
Load %
Sessions
Public IP
192.168.1.9
192.168.1.19

Role
Pri
Master 7
Backup 9

Model
ASA-5540
ASA-5520

IPsec
4
0

SSL
2
0

IPsec SSL
216
100
0
0

Configuring VPN Session Limits
You can run as many IPsec and SSL VPN sessions as your platform and ASA license supports. To view
the licensing information including maximum sessions for your ASA, enter the show version command
in global configuration mode. The following example shows the command and the licensing information
from the output of this command:
hostname(config)# show version
Cisco Adaptive Security Appliance Software Version 8.4(1)
Device Manager Version 6.4(1)
Compiled on Sun 02-Jan-11 03:45 by builders
System image file is "disk0:/cdisk.bin"
Config file at boot was "startup-config"
asa4 up 9 days 3 hours
Hardware:
ASA5510, 256 MB RAM, CPU Pentium 4 Celeron 1600 MHz
Internal ATA Compact Flash, 256MB
BIOS Flash M50FW080 @ 0xfff00000, 1024KB
Encryption hardware device : Cisco ASA-55x0 on-board
Boot microcode
:
SSL/IKE microcode
:
IPsec microcode
:
Number of accelerators:
0:
1:
2:
3:
4:
5:
6:

Ext:
Ext:
Ext:
Ext:
Ext:
Int:
Int:

Ethernet0/0
Ethernet0/1
Ethernet0/2
Ethernet0/3
Management0/0
Internal-Data0/0
Internal-Control0/0

:
:
:
:
:
:
:

address
address
address
address
address
address
address

is
is
is
is
is
is
is

001e.f75e.8b84,
001e.f75e.8b85,
001e.f75e.8b86,
001e.f75e.8b87,
001e.f75e.8b83,
0000.0001.0002,
0000.0001.0001,

Licensed features for this platform:
Maximum Physical Interfaces
: Unlimited
Maximum VLANs
: 100
Inside Hosts
: Unlimited
Failover
: Active/Active
VPN-DES
: Enabled

Cisco ASA 5500 Series Configuration Guide using the CLI

66-16

accelerator (revision 0x0)
CN1000-MC-BOOT-2.00
CNLite-MC-SSLm-PLUS-2.03
CNlite-MC-IPSECm-MAIN-2.06
1
irq
irq
irq
irq
irq
irq
irq

perpetual
perpetual
perpetual
perpetual
perpetual

9
9
9
9
11
11
5

Chapter 66

Setting General VPN Parameters
Configuring VPN Session Limits

VPN-3DES-AES
Security Contexts
GTP/GPRS
AnyConnect Premium Peers
AnyConnect Essentials
Other VPN Peers
Total VPN Peers
Shared License
AnyConnect for Mobile
AnyConnect for Cisco VPN Phone
Advanced Endpoint Assessment
UC Phone Proxy Sessions
Total UC Proxy Sessions
Botnet Traffic Filter
Intercompany Media Engine

:
:
:
:
:
:
:
:
:
:
:
:
:
:
:

Enabled
2
Disabled
250
Disabled
250
250
Disabled
Disabled
Disabled
Enabled
2
2
Disabled
Disabled

perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual
perpetual

This platform has an ASA 5510 Security Plus license.
hostname#

To limit AnyConnect VPN sessions (either IPsec/IKEv1 or SSL) to a lower value than the ASA allows,
use the vpn-sessiondb max-anyconnect-premium-or-essentials-limit command in global
configuration mode. To remove the session limit, use the no version of this command.
For example, if the ASA license allows 500 SSL VPN sessions, and you want to limit the number of
AnyConnect VPN sessions to 250, enter the following command:
hostname(config)# vpn-sessiondb max-anyconnect-premium-or-essentials-limit 250
hostname(config)#

To remove the session limit, use the no version of this command:
hostname(config)# no vpn-sessiondb max-anyconnect-premium-or-essentials-limit 250
hostname(config)#

To limit Cisco VPN client (IPsec IKEv1), Lan-to-Lan VPN, and clientless SSL VPN sessions to a lower
value than the ASA allows, enter the vpn-sessiondb max-other-vpn-limit command in global
configuration mode:
For example, if the ASA license allows 750 IPsec sessions, and you want to limit the number of IPsec
sessions to 500, enter the following command:
hostname(config)# vpn-sessiondb max-other-vpn-limit 500
hostname(config)#

To remove the session limit, use the no version of this command:
hostname(config)# no vpn-sessiondb max-other-vpn-limit 500
hostname(config)#

For a complete description of the features available with each license, see the document Managing
Feature Licenses for Cisco ASA 5500 Version 8.4 at this URL:
http://www.cisco.com/en/US/docs/security/asa/asa84/license_standalone/license_management/
license.html

Cisco ASA 5500 Series Configuration Guide using the CLI

66-17

Chapter 66
Configuring VPN Session Limits

Cisco ASA 5500 Series Configuration Guide using the CLI

66-18

Setting General VPN Parameters

CH A P T E R

67

Configuring Connection Profiles, Group Policies,
and Users
This chapter describes how to configure VPN connection profiles (formerly called “tunnel groups”),
group policies, and users. This chapter includes the following sections.
•

Overview of Connection Profiles, Group Policies, and Users, page 67-1

•

Configuring Connection Profiles, page 67-6

•

Group Policies, page 67-36

•

Configuring User Attributes, page 67-79

In summary, you first configure connection profiles to set the values for the connection. Then you
configure group policies. These set values for users in the aggregate. Then you configure users, which
can inherit values from groups and configure certain values on an individual user basis. This chapter
describes how and why to configure these entities.

Overview of Connection Profiles, Group Policies, and Users
Groups and users are core concepts in managing the security of virtual private networks (VPNs) and in
configuring the ASA. They specify attributes that determine user access to and use of the VPN. A group
is a collection of users treated as a single entity. Users get their attributes from group policies. A
connection profile identifies the group policy for a specific connection. If you do not assign a particular
group policy to a user, the default group policy for the connection applies.

Note

You configure connection profiles using tunnel-group commands. In this chapter, the terms “connection
profile” and “tunnel group” are often used interchangeably.
Connection profiles and group policies simplify system management. To streamline the configuration
task, the ASA provides a default LAN-to-LAN connection profile, a default remote access connection
profile, a default connection profile for SSL/IKEv2 VPN, and a default group policy (DfltGrpPolicy).
The default connection profiles and group policy provide settings that are likely to be common for many
users. As you add users, you can specify that they “inherit” parameters from a group policy. Thus you
can quickly configure VPN access for large numbers of users.
If you decide to grant identical rights to all VPN users, then you do not need to configure specific
connection profiles or group policies, but VPNs seldom work that way. For example, you might allow a
finance group to access one part of a private network, a customer support group to access another part,

Cisco ASA 5500 Series Configuration Guide using the CLI

67-1

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Connection Profiles

and an MIS group to access other parts. In addition, you might allow specific users within MIS to access
systems that other MIS users cannot access. Connection profiles and group policies provide the
flexibility to do so securely.

Note

The ASA also includes the concept of object groups, which are a superset of network lists. Object groups
let you define VPN access to ports as well as networks. Object groups relate to ACLs rather than to group
policies and connection profiles. For more information about using object groups, see Chapter 13,
“Configuring Objects.”
The security appliance can apply attribute values from a variety of sources. It applies them according to
the following hierarchy:
1.

Dynamic Access Policy (DAP) record

2.

Username

3.

Group policy

4.

Group policy for the connection profile

5.

Default group policy

Therefore, DAP values for an attribute have a higher priority than those configured for a user, group
policy, or connection profile.
When you enable or disable an attribute for a DAP record, the ASA applies that value and enforces it.
For example, when you disable HTTP proxy in dap webvpn mode, the security appliance looks no further
for a value. When you instead use the no value for the http-proxy command, the attribute is not present
in the DAP record, so the security appliance moves down to the AAA attribute in the username, and if
necessary, the group policy to find a value to apply. The ASA clientless SSL VPN configuration supports
only one http-proxy and one https-proxy command each. We recommend that you use ASDM to
configure DAP.

Connection Profiles
A connection profile consists of a set of records that determines tunnel connection policies. These
records identify the servers to which the tunnel user is authenticated, as well as the accounting servers,
if any, to which connection information is sent. They also identify a default group policy for the
connection, and they contain protocol-specific connection parameters. Connection profiles include a
small number of attributes that pertain to creating the tunnel itself. Connection profiles include a pointer
to a group policy that defines user-oriented attributes.
The ASA provides the following default connection profiles: DefaultL2Lgroup for LAN-to-LAN
connections, DefaultRAgroup for remote access connections, and DefaultWEBVPNGroup for SSL VPN
(browser-based) connections. You can modify these default connection profiles, but you cannot delete
them. You can also create one or more connection profiles specific to your environment. Connection
profiles are local to the ASA and are not configurable on external servers.
Connection profiles specify the following attributes:
•

General Connection Profile Connection Parameters, page 67-3

•

IPsec Tunnel-Group Connection Parameters, page 67-4

•

Connection Profile Connection Parameters for SSL VPN Sessions, page 67-5

Cisco ASA 5500 Series Configuration Guide using the CLI

67-2

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Connection Profiles

General Connection Profile Connection Parameters
General parameters are common to all VPN connections. The general parameters include the following:
•

Connection profile name—You specify a connection-profile name when you add or edit a
connection profile. The following considerations apply:
– For clients that use preshared keys to authenticate, the connection profile name is the same as

the group name that a client passes to the ASA.
– Clients that use certificates to authenticate pass this name as part of the certificate, and the ASA

extracts the name from the certificate.
•

Connection type—Connection types include IKEv1 remote-access, IPsec Lan-to-LAN, and
Anyconnect (SSL/IKEv2). A connection profile can have only one connection type.

•

Authentication, Authorization, and Accounting servers—These parameters identify the server
groups or lists that the ASA uses for the following purposes:
– Authenticating users
– Obtaining information about services users are authorized to access
– Storing accounting records

A server group can consist of one or more servers.
•

Default group policy for the connection—A group policy is a set of user-oriented attributes. The
default group policy is the group policy whose attributes the ASA uses as defaults when
authenticating or authorizing a tunnel user.

•

Client address assignment method—This method includes values for one or more DHCP servers or
address pools that the ASA assigns to clients.

•

Override account disabled—This parameter lets you override the “account-disabled” indicator
received from a AAA server.

•

Password management—This parameter lets you warn a user that the current password is due to
expire in a specified number of days (the default is 14 days), then offer the user the opportunity to
change the password.

•

Strip group and strip realm—These parameters direct the way the ASA processes the usernames it
receives. They apply only to usernames received in the form user@realm. A realm is an
administrative domain appended to a username with the @ delimiter (user@abc).
When you specify the strip-group command, the ASA selects the connection profile for user
connections by obtaining the group name from the username presented by the VPN client. The ASA
then sends only the user part of the username for authorization/authentication. Otherwise (if
disabled), the ASA sends the entire username, including the realm.
Strip-realm processing removes the realm from the username when sending the username to the
authentication or authorization server. If the command is enabled, the ASA sends only the user part
of the username authorization/authentication. Otherwise, the ASA sends the entire username.

•

Authorization required—This parameter lets you require authorization before a user can connect, or
turn off that requirement.

•

Authorization DN attributes—This parameter specifies which Distinguished Name attributes to use
when performing authorization.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-3

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Connection Profiles

IPsec Tunnel-Group Connection Parameters
IPsec parameters include the following:
•

A client authentication method: preshared keys, certificates, or both.
– For IKE connections based on preshared keys, this is the alphanumeric key itself (up to 128

characters long), associated with the connection policy.
– Peer-ID validation requirement—This parameter specifies whether to require validating the

identity of the peer using the peer’s certificate.
– If you specify certificates or both for the authentication method, the end user must provide a

valid certificate in order to authenticate.
•

An extended hybrid authentication method: XAUTH and hybrid XAUTH.
You use isakmp ikev1-user-authentication command to implement hybrid XAUTH authentication
when you need to use digital certificates for ASA authentication and a different, legacy method for
remote VPN user authentication, such as RADIUS, TACACS+ or SecurID.

•

ISAKMP (IKE) keepalive settings. This feature lets the ASA monitor the continued presence of a
remote peer and report its own presence to that peer. If the peer becomes unresponsive, the ASA
removes the connection. Enabling IKE keepalives prevents hung connections when the IKE peer
loses connectivity.
There are various forms of IKE keepalives. For this feature to work, both the ASA and its remote
peer must support a common form. This feature works with the following peers:
– Cisco AnyConnect VPN Client
– Cisco VPN Client (Release 3.0 and above)
– Cisco VPN 3000 Client (Release 2.x)
– Cisco VPN 3002 Hardware Client
– Cisco VPN 3000 Series Concentrators
– Cisco IOS software
– Cisco Secure PIX Firewall

Non-Cisco VPN clients do not support IKE keepalives.
If you are configuring a group of mixed peers, and some of those peers support IKE keepalives and
others do not, enable IKE keepalives for the entire group. The feature does not affect the peers that
do not support it.
If you disable IKE keepalives, connections with unresponsive peers remain active until they time
out, so we recommend that you keep your idle timeout short. To change your idle timeout, see
“Configuring Group Policies” section on page 67-39.

Note

To reduce connectivity costs, disable IKE keepalives if this group includes any clients
connecting via ISDN lines. ISDN connections normally disconnect if idle, but the IKE keepalive
mechanism prevents connections from idling and therefore from disconnecting.
If you do disable IKE keepalives, the client disconnects only when either its IKE or IPsec keys
expire. Failed traffic does not disconnect the tunnel with the Peer Timeout Profile values as it
does when IKE keepalives are enabled.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-4

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Connection Profiles

Note

If you have a LAN-to-LAN configuration using IKE main mode, make sure that the two peers
have the same IKE keepalive configuration. Both peers must have IKE keepalives enabled or
both peers must have it disabled.

•

If you configure authentication using digital certificates, you can specify whether to send the entire
certificate chain (which sends the peer the identity certificate and all issuing certificates) or just the
issuing certificates (including the root certificate and any subordinate CA certificates).

•

You can notify users who are using outdated versions of Windows client software that they need to
update their client, and you can provide a mechanism for them to get the updated client version. For
VPN 3002 hardware client users, you can trigger an automatic update. You can configure and change
the client-update, either for all connection profiles or for particular connection profiles.

•

If you configure authentication using digital certificates, you can specify the name of the trustpoint
that identifies the certificate to send to the IKE peer.

Connection Profile Connection Parameters for SSL VPN Sessions
Table 67-1 provides a list of connection profile attributes that are specific to SSL VPN (AnyConnect
client and clientless) connections. In addition to these attributes, you configure general connection
profile attributes common to all VPN connections. For step-by-step information about configuring
connection profiles, see Configuring Connection Profiles for Clientless SSL VPN Sessions, page 67-20.

Note

In earlier releases, “connection profiles” were known as “tunnel groups.” You configure a connection
profile with tunnel-group commands. This chapter often uses these terms interchangeably.
Table 67-1

Connection Profile Attributes for SSL VPN

Command

Function

authentication

Sets the authentication method, AAA or certificate.

customization

Identifies the name of a previously defined customization to apply.
Customizations determine the appearance of the windows that the user
sees upon login. You configure the customization parameters as part of
configuring clientless SSL VPN.

nbns-server

Identifies the name of the NetBIOS Name Service server (nbns-server) to
use for CIFS name resolution.

group-alias

Specifies one or more alternate names by which the server can refer to a
connection profile. At login, the user selects the group name from a
dropdown menu.

group-url

Identifies one or more group URLs. If you configure this attribute, users
coming in on a specified URL need not select a group at login.

dns-group

Identifies the DNS server group that specifies the DNS server name,
domain name, name server, number of retries, and timeout values for a
DNS server to use for a connection profile.

hic-fail-group-policy

Specifies a VPN feature policy if you use the Cisco Secure Desktop
Manager to set the Group-Based Policy attribute to “Use Failure
Group-Policy” or “Use Success Group-Policy, if criteria match.”

Cisco ASA 5500 Series Configuration Guide using the CLI

67-5

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

Table 67-1

Connection Profile Attributes for SSL VPN

Command

Function

override-svc-download

Overrides downloading the group-policy or username attributes
configured for downloading the AnyConnect VPN client to the remote
user.

radius-reject-message

Enables the display of the RADIUS reject message on the login screen
when authentication is rejected.

Configuring Connection Profiles
The following sections describe the contents and configuration of connection profiles:
•

Maximum Connection Profiles, page 67-6

•

Default IPsec Remote Access Connection Profile Configuration, page 67-7

•

Specifying a Name and Type for the Remote Access Connection Profile, page 67-8

•

Configuring Remote-Access Connection Profiles, page 67-7

•

Configuring LAN-to-LAN Connection Profiles, page 67-17

•

Configuring Connection Profiles for Clientless SSL VPN Sessions, page 67-20

•

Customizing Login Windows for Users of Clientless SSL VPN sessions, page 67-27

•

Configuring the Connection Profile for RADIUS/SDI Message Support for the AnyConnect Client,
page 67-34

You can modify the default connection profiles, and you can configure a new connection profile as any
of the three tunnel-group types. If you don’t explicitly configure an attribute in a connection profile, that
attribute gets its value from the default connection profile. The default connection-profile type is remote
access. The subsequent parameters depend upon your choice of tunnel type. To see the current
configured and default configuration of all your connection profiles, including the default connection
profile, enter the show running-config all tunnel-group command.

Maximum Connection Profiles
The maximum number of connection profiles (tunnel groups) that an ASA can support is a function of
the maximum number of concurrent VPN sessions for the platform + 5. For example, an ASA5505 can
support a maximum of 25 concurrent VPN sessions allowing for 30 tunnel groups (25+5). Attempting
to add an additional tunnel group beyond the limit results in the following message: "ERROR: The limit
of 30 configured tunnel groups has been reached"
Table Table 67-2specifies the maximum VPN sessions and connection profiles for each ASA platform.
Table 67-2

Maximum VPN Sessions and Connection Profiles Per ASA Platform

5505 Base/
Security Plus

5510/Base/
5520
Security Plus

5540

5550

5580-20

5580-40

Maximum VPN Sessions

10/25

250

750

5000

5000

10,000

10,000

Maximum Connection Profiles

15/30

255

755

5005

5005

10,005

10,005

Cisco ASA 5500 Series Configuration Guide using the CLI

67-6

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

Default IPsec Remote Access Connection Profile Configuration
The contents of the default remote-access connection profile are as follows:
tunnel-group DefaultRAGroup type remote-access
tunnel-group DefaultRAGroup general-attributes
no address-pool
no ipv6-address-pool
authentication-server-group LOCAL
accounting-server-group RADIUS
default-group-policy DfltGrpPolicy
no dhcp-server
no strip-realm
no password-management
no override-account-disable
no strip-group
no authorization-required
authorization-dn-attributes CN OU
tunnel-group DefaultRAGroup webvpn-attributes
hic-fail-group-policy DfltGrpPolicy
customization DfltCustomization
authentication aaa
no override-svc-download
no radius-reject-message
dns-group DefaultDNS
tunnel-group DefaultRAGroup ipsec-attributes
no pre-shared-key
peer-id-validate req
no chain
no trust-point
isakmp keepalive threshold 1500 retry 2
no radius-sdi-xauth
isakmp ikev1-user-authentication xauth
tunnel-group DefaultRAGroup ppp-attributes
no authentication pap
authentication chap
authentication ms-chap-v1
no authentication ms-chap-v2
no authentication eap-proxy

Configuring IPsec Tunnel-Group General Attributes
The general attributes are common across more than one tunnel-group type. IPsec remote access and
clientless SSL VPN tunnels share most of the same general attributes. IPsec LAN-to-LAN tunnels use a
subset. Refer to the command reference for complete descriptions of all commands. The following
sections describe, in order, how to configure remote-access and LAN-to-LAN connection profiles.

Configuring Remote-Access Connection Profiles
Use an remote-access connection profile when setting up a connection between the following remote
clients and a central-site ASA:
– Legacy Cisco VPN Client (connecting with IPsec/IKEv1)
– AnyConnect Secure Mobility Client (connecting with SSL or IPsec/IKEv2)
– Clientless SSL VPN (browser-based connecting with SSL)

Cisco ASA 5500 Series Configuration Guide using the CLI

67-7

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

– Cisco ASA5500 Easy VPN hardware client (connecting with IPsec/IKEv1)
– Cisco VPM 3002 hardware client (connecting with IPsec/IKEv1)

We also provide a default group policy named DfltGrpPolicy.
To configure an remote-access connection profile, first configure the tunnel-group general attributes,
then the remote-access attributes. See the following sections:
•

Specifying a Name and Type for the Remote Access Connection Profile, page 67-8.

•

Configuring Remote-Access Connection Profile General Attributes, page 67-8.

•

Configuring Double Authentication, page 67-12

•

Configuring Remote-Access Connection Profile IPsec IKEv1 Attributes, page 67-13.

•

Configuring IPsec Remote-Access Connection Profile PPP Attributes, page 67-15

Specifying a Name and Type for the Remote Access Connection Profile
Create the connection profile, specifying its name and type, by entering the tunnel-group command. For
an remote-access tunnel, the type is remote-access:
hostname(config)# tunnel-group tunnel_group_name type remote-access
hostname(config)#

For example, to create an remote-access connection profile named TunnelGroup1, enter the following
command:
hostname(config)# tunnel-group TunnelGroup1 type remote-access
hostname(config)#

Configuring Remote-Access Connection Profile General Attributes
To configure or change the connection profile general attributes, specify the parameters in the following
steps.
Step 1

To configure the general attributes, enter the tunnel-group general-attributes command, which enters
tunnel-group general-attributes configuration mode. The prompt changes to indicate the change in mode.
hostname(config)# tunnel-group tunnel_group_name general-attributes
hostname(config-tunnel-general)#

Step 2

Specify the name of the authentication-server group, if any, to use. If you want to use the LOCAL
database for authentication if the specified server group fails, append the keyword LOCAL:
hostname(config-tunnel-general)# authentication-server-group [(interface_name)] groupname
[LOCAL]
hostname(config-tunnel-general)#

The name of the authentication server group can be up to 16 characters long.
You can optionally configure interface-specific authentication by including the name of an interface after
the group name. The interface name, which specifies where the tunnel terminates, must be enclosed in
parentheses. The following command configures interface-specific authentication for the interface
named test using the server named servergroup1 for authentication:
hostname(config-tunnel-general)# authentication-server-group (test) servergroup1
hostname(config-tunnel-general)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-8

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

Step 3

Specify the name of the authorization-server group, if any, to use. When you configure this value, users
must exist in the authorization database to connect:
hostname(config-tunnel-general)# authorization-server-group groupname
hostname(config-tunnel-general)#

The name of the authorization server group can be up to 16 characters long. For example, the following
command specifies the use of the authorization-server group FinGroup:
hostname(config-tunnel-general)# authorization-server-group FinGroup
hostname(config-tunnel-general)#

Step 4

Specify the name of the accounting-server group, if any, to use:
hostname(config-tunnel-general)# accounting-server-group groupname
hostname(config-tunnel-general)#

The name of the accounting server group can be up to 16 characters long. For example, the following
command specifies the use of the accounting-server group named comptroller:
hostname(config-tunnel-general)# accounting-server-group comptroller
hostname(config-tunnel-general)#

Step 5

Specify the name of the default group policy:
hostname(config-tunnel-general)# default-group-policy policyname
hostname(config-tunnel-general)#

The name of the group policy can be up to 64 characters long. The following example sets DfltGrpPolicy
as the name of the default group policy:
hostname(config-tunnel-general)# default-group-policy DfltGrpPolicy
hostname(config-tunnel-general)#

Step 6

Specify the names or IP addresses of the DHCP server (up to 10 servers), and the names of the DHCP
address pools (up to 6 pools). The defaults are no DHCP server and no address pool. The dhcp-server
command will allow you to configure the security appliance to send additional options to the specified
DHCP servers when it is trying to get IP addresses for VPN clients. See the dhcp-server command in
the Cisco Security Appliance Command Reference guide for more information.
hostname(config-tunnel-general)# dhcp-server server1 [...server10]
hostname(config-tunnel-general)# address-pool [(interface name)] address_pool1
[...address_pool6]
hostname(config-tunnel-general)#

Note

If you specify an interface name, you must enclosed it within parentheses.

You configure address pools with the ip local pool command in global configuration mode.
Step 7

Specify the name of the NAC authentication server group, if you are using Network Admission Control,
to identify the group of authentication servers to be used for Network Admission Control posture
validation. Configure at least one Access Control Server to support NAC. Use the aaa-server command
to name the ACS group. Then use the nac-authentication-server-group command, using the same name
for the server group.
The following example identifies acs-group1 as the authentication server group to be used for NAC
posture validation:
hostname(config-group-policy)# nac-authentication-server-group acs-group1
hostname(config-group-policy)

Cisco ASA 5500 Series Configuration Guide using the CLI

67-9

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

The following example inherits the authentication server group from the default remote access group.
hostname(config-group-policy)# no nac-authentication-server-group
hostname(config-group-policy)

Note
Step 8

NAC requires a Cisco Trust Agent on the remote host.

Specify whether to strip the group or the realm from the username before passing it on to the AAA server.
The default is not to strip either the group name or the realm.
hostname(config-tunnel-general)# strip-group
hostname(config-tunnel-general)# strip-realm
hostname(config-tunnel-general)#

A realm is an administrative domain. If you strip the realm, the ASA uses the username and the group
(if present) authentication. If you strip the group, the ASA uses the username and the realm (if present)
for authentication.Enter the strip-realm command to remove the realm qualifier, and use the strip-group
command to remove the group qualilfier from the username during authentication. If you remove both
qualifiers, authentication is based on the username alone. Otherwise, authentication is based on the full
username@realm or username group string. You must specify strip-realm if your server is
unable to parse delimiters.
Step 9

Optionally, if your server is a RADIUS, RADIUS with NT, or LDAP server, you can enable password
management.

Note

If you are using an LDAP directory server for authentication, password management is
supported with the Sun Microsystems JAVA System Directory Server (formerly named the Sun
ONE Directory Server) and the Microsoft Active Directory.
Sun—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 ACI on
the default password policy.
Microsoft—You must configure LDAP over SSL to enable password management with
Microsoft Active Directory.
See the “Configuring Authorization with LDAP for VPN” section on page 35-16 for more
information.

This feature, which is disabled by default, warns a user when the current password is about to expire.
The default is to begin warning the user 14 days before expiration:
hostname(config-tunnel-general)# password-management
hostname(config-tunnel-general)#

If the server is an LDAP server, you can specify the number of days (0 through 180) before expiration
to begin warning the user about the pending expiration:
hostname(config-tunnel-general)# password-management [password-expire in days n]
hostname(config-tunnel-general)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-10

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

Note

The password-management command, entered in tunnel-group general-attributes
configuration mode replaces the deprecated radius-with-expiry command that was formerly
entered in tunnel-group ipsec-attributes mode.

When you configure the password-management command, the ASA notifies the remote user at login
that the user’s current password is about to expire or has expired. The ASA then offers the user the
opportunity to change the password. If the current password has not yet expired, the user can still log in
using that password. The ASA ignores this command if RADIUS or LDAP authentication has not been
configured.
Note that this does not change the number of days before the password expires, but rather, the number
of days ahead of expiration that the ASA starts warning the user that the password is about to expire.
If you do specify the password-expire-in-days keyword, you must also specify the number of days.
Specifying this command with the number of days set to 0 disables this command. The ASA does not
notify the user of the pending expiration, but the user can change the password after it expires.
See Configuring Microsoft Active Directory Settings for Password Management, page 67-28 for more
information.

Note

The ASA, releases 7.1 and later, generally supports password management for the AnyConnect
VPN Client, the Cisco IPsec VPN Client, the SSL VPN full-tunneling client, and Clientless
connections when authenticating with LDAP or with any RADIUS connection that supports
MS-CHAPv2. Password management is not supported for any of these connection types for
Kerberos/AD (Windows password) or NT 4.0 Domain.
Some RADIUS servers that support MS-CHAP do not currently support MS-CHAPv2. The
password-management command requires MS-CHAPv2, so please check with your vendor.
The RADIUS server (for example, Cisco ACS) could proxy the authentication request to another
authentication server. However, from the ASA perspective, it is talking only to a RADIUS server.
For LDAP, the method to change a password is proprietary for the different LDAP servers on the
market. Currently, the ASA implements the proprietary password management logic only for
Microsoft Active Directory and Sun LDAP servers. Native LDAP requires an SSL connection.
You must enable LDAP over SSL before attempting to do password management for LDAP. By
default, LDAP uses port 636.

Step 10

Optionally, configure the ability to override an account-disabled indicator from a AAA server, by
entering the override-account-disable command:
hostname(config-tunnel-general)# override-account-disable
hostname(config-tunnel-general)#

Note
Step 11

Allowing override-account-disable is a potential security risk.
Specify the attribute or attributes to use in deriving a name for an authorization query from a certificate.
This attribute specifies what part of the subject DN field to use as the username for authorization:
hostname(config-tunnel-general)# authorization-dn-attributes {primary-attribute
[secondary-attribute] | use-entire-name}

Cisco ASA 5500 Series Configuration Guide using the CLI

67-11

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

For example, the following command specifies the use of the CN attribute as the username for
authorization:
hostname(config-tunnel-general)# authorization-dn-attributes CN
hostname(config-tunnel-general)#

The authorization-dn-attributes are C (Country), CN (Common Name), DNQ (DN qualifier), EA
(E-mail Address), 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), and UPN (User Principal Name).
Step 12

Specify whether to require a successful authorization before allowing a user to connect. The default is
not to require authorization.
hostname(config-tunnel-general)# authorization-required
hostname(config-tunnel-general)#

Configuring Double Authentication
Double authentication is an optional feature that requires a user to enter an additional authentication
credential, such as a second username and password, on the login screen. Specify the following
commands to configure double authentication.
Step 1

Note

Specify the secondary authentication server group. This command specifies the AAA server group to use
as the secondary AAA server.

This command applies only to AnyConnect client VPN connections.
The secondary server group cannot specify an SDI server group. By default, no secondary authentication
is required.
hostname(config-tunnel-general)# secondary-authentication-server-group [interface_name]
{none | LOCAL | groupname [LOCAL]} [use-primary-name]

If you use the none keyword, no secondary authentication is required. The groupname value specifies
the AAA server group name. Local specifies the use of the internal server database, and when used with
the groupname value, LOCAL specifies fallback. For example, to set the primary authentication server
group to sdi_group and the secondary authentication server group to ldap_server, enter the following
commands:
hostname(config-tunnel-general)# authentication-server-group
hostname(config-tunnel-general)# secondary-authentication-server-group

Note

Step 2

If you specify the use-primary-name keyword, then the login dialog requests only one
username. In addition, if the usernames are extracted from a digital certificate, only the primary
username is used for authentication.

If obtaining the secondary username from a certificate, specify the secondary-username-from-certificate
command:
hostname(config-tunnel-general)# secondary-username-from-certificate C | CN | ... |
use-script

Cisco ASA 5500 Series Configuration Guide using the CLI

67-12

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

The values for the DN fields to extract from the certificate for use as a secondary username are the same
as for the primary username-from-certificate command. Alternatively, you can specify the use-script
keyword, which directs the ASA to use a script file generated by ASDM.
For example, to specify the Common Name as the primary username field and Organizational Unit as
the secondary username field, enter the following commands:
hostname(config-tunnel-general)# tunnel-group test1 general-attributes
hostname(config-tunnel-general)# username-from-certificate cn
hostname(config-tunnel-general)# secondary-username-from-certificate ou

Step 3

Specify the secondary-pre-fill-username command in tunnel-group webvpn-attributes mode to enable
extracting a secondary username from a client certificate for use in authentication. Use the keywords to
specify whether this command applies to a clientless connection or an SSL VPN (AnyConnect) client
connection and whether you want to hide the extracted username from the end user. This feature is
disabled by default. Clientless and SSL-client options can both exist at the same time, but you must
configure them in separate commands.
hostname(config-tunnel-general)# secondary-pre-fill-username-from-certificate {clientless
| ssl-client} [hide]

For example, to specify the use of pre-fill-username for both the primary and secondary authentication
for a connection, enter the following commands:
hostname(config-tunnel-general)# tunnel-group test1 general-attributes
hostname(config-tunnel-general)# pre-fill-username ssl-client
hostname(config-tunnel-general)# secondary-pre-fill-username ssl-client

Step 4

Specify which authentication server to use to obtain the authorization attributes to apply to the
connection. The primary authentication server is the default selection. This command is meaningful only
for double authentication.
hostname(config-tunnel-general)# authentication-attr-from-server {primary | secondary}

For example, to specify the use of the secondary authentication server, enter the following commands:
hostname(config-tunnel-general)# tunnel-group test1 general-attributes
hostname(config-tunnel-general)# authentication-attr-from-server secondary

Step 5

Specify which authentication username, primary or secondary, to associate with the session. The default
value is primary. With double authentication enabled, it is possible that two distinct usernames are
authenticated for the session. The administrator must designate one of the authenticated usernames as
the session username. The session username is the username provided for accounting, session database,
syslogs, and debug output.
hostname(config-tunnel-general)# authenticated-session-username {primary | secondary}

For example, to specify that the authentication username associated with the session must come from the
secondary authentication server, enter the following commands:
hostname(config-tunnel-general)# tunnel-group test1 general-attributes
hostname(config-tunnel-general)# authenticated-session-username secondary

Configuring Remote-Access Connection Profile IPsec IKEv1 Attributes
To configure the IPsec IKEv1 attributes for a remote-access connection profile, do the following steps.
The following description assumes that you have already created the remote-access connection profile.
Remote-access connection profiles have more attributes than LAN-to-LAN connection profiles:

Cisco ASA 5500 Series Configuration Guide using the CLI

67-13

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

Step 1

To specify the IPsec attributes of an remote-access tunnel-group, enter tunnel-group ipsec-attributes
mode by entering the following command. The prompt changes to indicate the mode change:
hostname(config)# tunnel-group tunnel-group-name ipsec-attributes
hostname(config-tunnel-ipsec)#

This command enters tunnel-group ipsec-attributes configuration mode, in which you configure the
remote-access tunnel-group IPsec attributes.
For example, the following command designates that the tunnel-group ipsec-attributes mode commands
that follow pertain to the connection profile named TG1. Notice that the prompt changes to indicate that
you are now in tunnel-group ipsec-attributes mode:
hostname(config)# tunnel-group TG1 type remote-access
hostname(config)# tunnel-group TG1 ipsec-attributes
hostname(config-tunnel-ipsec)#

Step 2

Specify the preshared key to support IKEv1 connections based on preshared keys. For example, the
following command specifies the preshared key xyzx to support IKEv1 connections for an IPsec IKEv1
remote access connection profile:
hostname(config-tunnel-ipsec)# ikev1 pre-shared-key xyzx
hostname(config-tunnel-ipsec)#

Step 3

Specify whether to validate the identity of the peer using the peer’s certificate:
hostname(config-tunnel-ipsec)# peer-id-validate option
hostname(config-tunnel-ipsec)#

The available options are req (required), cert (if supported by certificate), and nocheck (do not check).
The default is req.
For example, the following command specifies that peer-id validation is required:
hostname(config-tunnel-ipsec)# peer-id-validate req
hostname(config-tunnel-ipsec)#

Step 4

Specify whether to enable sending of a certificate chain. The following command includes the root
certificate and any subordinate CA certificates in the transmission:
hostname(config-tunnel-ipsec)# chain
hostname(config-tunnel-ipsec)#

This attribute applies to all IPsec tunnel-group types.
Step 5

Specify the name of a trustpoint that identifies the certificate to be sent to the IKE peer:
hostname(config-tunnel-ipsec)# ikev1 trust-point trust-point-name
hostname(config-tunnel-ipsec)#

The following command specifies mytrustpoint as the name of the certificate to be sent to the IKE peer:
hostname(config-ipsec)# ikev1 trust-point mytrustpoint

Step 6

Specify the ISAKMP keepalive threshold and the number of retries allowed.
hostname(config-tunnel-ipsec)# isakmp keepalive threshold  retry 
hostname(config-tunnel-ipsec)#

The threshold parameter specifies the number of seconds (10 through 3600) that the peer is allowed to
idle before beginning keepalive monitoring. The retry parameter is the interval (2 through 10 seconds)
between retries after a keepalive response has not been received. IKE keepalives are enabled by default.
To disable IKE keepalives, enter the no form of the isakmp command:

Cisco ASA 5500 Series Configuration Guide using the CLI

67-14

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

For example, the following command sets the IKE keepalive threshold value to 15 seconds and sets the
retry interval to 10 seconds:
hostname(config-tunnel-ipsec)# isakmp keepalive threshold 15 retry 10
hostname(config-tunnel-ipsec)#

The default value for the threshold parameter is 300 for remote-access and 10 for LAN-to-LAN, and the
default value for the retry parameter is 2.
To specify that the central site (“head end”) should never initiate ISAKMP monitoring, enter the
following command:
hostname(config-tunnel-ipsec)# isakmp keepalive threshold infinite
hostname(config-tunnel-ipsec)#

Step 7

Specify the ISAKMP hybrid authentication method, XAUTH or hybrid XAUTH.
You use isakmp ikev1-user-authentication command to implement hybrid XAUTH authentication
when you need to use digital certificates for ASA authentication and a different, legacy method for
remote VPN user authentication, such as RADIUS, TACACS+ or SecurID. Hybrid XAUTH breaks phase
1 of IKE down into the following two steps, together called hybrid authentication:
a.

The ASA authenticates to the remote VPN user with standard public key techniques. This
establishes an IKE security association that is unidirectionally authenticated.

b.

An XAUTH exchange then authenticates the remote VPN user. This extended authentication can use
one of the supported legacy authentication methods.

Note

Before the authentication type can be set to hybrid, you must configure the authentication server,
create a preshared key, and configure a trustpoint.

You can use the isakmp ikev1-user-authentication command with the optional interface parameter to
specify a particular interface. When you omit the interface parameter, the command applies to all the
interfaces and serves as a back-up when the per-interface command is not specified. When there are two
isakmp ikev1-user-authentication commands specified for a connection profile, and one uses the
interface parameter and one does not, the one specifying the interface takes precedence for that
particular interface.
For example, the following commands enable hybrid XAUTH on the inside interface for a connection
profile called example-group:
hostname(config)# tunnel-group example-group type remote-access
hostname(config)# tunnel-group example-group ipsec-attributes
hostname(config-tunnel-ipsec)# isakmp ikev1-user-authentication (inside) hybrid
hostname(config-tunnel-ipsec)#

Configuring IPsec Remote-Access Connection Profile PPP Attributes
To configure the Point-to-Point Protocol attributes for a remote-access connection profile, do the
following steps. PPP attributes apply only to IPsec remote-access connection profiles. The following
description assumes that you have already created the IPsec remote-access connection profile.
Step 1

Enter tunnel-group ppp-attributes configuration mode, in which you configure the remote-access
tunnel-group PPP attributes, by entering the following command. The prompt changes to indicate the
mode change:

Cisco ASA 5500 Series Configuration Guide using the CLI

67-15

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

hostname(config)# tunnel-group tunnel-group-name type remote-access
hostname(config)# tunnel-group tunnel-group-name ppp-attributes
hostname(config-tunnel-ppp)#

For example, the following command designates that the tunnel-group ppp-attributes mode commands
that follow pertain to the connection profile named TG1. Notice that the prompt changes to indicate that
you are now in tunnel-group ppp-attributes mode:
hostname(config)# tunnel-group TG1 type remote-access
hostname(config)# tunnel-group TG1 ppp-attributes
hostname(config-tunnel-ppp)#

Step 2

Specify whether to enable authentication using specific protocols for the PPP connection. The protocol
value can be:
•

pap—Enables the use of Password Authentication Protocol for the PPP connection.

•

chap—Enables the use of Challenge Handshake Authentication Protocol for the PPP connection.

•

ms-chap-v1 or ms-chap-v2—Enables the use of Microsoft Challenge Handshake Authentication
Protocol, version 1 or version 2 for the PPP connection.

•

eap—Enables the use of Extensible Authentication protocol for the PPP connection.

CHAP and MSCHAPv1 are enabled by default.
The syntax of this command is:
hostname(config-tunnel-ppp)# authentication protocol
hostname(config-tunnel-ppp)#

To disable authentication for a specific protocol, use the no form of the command:
hostname(config-tunnel-ppp)# no authentication protocol
hostname(config-tunnel-ppp)#

For example, the following command enables the use of the PAP protocol for a PPP connection.
hostname(config-tunnel-ppp)# authentication pap
hostname(config-tunnel-ppp)#

The following command enables the use of the MS-CHAP, version 2 protocol for a PPP connection:
hostname(config-tunnel-ppp)# authentication ms-chap-v2
hostname(config-tunnel-ppp)#

The following command enables the use of the EAP-PROXY protocol for a PPP connection:
hostname(config-tunnel-ppp)# authentication pap
hostname(config-tunnel-ppp)#

The following command disables the use of the MS-CHAP, version 1 protocol for a PPP connection:
hostname(config-tunnel-ppp)# no authentication ms-chap-v1
hostname(config-tunnel-ppp)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-16

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

Configuring LAN-to-LAN Connection Profiles
An IPsec LAN-to-LAN VPN connection profile applies only to LAN-to-LAN IPsec client connections.
While many of the parameters that you configure are the same as for IPsec remote-access connection
profiles, LAN-to-LAN tunnels have fewer parameters. The following sections show you how to
configure a LAN-to-LAN connection profile:
•

Specifying a Name and Type for a LAN-to-LAN Connection Profile, page 67-17

•

Configuring LAN-to-LAN Connection Profile General Attributes, page 67-17

•

Configuring LAN-to-LAN IPsec IKEv1 Attributes, page 67-18

Default LAN-to-LAN Connection Profile Configuration
The contents of the default LAN-to-LAN connection profile are as follows:
tunnel-group DefaultL2LGroup type ipsec-l2l
tunnel-group DefaultL2LGroup general-attributes
no accounting-server-group
default-group-policy DfltGrpPolicy
tunnel-group DefaultL2LGroup ipsec-attributes
no ikev1 pre-shared-key
peer-id-validate req
no chain
no ikev1 trust-point
isakmp keepalive threshold 10 retry 2

LAN-to-LAN connection profiles have fewer parameters than remote-access connection profiles, and
most of these are the same for both groups. For your convenience in configuring the connection, they are
listed separately here. Any parameters that you do not explicitly configure inherit their values from the
default connection profile.

Specifying a Name and Type for a LAN-to-LAN Connection Profile
To specify a name and a type for a connection profile, enter the tunnel-group command, as follows:
hostname(config)# tunnel-group tunnel_group_name type tunnel_type

For a LAN-to-LAN tunnel, the type is ipsec-l2l.; for example, to create the LAN-to-LAN connection
profile named docs, enter the following command:
hostname(config)# tunnel-group docs type ipsec-l2l
hostname(config)#

Configuring LAN-to-LAN Connection Profile General Attributes
To configure the connection profile general attributes, do the following steps:
Step 1

Enter tunnel-group general-attributes mode by specifying the general-attributes keyword:
hostname(config)# tunnel-group_tunnel-group-name general-attributes
hostname(config-tunnel-general)#

The prompt changes to indicate that you are now in config-general mode, in which you configure the
tunnel-group general attributes.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-17

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

For example, for the connection profile named docs, enter the following command:
hostname(config)# tunnel-group_docs general-attributes
hostname(config-tunnel-general)#

Step 2

Specify the name of the accounting-server group, if any, to use:
hostname(config-tunnel-general)# accounting-server-group groupname
hostname(config-tunnel-general)#

For example, the following command specifies the use of the accounting-server group acctgserv1:
hostname(config-tunnel-general)# accounting-server-group acctgserv1
hostname(config-tunnel-general)#

Step 3

Specify the name of the default group policy:
hostname(config-tunnel-general)# default-group-policy policyname
hostname(config-tunnel-general)#

For example, the following command specifies that the name of the default group policy is MyPolicy:
hostname(config-tunnel-general)# default-group-policy MyPolicy
hostname(config-tunnel-general)#

Configuring LAN-to-LAN IPsec IKEv1 Attributes
To configure the IPsec IKEv1 attributes, do the following steps:
Step 1

To configure the tunnel-group IPsec IKEv1 attributes, enter tunnel-group ipsec-attributes configuration
mode by entering the tunnel-group command with the IPsec-attributes keyword.
hostname(config)# tunnel-group tunnel-group-name ipsec-attributes
hostname(config-tunnel-ipsec)#

For example, the following command enters config-ipsec mode so you can configure the parameters for
the connection profile named TG1:
hostname(config)# tunnel-group TG1 ipsec-attributes
hostname(config-tunnel-ipsec)#

The prompt changes to indicate that you are now in tunnel-group ipsec-attributes configuration mode.
Step 2

Specify the preshared key to support IKEv1 connections based on preshared keys.
hostname(config-tunnel-ipsec)# ikev1 pre-shared-key key
hostname(config-tunnel-ipsec)#

For example, the following command specifies the preshared key XYZX to support IKEv1 connections
for an LAN-to-LAN connection profile:
hostname(config-tunnel-ipsec)# ikev1 pre-shared-key xyzx
hostname(config-tunnel-general)#

Step 3

Specify whether to validate the identity of the peer using the peer’s certificate:
hostname(config-tunnel-ipsec)# peer-id-validate option
hostname(config-tunnel-ipsec)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-18

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

The available options are req (required), cert (if supported by certificate), and nocheck (do not check).
The default is req. For example, the following command sets the peer-id-validate option to nocheck:
hostname(config-tunnel-ipsec)# peer-id-validate nocheck
hostname(config-tunnel-ipsec)#

Step 4

Specify whether to enable sending of a certificate chain. This action includes the root certificate and any
subordinate CA certificates in the transmission:
hostname(config-tunnel-ipsec)# chain
hostname(config-tunnel-ipsec)#

You can apply this attribute to all tunnel-group types.
Step 5

Specify the name of a trustpoint that identifies the certificate to be sent to the IKE peer:
hostname(config-tunnel-ipsec)# trust-point trust-point-name
hostname(config-tunnel-ipsec)#

For example, the following command sets the trustpoint name to mytrustpoint:
hostname(config-tunnel-ipsec)# trust-point mytrustpoint
hostname(config-tunnel-ipsec)#

You can apply this attribute to all tunnel-group types.
Step 6

Specify the ISAKMP (IKE) keepalive threshold and the number of retries allowed. The threshold
parameter specifies the number of seconds (10 through 3600) that the peer is allowed to idle before
beginning keepalive monitoring. The retry parameter is the interval (2 through 10 seconds) between
retries after a keepalive response has not been received. IKE keepalives are enabled by default. To
disable ISAKMP keepalives, enter isakmp keepalive disable.
For example, the following command sets the ISAKMP keepalive threshold to 15 seconds and sets the
retry interval to 10 seconds:
hostname(config-tunnel-ipsec)# isakmp keepalive threshold 15 retry 10
hostname(config-tunnel-ipsec)#

The default value for the threshold parameter for LAN-to-LAN is 10, and the default value for the retry
parameter is 2.
To specify that the central site (“head end”) should never initiate ISAKMP monitoring, enter the
following command:
hostname(config-tunnel-ipsec)# isakmp keepalive threshold infinite
hostname(config-tunnel-ipsec)#

Step 7

Specify the ISAKMP hybrid authentication method, XAUTH or hybrid XAUTH.
You use isakmp ikev1-user-authentication command to implement hybrid XAUTH authentication
when you need to use digital certificates for ASA authentication and a different, legacy method for
remote VPN user authentication, such as RADIUS, TACACS+ or SecurID. Hybrid XAUTH breaks phase
1 of IKE down into the following two steps, together called hybrid authentication:
a.

The ASA authenticates to the remote VPN user with standard public key techniques. This
establishes an IKE security association that is unidirectionally authenticated.

b.

An XAUTH exchange then authenticates the remote VPN user. This extended authentication can use
one of the supported legacy authentication methods.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-19

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

Note

Before the authentication type can be set to hybrid, you must configure the authentication server,
create a preshared key, and configure a trustpoint.

For example, the following commands enable hybrid XAUTH for a connection profile called
example-group:
hostname(config)# tunnel-group example-group type remote-access
hostname(config)# tunnel-group example-group ipsec-attributes
hostname(config-tunnel-ipsec)# isakmp ikev1-user-authentication hybrid
hostname(config-tunnel-ipsec)#

Configuring Connection Profiles for Clientless SSL VPN Sessions
The tunnel-group general attributes for clientless SSL VPN connection profiles are the same as those for
IPsec remote-access connection profiles, except that the tunnel-group type is webvpn and the
strip-group and strip-realm commands do not apply. You define the attribute specific to clientless SSL
VPN separately. The following sections describe how to configure clientless SSL VPN connection
profiles:
•

Configuring General Tunnel-Group Attributes for Clientless SSL VPN Sessions, page 67-20

•

Configuring Tunnel-Group Attributes for Clientless SSL VPN Sessions, page 67-23

Configuring General Tunnel-Group Attributes for Clientless SSL VPN Sessions
To configure or change the connection profile general attributes, specify the parameters in the following
steps.
Step 1

To configure the general attributes, enter tunnel-group general-attributes command, which enters
tunnel-group general-attributes configuration mode. Note that the prompt changes:
hostname(config)# tunnel-group tunnel_group_name general-attributes
hostname(config-tunnel-general)#

To configure the general attributes for TunnelGroup3, created in the previous section, enter the following
command:
hostname(config)# tunnel-group TunnelGroup3 general-attributes
hostname(config-tunnel-general)#

Step 2

Specify the name of the authentication-server group, if any, to use. If you want to use the LOCAL
database for authentication if the specified server group fails, append the keyword LOCAL:
hostname(config-tunnel-general)# authentication-server-group groupname [LOCAL]
hostname(config-tunnel-general)#

For example, to configure the authentication server group named test, and to provide fallback to the
LOCAL server if the authentication server group fails, enter the following command:
hostname(config-tunnel-general)# authentication-server-group test LOCAL
hostname(config-tunnel-general)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-20

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

The authentication-server-group name identifies a previously configured authentication server or group
of servers. Use the aaa-server command to configure authentication servers. The maximum length of
the group tag is 16 characters.
You can also configure interface-specific authentication by including the name of an interface in
parentheses before the group name. The following interfaces are available by default:
•

inside—Name of interface GigabitEthernet0/1

•

outside— Name of interface GigabitEthernet0/0

Other interfaces you have configured (using the interface command) are also available. The following
command configures interface-specific authentication for the interface named outside using the server
servergroup1 for authentication:
hostname(config-tunnel-general)# authentication-server-group (outside) servergroup1
hostname(config-tunnel-general)#

Step 3

Optionally, specify the name of the authorization-server group, if any, to use. If you are not using
authorization, go to Step 6. When you configure this value, users must exist in the authorization database
to connect:
hostname(config-tunnel-general)# authorization-server-group groupname
hostname(config-tunnel-general)#

Use the aaa-server command to configure authorization servers. The maximum length of the group tag
is 16 characters.
For example, the following command specifies the use of the authorization-server group FinGroup:
hostname(config-tunnel-general)# authorization-server-group FinGroup
hostname(config-tunnel-general)#

Step 4

Specify whether to require a successful authorization before allowing a user to connect. The default is
not to require authorization.
hostname(config-tunnel-general)# authorization-required
hostname(config-tunnel-general)#

Step 5

Specify the attribute or attributes to use in deriving a name for an authorization query from a certificate.
This attribute specifies what part of the subject DN field to use as the username for authorization:
hostname(config-tunnel-general)# authorization-dn-attributes {primary-attribute
[secondary-attribute] | use-entire-name}

For example, the following command specifies the use of the CN attribute as the username for
authorization:
hostname(config-tunnel-general)# authorization-dn-attributes CN
hostname(config-tunnel-general)#

The authorization-dn-attributes are C (Country), CN (Common Name), DNQ (DN qualifier), EA
(E-mail Address), 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), and UPN (User Principal Name).
Step 6

Optionally, specify the name of the accounting-server group, if any, to use. If you are not using
accounting, go to Step 7. Use the aaa-server command to configure accounting servers. The maximum
length of the group tag is 16 characters.:
hostname(config-tunnel-general)# accounting-server-group groupname
hostname(config-tunnel-general)#

For example, the following command specifies the use of the accounting-server group comptroller:

Cisco ASA 5500 Series Configuration Guide using the CLI

67-21

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

hostname(config-tunnel-general)# accounting-server-group comptroller
hostname(config-tunnel-general)#

Step 7

Optionally, specify the name of the default group policy. The default value is DfltGrpPolicy:
hostname(config-tunnel-general)# default-group-policy policyname
hostname(config-tunnel-general)#

The following example sets MyDfltGrpPolicy as the name of the default group policy:
hostname(config-tunnel-general)# default-group-policy MyDfltGrpPolicy
hostname(config-tunnel-general)#

Step 8

Optionally, specify the name or IP address of the DHCP server (up to 10 servers), and the names of the
DHCP address pools (up to 6 pools). Separate the list items with spaces. The defaults are no DHCP
server and no address pool.
hostname(config-tunnel-general)# dhcp-server server1 [...server10]
hostname(config-tunnel-general)# address-pool [(interface name)] address_pool1
[...address_pool6]
hostname(config-tunnel-general)#

Note

The interface name must be enclosed in parentheses.

You configure address pools with the ip local pool command in global configuration mode. See
Chapter 68, “Configuring IP Addresses for VPNs” for information about configuring address pools.
Step 9

Note

Optionally, if your server is a RADIUS, RADIUS with NT, or LDAP server, you can enable password
management.

If you are using an LDAP directory server for authentication, password management is supported with
the Sun Microsystems JAVA System Directory Server (formerly named the Sun ONE Directory Server)
and the Microsoft Active Directory.
•

Sun—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 ACI on the
default password policy.

•

Microsoft—You must configure LDAP over SSL to enable password management with Microsoft
Active Directory.

See the “Configuring Authorization with LDAP for VPN” section on page 35-16 for more information.

This feature, which is enabled by default, warns a user when the current password is about to expire. The
default is to begin warning the user 14 days before expiration:
hostname(config-tunnel-general)# password-management
hostname(config-tunnel-general)#

If the server is an LDAP server, you can specify the number of days (0 through 180) before expiration
to begin warning the user about the pending expiration:
hostname(config-tunnel-general)# password-management [password-expire in days n]
hostname(config-tunnel-general)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-22

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

Note

The password-management command, entered in tunnel-group general-attributes
configuration mode replaces the deprecated radius-with-expiry command that was formerly
entered in tunnel-group ipsec-attributes mode.

When you configure this command, the ASA notifies the remote user at login that the user’s current
password is about to expire or has expired. The ASA then offers the user the opportunity to change the
password. If the current password has not yet expired, the user can still log in using that password. The
ASA ignores this command if RADIUS or LDAP authentication has not been configured.
Note that this does not change the number of days before the password expires, but rather, the number
of days ahead of expiration that the ASA starts warning the user that the password is about to expire.
If you do specify the password-expire-in-days keyword, you must also specify the number of days.
See Configuring Microsoft Active Directory Settings for Password Management, page 67-28 for more
information.
Step 10

Specifying this command with the number of days set to 0 disables this command. The ASA does not
notify the user of the pending expiration, but the user can change the password after it
expires.Optionally, configure the ability to override an account-disabled indicator from the AAA server,
by entering the override-account-disable command:
hostname(config-tunnel-general)# override-account-disable
hostname(config-tunnel-general)#

Note

Allowing override account-disabled is a potential security risk.

Configuring Tunnel-Group Attributes for Clientless SSL VPN Sessions
To configure the parameters specific to a clientless SSL VPN connection profile, follow the steps in this
section. Clientless SSL VPN was formerly known as WebVPN, and you configure these attributes in
tunnel-group webvpn-attributes mode.
Step 1

To specify the attributes of a clientless SSL VPN tunnel-group, enter tunnel-group webvpn-attributes
mode by entering the following command. The prompt changes to indicate the mode change:
hostname(config)# tunnel-group tunnel-group-name webvpn-attributes
hostname(config-tunnel-ipsec)#

For example, to specify the webvpn-attributes for the clientless SSL VPN tunnel-group named sales,
enter the following command:
hostname(config)# tunnel-group sales webvpn-attributes
hostname(config-tunnel-webvpn)#

Step 2

To specify the authentication method to use: AAA, digital certificates, or both, enter the authentication
command. You can specify either aaa or certificate or both, in any order.
hostname(config-tunnel-webvpn)# authentication authentication_method
hostname(config-tunnel-webvpn)#

For example, The following command allows both AAA and certificate authentication:
hostname(config-tunnel-webvpn)# authentication aaa certificate

Cisco ASA 5500 Series Configuration Guide using the CLI

67-23

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

hostname(config-tunnel-webvpn)#

Applying Customization

Customizations determine the appearance of the windows that the user sees upon login. You configure
the customization parameters as part of configuring clientless SSL VPN.
To apply a previously defined web-page customization to change the look-and-feel of the web page that
the user sees at login, enter the customization command in username webvpn configuration mode:
hostname(config-username-webvpn)# customization {none | value customization_name}
hostname(config-username-webvpn)#

For example, to use the customization named blueborder, enter the following command:
hostname(config-username-webvpn)# customization value blueborder
hostname(config-username-webvpn)#

You configure the customization itself by entering the customization command in webvpn mode.
The following example shows a command sequence that first establishes a customization named “123”
that defines a password prompt. The example then defines a clientless SSL VPN tunnel-group named
“test” and uses the customization command to specify the use of the customization named “123”:
hostname(config)# webvpn
hostname(config-webvpn)# customization 123
hostname(config-webvpn-custom)# password-prompt Enter password
hostname(config-webvpn)# exit
hostname(config)# tunnel-group test type webvpn
hostname(config)# tunnel-group test webvpn-attributes
hostname(config-tunnel-webvpn)# customization value 123
hostname(config-tunnel-webvpn)#

Step 3

The ASA queries NetBIOS name servers to map NetBIOS names to IP addresses. Clientless SSL VPN
requires NetBIOS to access or share files on remote systems. Clientless SSL VPN uses NetBIOS and the
CIFS protocol to access or share files on remote systems. When you attempt a file-sharing connection to
a Windows computer by using its computer name, the file server you specify corresponds to a specific
NetBIOS name that identifies a resource on the network.
To make the NBNS function operational, you must configure at least one NetBIOS server (host). You
can configure up to three NBNS servers for redundancy. The ASA uses the first server on the list for
NetBIOS/CIFS name resolution. If the query fails, it uses the next server.
To specify the name of the NBNS (NetBIOS Name Service) server to use for CIFS name resolution, use
the nbns-server command. You can enter up to three server entries. The first server you configure is the
primary server, and the others are backups, for redundancy. You can also specify whether this is a master
browser (rather than just a WINS server), the timeout interval, and the number of retries. A WINS server
or a master browser is typically on the same network as the ASA, or reachable from that network. You
must specify the timeout interval before the number of retries:
hostname(config-tunnel-webvpn)# nbns-server {host-name | IP_address} [master]
[timeout seconds] [retry number]
hostname(config-tunnel-webvpn)#

For example, to configure the server named nbnsprimary as the primary server and the server
192.168.2.2 as the secondary server, each allowing three retries and having a 5-second timeout, enter the
following command:
hostname(config)# name 192.168.2.1 nbnsprimary
hostname(config-tunnel-webvpn)# nbns-server nbnsprimary master timeout 5 retry 3
hostname(config-tunnel-webvpn)# nbns-server 192.168.2.2 timeout 5 retry 3
hostname(config-tunnel-webvpn)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-24

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

The timeout interval can range from 1 through 30 seconds (default 2), and the number of retries can be
in the range 0 through 10 (default 2).
The nbns-server command in tunnel-group webvpn-attributes configuration mode replaces the
deprecated nbns-server command in webvpn configuration mode.
Step 4

To specify alternative names for the group, use the group-alias command. Specifying the group alias
creates one or more alternate names by which the user can refer to a tunnel-group. The group alias that
you specify here appears in the drop-down list on the user’s login page. Each group can have multiple
aliases or no alias, each specified in separate commands. This feature is useful when the same group is
known by several common names, such as “Devtest” and “QA”.
For each group alias, enter a group-alias command. Each alias is enabled by default. You can optionally
explicitly enable or disable each alias:
hostname(config-tunnel-webvpn)# group-alias alias [enable | disable]
hostname(config-tunnel-webvpn)#

For example, to enable the aliases QA and Devtest for a tunnel-group named QA, enter the following
commands:
hostname(config-tunnel-webvpn)# group-alias QA enable
hostname(config-tunnel-webvpn)# group-alias Devtest enable
hostname(config-tunnel-webvpn)#

Note
Step 5

The webvpn tunnel-group-list must be enabled for the (dropdown) group list to appear.
To specify incoming URLs or IP addresses for the group, use the group-url command. Specifying a
group URL or IP address eliminates the need for the user to select a group at login. When a user logs in,
the ASA looks for the user’s incoming URL or address in the tunnel-group-policy table. If it finds the
URL or address and if group-url is enabled in the connection profile, then the ASA automatically selects
the associated connection profile and presents the user with only the username and password fields in
the login window. This simplifies the user interface and has the added advantage of never exposing the
list of groups to the user. The login window that the user sees uses the customizations configured for that
connection profile.
If the URL or address is disabled and group-alias is configured, then the dropdown list of groups is also
displayed, and the user must make a selection.
You can configure multiple URLs or addresses (or none) for a group. Each URL or address can be
enabled or disabled individually. You must use a separate group-url command for each URL or address
specified. You must specify the entire URL or address, including either the http or https protocol.
You cannot associate the same URL or address with multiple groups. The ASA verifies the uniqueness
of the URL or address before accepting the URL or address for a connection profile.
For each group URL or address, enter a group-url command. You can optionally explicitly enable (the
default) or disable each URL or alias:
hostname(config-tunnel-webvpn)# group-url url [enable | disable]
hostname(config-tunnel-webvpn)#

For example, to enable the group URLs http://www.cisco.com and http://192.168.10.10 for the
tunnel-group named RadiusServer, enter the following commands:
hostname(config)# tunnel-group RadiusServer type webvpn
hostname(config)# tunnel-group RadiusServer general-attributes
hostname(config-tunnel-general)# authentication server-group RADIUS
hostname(config-tunnel-general)# accounting-server-group RADIUS

Cisco ASA 5500 Series Configuration Guide using the CLI

67-25

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

hostname(config-tunnel-general)# tunnel-group RadiusServer webvpn-attributes
hostname(config-tunnel-webvpn)# group-alias “Cisco Remote Access” enable
hostname(config-tunnel-webvpn)# group-url http://www.cisco.com enable
hostname(config-tunnel-webvpn)# group-url http://192.168.10.10 enable
hostname(config-tunnel-webvpn)#

For a more extensive example, see Customizing Login Windows for Users of Clientless SSL VPN
sessions, page 67-27.
Step 6

To exempt certain users from running Cisco Secure Desktop on a per connection profile basis if they
enter one of the group-urls, enter the following command:
hostname(config-tunnel-webvpn)# without-csd
hostname(config-tunnel-webvpn)#

Note

Step 7

Entering this command prevents the detection of endpoint conditions for these sessions, so you
may need to adjust the dynamic access policy (DAP) configuration.

To specify the DNS server group to use for a connection profile for clientless SSL VPN sessions, use
the dns-group command. The group you specify must be one you already configured in global
configuration mode (using the dns server-group and name-server commands).
By default, the connection profile uses the DNS server group DefaultDNS. However, this group must be
configured before the security appliance can resolve DNS requests.
The following example configures a new DNS server group named corp_dns and specifies that server
group for the connection profile telecommuters:
hostname(config)# dns server-group corp_dns
hostname(config-dns-server-group)# domain-name cisco.com
hostname(config-dns-server-group)# name-server 209.165.200.224
hostname(config)# tunnel-group telecommuters webvpn-attributes
hostname(config-tunnel-webvpn)# dns-group corp_dns
hostname(config-tunnel-webvpn)#

Step 8

(Optional) To enable extracting a username from a client certificate for use in authentication and
authorization, use the pre-fill-username command in tunnel-group webvpn-attributes mode. There is no
default value.
hostname(config)# pre-fill-username {ssl-client | clientless}

The pre-fill-username command enables the use of a username extracted from the certificate field
specified in the username-from-certificate command (in tunnel-group general-attributes mode) as the
username for username/password authentication and authorization. To use this pre-fill username from
certificate feature, you must configure both commands.

Note

In Release 8.0.4, the username is not pre-filled; instead, any data sent in the username field is
ignored.

The following example, entered in global configuration mode, creates an IPsec remote access tunnel
group named remotegrp, enables getting the username from a certificate, and specifies that the name for
an authentication or authorization query for an SSL VPN client must be derived from a digital certificate:
hostname(config)# tunnel-group remotegrp type ipsec_ra
hostname(config)# tunnel-group remotegrp general-attributes
hostname(config-tunnel-general)# username-from-certificate CN OU
hostname(config)# tunnel-group remotegrp webvpn-attributes
hostname(config-tunnel-webvpn)# pre-fill-username ssl-client

Cisco ASA 5500 Series Configuration Guide using the CLI

67-26

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

hostname(config-tunnel-webvpn)#

Step 9

(Optional) To specify whether to override the group policy or username attributes configuration for
downloading an AnyConnect or SSL VPN client, use the override-svc-download command. This feature
is disabled by default.
The security appliance allows clientless or AnyConnect client connections for remote users based on
whether clientless and/or SSL VPN is enabled in the group policy or username attributes with the
vpn-tunnel-protocol command. The anyconnect ask command further modifies the client user
experience by prompting the user to download the client or return to the WebVPN home page.
However, you might want clientless users logging in under specific tunnel groups to not experience
delays waiting for the download prompt to expire before being presented with the clientless SSL VPN
home page. You can prevent delays for these users at the connection profile level with the
override-svc-download command. This command causes users logging through a connection profile to
be immediately presented with the clientless SSL VPN home page regardless of the
vpn-tunnel-protocol or anyconnect ask command settings.
In the following example, the you enter tunnel-group webvpn attributes configuration mode for the
connection profile engineering and enable the connection profile to override the group policy and
username attribute settings for client download prompts:
hostname(config)# tunnel-group engineering webvpn-attributes
hostname(config-tunnel-webvpn)# override-svc-download

Step 10

(Optional) To enable the display of a RADIUS reject message on the login screen when authentication
is rejected, use the radius-eject-message command:
The following example enables the display of a RADIUS rejection message for the connection profile
named engineering:
hostname(config)# tunnel-group engineering webvpn-attributes
hostname(config-tunnel-webvpn)# radius-reject-message

Customizing Login Windows for Users of Clientless SSL VPN sessions
You can set up different login windows for different groups by using a combination of customization
profiles and connection profiles. For example, assuming that you had created a customization profile
called salesgui, you can create a connection profile for clientless SSL VPN sessions called sales that uses
that customization profile, as the following example shows:
Step 1

In webvpn mode, define a customization for clientless SSL VPN access, in this case named salesgui and
change the default logo to mycompanylogo.gif. You must have previously loaded mycompanylogo.gif
onto the flash memory of the ASA and saved the configuration. See “Chapter 74, “Configuring
Clientless SSL VPN”” for details.
hostname# webvpn
hostname (config-webvpn)# customization value salesgui
hostname(config-webvpn-custom)# logo file disk0:\mycompanylogo.gif
hostname(config-webvpn-custom)#

Step 2

In global configuration mode, set up a username and associate with it the customization for clientless
SSL VPN that you’ve just defined:
hostname# username seller attributes
hostname(config-username)# webvpn

Cisco ASA 5500 Series Configuration Guide using the CLI

67-27

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

hostname(config-username-webvpn)# customization value salesgui
hostname(config-username-webvpn)# exit
hostname(config-username)# exit
hostname#

Step 3

In global configuration mode, create a tunnel-group for clientless SSL VPN sessions named sales:
hostname# tunnel-group sales type webvpn
hostname(config-tunnel-webvpn)#

Step 4

Specify that you want to use the salesgui customization for this connection profile:
hostname# tunnel-group sales webvpn-attributes
hostname(config-tunnel-webvpn)# customization salesgui

Step 5

Set the group URL to the address that the user enters into the browser to log in to the ASA; for example,
if the ASA has the IP address 192.168.3.3, set the group URL to https://192.168.3.3:
hostname(config-tunnel-webvpn)# group-url https://192.168.3.3.
hostname(config-tunnel-webvpn)#

If a port number is required for a successful login, include the port number, preceded by a colon. The
ASA maps this URL to the sales connection profile and applies the salesgui customization profile to the
login screen that the user sees upon logging in to https://192.168.3.3.

Configuring Microsoft Active Directory Settings for Password Management
Note

If you are using an LDAP directory server for authentication, password management is supported with
the Sun Microsystems JAVA System Directory Server (formerly named the Sun ONE Directory Server)
and the Microsoft Active Directory.
•

Sun—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 ACI on the
default password policy.

•

Microsoft—You must configure LDAP over SSL to enable password management with Microsoft
Active Directory.

See the “Configuring Authorization with LDAP for VPN” section on page 35-16 for more information.

To use password management with Microsoft Active Directory, you must set certain Active Directory
parameters as well as configuring password management on the ASA. This section describes the Active
Directory settings associated with various password management actions. These descriptions assume
that you have also enabled password management on the ASA and configured the corresponding
password management attributes. The specific steps in the following sections refer to Active Directory
terminology under Windows 2000.
•

Using Active Directory to Force the User to Change Password at Next Logon, page 67-29.

•

Using Active Directory to Specify Maximum Password Age, page 67-30.

•

Using Active Directory to Override an Account Disabled AAA Indicator, page 67-31

•

Using Active Directory to Enforce Password Complexity, page 67-33.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-28

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

The following sections assume that you are using an LDAP directory server for authentication.

Using Active Directory to Force the User to Change Password at Next Logon
To force a user to change the user password at the next logon, specify the password-management
command in tunnel-group general-attributes configuration mode on the ASA and do the following steps
under Active Directory:
Step 1

Select to Start > Programs > Administrative Tools > Active Directory Users and Computers
(Figure 67-1).
Figure 67-1

Active Directory—Administrative Tools Menu

Step 2

Right-click Username > Properties > Account.

Step 3

Check the check box for User must change password at next logon (Figure 67-2).

Cisco ASA 5500 Series Configuration Guide using the CLI

67-29

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

Figure 67-2

Active Directory—User Must Change Password at Next Logon

The next time this user logs on, the ASA displays the following prompt: “New password required.
Password change required. You must enter a new password with a minimum length n to continue.” You
can set the minimum required password length, n, as part of the Active Directory configuration at Start >
Programs > Administrative Tools > Domain Security Policy > Windows Settings > Security Settings >
Account Policies > Password Policy. Select Minimum password length.

Using Active Directory to Specify Maximum Password Age
To enhance security, you can specify that passwords expire after a certain number of days. To specify a
maximum password age for a user password, specify the password-management command in
tunnel-group general-attributes configuration mode on the ASA and do the following steps under Active
Directory:
Step 1

Select Start > Programs > Administrative Tools > Domain Security Policy > Windows Settings >
Security Settings > Account Policies > Password Policy.

Step 2

Double-click Maximum password age. This opens the Security Policy Setting dialog box.

Step 3

Check the Define this policy setting check box and specify the maximum password age, in days, that you
want to allow.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-30

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

Figure 67-3

Note

Active Directory—Maximum Password Age

The radius-with-expiry command, formerly configured as part of tunnel-group remote-access
configuration to perform the password age function, is deprecated. The password-management
command, entered in tunnel-group general-attributes mode, replaces it.

Using Active Directory to Override an Account Disabled AAA Indicator
To override an account-disabled indication from a AAA server, specify the override-account-disable
command in tunnel-group general-attributes configuration mode on theASA and do the following steps
under Active Directory:

Note

Allowing override account-disabled is a potential security risk.

Step 1

Select Start > Programs > Administrative Tools > Active Directory Users and Computers.

Step 2

Right-click Username > Properties > Account and select Disable Account from the menu.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-31

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

Figure 67-4

Active Directory—Override Account Disabled

The user should be able to log on successfully, even though a AAA server provides an account-disabled
indicator.

Using Active Directory to Enforce Minimum Password Length
To enforce a minimum length for passwords, specify the password-management command in
tunnel-group general-attributes configuration mode on the ASA and do the following steps under Active
Directory:
Step 1

Select Start > Programs > Administrative Tools > Domain Security Policy.

Step 2

Select Windows Settings > Security Settings > Account Policies > Password Policy.

Step 3

Double-click Minimum Password Length. This opens the Security Policy Setting dialog box.

Step 4

Check the Define this policy setting check box and specify the minimum number of characters that the
password must contain.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-32

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

Figure 67-5

Active Directory—Minimum Password Length

Using Active Directory to Enforce Password Complexity
To enforce complex passwords—for example, to require that a password contain upper- and lowercase
letters, numbers, and special characters—specify the password-management command in tunnel-group
general-attributes configuration mode on the ASA and do the following steps under Active Directory:
Step 1

Select Start > Programs > Administrative Tools > Domain Security Policy. Select Windows Settings >
Security Settings > Account Policies > Password Policy.

Step 2

Double-click Password must meet complexity requirements to open the Security Policy Setting dialog
box.

Step 3

Check the Define this policy setting check box and select Enable.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-33

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Configuring Connection Profiles

Figure 67-6

Active Directory—Enforce Password Complexity

Enforcing password complexity takes effect only when the user changes passwords; for example, when
you have configured Enforce password change at next login or Password expires in n days. At login, the
user receives a prompt to enter a new password, and the system will accept only a complex password.

Configuring the Connection Profile for RADIUS/SDI Message Support for the
AnyConnect Client
This section describes procedures to ensure that the AnyConnect VPN client using RSA SecureID
Software tokens can properly respond to user prompts delivered to the client through a RADIUS server
proxying to an SDI server(s). This section contains the following topics:

Note

•

AnyConnect Client and RADIUS/SDI Server Interaction

•

Configuring the Security Appliance to Support RADIUS/SDI Messages

If you have configured the double-authentication feature, SDI authentication is supported only on the
primary authentication server.

AnyConnect Client and RADIUS/SDI Server Interaction
When a remote user connects to the ASA with the AnyConnect VPN client and attempts to authenticate
using an RSA SecurID token, the ASA communicates with the RADIUS server, which in turn,
communicates with the SDI server about the authentication.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-34

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Configuring Connection Profiles

During authentication, the RADIUS server presents access challenge messages to the ASA. Within these
challenge messages are reply messages containing text from the SDI server. The message text is different
when the ASA is communicating directly with an SDI server than when communicating through the
RADIUS proxy. Therefore, in order to appear as a native SDI server to the AnyConnect client, the ASA
must interpret the messages from the RADIUS server.
Also, because the SDI messages are configurable on the SDI server, the message text on the ASA must
match (in whole or in part) the message text on the SDI server. Otherwise, the prompts displayed to the
remote client user may not be appropriate for the action required during authentication. The AnyConnect
client may fail to respond and authentication may fail.
The following section describes how to configure the ASA to ensure successful authentication between
the client and the SDI server:

Configuring the Security Appliance to Support RADIUS/SDI Messages
The following section describes the steps to configure the ASA to interpret SDI-specific RADIUS reply
messages and prompt the AnyConnect user for the appropriate action:
Step 1

Configure a connection profile (tunnel group) to forward RADIUS reply messages in a manner that
simulates direct communication with an SDI server using the proxy-auth sdi command from
tunnel-group webvpn configuration mode. Users authenticating to the SDI server must connect over this
connection profile.
For example:
hostname(config)# tunnel-group sales webvpn attributes
hostname(tunnel-group-webvpn)# proxy-auth sdi

Step 2

Configure the RADIUS reply message text on the ASA to match (in whole or in part) the message text
sent by the RADIUS server with the proxy-auth_map sdi command from tunnel-group webvpn
configuration mode.
The default message text used by the ASA is the default message text used by
Cisco Secure Access Control Server (ACS). If you are using Cisco Secure ACS, and it is using the
default message text, you do not need to configure the message text on the ASA. Otherwise, use the
proxy-auth_map sdi command to ensure the message text matches.
Table 67-3 shows the message code, the default RADIUS reply message text, and the function of each
message. Because the security appliance searches for strings in the order that they appear in the table,
you must ensure that the string you use for the message text is not a subset of another string.
For example, “new PIN” is a subset of the default message text for both new-pin-sup and
next-ccode-and-reauth. If you configure new-pin-sup as “new PIN”, when the security appliance
receives “new PIN with the next card code” from the RADIUS server, it will match the text to the
new-pin-sup code instead of the next-ccode-and-reauth code.
Table 67-3

SDI Op-codes, Default Message Text, and Message Function

Message Code

Default RADIUS Reply
Message Text

next-code

Enter Next PASSCODE

Indicates the user must enter the NEXT tokencode
without the PIN.

new-pin-sup

Please remember your
new PIN

Indicates the new system PIN has been supplied and
displays that PIN for the user.

Function

Cisco ASA 5500 Series Configuration Guide using the CLI

67-35

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

Message Code

Default RADIUS Reply
Message Text

Function

new-pin-meth

Do you want to enter your Requests from the user which new PIN method to use to
own pin
create a new PIN.

new-pin-req

Enter your new
Alpha-Numerical PIN

Indicates a user-generated PIN and requests that the user
enter the PIN.

new-pin-reenter

Reenter PIN:

Used internally by the ASA for user-supplied PIN
confirmation. The client confirms the PIN without
prompting the user.

new-pin-sys-ok

New PIN Accepted

Indicates the user-supplied PIN was accepted.

next-ccode-and- new PIN with the next
reauth
card code

Follows a PIN operation and indicates the user must wait
for the next tokencode and to enter both the new PIN and
next tokencode to authenticate.

ready-for-syspin

Used internally by the ASA to indicate the user is ready
for the system-generated PIN.

ACCEPT A SYSTEM
GENERATED PIN

The following example enters aaa-server-host mode and changes the text for the RADIUS reply message
new-pin-sup:
hostname(config)# aaa-server radius_sales host 10.10.10.1
hostname(config-aaa-server-host)# proxy-auth_map sdi new-pin-sup “This is your new PIN”

Group Policies
This section describes group policies and how to configure them. It includes the following sections:
•

Default Group Policy, page 67-37

•

Configuring Group Policies, page 67-39

A group policy is a set of user-oriented attribute/value pairs for IPsec connections that are stored either
internally (locally) on the device or externally on a RADIUS server. The connection profile uses a group
policy that sets terms for user connections after the tunnel is established. Group policies let you apply
whole sets of attributes to a user or a group of users, rather than having to specify each attribute
individually for each user.
Enter the group-policy commands in global configuration mode to assign a group policy to users or to
modify a group policy for specific users.
The ASA includes a default group policy. In addition to the default group policy, which you can modify
but not delete, you can create one or more group policies specific to your environment.
You can configure internal and external group policies. Internal groups are configured on the ASA’s
internal database. External groups are configured on an external authentication server, such as RADIUS.
Group policies include the following attributes:
•

Identity

•

Server definitions

•

Client firewall settings

•

Tunneling protocols

•

IPsec settings

Cisco ASA 5500 Series Configuration Guide using the CLI

67-36

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

•

Hardware client settings

•

Filters

•

Client configuration settings

•

Connection settings

Default Group Policy
The ASA supplies a default group policy. You can modify this default group policy, but you cannot delete
it. A default group policy, named DfltGrpPolicy, always exists on the ASA, but this default group policy
does not take effect unless you configure the ASA to use it. When you configure other group policies,
any attribute that you do not explicitly specify takes its value from the default group policy. To view the
default group policy, enter the following command:
hostname(config)# show running-config all group-policy DfltGrpPolicy
hostname(config)#

To configure the default group policy, enter the following command:
hostname(config)# group-policy DfltGrpPolicy internal
hostname(config)#

Note

The default group policy is always internal. Despite the fact that the command syntax is
hostname(config)# group-policy DfltGrpPolicy {internal | external}, you cannot change its type
to external.
To change any of the attributes of the default group policy, use the group-policy attributes command
to enter attributes mode, then specify the commands to change whatever attributes that you want to
modify:
hostname(config)# group-policy DfltGrpPolicy attributes

Note

The attributes mode applies only to internal group policies.
The default group policy, DfltGrpPolicy, that the ASA provides is as follows:
show run all group-policy DfltGrpPolicy
group-policy DfltGrpPolicy internal
group-policy DfltGrpPolicy attributes
banner none
wins-server none
dns-server none
dhcp-network-scope none
vpn-access-hours none
vpn-simultaneous-logins 3
vpn-idle-timeout 30
vpn-session-timeout none
vpn-filter none
ipv6-vpn-filter none
vpn-tunnel-protocol ikev1 ikev2 l2tp-ipsec ssl-clientless
password-storage disable
ip-comp disable
re-xauth disable
group-lock none

Cisco ASA 5500 Series Configuration Guide using the CLI

67-37

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

pfs disable
ipsec-udp disable
ipsec-udp-port 10000
split-tunnel-policy tunnelall
split-tunnel-network-list none
default-domain none
split-dns none
intercept-dhcp 255.255.255.255 disable
secure-unit-authentication disable
user-authentication disable
user-authentication-idle-timeout 30
ip-phone-bypass disable
leap-bypass disable
nem disable
backup-servers keep-client-config
msie-proxy server none
msie-proxy method no-modify
msie-proxy except-list none
msie-proxy local-bypass disable
msie-proxy pac-url none
msie-proxy lockdown enable
vlan none
nac-settings none
address-pools none
ipv6-address-pools none
smartcard-removal-disconnect enable
scep-forwarding-url none
client-firewall none
client-access-rule none
webvpn
url-list none
filter none
homepage none
html-content-filter none
port-forward name Application Access
port-forward disable
http-proxy disable
sso-server none
anyconnect ssl dtls enable
anyconnect mtu 1406
anyconnect firewall-rule client-interface private none
anyconnect firewall-rule client-interface public none
anyconnect keep-installer installed
anyconnect ssl keepalive 20
anyconnect ssl rekey time none
anyconnect ssl rekey method none
anyconnect dpd-interval client 30
anyconnect dpd-interval gateway 300
anyconnect ssl compression none
anyconnect modules none
anyconnect profiles none
anyconnect ask none
customization none
keep-alive-ignore 4
http-comp gzip
download-max-size 2147483647
upload-max-size 2147483647
post-max-size 2147483647
user-storage none
storage-objects value cookies,credentials
storage-key none
hidden-shares none
smart-tunnel disable
activex-relay enable

Cisco ASA 5500 Series Configuration Guide using the CLI

67-38

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

unix-auth-uid 65534
unix-auth-gid 65534
file-entry enable
file-browsing enable
url-entry enable
deny-message value Login was successful, but because certain criteria
have not been met or due to some specific group policy, you do not have
permission to use any of the VPN features.
Contact your IT administrator for more information
smart-tunnel auto-signon disable
anyconnect ssl df-bit-ignore disable
anyconnect routing-filtering-ignore disable
smart-tunnel tunnel-policy tunnelall
always-on-vpn profile-setting

You can modify the default group policy, and you can also create one or more group policies specific to
your environment.

Configuring Group Policies
A group policy can apply to any kind of tunnel. In each case, if you do not explicitly define a parameter,
the group takes the value from the default group policy. To configure a group policy, follow the steps in
the subsequent sections.

Configuring an External Group Policy
External group policies take their attribute values from the external server that you specify. For an
external group policy, you must identify the AAA server group that the ASA can query for attributes and
specify the password to use when retrieving attributes from the external AAA server group. If you are
using an external authentication server, and if your external group-policy attributes exist in the same
RADIUS server as the users that you plan to authenticate, you have to make sure that there is no name
duplication between them.

Note

External group names on the ASA refer to user names on the RADIUS server. In other words, if you
configure external group X on the ASA, the RADIUS server sees the query as an authentication request
for user X. So external groups are really just user accounts on the RADIUS server that have special
meaning to the ASA. If your external group attributes exist in the same RADIUS server as the users that
you plan to authenticate, there must be no name duplication between them
The ASA supports user authorization on an external LDAP or RADIUS server. Before you configure the
ASA to use an external server, you must configure the server with the correct ASA authorization
attributes and, from a subset of these attributes, assign specific permissions to individual users. Follow
the instructions in Appendix C, “Configuring an External Server for Authorization and Authentication”
to configure your external server.
To configure an external group policy, do the following steps specify a name and type for the group
policy, along with the server-group name and a password:
hostname(config)# group-policy group_policy_name type server-group server_group_name
password server_password
hostname(config)#

Note

For an external group policy, RADIUS is the only supported AAA server type.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-39

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

For example, the following command creates an external group policy named ExtGroup that gets its
attributes from an external RADIUS server named ExtRAD and specifies that the password to use when
retrieving the attributes is newpassword:
hostname(config)# group-policy ExtGroup external server-group ExtRAD password newpassword
hostname(config)#

Note

You can configure several vendor-specific attributes (VSAs), as described in Appendix C, “Configuring
an External Server for Authorization and Authentication”. If a RADIUS server is configured to return
the Class attribute (#25), the ASA uses that attribute to authenticate the Group Name. On the RADIUS
server, the attribute must be formatted as: OU=groupname; where groupname is identical to the Group
Name configured on the ASA—for example, OU=Finance.

Configuring an Internal Group Policy
To configure an internal group policy, specify a name and type for the group policy:
hostname(config)# group-policy group_policy_name type
hostname(config)#

For example, the following command creates the internal group policy named GroupPolicy1:
hostname(config)# group-policy GroupPolicy1 internal
hostname(config)#

The default type is internal.
You can initialize the attributes of an internal group policy to the values of a preexisting group policy by
appending the keyword from and specifying the name of the existing policy:
hostname(config)# group-policy group_policy_name internal from group_policy_name
hostname(config-group-policy)#
hostname(config-group-policy)#

Configuring Group Policy Attributes
For internal group policies, you can specify particular attribute values. To begin, enter group-policy
attributes mode, by entering the group-policy attributes command in global configuration mode.
hostname(config)# group-policy name attributes
hostname(config-group-policy)#

The prompt changes to indicate the mode change. The group-policy-attributes mode lets you configure
attribute-value pairs for a specified group policy. In group-policy-attributes mode, explicitly configure
the attribute-value pairs that you do not want to inherit from the default group. The commands to do this
are described in the following sections.

Configuring WINS and DNS Servers
You can specify primary and secondary WINS servers and DNS servers. The default value in each case
is none. To specify these servers, do the following steps:
Step 1

Specify the primary and secondary WINS servers:
hostname(config-group-policy)# wins-server value {ip_address [ip_address] | none}

Cisco ASA 5500 Series Configuration Guide using the CLI

67-40

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

hostname(config-group-policy)#

The first IP address specified is that of the primary WINS server. The second (optional) IP address is
that of the secondary WINS server. Specifying the none keyword instead of an IP address sets WINS
servers to a null value, which allows no WINS servers and prevents inheriting a value from a default or
specified group policy.
Every time that you enter the wins-server command, you overwrite the existing setting. For example, if
you configure WINS server x.x.x.x and then configure WINS server y.y.y.y, the second command
overwrites the first, and y.y.y.y becomes the sole WINS server. The same is true for multiple servers. To
add a WINS server rather than overwrite previously configured servers, include the IP addresses of all
WINS servers when you enter this command.
The following example shows how to configure WINS servers with the IP addresses 10.10.10.15 and
10.10.10.30 for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# wins-server value 10.10.10.15 10.10.10.30
hostname(config-group-policy)#

Step 2

Specify the primary and secondary DNS servers:
hostname(config-group-policy)# dns-server value {ip_address [ip_address] | none}
hostname(config-group-policy)#

The first IP address specified is that of the primary DNS server. The second (optional) IP address is that
of the secondary DNS server. Specifying the none keyword instead of an IP address sets DNS servers to
a null value, which allows no DNS servers and prevents inheriting a value from a default or specified
group policy.
Every time that you enter the dns-server command you overwrite the existing setting. For example, if
you configure DNS server x.x.x.x and then configure DNS server y.y.y.y, the second command
overwrites the first, and y.y.y.y becomes the sole DNS server. The same is true for multiple servers. To
add a DNS server rather than overwrite previously configured servers, include the IP addresses of all
DNS servers when you enter this command.
The following example shows how to configure DNS servers with the IP addresses 10.10.10.15, and
10.10.10.30 for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# dns-server value 10.10.10.15 10.10.10.30
hostname(config-group-policy)#

Step 3

Configure the DHCP network scope:
hostname(config-group-policy)# dhcp-network-scope {ip_address | none}
hostname(config-group-policy)#

DHCP scope specifies the range of IP addresses (that is, a subnetwork) that the ASA DHCP server
should use to assign addresses to users of this group policy.
The following example shows how to set an IP subnetwork of 10.10.85.0 (specifying the address range
of 10.10.85.0 through 10.10.85.255) for the group policy named First Group:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# dhcp-network-scope 10.10.85.0

Cisco ASA 5500 Series Configuration Guide using the CLI

67-41

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

Configuring VPN-Specific Attributes
Follow the steps in this section to set the VPN attribute values. The VPN attributes control the access
hours, the number of simultaneous logins allowed, the timeouts, the egress VLAN or ACL to apply to
VPN sessions, and the tunnel protocol:
Step 1

Set the VPN access hours. To do this, you associate a group policy with a configured time-range policy,
using the vpn-access-hours command in group-policy configuration mode.
hostname(config-group-policy)# vpn-access-hours value {time-range | none}

A group policy can inherit a time-range value from a default or specified group policy. To prevent this
inheritance, enter the none keyword instead of the name of a time-range in this command. This keyword
sets VPN access hours to a null value, which allows no time-range policy.
The time-range variable is the name of a set of access hours defined in global configuration mode using
the time-range command. The following example shows how to associate the group policy named
FirstGroup with a time-range policy called 824:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# vpn-access-hours value 824

Step 2

Specify the number of simultaneous logins allowed for any user, using the vpn-simultaneous-logins
command in group-policy configuration mode.
hostname(config-group-policy)# vpn-simultaneous-logins

integer

The default value is 3. The range is an integer in the range 0 through 2147483647. A group policy can
inherit this value from another group policy. Enter 0 to disable login and prevent user access. The
following example shows how to allow a maximum of 4 simultaneous logins for the group policy named
FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# vpn-simultaneous-logins 4
hostname(config-group-policy)#

Note

While the maximum limit for the number of simultaneous logins is very large, allowing several
simultaneous logins could compromise security and affect performance.
Stale AnyConnect, IPsec Client, or Clientless sessions (sessions that are terminated abnormally) might
remain in the session database, even though a “new” session has been established with the same
username.
If the value of vpn-simultaneous-logins is 1, and the same user logs in again after an abnormal
termination, then the stale session is removed from the database and the new session is established. If,
however, the existing session is still an active connection and the same user logs in again, perhaps from
another PC, the first session is logged off and removed from the database, and the new session is
established.
If the number of simultaneous logins is a value greater than 1, then, when you have reached that
maximum number and try to log in again, the session with the longest idle time is logged off. If all
current sessions have been idle an equally long time, then the oldest session is logged off. This action
frees up a session and allows the new login.

Step 3

Configure the user timeout period by entering the vpn-idle-timeout command in group-policy
configuration mode or in username configuration mode:
hostname(config-group-policy)# vpn-idle-timeout {minutes | none}

Cisco ASA 5500 Series Configuration Guide using the CLI

67-42

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

hostname(config-group-policy)#

AnyConnect (SSL IPsec/IKEv2): Use the global WebVPN default-idle-timeout value (seconds) from the
command: hostname(config-webvpn)# default-idle-timeout
The range for this value in the WebVPN default-idle-timeout command is 60-86400 seconds; the
default Global WebVPN Idle timeout in seconds -- default is 1800 seconds (30 min).
Note

A non-zero idle timeout value is required by ASA for all AnyConnect connections.

For a WebVPN user, the default-idle-timeout value is enforced only if vpn-idle-timeout none is set in
the group policy/username attribute.
Site-to-Site (IKEv1, IKEv2) and IKEv1 remote-access: Disable timeout and allow for an unlimited idle
period.The following example shows how to set a VPN idle timeout of 15 minutes for the group policy
named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# vpn-idle-timeout 15
hostname(config-group-policy)#

Step 4

Configure the the time at which an idle-timeout alert message is displayed to the user using the
vpn-idle-timeout alert-interval {minutes | none} command. This alert message tells users how
many minutes left they have until their VPN session is disconnected due to inactivity.
The following example shows how to set vpn-idle-timeout alert-interval so that users will be
notified 20 minutes before their VPN session is disconnected due to inactivity. You can specify a range
of 1-30 minutes.
hostname(config-webvpn)# vpn-idle-timeout alert-interval 20
The none parameter of the command indicates that users will not receive an alert.
The no form of the command: no vpn-idle-timeout alert-interval
indicates that the VPN idle timeout alert-interval attribute will be inherited from the Default Group
Policy.

Step 5

Configure a maximum amount of time for VPN connections, using the vpn-session-timeout command
in group-policy configuration mode or in username configuration mode.
hostname(config-group-policy)# vpn-session-timeout {minutes | none}
hostname(config-group-policy)#

The minimum time is 1 minute, and the maximum time is 35791394 minutes. There is no default value.
At the end of this period of time, the ASA terminates the connection.
A group policy can inherit this value from another group policy. To prevent inheriting a value, enter the
none keyword instead of specifying a number of minutes with this command. Specifying the none
keyword permits an unlimited session timeout period and sets session timeout with a null value, which
disallows a session timeout.
The following example shows how to set a VPN session timeout of 180 minutes for the group policy
named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# vpn-session-timeout 180
hostname(config-group-policy)#

Step 6

Configure the the time at which a session-timeout alert message is displayed to the user using the
vpn-session-timeout alert-interval {minutes | none} command. This alert message tells users how
many minutes left they have until their VPN session is automatically disconnected.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-43

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

The following example shows how to set the vpn-session-timeout alert-interval so that users will
be notified 20 minutes before their VPN session is disconnected. You can specify a range of 1-30
minutes.
hostname(config-webvpn)# vpn-session-timeout alert-interval 20
The none parameter of the command indicates that users will not receive an alert.
The no form of the command: no vpn-session-timeout alert-interval
indicates that the VPN session timeout alert-interval attribute will be inherited from the Default Group
Policy.
Step 7

Choose one of the following options to specify an egress VLAN (also called “VLAN mapping”) for
remote access or specify an ACL to filter the traffic:
•

Enter the following command in group-policy configuration mode to specify the egress VLAN for
remote access VPN sessions assigned to this group policy or to a group policy that inherits this group
policy:
hostname(config-group-policy)#

[no] vlan {vlan_id |none}

no vlan removes the vlan_id from the group policy. The group policy inherits the vlan value from
the default group policy.

removes the vlan_id from the group policy and disables VLAN mapping for this group
policy. The group policy does not inherit the vlan value from the default group policy.

vlan none

vlan_id in the command vlan vlan_id is the number of the VLAN, in decimal format, to assign to
remote access VPN sessions that use this group policy. The VLAN must be configured on this ASA
per the instructions in the “Configuring VLAN Subinterfaces and 802.1Q Trunking” section on
page 6-30.
none disables the assignment of a VLAN to the remote access VPN sessions that match this group
policy.

Note
•

The egress VLAN feature works for HTTP connections, but not for FTP and CIFS.

Specify the name of the ACL to apply to VPN session, using the vpn-filter command in group policy
mode. (You can also configure this attribute in username mode, in which case the value configured
under username supersedes the group-policy value.)
hostname(config-group-policy)# vpn-filter {value ACL name | none}
hostname(config-group-policy)#

You configure ACLs to permit or deny various types of traffic for this group policy. You then enter
the vpn-filter command to apply those ACLs.
To remove the ACL, including a null value created by entering the vpn-filter none command, enter
the no form of this command. The no option allows inheritance of a value from another group policy.
A group policy can inherit this value from another group policy. To prevent inheriting a value, enter
the none keyword instead of specifying an ACL name. The none keyword indicates that there is no
access list and sets a null value, thereby disallowing an access list.
The following example shows how to set a filter that invokes an access list named acl_vpn for the
group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# vpn-filter acl_vpn
hostname(config-group-policy)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-44

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

A vpn-filter command is applied to post-decrypted traffic after it exits a tunnel and pre-encrypted traffic
before it enters a tunnel. An ACL that is used for a vpn-filter should NOT also be used for an interface
access-group. When a vpn-filter command is applied to a group policy that governs Remote Access VPN
client connections, the ACL should be configured with the client assigned IP addresses in the src_ip
position of the ACL and the local network in the dest_ip position of the ACL.
When a vpn-filter command is applied to a group-policy that governs a LAN to LAN VPN connection,
the ACL should be configured with the remote network in the src_ip position of the ACL and the local
network in the dest_ip position of the ACL.
Caution should be used when constructing the ACLs for use with the vpn-filter feature. The ACLs are
constructed with the post-decrypted traffic in mind. However, ACLs are also applied to the traffic in the
opposite direction. For this pre-encrypted traffic that is destined for the tunnel, the ACLs are constructed
with the src_ip and dest_ip positions swapped.
In the following example, the vpn-filter is used with a Remote Access VPN client.
This example assumes that the client assigned IP address is 10.10.10.1/24 and the local network is
192.168.1.0/24.
The following ACE will allow the Remote Access VPN client to telnet to the local network:
hostname(config-group-policy)# access-list vpnfilt-ra permit 10.10.10.1 255.255.255.255
192.168.1.0 255.255.255.0 eq 23

The following ACE will allow the local network to telnet to the Remote Access client:
hostname(config-group-policy)# access-list vpnfilt-ra permit 10.10.10.1 255.255.255.255 eq
23 192.168.1.0 255.255.255.0

Note

Note: The ACE access-list vpnfilt-ra permit 10.10.10.1 255.255.255.255 192.168.1.0 255.255.255.0 eq
23 will allow the local network to initiate a connection to the Remote Access client on any TCP port if
it uses a source port of 23. The ACE access-list vpnfilt-ra permit 10.10.10.1 255.255.255.255 eq 23
192.168.1.0 255.255.255.0 will allow the Remote Access client to initiate a connection to the local
network on any TCP port if it uses a source port of 23.
In the next example, the vpn-filter is used with a LAN to LAN VPN connection. This example assumes
that the remote network is 10.0.0.0/24 and the local network is 192.168.1.0/24.
The following ACE will allow remote network to telnet to the local network:
hostname(config-group-policy)# access-list vpnfilt-l2l permit 10.0.0.0 255.255.255.0
192.168.1.0 255.255.255.0 eq 23

The following ACE will allow the local network to telnet to the remote network:
hostname(config-group-policy)# access-list vpnfilt-l2l permit 10.0.0.0 255.255.255.0 eq 23
192.168.1.0 255.255.255.0

Note

Step 8

Note: The ACE access-list vpnfilt-l2l permit 10.0.0.0 255.255.255.0 192.168.1.0 255.255.255.0 eq 23
will allow the local network to initiate a connection to the remote network on any TCP port if it uses a
source port of 23. The ACE access-list vpnfilt-l2l permit 10.0.0.0 255.255.255.0 eq 23 192.168.1.0
255.255.255.0 will allow the remote network to initiate a connection to the local network on any TCP
port if it uses a source port of 23.

Specify the VPN tunnel type for this group policy.
vpn-tunnel-protocol {ikev1 | ikev2 | l2tp-ipsec | ssl-client | ssl-clientless}

Cisco ASA 5500 Series Configuration Guide using the CLI

67-45

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

The default is IPsec. To remove the attribute from the running configuration, enter the no form of this
command.
The parameter values for this command follow:
•

ikev1—Negotiates an IPsec IKEv1 tunnel between two peers (the Cisco VPN Client or another
secure gateway). Creates security associations that govern authentication, encryption,
encapsulation, and key management.

•

ikev2—Negotiates an IPsec IKEv2 tunnel between two peers (the AnyConnect Secure Mobility
Client or another secure gateway). Creates security associations that govern authentication,
encryption, encapsulation, and key management.

•

l2tp-ipsec—Negotiates an IPsec tunnel for an L2TP connection

•

ssl-client—Negotiates an SSL tunnel using TLS or DTLS with the AnyConnect Secure Mobility
Client.

•

ssl-clientless—Provides VPN services to remote users via an HTTPS-enabled web browser, and
does not require a client.

Enter this command to configure one or more tunneling modes. You must configure at least one tunneling
mode for users to connect over a VPN tunnel.
The following example shows how to configure the IPsec IKEv1 tunneling mode for the group policy
named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# vpn-tunnel-protocol ikev1
hostname(config-group-policy)#

Configuring Security Attributes
The attributes in this section specify certain security settings for the group:
Step 1

Specify whether to let users store their login passwords on the client system, using the
password-storage command with the enable keyword in group-policy configuration mode. To disable
password storage, use the password-storage command with the disable keyword.
hostname(config-group-policy)# password-storage {enable | disable}
hostname(config-group-policy)#

For security reasons, password storage is disabled by default. Enable password storage only on systems
that you know to be in secure sites.
To remove the password-storage attribute from the running configuration, enter the no form of this
command:
hostname(config-group-policy)# no password-storage
hostname(config-group-policy)#

Specifying the no form enables inheritance of a value for password-storage from another group policy.
This command does not apply to interactive hardware client authentication or individual user
authentication for hardware clients.
The following example shows how to enable password storage for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# password-storage enable
hostname(config-group-policy)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-46

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

Step 2

Specify whether to enable IP compression, which is disabled by default.

Note

IP compression is not supported for IPsec IKEv2 connections.

hostname(config-group-policy)# ip-comp {enable | disable}
hostname(config-group-policy)#

To enable LZS IP compression, enter the ip-comp command with the enable keyword in group-policy
configuration mode. To disable IP compression, enter the ip-comp command with the disable keyword.
To remove the ip-comp attribute from the running configuration, enter the no form of this command.
This enables inheritance of a value from another group policy.
hostname(config-group-policy)# no ip-comp
hostname(config-group-policy)#

Enabling data compression might speed up data transmission rates for remote dial-in users connecting
with modems.

Caution

Data compression increases the memory requirement and CPU usage for each user session and
consequently decreases the overall throughput of the ASA. For this reason, we recommend that you
enable data compression only for remote users connecting with a modem. Design a group policy specific
to modem users, and enable compression only for them.

Step 3

Specify whether to require that users reauthenticate on IKE re-key by using the re-xauth command with
the enable keyword in group-policy configuration mode.

Note

IKE re-key is not supported for IKEv2 connections.

If you enable reauthentication on IKE re-key, the ASA prompts the user to enter a username and
password during initial Phase 1 IKE negotiation and also prompts for user authentication whenever an
IKE re-key occurs. Reauthentication provides additional security.
If the configured re-key interval is very short, users might find the repeated authorization requests
inconvenient. To avoid repeated authorization requests, disable reauthentication. To check the
configured re-key interval, in monitoring mode, enter the show crypto ipsec sa command to view the
security association lifetime in seconds and lifetime in kilobytes of data. To disable user reauthentication
on IKE re-key, enter the disable keyword. Reauthentication on IKE re-key is disabled by default.
hostname(config-group-policy)# re-xauth {enable | disable}
hostname(config-group-policy)#

To enable inheritance of a value for reauthentication on IKE re-key from another group policy, remove
the re-xauth attribute from the running configuration by entering the no form of this command.
hostname(config-group-policy)# no re-xauth
hostname(config-group-policy)#

Note
Step 4

Reauthentication fails if there is no user at the other end of the connection.

Specify whether to restrict remote users to access only through the connection profile, using the
group-lock command in group-policy configuration mode.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-47

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

hostname(config-group-policy)# group-lock {value tunnel-grp-name | none}
hostname(config-group-policy)# no group-lock
hostname(config-group-policy)#

The tunnel-grp-name variable specifies the name of an existing connection profile that the ASA requires
for the user to connect. Group-lock restricts users by checking if the group configured in the VPN client
is the same as the connection profile to which the user is assigned. If it is not, the ASA prevents the user
from connecting. If you do not configure group-lock, the ASA authenticates users without regard to the
assigned group. Group locking is disabled by default.
To remove the group-lock attribute from the running configuration, enter the no form of this command.
This option allows inheritance of a value from another group policy.
To disable group-lock, enter the group-lock command with the none keyword. The none keyword sets
group-lock to a null value, thereby allowing no group-lock restriction. It also prevents inheriting a
group-lock value from a default or specified group policy
Step 5

Specify whether to enable perfect forward secrecy. In IPsec negotiations, perfect forward secrecy
ensures that each new cryptographic key is unrelated to any previous key. A group policy can inherit a
value for perfect forward secrecy from another group policy. Perfect forward secrecy is disabled by
default. To enable perfect forward secrecy, use the pfs command with the enable keyword in
group-policy configuration mode.
hostname(config-group-policy)# pfs {enable | disable}
hostname(config-group-policy)#

To disable perfect forward secrecy, enter the pfs command with the disable keyword.
To remove the perfect forward secrecy attribute from the running configuration and prevent inheriting a
value, enter the no form of this command.
hostname(config-group-policy)# no pfs
hostname(config-group-policy)#

Configuring the Banner Message
Specify the banner, or welcome message, if any, that you want to display. The default is no banner. The
message that you specify is displayed on remote clients when they connect. To specify a banner, enter
the banner command in group-policy configuration mode. The banner text can be up to 510 characters
long. Enter the “\n” sequence to insert a carriage return.

Note

A carriage-return/line-feed included in the banner counts as two characters.
To delete a banner, enter the no form of this command. Be aware that using the no version of the
command deletes all banners for the group policy.
A group policy can inherit this value from another group policy. To prevent inheriting a value, enter the
none keyword instead of specifying a value for the banner string, as follows:
hostname(config-group-policy)# banner {value banner_string | none}

The following example shows how to create a banner for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# banner value Welcome to Cisco Systems 7.0.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-48

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

Configuring IPsec-UDP Attributes for IKEv1
IPsec over UDP, sometimes called IPsec through NAT, lets a Cisco VPN client or hardware client
connect via UDP to a ASA that is running NAT. It is disabled by default. IPsec over UDP is proprietary;
it applies only to remote-access connections, and it requires mode configuration. The ASA exchanges
configuration parameters with the client while negotiating SAs. Using IPsec over UDP may slightly
degrade system performance.
To enable IPsec over UDP, configure the ipsec-udp command with the enable keyword in group-policy
configuration mode, as follows:
hostname(config-group-policy)# ipsec-udp {enable | disable}
hostname(config-group-policy)# no ipsec-udp

To use IPsec over UDP, you must also configure the ipsec-udp-port command, as described below.
To disable IPsec over UDP, enter the disable keyword. To remove the IPsec over UDP attribute from the
running configuration, enter the no form of this command. This enables inheritance of a value for IPsec
over UDP from another group policy.
The Cisco VPN client must also be configured to use IPsec over UDP (it is configured to use it by
default). The VPN 3002 requires no configuration to use IPsec over UDP.
The following example shows how to set IPsec over UDP for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# ipsec-udp enable

If you enabled IPsec over UDP, you must also configure the ipsec-udp-port command in group-policy
configuration mode. This command sets a UDP port number for IPsec over UDP. In IPsec negotiations,
the ASA listens on the configured port and forwards UDP traffic for that port even if other filter rules
drop UDP traffic. The port numbers can range from 4001 through 49151. The default port value is 10000.
To disable the UDP port, enter the no form of this command. This enables inheritance of a value for the
IPsec over UDP port from another group policy.
hostname(config-group-policy)# ipsec-udp-port port

The following example shows how to set an IPsec UDP port to port 4025 for the group policy named
FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# ipsec-udp-port 4025

Configuring Split-Tunneling Attributes
Split tunneling lets a remote-access client conditionally direct packets over a VPN tunnel in encrypted
form or to a network interface in clear text form. With split tunneling enabled, packets not bound for
destinations on the other side of the tunnel do not have to be encrypted, sent across the tunnel, decrypted,
and then routed to a final destination. The split-tunnel-policy command applies this split tunneling
policy to a specific network.

Note

The ASA does not currently support split tunneling for IPv6 traffic. The ASA tunnels all IPv6 traffic
through the VPN connection, even when the it has no IPv6 configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-49

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

Differences in Client Split Tunneling Behavior for Traffic within the Subnet
The AnyConnect client and the legacy Cisco VPN client (the IPsec/IKEv1 client) behave differently
when passing traffic to sites within the same subnet as the IP address assigned by the ASA. With
AnyConnect, the client passes traffic to all sites specified in the split tunneling policy you configured,
and to all sites that fall within the same subnet as the IP address assigned by the ASA. For example, if
the IP address assigned by the ASA is 10.1.1.1 with a mask of 255.0.0.0, the endpoint device passes all
traffic destined to 10.0.0.0/8, regardless of the split tunneling policy.
By contrast, the legacy Cisco VPN client only passes traffic to addresses specified by the split-tunneling
policy, regardless of the subnet assigned to the client.
Therefore, use a netmask for the assigned IP address that properly references the expected local subnet.

Setting the Split-Tunneling Policy
Set the rules for tunneling traffic by specifying the split-tunneling policy:
hostname(config-group-policy)# split-tunnel-policy {tunnelall | tunnelspecified |
excludespecified}
hostname(config-group-policy)# no split-tunnel-policy

The default is to tunnel all traffic. To set a split tunneling policy, enter the split-tunnel-policy command
in group-policy configuration mode. To remove the split-tunnel-policy attribute from the running
configuration, enter the no form of this command. This enables inheritance of a value for split tunneling
from another group policy.
The excludespecified keyword defines a list of networks to which traffic goes in the clear. This feature
is useful for remote users who want to access devices on their local network, such as printers, while they
are connected to the corporate network through a tunnel. This option applies only to the Cisco VPN
client.
The tunnelall keyword specifies that no traffic goes in the clear or to any other destination than the ASA.
This, in effect, disables split tunneling. Remote users reach Internet networks through the corporate
network and do not have access to local networks. This is the default option.
The tunnelspecified keyword tunnels all traffic from or to the specified networks. This option enables
split tunneling. It lets you create a network list of addresses to tunnel. Data to all other addresses travels
in the clear and is routed by the remote user’s Internet service provider.

Note

Split tunneling is primarily a traffic management feature, not a security feature. For optimum security,
we recommend that you do not enable split tunneling.
The following example shows how to set a split tunneling policy of tunneling only specified networks
for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# split-tunnel-policy tunnelspecified

Creating a Network List for Split-Tunneling
Create a network list for split tunneling using the split-tunnel-network-list command in group-policy
configuration mode.
hostname(config-group-policy)# split-tunnel-network-list {value access-list_name | none}
hostname(config-group-policy)# no split-tunnel-network-list value [access-list_name]

Cisco ASA 5500 Series Configuration Guide using the CLI

67-50

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

Split tunneling network lists distinguish networks that require traffic to travel across the tunnel from
those that do not require tunneling. The ASA makes split tunneling decisions on the basis of a network
list, which is an ACL that consists of a list of addresses on the private network.
If you use extended ACLs, the source network determines the split-tunneling network. The destination
network is ignored. In addition, because any is not an actual IP address or network address, do not use
the term for the source in the ACL.
The value access-list name parameter identifies an access list that enumerates the networks to tunnel or
not tunnel.
The none keyword indicates that there is no network list for split tunneling; the ASA tunnels all traffic.
Specifying the none keyword sets a split tunneling network list with a null value, thereby disallowing
split tunneling. It also prevents inheriting a default split tunneling network list from a default or specified
group policy.
To delete a network list, enter the no form of this command. To delete all split tunneling network lists,
enter the no split-tunnel-network-list command without arguments. This command deletes all
configured network lists, including a null list if you created one by entering the none keyword.
When there are no split tunneling network lists, users inherit any network lists that exist in the default
or specified group policy. To prevent users from inheriting such network lists, enter the
split-tunnel-network-list none command.
The following example shows how to set a network list called FirstList for the group policy named
FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# split-tunnel-network-list FirstList

Configuring Domain Attributes for Tunneling
You can specify a default domain name for tunneled packets or a list of domains to be resolved through
the split tunnel. The following sections describe how to set these domains.

Defining a Default Domain Name for Tunneled Packets
The ASA passes the default domain name to the IPsec client to append to DNS queries that omit the
domain field. When there are no default domain names, users inherit the default domain name in the
default group policy. To specify the default domain name for users of the group policy, enter the
default-domain command in group-policy configuration mode. To delete a domain name, enter the no
form of this command.
hostname(config-group-policy)# default-domain {value domain-name | none}
hostname(config-group-policy)# no default-domain [domain-name]

The value domain-name parameter identifies the default domain name for the group. To specify that
there is no default domain name, enter the none keyword. This command sets a default domain name
with a null value, which disallows a default domain name and prevents inheriting a default domain name
from a default or specified group policy.
To delete all default domain names, enter the no default-domain command without arguments. This
command deletes all configured default domain names, including a null list if you created one by
entering the default-domain command with the none keyword. The no form allows inheriting a domain
name.
The following example shows how to set a default domain name of FirstDomain for the group policy
named FirstGroup:

Cisco ASA 5500 Series Configuration Guide using the CLI

67-51

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# default-domain value FirstDomain

Defining a List of Domains for Split Tunneling
Enter a list of domains to be resolved through the split tunnel. Enter the split-dns command in
group-policy configuration mode. To delete a list, enter the no form of this command.
When there are no split tunneling domain lists, users inherit any that exist in the default group policy.
To prevent users from inheriting such split tunneling domain lists, enter the split-dns command with the
none keyword.
To delete all split tunneling domain lists, enter the no split-dns command without arguments. This
deletes all configured split tunneling domain lists, including a null list created by issuing the split-dns
command with the none keyword.
The parameter value domain-name provides a domain name that the ASA resolves through the split
tunnel. The none keyword indicates that there is no split DNS list. It also sets a split DNS list with a null
value, thereby disallowing a split DNS list, and prevents inheriting a split DNS list from a default or
specified group policy. The syntax of the command is as follows:
hostname(config-group-policy)# split-dns {value domain-name1 [domain-name2...
domain-nameN] | none}
hostname(config-group-policy)# no split-dns [domain-name domain-name2 domain-nameN]

Enter a single space to separate each entry in the list of domains. There is no limit on the number of
entries, but the entire string can be no longer than 255 characters. You can use only alphanumeric
characters, hyphens (-), and periods (.). If the default domain name is to be resolved through the tunnel,
you must explicitly include that name in this list.
The following example shows how to configure the domains Domain1, Domain2, Domain3, and
Domain4 to be resolved through split tunneling for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# split-dns value Domain1 Domain2 Domain3 Domain4

Configuring DHCP Intercept
A Microsoft XP anomaly results in the corruption of domain names if split tunnel options exceed 255
bytes. To avoid this problem, the ASA limits the number of routes it sends to 27 to 40 routes, with the
number of routes dependent on the classes of the routes.
DHCP Intercept lets Microsoft Windows XP clients use split-tunneling with the ASA. The ASA replies
directly to the Microsoft Windows XP client DHCP Inform message, providing that client with the
subnet mask, domain name, and classless static routes for the tunnel IP address. For Windows clients
prior to Windows XP, DHCP Intercept provides the domain name and subnet mask. This is useful in
environments in which using a DHCP server is not advantageous.
The intercept-dhcp command enables or disables DHCP intercept. The syntax of this command is as
follows:
[no] intercept-dhcp
hostname(config-group-policy)# intercept-dhcp netmask {enable | disable}
hostname(config-group-policy)#

The netmask variable provides the subnet mask for the tunnel IP address. The no version of the command
removes the DHCP intercept from the configuration.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-52

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

The following example shows how to set DHCP Intercepts for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# intercept-dhcp enable

Configuring Attributes for VPN Hardware Clients
The commands in this section enable or disable secure unit authentication and user authentication, and
set a user authentication timeout value for VPN hardware clients. They also let you allow Cisco IP
phones and LEAP packets to bypass individual user authentication and allow hardware clients using
Network Extension Mode to connect.

Configuring Secure Unit Authentication
Secure unit authentication provides additional security by requiring VPN hardware clients to
authenticate with a username and password each time that the client initiates a tunnel. With this feature
enabled, the hardware client does not have a saved username and password. Secure unit authentication
is disabled by default.

Note

With this feature enabled, to bring up a VPN tunnel, a user must be present to enter the username and
password.
Secure unit authentication requires that you have an authentication server group configured for the
connection profile the hardware client(s) use. If you require secure unit authentication on the primary
ASA, be sure to configure it on any backup servers as well.
Specify whether to enable secure unit authentication by entering the secure-unit-authentication
command with the enable keyword in group-policy configuration mode.
hostname(config-group-policy)# secure-unit-authentication {enable | disable}
hostname(config-group-policy)# no secure-unit-authentication

To disable secure unit authentication, enter the disable keyword. To remove the secure unit
authentication attribute from the running configuration, enter the no form of this command. This option
allows inheritance of a value for secure unit authentication from another group policy.
The following example shows how to enable secure unit authentication for the group policy named
FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# secure-unit-authentication enable

Configuring User Authentication
User authentication is disabled by default. When enabled, user authentication requires that individual
users behind a hardware client authenticate to gain access to the network across the tunnel. Individual
users authenticate according to the order of authentication servers that you configure.
Specify whether to enable user authentication by entering the user-authentication command with the
enable keyword in group-policy configuration mode.
hostname(config-group-policy)# user-authentication {enable | disable}
hostname(config-group-policy)# no user-authentication

Cisco ASA 5500 Series Configuration Guide using the CLI

67-53

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

To disable user authentication, enter the disable keyword. To remove the user authentication attribute
from the running configuration, enter the no form of this command. This option allows inheritance of a
value for user authentication from another group policy.
If you require user authentication on the primary ASA, be sure to configure it on any backup servers as
well.
The following example shows how to enable user authentication for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# user-authentication enable

Configuring an Idle Timeout
Set an idle timeout for individual users behind hardware clients by entering the
user-authentication-idle-timeout command in group-policy configuration mode. If there is no
communication activity by a user behind a hardware client in the idle timeout period, the ASA terminates
the client’s access:
hostname(config-group-policy)# user-authentication-idle-timeout {minutes | none}
hostname(config-group-policy)# no user-authentication-idle-timeout

Note

This timer terminates only the client’s access through the VPN tunnel, not the VPN tunnel itself.
The idle timeout indicated in response to the show uauth command is always the idle timeout value of
the user who authenticated the tunnel on the Cisco Easy VPN remote device.
The minutes parameter specifies the number of minutes in the idle timeout period. The minimum is 1
minute, the default is 30 minutes, and the maximum is 35791394 minutes.
To delete the idle timeout value, enter the no form of this command. This option allows inheritance of
an idle timeout value from another group policy.
To prevent inheriting an idle timeout value, enter the user-authentication-idle-timeout command with
the none keyword. This command sets the idle timeout with a null value, which disallows an idle timeout
and prevents inheriting an user authentication idle timeout value from a default or specified group policy.
The following example shows how to set an idle timeout value of 45 minutes for the group policy named
FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# user-authentication-idle-timeout 45

Configuring IP Phone Bypass
You can allow Cisco IP phones to bypass individual user authentication behind a hardware client. To
enable IP Phone Bypass, enter the ip-phone-bypass command with the enable keyword in group-policy
configuration mode. IP Phone Bypass lets IP phones behind hardware clients connect without
undergoing user authentication processes. IP Phone Bypass is disabled by default. If enabled, secure unit
authentication remains in effect.
To disable IP Phone Bypass, enter the disable keyword. To remove the IP phone Bypass attribute from
the running configuration, enter the no form of this command. This option allows inheritance of a value
for IP Phone Bypass from another group policy:
hostname(config-group-policy)# ip-phone-bypass {enable | disable}
hostname(config-group-policy)# no ip-phone-bypass

Cisco ASA 5500 Series Configuration Guide using the CLI

67-54

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

Note

You must configure mac-exempt to exempt the clients from authentication. Refer to the
“Configuring Device Pass-Through” section on page 71-8 for more information.

Configuring LEAP Bypass
When LEAP Bypass is enabled, LEAP packets from wireless devices behind a VPN 3002 hardware
client travel across a VPN tunnel prior to user authentication. This action lets workstations using Cisco
wireless access point devices establish LEAP authentication and then authenticate again per user
authentication. LEAP Bypass is disabled by default.
To allow LEAP packets from Cisco wireless access points to bypass individual users authentication,
enter the leap-bypass command with the enable keyword in group-policy configuration mode. To
disable LEAP Bypass, enter the disable keyword. To remove the LEAP Bypass attribute from the
running configuration, enter the no form of this command. This option allows inheritance of a value for
LEAP Bypass from another group policy:
hostname(config-group-policy)# leap-bypass {enable | disable}
hostname(config-group-policy)# no leap-bypass

Note

IEEE 802.1X is a standard for authentication on wired and wireless networks. It provides wireless LANs
with strong mutual authentication between clients and authentication servers, which can provide
dynamic per-user, per session wireless encryption privacy (WEP) keys, removing administrative burdens
and security issues that are present with static WEP keys.
Cisco Systems has developed an 802.1X wireless authentication type called Cisco LEAP. LEAP
(Lightweight Extensible Authentication Protocol) implements mutual authentication between a wireless
client on one side of a connection and a RADIUS server on the other side. The credentials used for
authentication, including a password, are always encrypted before they are transmitted over the wireless
medium.
Cisco LEAP authenticates wireless clients to RADIUS servers. It does not include RADIUS accounting
services.
This feature does not work as intended if you enable interactive hardware client authentication.

Caution

There might be security risks to your network in allowing any unauthenticated traffic to traverse the
tunnel.
The following example shows how to set LEAP Bypass for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# leap-bypass enable

Enabling Network Extension Mode
Network extension mode lets hardware clients present a single, routable network to the remote private
network over the VPN tunnel. IPsec encapsulates all traffic from the private network behind the
hardware client to networks behind the ASA. PAT does not apply. Therefore, devices behind the ASA

Cisco ASA 5500 Series Configuration Guide using the CLI

67-55

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

have direct access to devices on the private network behind the hardware client over the tunnel, and only
over the tunnel, and vice versa. The hardware client must initiate the tunnel, but after the tunnel is up,
either side can initiate data exchange.
Enable network extension mode for hardware clients by entering the nem command with the enable
keyword in group-policy configuration mode:
hostname(config-group-policy)# nem {enable | disable}
hostname(config-group-policy)# no nem

To disable NEM, enter the disable keyword. To remove the NEM attribute from the running
configuration, enter the no form of this command. This option allows inheritance of a value from another
group policy.
The following example shows how to set NEM for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# nem enable

Configuring Backup Server Attributes
Configure backup servers if you plan on using them. IPsec backup servers let a VPN client connect to
the central site when the primary ASA is unavailable.When you configure backup servers, the ASA
pushes the server list to the client as the IPsec tunnel is established. Backup servers do not exist until
you configure them, either on the client or on the primary ASA.
Configure backup servers either on the client or on the primary ASA. If you configure backup servers
on the ASA, it pushes the backup server policy to the clients in the group, replacing the backup server
list on the client if one is configured.

Note

If you are using hostnames, it is wise to have backup DNS and WINS servers on a separate network from
that of the primary DNS and WINS servers. Otherwise, if clients behind a hardware client obtain DNS
and WINS information from the hardware client via DHCP, and the connection to the primary server is
lost, and the backup servers have different DNS and WINS information, clients cannot be updated until
the DHCP lease expires. In addition, if you use hostnames and the DNS server is unavailable, significant
delays can occur.
To configure backup servers, enter the backup-servers command in group-policy configuration mode:
hostname(config-group-policy)# backup-servers {server1 server2... server10 |
clear-client-config | keep-client-config}

To remove a backup server, enter the no form of this command with the backup server specified. To
remove the backup-servers attribute from the running configuration and enable inheritance of a value for
backup-servers from another group policy, enter the no form of this command without arguments.
hostname(config-group-policy)# no backup-servers [server1 server2... server10 |
clear-client-config | keep-client-config]

The clear-client-config keyword specifies that the client uses no backup servers. The ASA pushes a null
server list.
The keep-client-config keyword specifies that the ASA sends no backup server information to the client.
The client uses its own backup server list, if configured. This is the default.
The server1 server 2.... server10 parameter list is a space-delimited, priority-ordered list of servers for
the VPN client to use when the primary ASA is unavailable. This list identifies servers by IP address or
hostname. The list can be 500 characters long, and it can contain up to10 entries.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-56

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

The following example shows how to configure backup servers with IP addresses 10.10.10.1 and
192.168.10.14, for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# backup-servers 10.10.10.1 192.168.10.14

Configuring Browser Client Parameters
The following commands configure the proxy server parameters for a client.
Step 1

Configure a browser proxy server and port for a client device by entering the msie-proxy server
command in group-policy configuration mode:
hostname(config-group-policy)# msie-proxy server {value server[:port] | none}
hostname(config-group-policy)#

The default value is none. To remove the attribute from the configuration, use the no form of the
command.
hostname(config-group-policy)# no msie-proxy server
hostname(config-group-policy)#

The line containing the proxy server IP address or hostname and the port number must be less than 100
characters long.
The following example shows how to configure the IP address 192.168.10.1 as a Microsoft Internet
Explorer proxy server, using port 880, for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# msie-proxy server value 192.168.21.1:880
hostname(config-group-policy)#

Step 2

Configure the browser proxy actions (“methods”) for a client device by entering the msie-proxy method
command in group-policy configuration mode.
hostname(config-group-policy)# msie-proxy method [auto-detect | no-modify | no-proxy |
use-server]
hostname(config-group-policy)#

The default value is use-server. To remove the attribute from the configuration, use the no form of the
command.
hostname(config-group-policy)# no msie-proxy method
use-server]
hostname(config-group-policy)#

[auto-detect | no-modify | no-proxy |

The available methods are as follows:
•

auto-detect—Enables the use of automatic proxy server detection in the browser for the client
device.

•

no-modify—Leaves the HTTP browser proxy server setting in the browser unchanged for this client
device.

•

no-proxy—Disables the HTTP proxy setting in the browser for the client device.

•

use-server—Sets the HTTP proxy server setting in the browser to use the value configured in the
msie-proxy server command.

The line containing the proxy server IP address or hostname and the port number must be less than 100
characters long.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-57

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

The following example shows how to configure auto-detect as the browser proxy setting for the group
policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# msie-proxy method auto-detect
hostname(config-group-policy)#

The following example configures the proxy setting for the group policy named FirstGroup to use the
server QAserver, port 1001 as the server for the client device:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# msie-proxy server QAserver:port 1001
hostname(config-group-policy)# msie-proxy method use-server
hostname(config-group-policy)#

Step 3

Configure browser proxy exception list settings for a local bypass on the client device by entering the
msie-proxy except-list command in group-policy configuration mode. These addresses are not accessed
by a proxy server. This list corresponds to the Exceptions box in the Proxy Settings dialog box.
hostname(config-group-policy)# msie-proxy except-list {value server[:port] | none}
hostname(config-group-policy)#

To remove the attribute from the configuration, use the no form of the command.
hostname(config-group-policy)# no msie-proxy except-list
hostname(config-group-policy)#

•

value server:port—Specifies the IP address or name of an MSIE server and port that is applied for
this client device. The port number is optional.

•

none—Indicates that there is no IP address/hostname or port and prevents inheriting an exception
list.

By default, msie-proxy except-list is disabled.
The line containing the proxy server IP address or hostname and the port number must be less than 100
characters long.
The following example shows how to set a browser proxy exception list, consisting of the server at IP
address 192.168.20.1, using port 880, for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# msie-proxy except-list value 192.168.20.1:880
hostname(config-group-policy)#

Step 4

Enable or disable browser proxy local-bypass settings for a client device by entering the msie-proxy
local-bypass command in group-policy configuration mode.
hostname(config-group-policy)# msie-proxy local-bypass {enable | disable}
hostname(config-group-policy)#

To remove the attribute from the configuration, use the no form of the command.
hostname(config-group-policy)# no msie-proxy local-bypass {enable | disable}
hostname(config-group-policy)#

By default, msie-proxy local-bypass is disabled.
The following example shows how to enable browser proxy local-bypass for the group policy named
FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# msie-proxy local-bypass enable
hostname(config-group-policy)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-58

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

Configuring Network Admission Control Parameters
The group-policy NAC commands in this section all have default values. Unless you have a good reason
for changing them, accept the default values for these parameters.
The security appliance uses Extensible Authentication Protocol (EAP) over UDP (EAPoUDP)
messaging to validate the posture of remote hosts. Posture validation involves the checking of a remote
host for compliancy with safety requirements before the assignment of a network access policy. An
Access Control Server must be configured for Network Admission Control before you configure NAC
on the security appliance.
The Access Control Server downloads the posture token, an informational text string configurable on the
ACS, to the security appliance to aid in system monitoring, reporting, debugging, and logging. A typical
posture token is Healthy, Checkup, Quarantine, Infected, or Unknown. Following posture validation or
clientless authentication, the ACS downloads the access policy for the session to the security appliance.
The following parameters let you configure Network Admission Control settings for the default group
policy or an alternative group policy.
Step 1

(Optional) Configure the status query timer period. The security appliance starts the status query timer
after each successful posture validation and status query response. The expiration of this timer triggers
a query for changes in the host posture, referred to as a status query. Enter the number of seconds in the
range 30 through 1800. The default setting is 300.
To specify the interval between each successful posture validation in a Network Admission Control
session and the next query for changes in the host posture, use the nac-sq-period command in
group-policy configuration mode:
hostname(config-group-policy)# nac-sq-period seconds
hostname(config-group-policy)#

To inherit the value of the status query timer from the default group policy, access the alternative group
policy from which to inherit it, then use the no form of this command:
hostname(config-group-policy)# no nac-sq-period [seconds]
hostname(config-group-policy)#

The following example changes the value of the status query timer to 1800 seconds:
hostname(config-group-policy)# nac-sq-period 1800
hostname(config-group-policy)

The following example inherits the value of the status query timer from the default group policy:
hostname(config-group-policy)# no nac-sq-period
hostname(config-group-policy)#

Step 2

(Optional) Configure the NAC revalidation period. The security appliance starts the revalidation timer
after each successful posture validation. The expiration of this timer triggers the next unconditional
posture validation. The security appliance maintains posture validation during revalidation. The default
group policy becomes effective if the Access Control Server is unavailable during posture validation or
revalidation. Enter the interval in seconds between each successful posture validation. The range is 300
through 86400. The default setting is 36000.
To specify the interval between each successful posture validation in a Network Admission Control
session, use the nac-reval-period command in group-policy configuration mode:

Cisco ASA 5500 Series Configuration Guide using the CLI

67-59

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

hostname(config-group-policy)# nac-reval-period seconds
hostname(config-group-policy)#

To inherit the value of the Revalidation Timer from the default group policy, access the alternative group
policy from which to inherit it, then use the no form of this command:
hostname(config-group-policy)# no nac-reval-period [seconds]
hostname(config-group-policy)#

The following example changes the revalidation timer to 86400 seconds:
hostname(config-group-policy)# nac-reval-period 86400
hostname(config-group-policy)

The following example inherits the value of the revalidation timer from the default group policy:
hostname(config-group-policy)# no nac-reval-period
hostname(config-group-policy)#

Step 3

(Optional) Configure the default ACL for NAC. The security appliance applies the security policy
associated with the selected ACL if posture validation fails. Specify none or an extended ACL. The
default setting is none. If the setting is none and posture validation fails, the security appliance applies
the default group policy.
To specify the ACL to be used as the default ACL for Network Admission Control sessions that fail
posture validation, use the nac-default-acl command in group-policy configuration mode:
hostname(config-group-policy)# nac-default-acl {acl-name | none}
hostname(config-group-policy)#

To inherit the ACL from the default group policy, access the alternative group policy from which to
inherit it, then use the no form of this command:
hostname(config-group-policy)# no nac-default-acl [acl-name | none]
hostname(config-group-policy)#

The elements of this command are as follows:
•

acl-name—Specifies the name of the posture validation server group, as configured on the ASA
using the aaa-server host command. The name must match the server-tag variable specified in that
command.

•

none—Disables inheritance of the ACL from the default group policy and does not apply an ACL
to NAC sessions that fail posture validation.

Because NAC is disabled by default, VPN traffic traversing the ASA is not subject to the NAC Default
ACL until NAC is enabled.
The following example identifies acl-1 as the ACL to be applied when posture validation fails:
hostname(config-group-policy)# nac-default-acl acl-1
hostname(config-group-policy)

The following example inherits the ACL from the default group policy:
hostname(config-group-policy)# no nac-default-acl
hostname(config-group-policy)

The following example disables inheritance of the ACL from the default group policy and does not apply
an ACL to NAC sessions that fail posture validation:
hostname(config-group-policy)# nac-default-acl none
hostname(config-group-policy)#

Cisco ASA 5500 Series Configuration Guide using the CLI

67-60

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

Step 4

Configure NAC exemptions for VPN. By default, the exemption list is empty.The default value of the
filter attribute is none. Enter the vpn-nac-exempt once for each operating system (and ACL) to be
matched to exempt remote hosts from posture validation.
To add an entry to the list of remote computer types that are exempt from posture validation, use the
vpn-nac-exempt command in group-policy configuration mode.
hostname(config-group-policy)# vpn-nac-exempt os "os name" [filter {acl-name | none}]
[disable]
hostname(config-group-policy)#

To disable inheritance and specify that all hosts are subject to posture validation, use the none keyword
immediately following vpn-nac-exempt.
hostname(config-group-policy)# vpn-nac-exempt none
hostname(config-group-policy)#

To remove an entry from the exemption list, use the no form of this command and name the operating
system (and ACL) in the entry to be removed.
hostname(config-group-policy)# no vpn-nac-exempt [os "os name"] [filter {acl-name | none}]
[disable]
hostname(config-group-policy)#

To remove all entries from the exemption list associated with this group policy and inherit the list from
the default group policy, use the no form of this command without specifying additional keywords.
hostname(config-group-policy)# no vpn-nac-exempt
hostname(config-group-policy)#

The syntax elements for these commands are as follows:
•

acl-name—Name of the ACL present in the ASA configuration.

•

disable—Disables the entry in the exemption list without removing it from the list.

•

filter—(Optional) filter

to apply an ACL to filter the traffic if the computer matches the

os name.
•

none—When entered immediately after vpn-nac-exempt, this keyword disables inheritance and
specifies that all hosts will be subject to posture validation.When entered immediately after filter,
this keyword indicates that the entry does not specify an ACL.

•

OS—Exempts an operating system from posture validation.

•

os name—Operating system name. Quotation marks are required only if the name includes a space
(for example, “Windows XP”).

The following example adds all hosts running Windows XP to the list of computers that are exempt from
posture validation:
hostname(config-group-policy)# vpn-nac-exempt os "Windows XP"
hostname(config-group-policy)

The following example exempts all hosts running Windows 98 that match an ACE in the ACL named
acl-1:
hostname(config-group-policy)# vpn-nac-exempt os "Windows 98" filter acl-1
hostname(config-group-policy)

The following example adds the same entry to the exemption list, but disables it:
hostname(config-group-policy)# vpn-nac-exempt os "Windows 98" filter acl-1 disable
hostname(config-group-policy)

Cisco ASA 5500 Series Configuration Guide using the CLI

67-61

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Group Policies

The following example removes the same entry from the exemption list, regardless of whether it is
disabled:
hostname(config-group-policy)# no vpn-nac-exempt os "Windows 98" filter acl-1
hostname(config-group-policy)

The following example disables inheritance and specifies that all hosts will be subject to posture
validation:
hostname(config-group-policy)# no vpn-nac-exempt none
hostname(config-group-policy)

The following example removes all entries from the exemption list:
hostname(config-group-policy)# no vpn-nac-exempt
hostname(config-group-policy)

Step 5

Enable or disable Network Admission Control by entering the following command:
hostname(config-group-policy)# nac {enable | disable}
hostname(config-group-policy)#

To inherit the NAC setting from the default group policy, access the alternative group policy from which
to inherit it, then use the no form of this command:
hostname(config-group-policy)# no nac [enable | disable]
hostname(config-group-policy)#

By default, NAC is disabled. Enabling NAC requires posture validation for remote access. If the remote
computer passes the validation checks, the ACS server downloads the access policy for the ASA to
enforce. NAC is disabled by default.
An Access Control Server must be present on the network.
The following example enables NAC for the group policy:
hostname(config-group-policy)# nac enable
hostname(config-group-policy)#

Configuring Address Pools
Configure a list of address pools for allocating addresses to remote clients by entering the address-pools
command in group-policy attributes configuration mode:
hostname(config-group-policy)# address-pools value address_pool1 [...address_pool6]
hostname(config-group-policy)#

The address-pools settings in this command override the local pool settings in the group. You can specify
a list of up to six local address pools to use for local address allocation.
The order in which you specify the pools is significant. The ASA allocates addresses from these pools
in the order in which the pools appear in this command.
To remove the attribute from the group policy and enable inheritance from other sources of group policy,
use the no form of this command:
hostname(config-group-policy)# no address-pools value address_pool1 [...address_pool6]
hostname(config-group-policy)#

The command address-pools none disables this attribute from being inherited from other sources of
policy, such as the DefaultGrpPolicy:

Cisco ASA 5500 Series Configuration Guide using the CLI

67-62

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Group Policies

hostname(config-group-policy)# address-pools none
hostname(config-group-policy)#

The command no address pools none removes the address-pools none command from the
configuration, restoring the default value, which is to allow inheritance.
hostname(config-group-policy)# no address-pools none

hostname(config-group-policy)#
The syntax elements of this command are as follows:
•

address_pool—Specifies the name of the address pool configured with the ip local pool command.
You can specify up to 6 local address pools.

•

none—Specifies that no address pools are configured and disables inheritance from other sources
of group policy.

•

value—Specifies a list of up to 6 address pools from which to assign addresses.

The following example entered in config-general configuration mode, configures pool 1 and pool20 as
lists of address pools to use for allocating addresses to remote clients for GroupPolicy1:
hostname(config)# ip local pool pool 192.168.10.1-192.168.10.100 mask 255.255.0.0
hostname(config)# ip local pool pool20 192.168.20.1-192.168.20.200 mask 255.255.0.0
hostname(config)# group-policy GroupPolicy1 attributes
hostname(config-group-policy)# address-pools value pool1 pool20
hostname(config-group-policy)#

Configuring Firewall Policies
A firewall isolates and protects a computer from the Internet by inspecting each inbound and outbound
individual packet of data to determine whether to allow or drop it. Firewalls provide extra security if
remote users in a group have split tunneling configured. In this case, the firewall protects the user’s PC,
and thereby the corporate network, from intrusions by way of the Internet or the user’s local LAN.
Remote users connecting to the ASA with the VPN client can choose the appropriate firewall option.
Set personal firewall policies that the ASA pushes to the VPN client during IKE tunnel negotiation by
using the client-firewall command in group-policy configuration mode. To delete a firewall policy, enter
the no form of this command.
To delete all firewall policies, enter the no client-firewall command without arguments. This command
deletes all configured firewall policies, including a null policy if you created one by entering the
client-firewall command with the none keyword.
When there are no firewall policies, users inherit any that exist in the default or other group policy. To
prevent users from inheriting such firewall policies, enter the client-firewall command with the none
keyword.
The Add or Edit Group Policy window, Client Firewall tab, lets you configure firewall settings for VPN
clients for the group policy being added or modified.

Note

Only VPN clients running Microsoft Windows can use these firewall features. They are currently not
available to hardware clients or other (non-Windows) software clients.
In the first scenario, a remote user has a personal firewall installed on the PC. The VPN client enforces
firewall policy defined on the local firewall, and it monitors that firewall to make sure it is running. If
the firewall stops running, the VPN client drops the connection to the ASA. (This firewall enforcement

Cisco ASA 5500 Series Configuration Guide using the CLI

67-63

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Supporting a Zone Labs Integrity Server

mechanism is called Are You There (AYT), because the VPN client monitors the firewall by sending it
periodic “are you there?” messages; if no reply comes, the VPN client knows the firewall is down and
terminates its connection to the ASA.) The network administrator might configure these PC firewalls
originally, but with this approach, each user can customize his or her own configuration.
In the second scenario, you might prefer to enforce a centralized firewall policy for personal firewalls
on VPN client PCs. A common example would be to block Internet traffic to remote PCs in a group using
split tunneling. This approach protects the PCs, and therefore the central site, from intrusions from the
Internet while tunnels are established. This firewall scenario is called push policy or Central Protection
Policy (CPP). On the ASA, you create a set of traffic management rules to enforce on the VPN client,
associate those rules with a filter, and designate that filter as the firewall policy. The ASA pushes this
policy down to the VPN client. The VPN client then in turn passes the policy to the local firewall, which
enforces it.

Supporting a Zone Labs Integrity Server
This section introduces the Zone Labs Integrity server, also called the Check Point Integrity server, and
presents an example procedure for configuring the ASA to support the Zone Labs Integrity server. The
Integrity server is a central management station for configuring and enforcing security policies on
remote PCs. If a remote PC does not conform to the security policy dictated by the Integrity server, it is
not granted access to the private network protected by the Integrity server and ASA.
This section includes the following topics:
•

Overview of the Integrity Server and ASA Interaction, page 67-64

•

Configuring Integrity Server Support, page 67-65

Overview of the Integrity Server and ASA Interaction
The VPN client software and the Integrity client software are co-resident on a remote PC. The following
steps summarize the actions of the remote PC, ASA, and Integrity server in the establishment of a session
between the PC and the enterprise private network:
1.

The VPN client software (residing on the same remote PC as the Integrity client software) connects
to the ASA and tells the ASA what type of firewall client it is.

2.

After the ASA approves the client firewall type, the ASA passes Integrity server address information
back to the Integrity client.

3.

With the ASA acting as a proxy, the Integrity client establishes a restricted connection with the
Integrity server. A restricted connection is only between the Integrity client and the Integrity server.

4.

The Integrity server determines if the Integrity client is in compliance with the mandated security
policies. If the Integrity client is in compliance with security policies, the Integrity server instructs
the ASA to open the connection and provide the Integrity client with connection details.

5.

On the remote PC, the VPN client passes connection details to the Integrity client and signals that
policy enforcement should begin immediately and the Integrity client can enter the private network.

6.

After the VPN connection is established, the Integrity server continues to monitor the state of the
Integrity client using client heartbeat messages.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-64

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Supporting a Zone Labs Integrity Server

Note

The current release of the ASA supports one Integrity server at a time, even though the user interfaces
support the configuration of up to five Integrity servers. If the active Integrity server fails, configure
another one on the ASA and then reestablish the VPN client session.

Configuring Integrity Server Support
This section describes an example procedure for configuring the ASA to support the Zone Labs Integrity
servers. The procedure involves configuring address, port, connection fail timeout and fail states, and
SSL certificate parameters.
To configure the Integrity server, perform the following steps:

Step 1

Command

Purpose

zonelabs-Integrity server-address {hostname1 |
ip-address1}

Configures an Integrity server using the IP address
10.0.0.5.

Example:
hostname(config)# zonelabs-Integrity server-address
10.0.0.5

Step 2

Specifies port 300 (the default port is 5054).

zonelabs-integrity port port-number

Example:
hostname(config)# zonelabs-integrity port 300

Step 3

Specifies the inside interface for communications
with the Integrity server.

zonelabs-integrity interface interface

Example:
hostname(config)# zonelabs-integrity interface
inside

Step 4

zonelabs-integrity fail-timeout timeout

Example:
hostname(config)# zonelabs-integrity fail-timeout 12

Ensures that the ASA waits 12 seconds for a response
from either the active or standby Integrity servers
before declaring the Integrity server as failed and
closing the VPN client connections.
Note

Step 5

zonelabs-integrity fail-close

Example:

If the connection between the ASA and the
Integrity server fails, the VPN client
connections remain open by default so that
the enterprise VPN is not disrupted by the
failure of an Integrity server. However, you
may want to close the VPN connections if the
Zone Labs Integrity server fails.

Configures the ASA so that connections to VPN clients
close when the connection between the ASA and the
Zone Labs Integrity server fails.

hostname(config)# zonelabs-integrity fail-close

Cisco ASA 5500 Series Configuration Guide using the CLI

67-65

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Supporting a Zone Labs Integrity Server

Step 6

Command

Purpose

zonelabs-integrity fail-open

Returns the configured VPN client connection fail
state to the default and ensures that the client
connections remain open.

Example:
hostname(config)# zonelabs-integrity fail-open

Step 7

Specifies that the Integrity server connects to port
300 (the default is port 80) on the ASA to request the
server SSL certificate.

zonelabs-integrity ssl-certificate-port
cert-port-number

Example:
hostname(config)# zonelabs-integrity
ssl-certificate-port 300

Step 8

zonelabs-integrity ssl-client-authentication {enable
| disable}

While the server SSL certificate is always
authenticated, also specifies that the client SSL
certificate of the Integrity server be authenticated.

Example:
hostname(config)# zonelabs-integrity
ssl-client-authentication enable

To set the firewall client type to the Zone Labs Integrity type, enter the following command:
Command

Purpose

client-firewall {opt | req} zonelabs-integrity

For more information, see the “Configuring Firewall
Policies” section on page 67-63. The command arguments
that specify firewall policies are not used when the firewall
type is zonelabs-integrity, because the Integrity server
determines these policies.

Example:
hostname(config)# client-firewall req
zonelabs-integrity

Setting Client Firewall Parameters
Enter the following commands to set the appropriate client firewall parameters. You can configure only
one instance of each command. Table 67-4 lists the syntax elements of these commands. For more
information, see the “Configuring Firewall Policies” section on page 67-63.

Cisco Integrated Firewall
hostname(config-group-policy)# client-firewall {opt | req} cisco-integrated acl-in ACL
acl-out ACL

Cisco Security Agent
hostname(config-group-policy)# client-firewall {opt | req} cisco-security-agent

No Firewall
hostname(config-group-policy)# client-firewall none

Cisco ASA 5500 Series Configuration Guide using the CLI

67-66

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Supporting a Zone Labs Integrity Server

Custom Firewall
hostname(config-group-policy)# client-firewall {opt | req} custom vendor-id num product-id
num policy {AYT | CPP acl-in ACL acl-out ACL} [description string]

Zone Labs Firewalls
hostname(config-group-policy)# client-firewall {opt | req} zonelabs-integrity

Note

When the firewall type is zonelabs-integrity, do not include arguments. The Zone Labs Integrity Server
determines the policies.
hostname(config-group-policy)# client-firewall {opt | req} zonelabs-zonealarm policy {AYT
| CPP acl-in ACL acl-out ACL}
hostname(config-group-policy)# client-firewall {opt | req} zonelabs-zonealarmorpro policy
{AYT | CPP acl-in ACL acl-out ACL}
client-firewall {opt | req} zonelabs-zonealarmpro policy {AYT | CPP acl-in ACL acl-out
ACL}

Sygate Personal Firewalls
hostname(config-group-policy)# client-firewall {opt | req} sygate-personal
hostname(config-group-policy)# client-firewall {opt | req} sygate-personal-pro
hostname(config-group-policy)# client-firewall {opt | req} sygate-security-agent

Network Ice, Black Ice Firewall:
hostname(config-group-policy)# client-firewall {opt | req} networkice-blackice

Table 67-4

client-firewall Command Keywords and Variables

Parameter

Description

acl-in ACL

Provides the policy the client uses for inbound traffic.

acl-out ACL

Provides the policy the client uses for outbound traffic.

AYT

Specifies that the client PC firewall application controls the firewall
policy. The ASA checks to make sure that the firewall is running. It
asks, “Are You There?” If there is no response, the ASA tears down
the tunnel.

cisco-integrated

Specifies Cisco Integrated firewall type.

cisco-security-agent

Specifies Cisco Intrusion Prevention Security Agent firewall type.

CPP

Specifies Policy Pushed as source of the VPN client firewall policy.

custom

Specifies Custom firewall type.

description string

Describes the firewall.

networkice-blackice

Specifies Network ICE Black ICE firewall type.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-67

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Supporting a Zone Labs Integrity Server

Table 67-4

client-firewall Command Keywords and Variables

none

Indicates that there is no client firewall policy. Sets a firewall policy
with a null value, thereby disallowing a firewall policy. Prevents
inheriting a firewall policy from a default or specified group policy.

opt

Indicates an optional firewall type.

product-id

Identifies the firewall product.

req

Indicates a required firewall type.

sygate-personal

Specifies the Sygate Personal firewall type.

sygate-personal-pro

Specifies Sygate Personal Pro firewall type.

sygate-security-agent

Specifies Sygate Security Agent firewall type.

vendor-id

Identifies the firewall vendor.

zonelabs-integrity

Specifies Zone Labs Integrity Server firewall type.

zonelabs-zonealarm

Specifies Zone Labs Zone Alarm firewall type.

zonelabs-zonealarmorpro
policy

Specifies Zone Labs Zone Alarm or Pro firewall type.

zonelabs-zonealarmpro policy Specifies Zone Labs Zone Alarm Pro firewall type.
The following example shows how to set a client firewall policy that requires Cisco Intrusion Prevention
Security Agent for the group policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# client-firewall req cisco-security-agent
hostname(config-group-policy)#

Configuring Client Access Rules
Configure rules that limit the remote access client types and versions that can connect via IPsec through
the ASA by using the client-access-rule command in group-policy configuration mode. Construct rules
according to these guidelines:
•

If you do not define any rules, the ASA permits all connection types.

•

When a client matches none of the rules, the ASA denies the connection. If you define a deny rule,
you must also define at least one permit rule; otherwise, the ASA denies all connections.

•

For both software and hardware clients, type and version must exactly match their appearance in the
show vpn-sessiondb remote display.

•

The * character is a wildcard, which you can enter multiple times in each rule. For example,
client-access rule 3 deny type * version 3.* creates a priority 3 client access rule that denies all
client types running release versions 3.x software.

•

You can construct a maximum of 25 rules per group policy.

•

There is a limit of 255 characters for an entire set of rules.

•

You can enter n/a for clients that do not send client type and/or version.

To delete a rule, enter the no form of this command. This command is equivalent to the following
command:
hostname(config-group-policy)# client-access-rule 1 deny type "Cisco VPN Client" version
4.0

Cisco ASA 5500 Series Configuration Guide using the CLI

67-68

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Supporting a Zone Labs Integrity Server

To delete all rules, enter the no client-access-rule command without arguments. This deletes all
configured rules, including a null rule if you created one by issuing the client-access-rule command with
the none keyword.
By default, there are no access rules. When there are no client access rules, users inherit any rules that
exist in the default group policy.
To prevent users from inheriting client access rules, enter the client-access-rule command with the none
keyword. The result of this command is that all client types and versions can connect.
hostname(config-group-policy)# client-access rule priority {permit | deny} type type
version {version | none}
hostname(config-group-policy)# no client-access rule [priority {permit | deny} type type
version version]

Table 67-5 explains the meaning of the keywords and parameters in these commands.
Table 67-5

client-access rule Command Keywords and Variables

Parameter

Description

deny

Denies connections for devices of a particular type and/or version.

none

Allows no client access rules. Sets client-access-rule to a null value, thereby
allowing no restriction. Prevents inheriting a value from a default or
specified group policy.

permit

Permits connections for devices of a particular type and/or version.

priority

Determines the priority of the rule. The rule with the lowest integer has the
highest priority. Therefore, the rule with the lowest integer that matches a
client type and/or version is the rule that applies. If a lower priority rule
contradicts, the ASA ignores it.

type type

Identifies device types via free-form strings, for example VPN 3002. A
string must match exactly its appearance in the show vpn-sessiondb
remote display, except that you can enter the * character as a wildcard.

version version

Identifies the device version via free-form strings, for example 7.0. A string
must match exactly its appearance in the show vpn-sessiondb remote
display, except that you can enter the * character as a wildcard.

The following example shows how to create client access rules for the group policy named FirstGroup.
These rules permit Cisco VPN clients running software version 4.x, while denying all Windows NT
clients:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# client-access-rule 1 deny type WinNT version *
hostname(config-group-policy)# client-access-rule 2 permit “Cisco VPN Client” version 4.*

Note

The “type” field is a free-form string that allows any value, but that value must match the fixed
value that the client sends to the ASA at connect time.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-69

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Supporting a Zone Labs Integrity Server

Configuring Group-Policy Attributes for Clientless SSL VPN Sessions
Clientless SSL VPN lets users establish a secure, remote-access VPN tunnel to the ASA using a web
browser. There is no need for either a software or hardware client. Clientless SSL VPN provides easy
access to a broad range of web resources and web-enabled applications from almost any computer that
can reach HTTPS Internet sites. Clientless SSL VPN uses SSL and its successor, TLS1, to provide a
secure connection between remote users and specific, supported internal resources that you configure at
a central site. The ASA recognizes connections that need to be proxied, and the HTTP server interacts
with the authentication subsystem to authenticate users. By default, clientless SSL VPN is disabled.
You can customize a configuration of clientless SSL VPN for specific internal group policies.

Note

The webvpn mode that you enter from global configuration mode lets you configure global settings for
clientless SSL VPN sessions. The webvpn mode described in this section, which you enter from
group-policy configuration mode, lets you customize a configuration of group policies specifically for
clientless SSL VPN sessions.
In group-policy webvpn configuration mode, you can specify whether to inherit or customize the
following parameters, each of which is described in the subsequent sections:
•

customizations

•

html-content-filter

•

homepage

•

filter

•

url-list

•

port-forward

•

port-forward-name

•

sso server (single-signon server)

•

auto-signon

•

deny message

•

AnyConnect Secure Mobility Client

•

keep-alive ignore

•

HTTP compression

In many instances, you define the webvpn attributes as part of configuring clientless SSL VPN, then you
apply those definitions to specific groups when you configure the group-policy webvpn attributes. Enter
group-policy webvpn configuration mode by using the webvpn command in group-policy configuration
mode. Webvpn commands for group policies define access to files, URLs and TCP applications over
clientless SSL VPN sessions. They also identify ACLs and types of traffic to filter. Clientless SSL VPN
is disabled by default. See the description of Chapter 74, “Configuring Clientless SSL VPN” for more
information about configuring the attributes for clientless SSL VPN sessions.
To remove all commands entered in group-policy webvpn configuration mode, enter the no form of this
command. These webvpn commands apply to the username or group policy from which you configure
them.
hostname(config-group-policy)# webvpn
hostname(config-group-policy)# no webvpn

Cisco ASA 5500 Series Configuration Guide using the CLI

67-70

Chapter 67

Configuring Connection Profiles, Group Policies, and Users
Supporting a Zone Labs Integrity Server

The following example shows how to enter group-policy webvpn configuration mode for the group
policy named FirstGroup:
hostname(config)# group-policy FirstGroup attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)#

Applying Customization
Customizations determine the appearance of the windows that the user sees upon login. You configure
the customization parameters as part of configuring clientless SSL VPN. To apply a previously defined
web-page customization to change the look-and-feel of the web page that the user sees at login, enter the
customization command in group-policy webvpn configuration mode:
hostname(config-group-webvpn)# customization customization_name
hostname(config-group-webvpn)#

For example, to use the customization named blueborder, enter the following command:
hostname(config-group-webvpn)# customization blueborder
hostname(config-group-webvpn)#

You configure the customization itself by entering the customization command in webvpn mode.
The following example shows a command sequence that first establishes a customization named 123 that
defines a password prompt. The example then defines a group policy named testpolicy and uses the
customization command to specify the use of the customization named 123 for clientless SSL VPN
sessions:
hostname(config)# webvpn
hostname(config-webvpn)# customization 123
hostname(config-webvpn-custom)# password-prompt Enter password
hostname(config-webvpn)# exit
hostname(config)# group-policy testpolicy nopassword
hostname(config)# group-policy testpolicy attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# customization value 123
hostname(config-group-webvpn)#

Specifying a “Deny” Message
You can specify the message delivered to a remote user who logs into a clientless SSL VPN session
successfully, but has no VPN privileges, by entering the deny-message command in group-policy
webvpn configuration mode:
hostname(config-group-webvpn)# deny-message value "message"
hostname(config-group-webvpn)# no deny-message value "message"
hostname(config-group-webvpn)# deny-message none

The no deny-message value command removes the message string, so that the remote user does not
receive a message.
The no deny-message none command removes the attribute from the connection profile policy
configuration. The policy inherits the attribute value.
The message can be up to 491 alphanumeric characters long, including special characters, spaces, and
punctuation, but not counting the enclosing quotation marks. The text appears on the remote user’s
browser upon login. When typing the string in the deny-message value command, continue typing even
if the command wraps.

Cisco ASA 5500 Series Configuration Guide using the CLI

67-71

Chapter 67

Configuring Connection Profiles, Group Policies, and Users

Supporting a Zone Labs Integrity Server

The default deny message is: “Login was successful, but because certain criteria have not been met or
due to some specific group policy, you do not have permission to use any of the VPN features. Contact
your IT administrator for more information.”
The first command in the following example creates an internal group policy named group2. The
subsequent commands modify the attributes, including the webvpn deny message associated with that
policy.
hostname(config)# group-policy group2 internal
hostname(config)# group-policy group2 attributes
hostname(config-group)# webvpn
hostname(config-group-webvpn)# deny-message value "Your login credentials are OK. However,
you have not been granted rights to use the VPN features. Contact your administrator for
more information."
hostname(config-group-webvpn)

Configuring Group-Policy Filter Attributes for Clientless SSL VPN Sessions
Specify whether to filter Java, ActiveX, images, scripts, and cookies from clientless SSL VPN sessions
for this group policy by using the html-content-filter command in webvpn mode. HTML filtering is
disabled by default.
To remove a content filter, enter the no form of this command. To remove all content filters, including a
null value created by issuing the html-content-filter command with the none keyword, enter the no
form of this command without arguments. The no option allows inheritance of a value from another
group policy. To prevent inheriting an html content filter, enter the html-content-filter command with
the none keyword.
Using the command a second time overrides the previous setting.
hostname(config-group-webvpn)# html-content-filter {java | images | scripts | cookies |
none}
hostname(config-group-webvpn)# no html-content-filter [java | images | scripts | cookies |
none]

Table 67-6 describes the meaning of the keywords used in this command.
Table 67-6

filter Command Keywords

Keyword

Meaning

cookies

Removes cookies from images, providing limited ad filtering and privacy.

images

Removes references to images (removes  tags).

java

Removes references to Java and ActiveX (removes ,
, and  tags).

none

Indicates that there is no filtering. Sets a null value, thereby disallowing
filtering. Prevents inheriting filtering values.

scripts

Removes references to scripting (removes 





								

Navigation menu