Cisco ASA Series Command Reference, 8.4, 8.5, 8.6, and 8.7
ack-netmask-convert -- auto-update timeout

Table Of Contents

acl-netmask-convert through auto-update timeout Commands

acl-netmask-convert

action

action-uri

activation-key

activex-relay

ad-agent-mode

address (dynamic-filter blacklist or whitelist)

address (media-termination)

address-pool (tunnel-group general attributes mode)

address-pools (group-policy attributes configuration mode)

admin-context

allocate-interface

allocate-ips

allow-ssc-mgmt

always-on-vpn

anyconnect ask

anyconnect df-bit-ignore

anyconnect dpd-interval

anyconnect dtls compression

anyconnect enable

anyconnect firewall-rule

anyconnect image

anyconnect keep-installer

anyconnect modules

anyconnect mtu

anyconnect profiles (group-policy or username attributes)

anyconnect profiles (webvpn)

anyconnect routing-filtering-ignore

anyconnect ssl compression

anyconnect ssl df-bit-ignore

anyconnect ssl dtls enable

anyconnect ssl keepalive

anyconnect ssl rekey

anyconnect-essentials

apcf

appl-acl

application-access

application-access hide-details

area

area authentication

area default-cost

area filter-list prefix

area nssa

area range

area stub

area virtual-link

arp

arp permit-nonconnected

arp-inspection

arp permit-nonconnected

arp timeout

asdm disconnect

asdm disconnect log_session

asdm history enable

asdm image

asdm location

asp load-balance per-packet

asr-group

assertion-consumer-url

attribute

auth-cookie-name

authenticated-session-username

authentication-attr-from-server

authentication-certificate

authentication-exclude

authentication

authentication eap-proxy

authentication key eigrp

authentication mode eigrp

authentication ms-chap-v1

authentication ms-chap-v2

authentication pap

authentication-certificate

authentication-port

authentication-server-group (imap4s, pop3s, smtps)

authentication-server-group (tunnel-group general-attributes)

authorization-required

authorization-server-group

auth-prompt

auto-signon

auto-summary

auto-update device-id

auto-update poll-at

auto-update poll-period

auto-update server

auto-update timeout


acl-netmask-convert through auto-update timeout Commands


acl-netmask-convert

To specify how the ASA treats netmasks received in a downloadable ACL from a RADIUS server that is accessed by using the aaa-server host command, use the acl-netmask-convert command in aaa-server host configuration mode. To remove the specified behavior for the ASA, use the no form of this command.

acl-netmask-convert {auto-detect | standard | wildcard}

no acl-netmask-convert

Syntax Description

auto-detect

Specifies that the ASA should attempt to determine the type of netmask expression used. If it detects a wildcard netmask expression, it converts it to a standard netmask expression. See "Usage Guidelines" for more information about this keyword.

standard

Specifies that the ASA assumes downloadable ACLs received from the RADIUS server contain only standard netmask expressions. No translation from wildcard netmask expressions is performed.

wildcard

Specifies that the ASA assumes downloadable ACLs received from the RADIUS server contain only wildcard netmask expressions and it converts them all to standard netmask expressions when the ACLs are downloaded.


Defaults

By default, no conversion from wildcard netmask expressions is performed.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Aaa-server-host configuration


Command History

Release
Modification

7.0(4)

This command was introduced.


Usage Guidelines

Use the acl-netmask-convert command with the wildcard or auto-detect keywords when a RADIUS server provides downloadable ACLs that contain netmasks in wildcard format. The ASA expects downloadable ACLs to contain standard netmask expressions, whereas Cisco VPN 3000 series concentrators expect downloadable ACLs to contain wildcard netmask expressions that are the reverse of a standard netmask expression. A wildcard mask has ones in bit positions to ignore, zeros in bit positions to match. The acl-netmask-convert command helps minimize the effects of these differences on how you configure downloadable ACLs on your RADIUS servers.

The auto-detect keyword is helpful when you are uncertain how the RADIUS server is configured; however, wildcard netmask expressions with "holes" in them cannot be unambiguously detected and converted. For example, the wildcard netmask 0.0.255.0 permits anything in the third octet and can be used validly on Cisco VPN 3000 series concentrators, but the ASA may not detect this expression as a wildcard netmask.

Examples

The following example configures a RADIUS AAA server named "srvgrp1" on host "192.168.3.4", enables conversion of downloadable ACL netmasks, sets a timeout of 9 seconds, sets a retry-interval of 7 seconds, and configures authentication port 1650:

hostname(config)# aaa-server svrgrp1 protocol radius
hostname(config-aaa-server-group)# aaa-server svrgrp1 host 192.168.3.4
hostname(config-aaa-server-host)# acl-netmask-convert wildcard
hostname(config-aaa-server-host)# timeout 9
hostname(config-aaa-server-host)# retry-interval 7
hostname(config-aaa-server-host)# authentication-port 1650
hostname(config-aaa-server-host)# exit
hostname(config)# 

Related Commands

Command
Description

aaa authentication

Enables or disables LOCAL, TACACS+, or RADIUS user authentication, on a server designated by the aaa-server command, or ASDM user authentication.

aaa-server host

Enters aaa-server host configuration mode, so you can configure AAA server parameters that are host-specific.

clear configure aaa-server

Removes all AAA command statements from the configuration.

show running-config aaa-server

Displays AAA server statistics for all AAA servers, for a particular server group, for a particular server within a particular group, or for a particular protocol.


action

To either apply access policies to a session or teminate the session, use the action command in dynamic-access-policy-record configuration mode. To reset the session to apply an access policy to a session, use the no form of this command.

action {continue | terminate}

no action {continue | terminate}

Syntax Description

continue

Applies the access policies to the session.

terminate

Terminates the connection.


Defaults

The default value is continue.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Dynamic-access-policy-record configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

Use the continue keyword to apply the access policies to the session in all of the selected DAP records. Use the terminate keyword to terminate the connection in any of the selected DAP records.

Examples

The following example shows how to terminate a session for the DAP policy Finance:

hostname (config)# config-dynamic-access-policy-record Finance
hostname(config-dynamic-access-policy-record)# action terminate
hostname(config-dynamic-access-policy-record)# 

Related Commands

Command
Description

dynamic-access-policy-record

Creates a DAP record.

show running-config dynamic-access-policy-record [name]

Displays the running configuration for all DAP records, or for the named DAP record.


action-uri

To specify a web server URI to receive a username and password for single sign-on authentication, use the action-uri command in aaa-server-host configuration mode. This is an SSO with HTTP Forms command. To reset the URI parameter value, use the no form of this command.

action-uri string

no action-uri


Note To configure SSO with the HTTP protocol correctly, you must have a thorough working knowledge of authentication and HTTP protocol exchanges.


Syntax Description

string

The URI for an authentication program. You can enter it on multiple lines. The maximum number of characters for each line is 255. The maximum number of characters for the complete URI is 2048 characters.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Aaa-server-host configuration


Command History

Release
Modification

7.1(1)

This command was introduced.


Usage Guidelines

A URI or Uniform Resource Identifier is a compact string of characters that identifies a point of content on the Internet, whether it be a page of text, a video or sound clip, a still or animated image, or a program. The most common form of URI is the web page address, which is a particular form or subset of URI called a URL.

The WebVPN server of the ASA can use a POST request to submit a single sign-on authentication request to an authenticating web server. To accomplish this, configure the ASA to pass a username and a password to an action URI on an authenticating web server using an HTTP POST request. The action-uri command specifies the location and name of the authentication program on the web server to which the ASA sends the POST request.

You can discover the action URI on the authenticating web server by connecting to the web server login page directly with a browser. The URL of the login web page displayed in your browser is the action URI for the authenticating web server.

For ease of entry, you can enter URIs on multiple, sequential lines. The ASA then concatenates the lines into the URI as you enter them. While the maximum characters per action-uri line is 255 characters, you can enter fewer characters on each line.


Note Any question mark in the string must be preceded by a CTRL-v escape sequence.


Examples

The following example specifies the URI on www.example.com:

http://www.example.com/auth/index.html/appdir/authc/forms/MCOlogin.fcc?TYPE=33554433&REALMOID=06-000a1311-a828-1185-ab41-8333b16a0008&GUID=&SMAUTHREASON=0&METHOD=GET&SMAGENTNAME=$SM$5FZmjnk3DRNwNjk2KcqVCFbIrNT9%2bJ0H0KPshFtg6rB1UV2PxkHqLw%3d%3d&TARGET=https%3A%2F%2Fauth.example.com

hostname(config)# aaa-server testgrp1 host www.example.com
hostname(config-aaa-server-host)# action-uri http://www.example.com/auth/index.htm
hostname(config-aaa-server-host)# action-uri l/appdir/authc/forms/MCOlogin.fcc?TYP
hostname(config-aaa-server-host)# action-uri 554433&REALMOID=06-000a1311-a828-1185
hostname(config-aaa-server-host)# action-uri -ab41-8333b16a0008&GUID=&SMAUTHREASON
hostname(config-aaa-server-host)# action-uri =0&METHOD=GET&SMAGENTNAME=$SM$5FZmjnk
hostname(config-aaa-server-host)# action-uri 3DRNwNjk2KcqVCFbIrNT9%2bJ0H0KPshFtg6r
hostname(config-aaa-server-host)# action-uri B1UV2PxkHqLw%3d%3d&TARGET=https%3A%2F
hostname(config-aaa-server-host)# action-uri %2Fauth.example.com
hostname(config-aaa-server-host)#

Note You must include the hostname and protocol in the action URI. In the preceding example, these are included in http://www.example.com at the start of the URI.


Related Commands

Command
Description

auth-cookie-name

Specifies a name for the authentication cookie.

hidden-parameter

Creates hidden parameters for exchange with the SSO server.

password-parameter

Specifies the name of the HTTP POST request parameter in which a user password must be submitted for SSO authentication.

start-url

Specifies the URL at which to retrieve a pre-login cookie.

user-parameter

Specifies the name of the HTTP POST request parameter in which a username must be submitted for SSO authentication.


activation-key

To enter a license activation key on the ASA, use the activation-key command in privileged EXEC mode.

activation-key [noconfirm] activation_key [activate | deactivate]

Syntax Description

activate

Activates a time-based activation key. activate is the default value. The last time-based key that you activate for a given feature is the active one.

activation_key

Applies an activation key to the ASA. The activation_key is a five-element hexadecimal string with one space between each element. The leading 0x specifier is optional; all values are assumed to be hexadecimal.

You can install one permanent key, and multiple time-based keys. If you enter a new permanent key, it overwrites the already installed one.

deactivate

Deactivates a time-based activation key. The activation key is still installed on the ASA when you deactivate it, and you can activate it later using the activate 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.

noconfirm

(Optional) Enters an activation key without prompting you for confirmation.


Defaults

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 show activation-key command to determine which licenses you have installed.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Privileged EXEC


Command History

Release
Modification

7.0(5)

Increased the following limits:

ASA 5510 Base license connections from 32000 to 5000; VLANs from 0 to 10.

ASA 5510 Security Plus license connections from 64000 to 130000; VLANs from 10 to 25.

ASA 5520 connections from 130000 to 280000; VLANs from 25 to 100.

ASA 5540 connections from 280000 to 400000; VLANs from 100 to 200.

7.1(1)

SSL VPN licenses were introduced.

7.2(1)

A 5000-user SSL VPN license was introduced for the ASA 5550 and above.

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.

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

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.

8.0(2)

The Advanced Endpoint Assessment license was introduced.

VPN load balancing is now supported on the ASA 5510 Security Plus license.

8.0(3)

The AnyConnect for Mobile license was introduced.

8.0(4)/8.1(2)

Support for time-based licenses was introduced.

8.1(2)

The number of VLANs supported on the ASA 5580 are increased from 100 to 250.

8.0(4)

The UC Proxy sessions license was introduced.

8.2(1)

The Botnet Traffic Filter license was introduced.

The AnyConnect Essentials License was introduced. 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.

Shared licenses for SSL VPN were introduced.

8.2(2)

The Mobility Proxy no longer requires the UC Proxy license.

8.3(1)

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.

Time-based licenses are now stackable.

The IME license was introduced.

You can now install multiple time-based licenses, and have one license per feature active at a time.

You can now activate or deactivate time-based licenses using activate or deactivate keywords.

8.4(1)

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.

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

We increased the firewall connection limits:

ASA 5580-20—1,000 K to 2,000 K.

ASA 5580-40—2,000 K to 4,000 K.

ASA 5585-X with SSP-10: 750 K to 1,000 K

ASA 5585-X with SSP-20: 1,000 K to 2,000 K

ASA 5585-X with SSP-40: 2,000 K to 4,000 K

ASA 5585-X with SSP-60: 2,000 K to 10,000 K

For the ASA 5580, the AnyConnect VPN session limit was increased from 5,000 to 10,000.

For the ASA 5580, the other VPN session limit was increased from 5,000 to 10,000.

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

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.


Usage Guidelines

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 SSL VPN sessions.

After obtaining the Product Authorization Keys, register them on Cisco.com at one of the following URLs.

If you are a registered user of Cisco.com, go to the following website:

http://www.cisco.com/go/license

If you are not a registered user of Cisco.com, go to the following website:

http://www.cisco.com/go/license/public

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.

Failover Guidelines

Shared licenses are not supported in Active/Active mode.

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.

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:

Downgrading to Version 8.1 or earlier—After you upgrade, if you activate additional feature licenses that were introduced before 8.2, then the activation key continues to be compatible with earlier versions if you downgrade. However if you activate feature licenses that were introduced in 8.2 or later, then the activation key is not backwards compatible. If you have an incompatible license key, then see the following guidelines:

If you previously entered an activation key in an earlier version, then the ASA uses that key (without any of the new licenses you activated in Version 8.2 or later).

If you have a new system and do not have an earlier activation key, then you need to request a new activation key compatible with the earlier version.

Downgrading to Version 8.2 or earlier—Version 8.3 introduced more robust time-based key usage as well as failover license changes:

If you have more than one time-based activation key active, when you downgrade, only the most recently activated time-based key can be active. Any other keys are made inactive.

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

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, 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: full SSL VPN license, shared SSL VPN 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.

Some permanent licenses require you to reload the ASA after you activate them. Table 2-1 lists the licenses that require reloading.

Table 2-1 Permanent License Reloading Requirements

Model
License Action Requiring Reload

ASA 5505 and 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).


Examples

The following example shows how to change the activation key on the ASA:

hostname# activation-key 0xd11b3d48 0xa80a4c0a 0x48e0fd1c 0xb0443480 0x843fc490

The following is sample output from the activation-key command that shows output for failover when the new activation key is different than the old activation key:

hostname# activation-key 0xyadayada 0xyadayada 0xyadayada 0xyadayada 0xyadayada
Validating activation key. This may take a few minutes...
The following features available in the running permanent activation key are NOT available 
in the new activation key:
Failover is different.
   running permanent activation key: Restricted (R)
   new activation key: Unrestricted (UR)
WARNING: The running activation key was not updated with the requested key.
Proceed with updating flash activation key? [y]
Flash permanent activation key was updated with the requested key.

The following is sample output from a license file:

Serial Number Entered: 123456789ja 
Number of Virtual Firewalls Selected: 10 
Formula One device: ASA 5520 
Failover                       : Enabled   
VPN-DES                        : Enabled   
VPN-3DES-AES                   : Enabled   
Security Contexts              : 10        
GTP/GPRS                       : Disabled  
SSL VPN Peers                  : Default   
Total VPN Peers                : 750       
Advanced Endpoint Assessment   : Disabled  
AnyConnect for Mobile          : Enabled   
AnyConnect for Cisco VPN Phone : Disabled  
Shared License                 : Disabled  
UC Phone Proxy Sessions        : Default   
Total UC Proxy Sessions        : Default   
AnyConnect Essentials          : Disabled  
Botnet Traffic Filter          : Disabled  
Intercompany Media Engine      : Enabled   
------------------------------------------
THE FOLLOWING ACTIVATION KEY IS VALID FOR:
ASA SOFTWARE RELEASE 8.2+ ONLY.
Platform = asa
123456789JA:	yadayda1 yadayda1 yadayda1 yadayda1 yadayda1 
------------------------------------------
THE FOLLOWING ACTIVATION KEY IS VALID FOR:
ALL ASA SOFTWARE RELEASES, BUT EXCLUDES ANY
8.2+ FEATURES FOR BACKWARDS COMPATIBILITY.
Platform = asa
123456789JA:	yadayda2 yadayda2 yadayda2 yadayda2 yadayda2 

Related Commands

Command
Description

anyconnect-essentials

Enables or disables the Anyconnect Essentials license.

show activation-key

Shows the activation key.

show version

Shows the software version and activation key.


activex-relay

To incorporate applications that need ActiveX over the clientless portal, use the activex-relay command in group-policy webvpn configuration mode or username webvpn configuration mode. Use the no form of this command to inherit the activex-relay command from the default group policy.

activex-relay {enable | disable}

no activex-relay

Syntax Description

enable

Enables ActiveX on WebVPN sessions.

disable

Disables ActiveX on WebVPN sessions.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group-policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

Use the activex-relay enable command to let users launch ActiveX from the WebVPN browser for any HTML content that has the object tags (such as images, audio, videos, JAVA applets, ActiveX, pdf, or flash). These applications use the WebVPN session to download and upload ActiveX controls. The ActiveX relay remains in force until the WebVPN session closes. If you plan to use something like Microsoft OWA 2007, you should disable ActiveX.


Note Because they have the same functionality, the activex-relay enable command generates smart tunnel logs even if smart tunnel is disabled.


Examples

The following example enables ActiveX controls on WebVPN sessions associated with a given group policy:

hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# activex-relay enable
hostname(config-group-webvpn)

The following example disables ActiveX controls on WebVPN sessions associated with a given username:

hostname(config-username-policy)# webvpn
hostname(config-username-webvpn)# activex-relay disable
hostname(config-username-webvpn)

ad-agent-mode

To enables the AD Agent mode so that you can configure the Active Directory Agent for the Cisco Identify Firewall instance, use the ad-agent-mode command in global configuration mode.

ad-agent-mode

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

8.4(2)

The command was introduced.


Usage Guidelines

To configure the Active Directory Agent for the Identity Firewall, you must enter the ad-agent-mode command, which is a submode of the aaa-server command. Entering the ad-agent-mode command enters the aaa server group configuration mode.

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.

Examples

The following example shows how to enable ad-agent-mode while configuring the Active Directory Agent for the Identity Firewall:

hostname(config)# aaa-server adagent protocol radius
hostname(config)# ad-agent-mode
hostname(config-aaa-server-group)# aaa-server adagent (inside) host 192.168.1.101
hostname(config-aaa-server-host)# key mysecret
hostname(config-aaa-server-hostkey)# user-identity ad-agent aaa-server adagent
hostname(config-aaa-server-host)# test aaa-server ad-agent

Related Commands

Command
Description

aaa-server

Creates a AAA server group and configures AAA server parameters that are group-specific and common to all group hosts.

clear configure user-identity

Clears the configuration for the Identity Firewall feature.


address (dynamic-filter blacklist or whitelist)

To add an IP address to the Botnet Traffic Filter blacklist or whitelist, use the address command in dynamic-filter blacklist or whitelist configuration mode. To remove the address, use the no form of this command. The static database lets you augment the dynamic database with domain names or IP addresses that you want to whitelist or blacklist.

address ip_address mask

no address ip_address mask

Syntax Description

ip_address

Adds an IP address to the blacklist.

mask

Defines the subnet mask for the IP address. The mask can be for a single host or for a subnet.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Dynamic-filter blacklist or whitelist configuration


Command History

Release
Modification

8.2(1)

This command was introduced.


Usage Guidelines

After you enter the dynamic-filter whitelist or blacklist configuration mode, you can manually enter domain names or IP addresses (host or subnet) that you want to tag as good names in a whitelist or bad names in a blacklist using the address and name commands.

You can enter this command multiple times for multiple entries. You can add up to 1000 blacklist and 1000 whitelist entries.

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

Related Commands

Command
Description

clear configure dynamic-filter

Clears the running Botnet Traffic Filter configuration.

clear dynamic-filter dns-snoop

Clears Botnet Traffic Filter DNS snooping data.

clear dynamic-filter reports

Clears Botnet Traffic filter report data.

clear dynamic-filter statistics

Clears Botnet Traffic filter statistics.

dns domain-lookup

Enables the ASA to send DNS requests to a DNS server to perform a name lookup for supported commands.

dns server-group

Identifies a DNS server for the ASA.

dynamic-filter blacklist

Edits the Botnet Traffic Filter blacklist.

dynamic-filter database fetch

Manually retrieves the Botnet Traffic Filter dynamic database.

dynamic-filter database find

Searches the dynamic database for a domain name or IP address.

dynamic-filter database purge

Manually deletes the Botnet Traffic Filter dynamic database.

dynamic-filter enable

Enables the Botnet Traffic Filter for a class of traffic or for all traffic if you do not specify an access list.

dynamic-filter updater-client enable

Enables downloading of the dynamic database.

dynamic-filter use-database

Enables use of the dynamic database.

dynamic-filter whitelist

Edits the Botnet Traffic Filter whitelist.

inspect dns dynamic-filter-snoop

Enables DNS inspection with Botnet Traffic Filter snooping.

name

Adds a name to the blacklist or whitelist.

show asp table dynamic-filter

Shows the Botnet Traffic Filter rules that are installed in the accelerated security path.

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 dynamic-filter dns-snoop

Shows the Botnet Traffic Filter DNS snooping summary, or with the detail keyword, the actual IP addresses and names.

show dynamic-filter reports

Generates reports of the top 10 botnet sites, ports, and infected hosts.

show dynamic-filter statistics

Shows how many connections were monitored with the Botnet Traffic Filter, and how many of those connections match the whitelist, blacklist, and greylist.

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 running-config dynamic-filter

Shows the Botnet Traffic Filter running configuration.


address (media-termination)

To specify the address for a media termination instance to use for media connections to the Phone Proxy feature, use the address command in the media-termination configuration mode. To remove the address from the media termination configuration, use the no form of this command.

address ip_address [interface intf_name]

no address ip_address [interface intf_name]

Syntax Description 

interface intf_name

Specifies the name of the interface for which the media termination address is used. Only one media-termination address can be configured per interface.

ip_address

Specifies the IP address to use for the media termination instance.


Defaults

There are no default settings for this command.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Media-termination configuration


Command History 

Release
Modification

8.2(1)

The command was introduced.


Usage Guidelines

The ASA must have IP addresses for media termination that meet the following criteria:

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 the interface.

See the CLI configuration guide for the complete list of prerequisites that you must follow when creating the media termination instance and configuring the media termination addresses.

Examples

The following example shows the use of the media-termination address command to specify the IP address to use for media connections:

hostname(config)# media-termination mediaterm1
hostname(config-media-termination)# address 192.0.2.25 interface inside
hostname(config-media-termination)# address 10.10.0.25 interface outside

Related Commands 

Command
Description

phone-proxy

Configures the Phone Proxy instance.

media-termination

Configures the media termination instance to apply to a Phone Proxy instance.


address-pool (tunnel-group general attributes mode)

To specify a list of address pools for allocating addresses to remote clients, use the address-pool command in tunnel-group general-attributes configuration mode. To eliminate address pools, use the no form of this command.

address-pool [(interface name)] address_pool1 [...address_pool6]

no address-pool [(interface name)] address_pool1 [...address_pool6]

Syntax Description

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.

interface name

(Optional) Specifies the interface to be used for the address pool.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group general-attributes configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

You can enter multiples of each of these commands, one per interface. If an interface is not specified, then the command specifies the default for all interfaces that are not explicitly referenced.

The address-pools settings in the group-policy address-pools command override the local pool settings in the tunnel group address-pool command.

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.

Examples

The following example entered in config-tunnel-general configuration mode, specifies a list of address pools for allocating addresses to remote clients for an IPsec remote-access tunnel group test:

hostname(config)# tunnel-group test type remote-access
hostname(config)# tunnel-group test general
hostname(config-tunnel-general)# address-pool (inside) addrpool1 addrpool2 addrpool3
hostname(config-tunnel-general)# 

Related Commands

Command
Description

ip local pool

Configures IP address pools to be used for VPN remote-access tunnels.

clear configure tunnel-group

Clears all configured tunnel groups.

show running-config tunnel-group

Shows the tunnel group configuration for all tunnel groups or for a particular tunnel group.

tunnel-group-map default-group

Associates the certificate map entries created using the crypto ca certificate map command with tunnel groups.


address-pools (group-policy attributes configuration mode)

To specify a list of address pools for allocating addresses to remote clients, use the address-pools command in group-policy attributes configuration mode. To remove the attribute from the group policy and enable inheritance from other sources of group policy, use the no form of this command.

address-pools value address_pool1 [...address_pool6]

no address-pools value address_pool1 [...address_pool6]

address-pools none

no address-pools none

Syntax Description

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.


Defaults

By default, the address pool attribute allows inheritance.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group-policy attributes configuration


Command History

Release
Modification

7.2(1)

This command was introduced.


Usage Guidelines

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.

The command address-pools none disables this attribute from being inherited from other sources of policy, such as the DefaultGrpPolicy. The command no address pools none removes the address-pools none command from the configuration, restoring the default value, which is to allow inheritance.

Examples

The following example entered in config-general configuration mode, configures pool_1 and pool_20 as lists of address pools to use for allocating addresses to remote clients for GroupPolicy1:

hostname(config)# ip local pool pool_1 192.168.10.1-192.168.10.100 mask 255.255.0.0
hostname(config)# ip local pool pool_20 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 pool_1 pool_20
hostname(config-group-policy)# 

Related Commands

Command
Description

ip local pool

Configures IP address pools to be used for VPN group policies.

clear configure group-policy

Clears all configured group policies.

show running-config group-policy

Shows the configuration for all group-policies or for a particular group-policy.


admin-context

To set the admin context for the system configuration, use the admin-context command in global configuration mode.

admin-context name

Syntax Description

name

Sets the name as a string up to 32 characters long. If you have not defined any contexts yet, then first specify the admin context name with this command. Then, the first context you add using the context command must be the specified admin context name.

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.

"System" or "Null" (in uppercase or lowercase letters) are reserved names, and cannot be used.


Defaults

For a new ASA in multiple context mode, the admin context is called "admin."

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

You can set any context to be the admin context, as long as the context configuration resides on the internal flash memory.

You cannot remove the current admin context, unless you remove all contexts using the clear configure context command.

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 ASA software or allowing remote management for an administrator), it uses one of the contexts that is designated as the admin context.

Examples

The following example sets the admin context to be "administrator":

hostname(config)# admin-context administrator

Related Commands

Command
Description

clear configure context

Removes all contexts from the system configuration.

context

Configures a context in the system configuration and enters context configuration mode.

show admin-context

Shows the current admin context name.


allocate-interface

To allocate interfaces to a security context, use the allocate-interface command in context configuration mode. To remove an interface from a context, use the no form of this command.

allocate-interface physical_interface [map_name] [visible | invisible]

no allocate-interface physical_interface

allocate-interface physical_interface.subinterface[-physical_interface.subinterface] [map_name[-map_name]] [visible | invisible]

no allocate-interface physical_interface.subinterface[-physical_interface.subinterface]

Syntax Description

invisible

(Default) Allows context users to only see the mapped name (if configured) in the show interface command.

map_name

(Optional) Sets a mapped name.

The map_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

For subinterfaces, you can specify a range of mapped names.

See the "Usage Guidelines" section for more information about ranges.

physical_interface

Sets the interface ID, such as gigabitethernet0/1. See the interface command for accepted values. Do not include a space between the interface type and the port number.

subinterface

Sets the subinterface number. You can identify a range of subinterfaces.

visible

(Optional) Allows context users to see physical interface properties in the show interface command even if you set a mapped name.


Defaults

The interface ID is invisible in the show interface command output by default if you set a mapped name.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Context configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

You can enter this command multiple times to specify different ranges. To change the mapped name or visible setting, reenter the command for a given interface ID, and set the new values; you do not need to enter the no allocate-interface command and start over. If you remove the allocate-interface command, the ASA removes any interface-related configuration in the context.

Transparent firewall mode allows only two interfaces to pass through traffic; however, on the ASA adaptive security appliance, you can use the dedicated management interface, Management 0/0, (either the physical interface or a subinterface) as a third interface for management traffic.


Note 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. Transparent mode does not allow shared interfaces.

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 gigabitethernet0/1.1-gigabitethernet0/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 gigabitethernet0/0.100-gigabitethernet0/0.199 int1-int15, for example, the command fails.

Examples

The following example shows gigabitethernet0/1.100, gigabitethernet0/1.200, and gigabitethernet0/2.300 through gigabitethernet0/1.305 assigned to the context. The mapped names are int1 through int8.

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

Related Commands

Command
Description

context

Creates a security context in the system configuration and enters context configuration mode.

interface

Configures an interface and enters interface configuration mode.

show context

Shows a list of contexts (system execution space) or information about the current context.

show interface

Displays the runtime status and statistics of interfaces.

vlan

Assigns a VLAN ID to a subinterface.


allocate-ips

To allocate an IPS virtual sensor to a security context if you have the AIP SSM installed, use the allocate-ips command in context configuration mode. To remove a virtual sensor from a context, use the no form of this command.

allocate-ips sensor_name [mapped_name] [default]

no allocate-ips sensor_name [mapped_name] [default]

Syntax Description

default

(Optional) 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 on the AIP SSM.

mapped_name

(Optional) Sets a mapped name 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" senors to sensor1 and sensor2 in context A, but map the "medsec" and "lowsec" sensors to sensor1 and sensor2 in context B.

sensor_name

Sets the sensor name configured on the AIP SSM. To view the sensors that are configured on the AIP SSM, 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 AIP SSM, you get an error, but the allocate-ips command is entered as is. Until you create a sensor of that name on the AIP SSM, the context assumes the sensor is down.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Context configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

You can assign one or more IPS virtual sensors to each context. Then, when you configure the context to send traffic to the AIP SSM using the ips command, 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 AIP SSM 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.


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 AIP SSM is used.

hostname(config-ctx)# context A
hostname(config-ctx)# allocate-interface gigabitethernet0/0.100 int1
hostname(config-ctx)# allocate-interface gigabitethernet0/0.102 int2
hostname(config-ctx)# allocate-interface gigabitethernet0/0.110-gigabitethernet0/0.115 
int3-int8
hostname(config-ctx)# allocate-ips sensor1 ips1 default
hostname(config-ctx)# allocate-ips sensor2 ips2
hostname(config-ctx)# config-url ftp://user1:passw0rd@10.1.1.1/configlets/test.cfg
hostname(config-ctx)# member gold
hostname(config-ctx)# context sample
hostname(config-ctx)# allocate-interface gigabitethernet0/1.200 int1
hostname(config-ctx)# allocate-interface gigabitethernet0/1.212 int2
hostname(config-ctx)# allocate-interface gigabitethernet0/1.230-gigabitethernet0/1.235 
int3-int8
hostname(config-ctx)# allocate-ips sensor1 ips1
hostname(config-ctx)# allocate-ips sensor3 ips2
hostname(config-ctx)# config-url ftp://user1:passw0rd@10.1.1.1/configlets/sample.cfg
hostname(config-ctx)# member silver

Related Commands

Command
Description

context

Creates a security context in the system configuration and enters context configuration mode.

ips

Diverts traffic to the AIP SSM for inspection.

show context

Shows a list of contexts (system execution space) or information about the current context.

show ips

Shows the virtual sensors configured on the AIP SSM.


allow-ssc-mgmt

To set an interface on the ASA 5505 to be the SSC management interface, use the allow-ssc-mgmt command in interface configuration mode. To unassign an interface, use the no form of this command.

allow-ssc-mgmt

no allow-ssc-mgmt

Syntax Description

This command has no arguments or keywords.

Command Default

This command is enabled in the factory default configuration for VLAN 1.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Interface configuration


Command History

Release
Modification

8.2(1)

We introduced this command.


Usage Guidelines

An SSC does not have any external interfaces. You can configure a VLAN as a management VLAN to allow access to an internal management IP address over the backplane. By default, VLAN 1 is enabled for the SSC management address. You can only assign one VLAN as the SSC management VLAN.

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 in the SSC), you can configure NAT and supply ASDM with the translated address when you want to access the SSC.

Examples

The following example disables management access on VLAN 1, and enables it for VLAN 2:

hostname(config)# interface vlan 1
hostname(config-if)# no allow-ssc-mgmt
hostname(config-if)# interface vlan 2
hostname(config-if)# allow-ssc-mgmt

Related Commands

Command
Description

interface

Configures an interface.

ip address

Sets the management IP address for a bridge group.

nameif

Sets the interface name.

security-level

Sets the interface security level.

hw-module module ip

Configures the management IP address for the SSC.

hw-module module allow-ip

Sets the hosts that are allowed to access the management IP address.


always-on-vpn

To configure the behavior of the AnyConnect Always-On-VPN functionality, use the always-on-vpn command in group policy configuration mode.

Syntax Description

To use the always-on-vpn setting configured in the AnyConnect profile:

always-on-vpn profile-setting

To switch off the Always-On-VPN functionality:

always-on-vpn disable

Command Default

Always-On-VPN functionality is switched off by default.

Command History

Release
Modification

8.3(1)

We introduced this command.


Usage Guidelines

To enable Always-On-VPN functionality for AnyConnect users, configure an AnyConnect profile in the profile editor. Then configure the group-policy attributes for the appropriate policy.

Examples

The following example disables management access on VLAN 1, and enables it for VLAN 2:

hostname(config)# group-policy <group policy> attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# always-on-vpn profile-setting

Related Commands

Command
Description

webvpn

Configure group policy for WebVPN.


anyconnect ask

To enable the ASA to prompt remote SSL VPN client users to download the client, use the anyconnect ask command in the group policy webvpn or username webvpn configuration mode. To disable prompting for download of the client, use the no form of this command.

anyconnect ask {none | enable [default {webvpn | anyconnect} timeout value]}

no anyconnect ask none [default {webvpn | anyconnect}]

Syntax Description

none

Immediately performs the default action.

enable

Prompts the remote user to download the client or goes to the portal page for clientless connections and waits indefinitely for user response.

default anyconnect timeout value

Prompts the remote user to download the client or goes to the portal page for clientless connections, and waits the duration of value before taking the default action—downloading the client.

default webvpn timeout value

Prompts the remote user to download the client or goes to the portal page for clientless connections, and waits the duration of value before taking the default action—displaying the WebVPN portal page.


Defaults

The default for this command is anyconnect ask none default webvpn. The ASA immediately displays the portal page for clientless connections.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.

8.4(1)

The anyconnect ask command replaced the svc ask command.


Usage Guidelines

Figure 2-1 shows the prompt displayed to remote users when either default anyconnect timeout value or default webvpn timeout value is configured:

Figure 2-1 Prompt Displayed to Remote Users for SSL VPN Client Download

Examples

The following example configures the ASA to prompt the remote user to download the client or go to the portal page and wait 10 seconds for user response before downloading the client:

hostname(config-group-webvpn)# anyconnect ask enable default svc timeout 10

Related Commands

Command
Description

show webvpn anyconnect

Displays information about installed SSL VPN clients.

anyconnect

Enables or requires the SSL VPN client for a specific group or user.

anyconnect image

Specifies a client package file that the ASA expands in cache memory for downloading to remote PCs.


anyconnect df-bit-ignore

To ignore the DF bit in packets that need fragmentation, use the anyconnect-df-bit-ignore command in group policy webvpn configuration mode. To acknowledge the DF bits that need fragmentation, use the no form of the command.

anyconnect df-bit-ignore {enable | none}

no anyconnect df-bit-ignore {enable | none}

Syntax Description

enable

Enables DF-bit ignore for AnyConnect client.

none

Disables DF-bit for AnyConnect client.


Defaults

By default, this option is not enabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration


Command History

Release
Modification

8.2(2)

The svc df-bit-ignore command was introduced.

8.4(1)

The anyconnect df-bit-ignore command replaced the svc df-bit-ignore command.


Examples

vmb-5520(config-group-webvpn)# anyconnect routing-filtering-ignore ?
config-group-webvpn mode commands/options:
  enable  Enable Routing/Filtering for AnyConnect Client
  none    Disable Routing/Filtering for AnyConnect Client

anyconnect dpd-interval

To enable Dead Peer Detection (DPD) on the ASA and to set the frequency that either the remote client or the ASA performs DPD over SSL VPN connections, use the anyconnect dpd-interval command in group policy or username webvpn mode. To remove the command from the configuration and cause the value to be inherited, use the no form of this command.

This command applies to IKEv2. IKEv1 DPD is configured by the isakmp keepalive command.

anyconnect dpd-interval {[gateway {seconds | none}] | [client {seconds | none}]}

no anyconnect dpd-interval {[gateway {seconds | none}] | [client {seconds | none}]}

Syntax Description

client none

Disables DPD that the client performs.

client seconds

Specifies the frequency, from 30 to 3600 seconds, that the client performs DPD.

gateway none

Disables DPD that the ASA performs.

gateway seconds

Specifies the frequency, from 30 to 3600 seconds, that the ASA performs DPD.


Defaults

DPD is enabled and set to 30 seconds for both the ASA (gateway) and the client.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

7.1(1)

This command was introduced.

8.0(3)

The default setting changed from disabled to 30 seconds for both the ASA (gateway) and the client.

8.4(1)

The anyconnect dpd-interval command replaced the svc dpd-interval command.


Examples

In the following example, the user configures the DPD frequency performed by the ASA (gateway) to 3000 seconds, and the DPD frequency performed by the client to 1000 seconds, for the existing group policy sales:

hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect dpd-interval gateway 3000
hostname(config-group-webvpn)# anyconnect dpd-interval client 1000

anyconnect dtls compression

To enable compression on low bandwidth links for a specific group or user, use the anyconnect dtls compression command in group policy webvpn or username webvpn configuration mode. To delete the configuration from the group, use the no form of the command.

anyconnect dtls compression {lzs | none}

no anyconnect dtls compression {lzs | none}

Syntax Description

lzs

Enables a stateless compression algorithm.

none

Disables compression.


Defaults

The default is to not enable AnyConnect compression.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.4(2)

This command was introduced.


Examples

The following examples shows the sequence to disable compression:

asa# config terminal
asa(config)# group-policy DfltGrpPolicy attributes
asa(config-group-policy)# webvpn
asa(config-group-webvpn)# anyconnect ssl compression none
asa(config-group-webvpn)# anyconnect dtls compression none

anyconnect enable

To enable the ASA to download an AnyConnect client to remote computers, use the anyconnect enable command from webvpn configuration mode. To remove the command from the configuration, use the no form of this command:

anyconnect enable

no anyconnect enable

Defaults

The default is disabled. The ASA does not download the client.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration


Command History

Release
Modification

7.1(1)

This command was introduced as svc enable.

8.4(1)

The anyconnect enable command replaced the svc enable command.


Usage Guidelines

Entering the no anyconnect enable command does not terminate active sessions.

The anyconnect enable command must be issued after configuring the AnyConnect images with the anyconnect image xyz command. If the anyconnect enable command is not entered, AnyConnect does not function as expected, and the show webvpn svc command considers the SSL VPN client as not enabled rather than listing the installed AnyConnect packages.

Examples

In the following example, the user enables the ASA to download the client:

(config)# webvpn
(config-webvpn)# anyconnect enable

Related Commands

Command
Description

anyconnect image

Specifies an AnyConnect SSL VPN client package file that the ASA expands in cache memory for downloading to remote PCs.

anyconnect modules

Specifies the names of modules that the AnyConnect SSL VPN Client requires for optional features.

anyconnect profiles

Specifies the name of the file used to store profiles that the ASA downloads to the Cisco AnyConnect SSL VPN client.

show webvpn anyconnect

Displays information about SSL VPN clients installed on the ASA and loaded in cache memory for downloading to remote PCs.

anyconnect localization

Specifies the package file used to store localization files that are downloaded to the Cisco AnyConnect VPN Client.


anyconnect firewall-rule

To establish a public or provide ACL firewall, use the anyconnect firewall-rule command in group policy webvpn or username webvpn configuration mode.

anyconnect firewall-rule <client interface> <public | private> <ACL>

Syntax Description

ACL

Specifies the access control list.

client interface

Specifies the client interface.

private

Configures a private interface rule.

public

Configures a public interface rule.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.3(1)

This command was introduced.

8.4(1)

The anyconnect firewall-rule command replaced the svc firewall-rule command.


Usage Guidelines

The following guidelines clarify how the AnyConnect client uses the firewall:

The source IP is not used for firewall rules. The client ignores the source IP information in the firewall rules sent from the ASA. The client determines the source IP depending on whether the rules are public or private. Public rules are applied to all interfaces on the client. Private rules are applied to the Virtual Adapter.

The ASA supports many protocols for ACL rules. However, the AnyConnect firewall feature supports only TCP, UDP, ICMP, and IP. If the client receives a rule with a different protocol, it treats it as an invalid firewall rule, and then disables split tunneling and uses full tunneling for security reasons.

Be aware of the following differences in behavior for each operating system:

For Windows computers, deny rules take precedence over allow rules in Windows Firewall. If the ASA pushes down an allow rule to the AnyConnect client, but the user has created a custom deny rule, the AnyConnect rule is not enforced.

On Windows Vista, when a firewall rule is created, Vista takes the port number range as a comma-separated string. The port range can be a maximum of 300 ports. For example, from 1-300 or 5000-5300. If you specify a range greater than 300 ports, the firewall rule is applied only to the first 300 ports.

Windows users whose firewall service must be started by the AnyConnect client (not started automatically by the system) may experience a noticeable increase in the time it takes to establish a VPN connection.

On Mac computers, the AnyConnect client applies rules sequentially in the same order the ASA applies them. Global rules should always be last.

For third-party firewalls, traffic is passed only if both the AnyConnect client firewall and the third-party firewall allow that traffic type. If the third-party firewall blocks a specify traffic type that the AnyConnect client allows, the client blocks the traffic.

For extensive information about the AnyConnect client firewall including ACL rule examples for local printing and tethered device support, see the AnyConnect Administrator Guide.


Note To function as expected, this command requires a release of the AsyncOS for Web Version 7.0 that provides AnyConnect Secure Mobility licensing support for the AnyConnect secure mobility client. It also requires an AnyConnect release that supports AnyConnect Secure Mobility, ASA 8.3, and ASDM 6.3.


Examples

The following example enables the ACL AnyConnect_Client_Local_Print as a public firewall:

hostname(config)# group-policy example_group attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect firewall-rule client-interface public value 
AnyConnect_Client_Local_Print

Related Commands

Command
Description

show webvpn anyconnect

Displays information about installed SSL VPN clients.

anyconnect

Enables or requires the SSL VPN client for a specific group or user.

anyconnect image

Specifies a client package file that the ASA expands in cache memory for downloading to remote PCs.


anyconnect image

To install or upgrade the AnyConnect distribution package and add it to the running configuration, use the anyconnect image command in webvpn configuration mode. To remove the AnyConnect distribution package from the running configuration, use the no form of this command:

anyconnect image path order [regex expression]

no anyconnect image path order [regex expression]

Syntax Description

order

With multiple client package files, order specifies the order of the package files, from 1 to 65535. The ASA downloads portions of each client, in the order you specify, to the remote PC until it achieves a match with the operating system.

path

Specifies the path and filename of the AnyConnect package, up to 255 characters.

regex expression

Specifies a string that the ASA uses to match the User-Agent string passed by the browser.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

webvpn configuration


Command History

Release
Modification

7.1(1)

This command was introduced.

8.0(1)

The regex keyword was added.

8.4(1)

The anyconnect image command replaced the svc image command.


Usage Guidelines

Numbering the package files establishes the order in which the ASA downloads portions of them to the remote PC, until it achieves a match with the operating system. The ASA downloads the package file with the lowest number first. Therefore, you should assign the lowest number to the package file that matches the most commonly encountered operating system used on remote PCs.

The default order is 1. If you do not specify the order argument, each time you enter the svc image command, you overwrite the image that was previously considered number 1.

You can enter the anyconnect image command for each client package file in any order. For example, you can specify the package file to be downloaded second (order 2) before entering the anyconnect image command specifying the package file to be downloaded first (order 1).

For mobile users, you can decrease the connection time of the mobile device by using the regex keyword. When the browser connects to the ASA, it includes the User-Agent string in the HTTP header. When the ASA receives the string, if the string matches an expression configured for an image, it immediately downloads that image without testing the other client images.


Note When using the standalone client, the regex command is ignored. It is used only for the web browser as a performance enhancement, and the regex string is not matched with any user or agent provided by the standalone client.


The ASA expands both AnyConnect client and Cisco Secure Desktop (CSD) package files in cache memory. In order for the ASA to successfully expand the package files, there must be enough cache memory to store the images and files of the package file.

If the ASA detects that there is not enough cache memory to expand a package, it displays an error message to the console. The following example shows an error message reported after an attempt was made to install a package file with the svc image command:

hostname(config-webvpn)# anyconnect image disk0:/anyconnect-win-3.0.0520-k9.pkg
ERROR: File write error (check disk space)
ERROR: Unable to load SVC image - extraction failed

If this occurs when you attempt to install a package file, examine the amount of cache memory remaining and the size of any previously installed packages with the dir cache:/ command from global configuration mode.


Note If your ASA has only the default internal flash memory size or the default DRAM size (for cache memory) you could have problems storing and loading multiple AnyConnect client packages on the ASA. Even if there is enough space in flash memory to hold the package files, the ASA could run out of cache memory when it unzips and loads the client images. For more information about the ASA memory requirements when deploying AnyConnect, and possibly upgrading the ASA memory, see the latest release notes for the Cisco ASA 5500 Series.


Examples

The following example loads AnyConnect client package files for Windows, MAC, and Linux in that order:

hostname(config)# webvpn
hostname(config-webvpn)# anyconnect image disk0:/anyconnect-win-3.0.0527-k9.pkg 1
hostname(config-webvpn)# anyconnect image disk0:/anyconnect-macosx-i386-3.0.0414-k9.pkg 2
hostname(config-webvpn)# anyconnect image disk0:/anyconnect-linux-3.0.0414-k9.pkg 3
hostname(config-webvpn)

The next example shows the output of the show webvpn anyconnect command, which displays the file AnyConnect client packages loaded and their order:

hostname(config-webvpn)# show webvpn anyconnect
1. disk0:/anyconnect-win-3.0.0527-k9.pkg 1 dyn-regex=/Windows NT/
  CISCO STC win2k+
  3,0,0527
  Hostscan Version 3.0.0527
  Tue 10/19/2010 16:16:56.25
2. disk0:/anyconnect-macosx-i386-3.0.0414-k9.pkg 2 dyn-regex=/Intel Mac OS X/
  CISCO STC Darwin_i386
  3.0.0414
  Wed Oct 20 20:39:53 MDT 2010
3. disk0:/anyconnect-linux-3.0.0414-k9.pkg 3 dyn-regex=/Linux i[1-9]86/
  CISCO STC Linux
  3.0.0414
  Wed Oct 20 20:42:02 MDT 2010
3 AnyConnect Client(s) installed
hostname(config-webvpn)#

Related Commands

Command
Description

anyconnect modules

Specifies the names of modules that the AnyConnect SSL VPN Client requires for optional features.

anyconnect profiles

Specifies the name of the file used to store profiles that the ASA downloads to the Cisco AnyConnect SSL VPN client.

show webvpn anyconnect

Displays information about SSL VPN clients installed on the ASA and loaded in cache memory for downloading to remote PCs.

anyconnect localization

Specifies the package file used to store localization files that are downloaded to the Cisco AnyConnect VPN Client.


anyconnect keep-installer

To enable the permanent installation of an SSL VPN client on a remote PC, use the anyconnect keep-installer command in group-policy webvpn or username webvpn configuration mode. To remove the command from the configuration and cause the value to be inherited, use the no form of this command :

anyconnect keep-installer {installed | none}

no anyconnect keep-installer {installed | none}

Syntax Description

installed

Disables the automatic uninstalling feature of the client. The client remains installed on the remote PC for future connections.

none

Specifies that the client uninstalls from the remote computer after the active connection terminates.


Defaults

Permanent installation of the client is enabled. The client remains on the remote computer at the end of the session.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

7.1(1)

This command was introduced.

8.4(1)

The anyconnect keep-installer command replaced the svc keep-installer command.


Usage Guidelines

This command does not apply to versions of AnyConnect after 2.5, but is still available for backward compatibility. Using the anyconnect keep-installer command does not affect AnyConnect 3.0 or later.

Examples

In the following example, the user enters group policy webvpn configuration mode and configures the group policy to remove the client at the end of the session:

hostname(config-group-policy)#webvpn
hostname(config-group-webvpn)# anyconnect keep-installer none
hostname(config-group-webvpn)#

Related Commands

Command
Description

show webvpn anyconnect

Displays information about AnyConnect clients installed on the ASA and loaded in cache memory for downloading to remote PCs.

anyconnect

Enables or requires the SSL VPN client for a specific group or user.

anyconnect enable

Enables the ASA to download AnyConnect client files to remote PCs.

anyconnect image

Specifies an AnyConnect client package file that the ASA expands in cache memory for downloading to remote PCs.


anyconnect modules

To specify the names of modules that the AnyConnect SSL VPN Client requires for optional features, use the anyconnect modules command in group policy webvpn or username webvpn configuration mode. To remove the command from the configuration, use the no form of this command.

anyconnect modules {none | value string}

no anyconnect modules {none | value string}

Syntax Description

string

The name of the optional module, up to 256 characters. Separate multiple strings with commas.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced as svc modules.

8.4(1)

The anyconnect modules form of the command was introduced.


Usage Guidelines

To minimize download time, the client only requests downloads (from the ASA) of modules that it needs for each feature that it supports. The anyconnect modules command enables the ASA to download these modules.

The following table shows the string values that represent AnyConnect Modules.

String Representing AnyConnect Module
AnyConnect Module Name

dart

AnyConnect DART (Diagnostics and Reporting Tool)

nam

AnyConnect Network Access Manager

vpngina

AnyConnect SBL (Start Before Logon)

websecurity

AnyConnect Web Security Module

telemetry

AnyConnect Telemetry Module

posture

AnyConnect Posture Module

none

If you choose none, the ASA downloads the essential files with no optional modules. Existing modules are removed from the group policy.


Examples

In the following example, the user enters group-policy attributes mode for the group policy PostureModuleGroup, enters webvpn configuration mode for the group policy, and specifies the string posture and telemetry so that the AnyConnect Posture Module and AnyConnect Telemetry Module will be downloaded to the endpoint when it connects to the ASA:

hostname> en 
Password: 
hostname# config t
hostname(config)# group-policy PostureModuleGroup attributes 
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect modules value posture,telemetry 
hostname(config-group-webvpn)# write mem 
Building configuration...
Cryptochecksum: 40975338 b918425d 083b391f 9e5a5c69 
22055 bytes copied in 3.440 secs (7351 bytes/sec)
[OK]
hostname(config-group-webvpn)# 

To remove a module from a group policy, resend the command, specifying only the module values that you want to keep. For example, the following command removes the telemetry module:

hostname(config-group-webvpn)# anyconnect modules value posture

Related Commands

Command
Description

show webvpn anyconnect

Displays information about AnyConnect packages that are loaded in cache memory on the ASA and available for download.

anyconnect enable

Enables an AnyConnect client for a specific group or user.

anyconnect image

Specifies an AnyConnect client package file that the ASA expands in cache memory for downloading to remote PCs.


anyconnect mtu

To adjust the MTU size for SSL VPN connections established by the Cisco AnyConnect VPN Client, use the anyconnect mtu command in group policy webvpn or username webvpn configuration mode. To remove the command from the configuration, use the no form of this command.

anyconnect mtu size

no anyconnect mtu size

Syntax Description

size

The MTU size in bytes, from 256 to 1406 bytes.


Defaults

The default size is 1406. The default for this command in the default group policy is no svc mtu.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.

8.4(1)

The anyconnect mtu form of the command replaced svc mtu.


Usage Guidelines

This command affects only the AnyConnect client. The Cisco SSL VPN Client is not capable of adjusting to different MTU sizes. In addition, this command affects AnyConnect client connections established in only SSL and those established in SSL with DTLS.

The MTU size is adjusted automatically based on the MTU of the interface that the connection uses, minus the IP/UDP/DTLS overhead.

The minimum MTU allowed on an IPv6 enabled interface is 1280 bytes; however, if IPsec is enabled on the interface, the MTU value should not be set below 1380 because of the overhead of IPsec encryption. Setting the interface below 1380 bytes may result in dropped packets.

Examples

The following example configures the MTU size to 500 bytes for the group policy telecommuters:

hostname(config)# group-policy telecommuters attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect mtu 500

Related Commands

Command
Description

anyconnect keep-installer

Disables the automatic uninstalling feature of the client. After the initial download, the client remains on the remote PC after the connection terminates.

anyconnect ssl dtls

Enables DTLS for CVCs establishing SSL VPN connections.

show run webvpn

Displays configuration information about WebVPN, including anyconnect commands.


anyconnect profiles (group-policy or username attributes)

To specify a CVC profiles package downloaded to Cisco AnyConnect VPN Client (CVC) users, use the anyconnect profiles command in group policy webvpn or username attributes webvpn configuration mode. To remove the command from the configuration and cause the value it to be inherited, use the no form of this command.

anyconnect profiles {value profile | none}

no anyconnect profiles {value profile | none } [type type]

Syntax Description

profile

The name of the profile.

type type

The user who corresponds to the standard AnyConnect profile or any alphanumeric value.


Defaults

The default is none. The ASA does not download profiles.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.

8.3

The optional type value was introduced.

8.4(1)

The anyconnect profiles form of the command replaced svc profiles.


Usage Guidelines

When entered in group policy webvpn or username attributes webvpn configuration mode, this command enables the ASA to download profiles to CVC users on a group policy or username basis. To download a CVC profile to all CVC users, use this command in webvpn configuration mode.

A CVC profile is a group of configuration parameters that the CVC uses to configure the connection entries that appear in the CVC user interface, including the names and addresses of host computers. You can create and save profiles using the CVC user interface. You can also edit this file with a text editor and set advanced parameters that are not available through the user interface.

The CVC installation contains one profile template (cvcprofile.xml) that you can edit and use as a basis to create other profile files. For more information about editing CVC profiles, see the Cisco AnyConnect VPN Client Administrator Guide.

Examples

In the following example, the user queries the anyconnect profiles value command, which displays the available profiles:

asa1(config-group-webvpn)# anyconnect profiles value ?
config-group-webvpn mode commands/options:
Available configured profile packages:
  engineering
  sales

Then the user configures the group policy to use the CVC profile sales:

asa1(config-group-webvpn)# anyconnect profiles sales

Related Commands

Command
Description

show webvpn anyconnect

Displays information about installed AnyConnect clients.

anyconnect

Enables or requires an SSL VPN client for a specific group or user.

anyconnect image

Specifies an AnyConnect client package file that the ASA expands in cache memory for downloading to remote PCs.


anyconnect profiles (webvpn)

To specify a file as a profiles package that the ASA loads in cache memory and makes available to group policies and username attributes of Cisco AnyConnect VPN Client (CVC) users, use the anyconnect profiles command in webvpn configuration mode. To remove the command from the configuration and cause the ASA to unload the package file from cache memory, use the no form of this command.

anyconnect profiles {profile path}

no anyconnect profiles {profile path}

Syntax Description

path

The path and filename of the profile file in flash memory of the ASA.

profile

The name of the profile to create in cache.


Defaults

The default is none. The ASA does not load a profiles package in cache memory.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.

8.4(1)

The anyconnect profiles form of the command replaced svc profiles.


Usage Guidelines

A CVC profile is a group of configuration parameters that the CVC uses to configure the connection entries that appear in the CVC user interface, including the names and addresses of host computers. You can create and save profiles using the CVC user interface.

You can also edit this file with a text editor and set advanced parameters that are not available through the user interface. The CVC installation contains one profile template (cvcprofile.xml) that you can edit and use as a basis to create other profile files. For more information about editing CVC profiles, see the Cisco AnyConnect VPN Client Administrator Guide.

After you create a new CVC profile and upload it to flash memory, identify the XML file to the ASA as a profile using the anyconnect profiles command in webvpn configuration mode. The command loads the files in cache memory on the ASA. Then you can specify the profile for a group or user with the anyconnect profiles command in group policy webvpn configuation or username attributes configuration mode.

Examples

In the following example, the user previously created two new profile files (sales_hosts.xml and engineering_hosts.xml) from the cvcprofile.xml file provided in the CVC installation and uploaded them to flash memory of the ASA.

Now the user identifies these files to the ASA as CVC profiles, specifying the names sales and engineering:

asa1(config-webvpn)# anyconnect profiles sales disk0:sales_hosts.xml
asa1(config-webvpn)# anyconnect profiles engineering disk0:engineering_hosts.xml

Entering the dir cache:stc/profiles command shows the profiles loaded into cache memory:

asa1(config-webvpn)# dir cache:stc/profiles
Directory of cache:stc/profiles/
0      ----  774         11:54:41 Nov 22 2006  engineering.pkg
0      ----  774         11:54:29 Nov 22 2006  sales.pkg
2428928 bytes total (18219008 bytes free)
asa1(config-webvpn)#

Now these profiles are available to the svc profiles command in group policy webvpn configuration or username attributes configurate mode:

asa1(config)# group-policy sales attributes
asa1(config-group-policy)# webvpn
asa1(config-group-webvpn)# anyconnect profiles value ?
config-group-webvpn mode commands/options:
Available configured profile packages:
  engineering
  sales

Related Commands

Command
Description

show webvpn anyconnect

Displays information about installed AnyConnect clients.

anyconnect

Enables or requires the SSL VPN client for a specific group or user.

anyconnect image

Specifies an AnyConnect package file that the ASA expands in cache memory for downloading to remote PCs.


anyconnect routing-filtering-ignore

To notify the AnyConnect client that it should ignore routing and filtering rules, use the anyconnect routing-filtering-ignore command in group policy webvpn configuration mode. To turn off the notification of ignoring routing and filtering rules, use the no form of the command.

anyconnect routing-filtering-ignore {enable | none}

no anyconnect routing-filtering-ignore {enable | none}

Syntax Description

enable

Enables routing and filtering rules for AnyConnect client.

none

Disables routing and filtering rules for AnyConnect client.


Defaults

By default, this option is not enabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration


Command History

Release
Modification

8.2(3)

This command was introduced.


Examples

vmb-5520(config-group-webvpn)# anyconnect routing-filtering-ignore ?
config-group-webvpn mode commands/options:
  enable  Enable Routing/Filtering for AnyConnect Client
  none    Disable Routing/Filtering for AnyConnect Client

anyconnect ssl compression

To enable compression of http data over an SSL VPN connection for a specific group or user, use the anyconnect ssl compression command in the group policy webvpn or username webvpn configuration mode. To remove the command from the configuration and cause the value to be inherited, use the no form of this command.

anyconnect ssl compression {deflate | lzs | none}

no anyconnect ssl compression {deflate | lzs | none}

Syntax Description

deflate

Enables a deflate compression algorithm.

lzs

Enables a stateless compression algorithm.

none

Disables compression.


Defaults

Compression is set to none (disabled).

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.4(2)

This command was introduced.


Usage Guidelines

For SSL VPN connections, the compression command configured in webvpn configuration mode overrides the anyconnect ssl compression command configured in group policy and username webvpn modes.

Examples

In the following example, SVC compression is disabled for the group policy sales:

hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect ssl compression none

Related Commands

Command
Description

anyconnect

Enables or requires the SSL VPN client for a specific group or user.

anyconnect keepalive

Specifies the frequency at which a client on a remote computer sends keepalive messages to the ASA over an SSL VPN connection.

anyconnect keep-installer

Disables the automatic uninstalling feature of the client. The client remains installed on the remote PC for future connections.

anyconnect rekey

Enables the client to perform a rekey on an SSL VPN connection.


anyconnect ssl df-bit-ignore

To enable the forced fragmentation of packets on an SSL VPN connection (allowing them to pass through the tunnel) for a specific group or user, use the anyconnect ssl df-bit-ignore command in the group policy webvpn or username webvpn configuration mode. To remove the command from the configuration and cause the value to be inherited, use the no form of this command.

anyconnect ssl df-bit-ignore {enable | disable}

no anyconnect ssl df-bit-ignore

Syntax Description

enable

Enable DF-bit ignore for AnyConnect with SSL.

disable

Disable DF-bit for AnyConnect with SSL.


Defaults

DF bit ignore is set to disabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.4(1)

The anyconnect ssl df-bit-ignore form of the command replaced svc df-bit-ignore.


Usage Guidelines

This feature allows the force fragmentation of packets that have the DF bit set, allowing them to pass through the tunnel. An example use case is for servers in your network that do not respond correctly to TCP MSS negotiations.

Examples

In the following example, DF bit ignore is enabled for the group policy sales:

hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect ssl df-bit-ignore enable

Related Commands

Command
Description

anyconnect

Enables or requires the SSL VPN client for a specific group or user.

anyconnect keepalive

Specifies the frequency at which a client on a remote computer sends keepalive messages to the ASA over an SSL VPN connection.

anyconnect keep-installer

Disables the automatic uninstalling feature of the client. The client remains installed on the remote PC for future connections.

anyconnect rekey

Enables the client to perform a rekey on an SSL VPN connection.


anyconnect ssl dtls enable

To enable Datagram Transport Layer Security (DTLS) connections on an interface for specific groups or users establishing SSL VPN connections with the Cisco AnyConnect VPN Client, use the anyconnect ssl dtls enable command in group policy webvpn or username attributes webvpn configuration mode. To remove the command from the configuration and cause the value to be inherited, use the no form of this command.

anyconnect ssl dtls enable interface

no anyconnect ssl dtls enable interface

Syntax Description

interface

The name of the interface.


Defaults

The default is enabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.

8.4(1)

The anyconnect ssl dtls form of the command replaced svc dtls.


Usage Guidelines

Enabling DTLS allows the AnyConnect client establishing an SSL VPN connection to use two simultaneous tunnels—an SSL tunnel and a DTLS tunnel. Using DTLS avoids latency and bandwidth problems associated with some SSL connections and improves the performance of real-time applications that are sensitive to packet delays.

If you do not enable DTLS, AnyConnect client users establishing SSL VPN connections connect with an SSL tunnel only.

This command enables DTLS for specific groups or users. To enable DTLS for all AnyConnect client users, use the anyconnect ssl dtls enable command in webvpn configuration mode.

Examples

The following example enters group policy webvpn configuration mode for the group policy sales and enables DTLS:

hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect ssl dtls enable

Related Commands

Command
Description

dtls port

Specifies a UDP port for DTLS.

anyconnect dtls

Enables DTLS for groups or users establishing SSL VPN connections.

vpn-tunnel-protocol

Specifies VPN protocols that the ASA allows for remote access, including SSL.


anyconnect ssl keepalive

To configure the frequency of keepalive messages that a remote client sends to the ASA over SSL VPN connections, use the anyconnect ssl keepalive command in group policy webvpn or username webvpn configuration mode. To remove the command from the configuration and cause the value to be inherited, use the no form of this command.

anyconnect ssl keepalive {none | seconds}

no anyconnect ssl keepalive {none | seconds}

Syntax Description

none

Disables keepalive messages.

seconds

Enables keepalive messages and specifies the frequency of the messages, from 15 to 600 seconds.


Defaults

The default is 20 seconds.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

7.1(1)

This command was introduced.

8.0(3)

The default setting changed from disabled to 20 seconds.

8.4(1)

The anyconnect ssl keepalive form of the command replaced svc keepalive.


Usage Guidelines

Both the Cisco SSL VPN Client (SVC) and the Cisco AnyConnect VPN Client can send keepalive messages when they establish SSL VPN connections to the ASA.

You can adjust the frequency of keepalive messages (specified by seconds), to ensure that an SSL VPN connection through a proxy, firewall, or NAT device remains open, even if the device limits the time that the connection can be idle.

Adjusting the frequency also ensures that the client does not disconnect and reconnect when the remote user is not actively running a socket-based application, such as Microsoft Outlook or Microsoft Internet Explorer.


Note Keepalives are enabled by default. If you disable keepalives, in the event of a failover event, SSL VPN client sessions are not carried over to the standby device.


Examples

In the following example, the user configures the ASA to enable the client to send keepalive messages, with a frequency of 300 seconds (5 minutes), for the existing group policy named sales:

hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect ssl keepalive 300

Related Commands

Command
Description

anyconnect

Enables or requires an SSL VPN client for a specific group or user.

anyconnect dpd-interval

Enables Dead Peer Detection (DPD) on the ASA, and sets the frequency that either the client or the ASA performs DPD.

anyconnect keep-installer

Disables the automatic uninstalling feature of the client, allowing it to remain installed on the remote PC for future connections.

anyconnect ssl rekey

Enables the client to perform a rekey on a session.


anyconnect ssl rekey

To enable a remote client to perform a rekey on an SSL VPN connection, use the anyconnect ssl rekey command in group-policy webvpn or username webvpn configuration mode.To remove the command from the configuration and cause the value to be inherited, use the no form of the command.

anyconnect ssl rekey {method {ssl | new-tunnel} | time minutes | none}

no anyconnect ssl rekey {method {ssl | new-tunnel} | time minutes | none}

Syntax Description

method new-tunnel

Specifies that the client establishes a new tunnel during rekey.

method none

Disables rekey.

method ssl

Specifies that the client establishes a new tunnel during rekey.

time minutes

Specifies the number of minutes from the start of the session until the rekey takes place, from 4 to 10080 (1 week).


Defaults

The default is none (disabled).

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Group policy webvpn configuration

Username webvpn configuration


Command History

Release
Modification

7.1(1)

This command was introduced as svc rekey.

8.0

The behavior of the svc rekey method ssl form of the command changed to that of the svc rekey method new-tunnel in order to prevent the possibility of a "man in the middle" attack.

8.4(1)

The anyconnect ssl rekey form of the command replaced svc rekey.


Usage Guidelines

The Cisco AnyConnect Secure Mobility Client can perform a rekey on an SSL VPN connection to the ASA. Configuring the rekey method as ssl or new-tunnel specifies that the client establishes a new tunnel during rekey instead of the SSL renegotiation taking place during the rekey.

Examples

In the following example, the user specifies that remote clients belonging to the group policy sales renegotiate with SSL during rekey, and rekey occurs 30 minutes after the session begins:

hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect ssl rekey method ssl
hostname(config-group-webvpn)# anyconnect ssl rekey time 30

Related Commands

Command
Description

anyconnect enable

Enables or requires the AnyConnect Secure Mobility Client for a specific group or user.

anyconnect dpd-interval

Enables Dead Peer Detection (DPD) on the ASA, and sets the frequency that either the AnyConnect Secure Mobility Client or the ASA performs DPD.

anyconnect keepalive

Specifies the frequency at which an AnyConnect Secure Mobility Client on a remote computer sends keepalive messages to the ASA.

anyconnect keep-installer

Enables the permanent installation of an AnyConnect Secure Mobility Client onto a remote computer.


anyconnect-essentials

To enable AnyConnect Essentials on the ASA, use the anyconnect-essentials command in group policy webvpn configuration mode. To disable the use of AnyConnect Essentials and enable the premium AnyConnect client instead, use the no form of this command.

anyconnect-essentials

no anyconnect-essentials

Defaults

AnyConnect Essentials is enabled by default.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

webvpn configuration


Command History

Release
Modification

8.2(1)

This command was introduced.


Usage Guidelines

Use this command to toggle between using the full AnyConnect SSL VPN client and the AnyConnect Essentials SSL VPN client, assuming that the full AnyConnect client license is installed. AnyConnect Essentials is a separately licensed SSL VPN client, entirely configured on the ASA, that provides the premium AnyConnect capability, with the following exceptions:

No CSD (including HostScan/Vault/Cache Cleaner)

No clientless SSL VPN

The AnyConnect Essentials client provides remote end users running Microsoft Windows Vista, Windows Mobile, Windows XP or Windows 2000, Linux, or Macintosh OS X, with the benefits of a Cisco SSL VPN client.

You enable or disable the AnyConnect Essentials license by using the anyconnect-essentials command, which is meaningful only after you have installed the AnyConnect Essentials license on the ASA. Without this license, this command returns the following error message:

ERROR: Command requires AnyConnect Essentials license

Note This command just enables or disables the use of AnyConnect Essentials. The AnyConnect Essentials license itself is not affected by the setting of the anyconnect-essentials command.


When the AnyConnect Essentials license is enabled, AnyConnect clients use Essentials mode, and Clientless SSL VPN access is disabled. When the AnyConnect Essentials license is disabled, AnyConnect clients use the full AnyConnect SSL VPN Client license.

If you have active clientless SSL VPN connections, and you enable the AnyConnect Essentials license, then all connections are logged off and will need to be reestablished.

Examples

In the following example, the user enters webvpn configuration mode and enables the AnyConnect Essentials VPN client:

hostname(config)# webvpn
hostname(config-webvpn)# anyconnect-essentials

apcf

To enable an Application Profile Customization Framework profile, use the apcf command in webvpn configuration mode. To disable a particular APCF script, use the no form of this command. To disable all APCF scripts, use the no form of this command without arguments.

apcf URL/filename.ext

no apcf [URL/filename.ext]

Syntax Description

filename.extension

Specifies the name of the APCF customization script. These scripts are always in XML format. The extension might be .xml, .txt, .doc or one of many others

URL

Specifies the location of the APCF profile to load and use on the ASA. Use one of the following URLs: http://, https://, tftp://, ftp://; flash:/, disk#:/'

The URL might include a server, port, and path. If you provide only the filename, the default URL is flash:/. You can use the copy command to copy an APCF profile to flash memory.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration


Command History

Release
Modification

7.1(1)

This command was introduced.


Usage Guidelines

The apcf command enables the ASA to handle non-standard web applications and web resources so that they render correctly over a WebVPN connection. An APCF profile contains a script that specifies when (pre, post), where (header, body, request, response), and what data to transform for a particular application.

You can use multiple APCF profiles on the ASA. When you do, the ASA applies each one of them in the order of oldest to newest.

We recommend that you use the APCF command only with the support of the Cisco TAC.

Examples

The following example shows how to enable an APCF named apcf1, located on flash memory at /apcf:

hostname(config)# webvpn
hostname(config-webvpn)# apcf flash:/apcf/apcf1.xml
hostname(config-webvpn)#

This example shows how to enable an APCF named apcf2.xml, located on an HTTPS server called myserver, port 1440, at /apcf:

hostname(config)# webvpn
hostname(config-webvpn)# apcf https://myserver:1440/apcf/apcf2.xml
hostname(config-webvpn)#

Related Commands

Command
Description

proxy-bypass

Configures minimal content rewriting for a particular application.

rewrite

Determines whether traffic travels through the ASA.

show running config webvpn apcf

Displays the APCF configuration.


appl-acl

To identify a previously configured web-type ACL to apply to a session, use the appl-acl command in dap webvpn configuration mode. To remove the attribute from the configuration, use the no form of this command; to remove all web-type ACLs, use the no form of this command without arguments.

appl-acl identifier

no appl-acl [identifier]

Syntax Description

identifier

The name of the previously configured web-type ACL Maximum 240 characters.


Defaults

No default value or behaviors.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Dap webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

To configure web-type ACLs, use the access-list_webtype command in global configuration mode.

Use the appl-acl command multiple times to apply more than one web-type ACL to the DAP policy.

Examples

The following example shows how to apply the previously configured web-type ACL called newacl to the dynamic access policy:

hostname (config)# config-dynamic-access-policy-record Finance
hostname(config-dynamic-access-policy-record)# webvpn
hostname(config-dynamic-access-policy-record)# appl-acl newacl

Related Commands

Command
Description

dynamic-access-policy-record

Creates a DAP record.

access-list_webtype

Creates a web-type ACL.


application-access

To customize the Application Access fiels of the WebVPN Home page that is displayed to authenticated WebVPN users, and the Application Access window that is launched when the user selects an application, use the application-access command in customization configuration mode. To remove the command from the configuration and cause the value to be inherited, use the no form of this command.

application-access {title | message | window} {text | style} value

no application-access {title | message | window} {text | style} value

Syntax Description

message

Changes the message displayed under the title of the Application Access field.

style

Changes the style of the Application Access field.

text

Changes the text of the Application Access field.

title

Changes the title of the Application Access field.

value

The actual text to display (maximum 256 characters), or Cascading Style Sheet (CSS) parameters (maximum 256 characters).

window

Changes the Application Access window.


Defaults

The default title text of the Application Access field is "Application Access".

The default title style of the Application Access field is:

background-color:#99CCCC;color:black;font-weight:bold;text-transform:uppercase

The default message text of the Application Access field is "Start Application Client".

The default message style of the Application Access field is:

background-color:#99CCCC;color:maroon;font-size:smaller.

The default window text of the Application Access window is:

"Close this window when you finish using Application Access. Please wait for the table to be displayed before starting applications.".

The default window style of the Application Access window is:

background-color:#99CCCC;color:black;font-weight:bold.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Customization configuration


Command History

Release
Modification

7.1(1)

This command was introduced.


Usage Guidelines

This command is accessed by using the webvpn command or the tunnel-group webvpn-attributes command.

The style option is expressed as any valid Cascading Style Sheet (CSS) parameters. Describing these parameters is beyond the scope of this document. For more information about CSS parameters, consult CSS specifications at the World Wide Web Consortium (W3C) website at www.w3.org. Appendix F of the CSS 2.1 Specification contains a convenient list of CSS parameters, and is available at www.w3.org/TR/CSS21/propidx.html.

The following tips can help you make the most common changes to the WebVPN pages—the page colors:

You can use a comma-separated RGB value, an HTML color value, or the name of the color if recognized in HTML.

RGB format is 0,0,0, a range of decimal numbers from 0 to 255 for each color (red, green, blue); the comma separated entry indicates the level of intensity of each color to combine with the others.

HTML format is #000000, six digits in hexadecimal format; the first and second represent red, the third and fourth green, and the fifth and sixth represent blue.


Note To easily customize the WebVPN pages, we recommend that you use ASDM, which has convenient features for configuring style elements, including color swatches and preview capabilities.


Examples

The following example customizes the background color of the Application Access field to the RGB hex value 66FFFF, a shade of green:

F1-asa1(config)# webvpn
F1-asa1(config-webvpn)# customization cisco
F1-asa1(config-webvpn-custom)# application-access title style background-color:#66FFFF

Related Commands

Command
Description

application-access hide-details

Enables or disables the display of the application details in the Application Access window.

browse-networks

Customizes the Browse Networks field of the WebVPN Home page.

file-bookmarks

Customizes the File Bookmarks title or links on the WebVPN Home page.

web-applications

Customizes the Web Application field of the WebVPN Home page.

web-bookmarks

Customizes the Web Bookmarks title or links on the WebVPN Home page.


application-access hide-details

To hide application details that are displayed in the WebVPN Applications Access window, use the application-access hide-details command in customization configuration mode, which is accessed by using the webvpn command or the tunnel-group webvpn-attributes command. To remove the command from the configuration and cause the value to be inherited, use the no form of this command.

application-access hide-details {enable | disable}

no application-access [hide-details {enable | disable}]

Syntax Description

disable

Does not hide application details in the Application Access window.

enable

Hides application details in the Application Access window.


Defaults

The default is disabled. Application details appear in the Application Access window.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Customization configuration


Command History

Release
Modification

7.1(1)

This command was introduced.


Examples

The following example disables the appearance of the application details:

hostname(config)# webvpn
hostname(config-webvpn)# customization cisco
hostname(config-webvpn-custom)# application-access hide-details disable

Related Commands

Command
Description

application-access

Customizes the Application Access field of the WebVPN Home page.

browse-networks

Customizes the Browse Networks field of the WebVPN Home page.

web-applications

Customizes the Web Application field of the WebVPN Home page.


area

To create an OSPF area, use the area command in router configuration mode. To remove the area, use the no form of this command.

area area_id

no area area_id

Syntax Description

area_id

The ID of the area being created. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

The area that you create does not have any parameters set. Use the related area commands to set the area parameters.

Examples

The following example shows how to create an OSPF area with an area ID of 1:

hostname(config-router)# area 1
hostname(config-router)#

Related Commands

Command
Description

area authentication

Enables authentication for the OSPF area.

area nssa

Defines the area as a not-so-stubby area.

area stub

Defines the area as a stub area.

router ospf

Enters router configuration mode.

show running-config router

Displays the commands in the global router configuration.


area authentication

To enable authentication for an OSPF area, use the area authentication command in router configuration mode. To disable area authentication, use the no form of this command.

area area_id authentication [message-digest]

no area area_id authentication [message-digest]

Syntax Description

area_id

The identifier of the area on which authentication is to be enabled. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.

message-digest

(Optional) Enables Message Digest 5 (MD5) authentication on the area specified by the area_id.


Defaults

Area authentication is disabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

If the specified OSPF area does not exist, it is created when this command is entered. Entering the area authentication command without the message-digest keyword enables simple password authentication. Including the message-digest keyword enables MD5 authentication.

Examples

The following example shows how to enable MD5 authentication for area 1:

hostname(config-router)# area 1 authentication message-digest
hostname(config-router)#

Related Commands

Command
Description

router ospf

Enters router configuration mode.

show running-config router

Displays the commands in the global router configuration.


area default-cost

To specify a cost for the default summary route sent into a stub or NSSA, use the area default-cost command in router configuration mode. To restore the default cost value, use the no form of this command.

area area_id default-cost cost

no area area_id default-cost

Syntax Description

area_id

The identifier of the stub or NSSA whose default cost is being changed. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.

cost

Specifies the cost for the default summary route that is used for a stub or NSSA. Valid values range from 0 to 65535


Defaults

The default value of cost is 1.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

If the specified area has not been previously defined using the area command, this command creates the area with the specified parameters.

Examples

The following example show how to specify a default cost for summary route sent into a stub or NSSA:

hostname(config-router)# area 1 default-cost 5
hostname(config-router)#

Related Commands

Command
Description

area nssa

Defines the area as a not-so-stubby area.

area stub

Defines the area as a stub area.

router ospf

Enters router configuration mode.

show running-config router

Displays the commands in the global router configuration.


area filter-list prefix

To filter prefixes advertised in Type 3 LSAs between OSPF areas of an ABR, use the area filter-list prefix command in router configuration mode. To change or cancel the filter, use the no form of this command.

area area_id filter-list prefix list_name {in | out}

no area area_id filter-list prefix list_name {in | out}

Syntax Description

area_id

Identifier of the area for which filtering is configured. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.

in

Applies the configured prefix list to prefixes advertised inbound to the specified area.

list_name

Specifies the name of a prefix list.

out

Applies the configured prefix list to prefixes advertised outbound from the specified area.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

If the specified area has not been previously defined using the area command, this command creates the area with the specified parameters.

Only Type 3 LSAs can be filtered. If an ASBR is configured in the private network, then it will send Type 5 LSAs (describing private networks) which are flooded to the entire AS including the public areas.

Examples

The following example filters prefixes that are sent from all other areas to area 1:

hostname(config-router)# area 1 filter-list prefix-list AREA_1 in
hostname(config-router)#

Related Commands

Command
Description

router ospf

Enters router configuration mode.

show running-config router

Displays the commands in the global router configuration.


area nssa

To configure an area as an NSSA, use the area nssa command in router configuration mode. To remove the NSSA designation from the area, use the no form of this command.

area area_id nssa [no-redistribution] [default-information-originate [metric-type {1 | 2}] [metric value]] [no-summary]

no area area_id nssa [no-redistribution] [default-information-originate [metric-type {1 | 2}] [metric value]] [no-summary]

Syntax Description

area_id

Identifier of the area being designated as an NSSA. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.

default-information-originate

Used to generate a Type 7 default into the NSSA area. This keyword only takes effect on an NSSA ABR or an NSSA ASBR.

metric metric_value

(Optional) Specifies the OSPF default metric value. Valid values range from 0 to 16777214.

metric-type {1 | 2}

(Optional) the OSPF metric type for default routes. Valid values are the following:

1—type 1

2—type 2.

The default value is 2.

no-redistribution

(Optional) Used when the router is an NSSA ABR and you want the redistribute command to import routes only into the normal areas, but not into the NSSA area.

no-summary

(Optional) Allows an area to be a not-so-stubby area but not have summary routes injected into it.


Defaults

The defaults are as follows:

No NSSA area is defined.

The metric-type is 2.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

If the specified area has not been previously defined using the area command, this command creates the area with the specified parameters.

If you configure one option for an area, and later specify another option, both options are set. For example, entering the following two command separately results in a single command with both options set in the configuration:

area 1 nssa no-redistribution
area area_id nssa default-information-originate

Examples

The following example shows how setting two options separately results in a single command in the configuration:

hostname(config-router)# area 1 nssa no-redistribution
hostname(config-router)# area 1 nssa default-information-originate
hostname(config-router)# exit
hostname(config-router)# show running-config router ospf 1
router ospf 1
 area 1 nssa no-redistribution default-information-originate

Related Commands

Command
Description

area stub

Defines the area as a stub area.

router ospf

Enters router configuration mode.

show running-config router

Displays the commands in the global router configuration.


area range

To consolidate and summarize routes at an area boundary, use the area range command in router configuration mode. To disable this function, use the no form of this command.

area area_id range address mask [advertise | not-advertise]

no area area_id range address mask [advertise | not-advertise]

Syntax Description

address

IP address of the subnet range.

advertise

(Optional) Sets the address range status to advertise and generates Type 3 summary link-state advertisements (LSAs).

area_id

Identifier of the area for which the range is configured. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.

mask

IP address subnet mask.

not-advertise

(Optional) Sets the address range status to DoNotAdvertise. The Type 3 summary LSA is suppressed, and the component networks remain hidden from other networks.


Defaults

The address range status is set to advertise.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

If the specified area has not been previously defined using the area command, this command creates the area with the specified parameters.

The area range command is used only with ABRs. It is used to consolidate or summarize routes for an area. The result is that a single summary route is advertised to other areas by the ABR. Routing information is condensed at area boundaries. External to the area, a single route is advertised for each address range. This behavior is called route summarization. You can configure multiple area range commands for an area. Thus, OSPF can summarize addresses for many different sets of address ranges.

The no area area_id range ip_address netmask not-advertise command removes only the not-advertise optional keyword.

Examples

The following example specifies one summary route to be advertised by the ABR to other areas for all subnets on network 10.0.0.0 and for all hosts on network 192.168.110.0:

hostname(config-router)# area 10.0.0.0 range 10.0.0.0 255.0.0.0
hostname(config-router)# area 0 range 192.168.110.0 255.255.255.0
hostname(config-router)# 

Related Commands

Command
Description

router ospf

Enters router configuration mode.

show running-config router

Displays the commands in the global router configuration.


area stub

To define an area as a stub area, use the area stub command in router configuration mode. To remove the stub area function, use the no form of this command.

area area_id [no-summary]

no area area_id [no-summary]

Syntax Description

area_id

Identifier for the stub area. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.

no-summary

Prevents an ABR from sending summary link advertisements into the stub area.


Defaults

The default behaviors are as follows:

No stub areas are defined.

Summary link advertisements are sent into the stub area.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

The command is used only on an ABR attached to a stub or NSSA.

There are two stub area router configuration commands: the area stub and area default-cost commands. In all routers and access servers attached to the stub area, the area should be configured as a stub area using the area stub command. Use the area default-cost command only on an ABR attached to the stub area. The area default-cost command provides the metric for the summary default route generated by the ABR into the stub area.

Examples

The following example configures the specified area as a stub area:

hostname(config-router)# area 1 stub
hostname(config-router)#

Related Commands

Command
Description

area default-cost

Specifies a cost for the default summary route sent into a stub or NSSA

area nssa

Defines the area as a not-so-stubby area.

router ospf

Enters router configuration mode.

show running-config router

Displays the commands in the global router configuration.


area virtual-link

To define an OSPF virtual link, use the area virtual-link command in router configuration mode. To reset the options or remove the virtual link, use the no form of this command.

area area_id virtual-link router_id [authentication [message-digest | null]] [hello-interval seconds] [retransmit-interval seconds] [transmit-delay seconds] [dead-interval seconds [[[[authentication-key[0 | 8] key ] | [message-digest-key key_id md5 [0 | 8] key ]]]]

no area area_id virtual-link router_id [authentication [message-digest | null]] [hello-interval seconds] [retransmit-interval seconds] [transmit-delay seconds] [dead-interval seconds [[[[authentication-key [0 | 8] key ] | [message-digest-key key_id md5 [0 | 8] key ]]]]

Syntax Description

area_id

Area ID of the transit area for the virtual link. You can specify the identifier as either a decimal number or an IP address. Valid decimal values range from 0 to 4294967295.

authentication

(Optional) Specifies the authentication type.

authentication-key
[0 | 8]key

(Optional) Specifies an OSPF authentication password for use by neighboring routing devices.

dead-interval seconds

(Optional) Specifies the interval before declaring a neighboring routing device is down if no hello packets are received; valid values are from 1 to 65535 seconds.

hello-interval seconds

(Optional) Specifies the interval between hello packets sent on the interface; valid values are from 1 to 65535 seconds.

md5 [0 | 8] key

(Optional) Specifies an alphanumeric key up to 16 bytes.

message-digest

(Optional) Specifies that message digest authentication is used.

message-digest-key key_id

(Optional) Enables the Message Digest 5 (MD5) authentication and specifies the numerical authentication key ID number; valid values are from 1 to 255.

0

Specifies an unencrypted password will follow.

8

Specifies an encrypted password will follow.

null

(Optional) Specifies that no authentication is used. Overrides password or message digest authentication if configured for the OSPF area.

retransmit-interval seconds

(Optional) Specifies the time between LSA retransmissions for adjacent routers belonging to the interface; valid values are from 1 to 65535 seconds.

router_id

The router ID associated with the virtual link neighbor. The router ID is internally derived by each router from the interface IP addresses. This value must be entered in the format of an IP address. There is no default.

transmit-delay seconds

(Optional) Specifies the delay time between when OSPF receives a topology change and when it starts a shortest path first (SPF) calculation in seconds from 0 to 65535. The default is 5 seconds.



Note Single-digit passwords and passwords starting with a digit followed by a whitespace are no longer supported.


Defaults

The defaults are as follows:

area_id: No area ID is predefined.

router_id: No router ID is predefined.

hello-interval seconds: 10 seconds.

retransmit-interval seconds: 5 seconds.

transmit-delay seconds: 1 second.

dead-interval seconds: 40 seconds.

authentication-key [0 | 8] key: No key is predefined.

message-digest-key key_id md5 [0 | 8] key: No key is predefined.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

In OSPF, all areas must be connected to a backbone area. If the connection to the backbone is lost, it can be repaired by establishing a virtual link.

The smaller the hello interval, the faster topological changes are detected, but more routing traffic ensues.

The setting of the retransmit interval should be conservative, or needless retransmissions occur. The value should be larger for serial lines and virtual links.

The transmit delay value should take into account the transmission and propagation delays for the interface.

The specified authentication key is used only when authentication is enabled for the backbone with the area area_id authentication command.

The two authentication schemes, simple text and MD5 authentication, are mutually exclusive. You can specify one or the other or neither. Any keywords and arguments you specify after authentication-key [0 | 8] key or message-digest-key key_id md5[0 | 8] key are ignored. Therefore, specify any optional arguments before such a keyword-argument combination.

If the authentication type is not specified for an interface, the interface uses the authentication type specified for the area. If no authentication type has been specified for the area, the area default is null authentication.


Note Each virtual link neighbor must include the transit area ID and the corresponding virtual link neighbor router ID for a virtual link to be properly configured. Use the show ospf command to see the router ID.


To remove an option from a virtual link, use the no form of the command with the option that you want removed. To remove the virtual link, use the no area area_id virtual-link command.

Examples

The following example establishes a virtual link with MD5 authentication:

hostname(config-router)# area 10.0.0.0 virtual-link 10.3.4.5 message-digest-key 3 md5 8 
sa5721bk47

Related Commands

Command
Description

area authentication

Enables authentication for an OSPF area.

router ospf

Enters router configuration mode.

show ospf

Displays general information about the OSPF routing processes.

show running-config router

Displays the commands in the global router configuration.


arp

To add a static ARP entry to the ARP table, use the arp command in global configuration mode. To remove the static entry, use the no form of this command.

arp interface_name ip_address mac_address [alias]

no arp interface_name ip_address mac_address

Syntax Description

alias

(Optional) Enables proxy ARP for this mapping. If the ASA receives an ARP request for the specified IP address, then it responds with the ASA MAC address. When the ASA receives traffic destined for the host belonging to the IP address, the ASA forwards the traffic to the host MAC address that you specify in this command. This keyword is useful if you have devices that do not perform ARP, for example.

In transparent firewall mode, this keyword is ignored; the ASA does not perform proxy ARP.

interface_name

The interface attached to the host network.

ip_address

The host IP address.

mac_address

The host MAC address.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

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.

A static ARP entry maps a MAC address to an IP address and identifies the interface through which the host is reached. Static ARP entries do not time out, and might help you solve a networking problem. In transparent firewall mode, the static ARP table is used with ARP inspection (see the arp-inspection command).


Note In transparent firewall mode, dynamic ARP entries are used for traffic to and from the ASA, such as management traffic.


Examples

The following example creates a static ARP entry for 10.1.1.1 with the MAC address 0009.7cbe.2100 on the outside interface:

hostname(config)# arp outside 10.1.1.1 0009.7cbe.2100

Related Commands

Command
Description

arp timeout

Sets the time before the ASA rebuilds the ARP table.

arp-inspection

For transparent firewall mode, inspects ARP packets to prevent ARP spoofing.

show arp

Shows the ARP table.

show arp statistics

Shows ARP statistics.

show running-config arp

Shows the current configuration of the ARP timeout.


arp permit-nonconnected

To enable the ARP cache to also include non-directly-connected subnets, use the arp permit-nonconnected command in global configuration mode. To disable non-connected subnets, use the no form of this command.

arp permit-nonconnected

no arp permit-nonconnected

Syntax Description

This command has no arguments or keywords.

Command Default

This command is disabled by default.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

8.4(5)

We introduced this command.


Usage Guidelines

The ASA ARP cache only contains entries from directly-connected subnets by default. This command lets you 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.

Examples

The following example enables non-connected subnets:

hostname(config)# arp permit non-connected

Related Commands

Command
Description

arp

Adds a static ARP entry.


arp-inspection

To enable ARP inspection for transparent firewall mode, use the arp-inspection command in global configuration mode. To disable ARP inspection, use the no form of this command.

arp-inspection interface_name enable [flood | no-flood]

no arp-inspection interface_name enable

Syntax Description

enable

Enables ARP inspection.

flood

(Default) Specifies that packets that do not match any element of a static ARP entry are flooded out all interfaces except the originating interface. If there is a mismatch between the MAC address, the IP address, or the interface, then the ASA drops the packet.

Note The management-specific interface, if present, never floods packets even if this parameter is set to flood.

interface_name

The interface on which you want to enable ARP inspection.

no-flood

(Optional) Specifies that packets that do not exactly match a static ARP entry are dropped.


Defaults

By default, ARP inspection is disabled on all interfaces; all ARP packets are allowed through the ASA. When you enable ARP inspection, the default is to flood non-matching ARP packets.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

Configure static ARP entries using the arp command before you enable ARP inspection.

ARP inspection checks all ARP packets against static ARP entries (see the arp command) and blocks mismatched packets. This feature prevents ARP spoofing.

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.


Note In transparent firewall mode, dynamic ARP entries are used for traffic to and from the ASA, such as management traffic.


Examples

The following example enables ARP inspection on the outside interface and sets the ASA to drop any ARP packets that do not match the static ARP entry:

hostname(config)# arp outside 209.165.200.225 0009.7cbe.2100
hostname(config)# arp-inspection outside enable no-flood

Related Commands

Command
Description

arp

Adds a static ARP entry.

clear configure arp-inspection

Clears the ARP inspection configuration.

firewall transparent

Sets the firewall mode to transparent.

show arp statistics

Shows ARP statistics.

show running-config arp

Shows the current configuration of the ARP timeout.


arp permit-nonconnected

To allow population of the ARP cache for nonconnected subnets, use the arp permit-nonconnected command in global configuration mode. To restore the default setting, use the no form of this command.

arp permit-nonconnected

no arp permit-nonconnected

Syntax Description

This command has no arguments or keywords.

Defaults

The default setting is disabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

8.4(5)

We introduced this command.


Usage Guidelines

You can enable the population of the ARP cache for nonconnected subnet entries using this command.

Examples

The following example enables population of the ARP cache for nonconnected subnets:

hostname(config)# arp permit-nonconnected 

Related Commands

Command
Description

arp

Adds a static ARP entry.

show arp statistics

Shows ARP statistics.

show running-config arp timeout

Shows the current configuration of the ARP timeout.


arp timeout

To set the time before the ASA rebuilds the ARP table, use the arp timeout command in global configuration mode. To restore the default timeout, use the no form of this command.

arp timeout seconds

no arp timeout seconds

Syntax Description

seconds

The number of seconds between ARP table rebuilds, from 60 to 4294967.


Defaults

The default value is 14,400 seconds (4 hours).

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

Preexisting

This command was preexisting.


Usage Guidelines

Rebuilding the ARP table automatically updates new host information and removes old host information. You might want to reduce the timeout because the host information changes frequently.

Examples

The following example changes the ARP timeout to 5,000 seconds:

hostname(config)# arp timeout 5000

Related Commands

Command
Description

arp

Adds a static ARP entry.

arp-inspection

For transparent firewall mode, inspects ARP packets to prevent ARP spoofing.

show arp statistics

Shows ARP statistics.

show running-config arp timeout

Shows the current configuration of the ARP timeout.


asdm disconnect

To terminate an active ASDM session, use the asdm disconnect command in privileged EXEC mode.

asdm disconnect session

Syntax Description

session

The session ID of the active ASDM session to be terminated. You can display the session IDs of all active ASDM sessions using the show asdm sessions command.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Privileged EXEC


Command History

Release
Modification

7.0(1)

This command was changed from the pdm disconnect command to the asdm disconnect command.


Usage Guidelines

Use the show asdm sessions command to display a list of active ASDM sessions and their associated session IDs. Use the asdm disconnect command to terminate a specific session.

When you terminate an ASDM session, any remaining active ASDM sessions keep their associated session ID. For example, if there are three active ASDM sessions with the session IDs of 0, 1, and 2, and you terminate session 1, the remaining active ASDM sessions keep the session IDs 0 and 2. The next new ASDM session in this example would be assigned a session ID of 1, and any new sessions after that would begin with the session ID 3.

Examples

The following example terminates an ASDM session with a session ID of 0. The show asdm sessions commands display the active ASDM sessions before and after the asdm disconnect command is entered.

hostname# show asdm sessions
0 192.168.1.1
1 192.168.1.2
hostname# asdm disconnect 0
hostname# show asdm sessions
1 192.168.1.2

Related Commands

Command
Description

show asdm sessions

Displays a list of active ASDM sessions and their associated session ID.


asdm disconnect log_session

To terminate an active ASDM logging session, use the asdm disconnect log_session command in privileged EXEC mode.

asdm disconnect log_session session

Syntax Description

session

The session ID of the active ASDM logging session to be terminated. You can display the session IDs of all active ASDM sessions using the show asdm log_sessions command.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Privileged EXEC


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

Use the show asdm log_sessions command to display a list of active ASDM logging sessions and their associated session IDs. Use the asdm disconnect log_session command to terminate a specific logging session.

Each active ASDM session has one or more associated ASDM logging sessions. ASDM uses the logging session to retrieve syslog messages from the ASA. Terminating a log session may have an adverse effect on the active ASDM session. To terminate an unwanted ASDM session, use the asdm disconnect command.


Note Because each ASDM session has at least one ASDM logging session, the output for the show asdm sessions and show asdm log_sessions may appear to be the same.


When you terminate an ASDM logging session, any remaining active ASDM logging sessions keep their associated session ID. For example, if there are three active ASDM logging sessions with the session IDs of 0, 1, and 2, and you terminate session 1, the remaining active ASDM logging sessions keep the session IDs 0 and 2. The next new ASDM logging session in this example would be assigned a session ID of 1, and any new logging sessions after that would begin with the session ID 3.

Examples

The following example terminates an ASDM session with a session ID of 0. The show asdm log_sessions commands display the active ASDM sessions before and after the asdm disconnect log_sessions command is entered.

hostname# show asdm log_sessions
0 192.168.1.1
1 192.168.1.2
hostname# asdm disconnect 0
hostname# show asdm log_sessions
1 192.168.1.2

Related Commands

Command
Description

show asdm log_sessions

Displays a list of active ASDM logging sessions and their associated session ID.


asdm history enable

To enable ASDM history tracking, use the asdm history enable command in global configuration mode. To disable ASDM history tracking, use the no form of this command.

asdm history enable

no asdm history enable

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was changed from the pdm history enable command to the asdm history enable command.


Usage Guidelines

The information obtained by enabling ASDM history tracking is stored in the ASDM history buffer. You can view this information using the show asdm history command. The history information is used by ASDM for device monitoring.

Examples

The following example enables ASDM history tracking:

hostname(config)# asdm history enable
hostname(config)#

Related Commands

Command
Description

show asdm history

Displays the contents of the ASDM history buffer.


asdm image

To specify the location of the ASDM software image in flash memory, use the asdm image command in global configuration mode. To remove the image location, use the no form of this command.

asdm image url

no asdm image [url]

Syntax Description

url

Sets the location of the ASDM image in flash memory. See the following URL syntax:

disk0:/[path/]filename

For the ASA 5500 series adaptive security appliance, this URL indicates the internal flash memory. You can also use flash instead of disk0; they are aliased.

disk1:/[path/]filename

For the ASA 5500 series adaptive security appliance, this URL indicates the external flash memory card.

flash:/[path/]filename

This URL indicates the internal flash memory.


Defaults

If you do not include this command in your startup configuration, the ASA uses the first ASDM image it finds at startup. It searches the root directory of internal Flash memory and then external flash memory. The ASA then inserts the asdm image command into the running configuration if it discovered an image.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

You can store more than one ASDM software image in flash memory. If you enter the asdm image command to specify a new ASDM software image while there are active ASDM sessions, the new command does not disrupt the active sessions; active ASDM sessions continue to use the ASDM software image they started with. New ASDM sessions use the new software image. If you enter the no asdm image command, the command is removed from the configuration. However, you can still access ASDM from the ASA using the last-configured image location.

If you do not include this command in your startup configuration, the ASA uses the first ASDM image it finds at startup. It searches the root directory of internal flash memory and then external flash memory. The ASA then inserts the asdm image command into the running configuration if it discovered an image. Be sure to save the running configuration to the startup configuration using the write memory command. If you do not save the asdm image command to the startup configuration, every time you reboot, the ASA searches for an ASDM image and inserts the asdm image command into your running configuration. If you are using Auto Update, the automatic addition of this command at startup causes the configuration on the ASA not to match the configuration on the Auto Update Server. This mismatch causes the ASA to download the configuration from the Auto Update Server. To avoid unnecessary Auto Update activity, save the asdm image command to the startup configuration.

Examples

The following example sets the ASDM image to asdm.bin:

hostname(config)# asdm image flash:/asdm.bin
hostname(config)#

Related Commands

Command
Description

show asdm image

Displays the current ASDM image file.

boot

Sets the software image and startup configuration files.


asdm location


Caution Do not manually configure this command. ASDM adds asdm location commands to the running configuration and uses them for internal communication. This command is included in the documentation for informational purposes only.

asdm location ip_addr netmask if_name

asdm location ipv6_addr/prefix if_name

Syntax Description

if_name

The name of the highest security interface. If you have multiple interfaces at the highest security, then an arbitrary interface name is chosen. This interface name is not used, but is a required parameter.

ip_addr

The IP address used internally by ASDM to define the network topology.

ipv6_addr/prefix

The IPv6 address and prefix used internally by ASDM to define the network topology.

netmask

The subnet mask for ip_addr.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was changed from the pdm location command to the asdm location command.


Usage Guidelines

Do not manually configure or remove this command.

asp load-balance per-packet

For multi-core ASAs, to change the load balancing behavior, use the asp load-balance per-packet command in global configuration mode. The default behavior is to allow only one core to receive packets from an interface receive ring at a time. The asp load-balance per-packet command changes this behavior to allow multiple cores to receive packets from an interface receive ring and work on them independently. The default behavior is optimized for scenarios where packets are received uniformly on all interface rings. The per-packet behavior is optimized for scenarios where traffic is asymmetrically distributed on interface receive rings. To restore the default load-balancing mechanism, use the no form of this command.

asp load-balance per-packet

no asp load-balance per-packet

Syntax Description

This command has no arguments or keywords.

Command Default

By default, the load-balancing mechanism favors many interfaces.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

8.1(1)

We introduced this command.


Usage Guidelines

Performance on the ASAs with multiple cores can vary depending on the number of processors, the number of interface receive rings, and the nature of the traffic passing through. Using the asp load-balance per-packet command allows multiple cores to work simultaneously on packets received from a single interface receive ring. This command provides for parallel processing if the packets received are spread over many independent connections. Note that this command can cause additional queuing overhead for packets from the same and related connections because these packets are processed by one core.

If the system drops packets, and show cpu is far less than 100%, then this command may help your throughput if the packets belong to many unrelated connections. The CPU usage is a good indicator as to how many cores are effectively being used. For example on the ASA 5580-40 which includes 8 cores, if two cores are used, then show cpu will be 25%; four cores will be 50%; and six cores will be 75%.

See also the show asp load-balance command.

Examples

The following example enables per-packet load balancing:

hostname(config)# asp load-balance per-packet

Related Commands

Command
Description

show asp load-balance

Displays a histogram of the load balancer queue sizes.


asr-group

To specify an asymmetrical routing interface group ID, use the asr-group command in interface configuration mode. To remove the ID, use the no form of this command.

asr-group group_id

no asr-group group_id

Syntax Description

group_id

The asymmetric routing group ID. Valid values are from 1 to 32.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Interface configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

When Active/Active failover is enabled, you may encounter situations in which load balancing causes the return traffic for outbound connections to be routed through an active context on the peer unit, and the context for the outbound connection is in the standby group.

The asr-group command causes incoming packets to be reclassified with the interface of the same asr-group if a flow with the incoming interface cannot be found. If reclassification finds a flow with another interface, and the associated context is in standby state, then the packet is forwarded to the active unit for processing.

Stateful Failover must be enabled for this command to take effect.

You can view ASR statistics using the show interface detail command. These statistics include the number of ASR packets sent, received, and dropped on an interface.


Note No two interfaces in the same context should be configured in the same ASR group.


Examples

The following example assigns the selected interfaces to the asymmetric routing group 1.

Context ctx1 configuration:

hostname/ctx1(config)# interface Ethernet2
hostname/ctx1(config-if)# nameif outside
hostname/ctx1(config-if)# ip address 192.168.1.11 255.255.255.0 standby 192.168.1.21
hostname/ctx1(config-if)# asr-group 1

Context ctx2 configuration:

hostname/ctx2(config)# interface Ethernet3
hostname/ctx2(config-if)# nameif outside
hostname/ctx2(config-if)# ip address 192.168.1.31 255.255.255.0 standby 192.168.1.41
hostname/ctx2(config-if)# asr-group 1

Related Commands

Command
Description

interface

Enters interface configuration mode.

show interface

Displays interface statistics.


assertion-consumer-url

To identify the URL that the security device accesses to contact the assertion consumer service, use the assertion-consumer-url command in the webvpn configuration mode for that specific SAML-type SSO server. To remove the URL from the assertion, use the no form of this command.

assertion-consumer-url url

no assertion-consumer-url [url]

Syntax Description

url

Specifies the URL of the assertion consumer service used by the SAML-type SSO server. The URL must start with either http:// or https: and must be less than 255 alphanumeric characters.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

Single sign-on support, available only for WebVPN, lets users access different secure services on different servers without entering a username and password more than once. The ASA currently supports the SAML POST-type SSO server and the SiteMinder-type of SSO server.

This command applies only to SAML-type SSO Servers.

If the URL begins with HTTPS, the requirement is to install the root certificate for the assertion consumer service SSL certificate.

The following example specifies the assertion-consumer-url for a SAML-type SSO server:

hostname(config-webvpn)# sso server myhostname type saml-v1.1-post
hostname(config-webvpn-sso-saml# assertion-consumer-url https://saml-server/postconsumer
hostname(config-webvpn-sso-saml#

Related Commands

Command
Description

issuer

Specifies the SAML-type SSO server security device name.

request-timeout

Specifies the number of seconds before a failed SSO authentication attempt times out.

show webvpn sso-server

Displays the operating statistics for all SSO servers configured on the security device.

sso-server

Creates a WebVPN Single Sign-On server.

trustpoint

Specifies a trustpoint name that contains the certificate to use to sign the SAML-type browser assertion.


attribute

To specify attribute value pairs that the ASA writes to the DAP attribute database, enter the attribute command in dap test attributes mode.

attribute name value

Syntax Description

name

Specifies a well-known attribute name, or an attribute that incorporates a "label" tag. The label tag corresponds to the Endpoint ID that you configure for file, registry, process, anti-virus, anti-spyware, and personal firewall endpoint attributes in the DAP record

value

The value assigned to the AAA attribute.


Command Default

No default value or behaviors.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

DAP attributes configuration mode


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

Use this command multiple times to enter multiple attribute value pairs.

Normally the ASA retrieves user authorization attributes from the AAA server and retrieves endpoint attributes from Cisco Secure Desktop, Host Scan, CNA or NAC. For the test command, you specify the user authorization and endpoint attributes in this attributes mode. The ASA writes them to an attribute database that the DAP subsystem references when evaluating the AAA selection attributes and endpoint select attributes for a DAP record.

Examples

The following example assumes that ASA selects two DAP records if the authenticated user is a member of the SAP group and has anti-virus software installed on the endpoint system. The Endpoint ID for the anti-virus software endpoint rule is nav.

The DAP records have the following policy attributes:

DAP Record 1
DAP Record 2

action = continue

action = continue

port-forward = enable hostlist1

url-list = links2

url-entry = enable


hostname # test dynamic-access-policy attributes
hostname(config-dap-test-attr)# attribute aaa.ldap.memberof SAP
hostname(config-dap-test-attr)# attribute endpoint.av.nav.exists true
hostname(config-dap-test-attr)# exit
hostname # test dynamic-access-policy execute
Policy Attributes:
action = continue
port-forward = enable hostlist1
url-list = links2
url-entry = enable
hostname #

Related Commands

Command
Description

display

Displays current attribute lists.

dynamic-access-policy-record

Creates a DAP record.

test dynamic-access-policy attributes

Enters attributes.

test dynamic-access-policy execute

Executes the logic that generates the DAP and displays the resulting access policies to the console.


l

auth-cookie-name

To specify the name of an authentication cookie, use the auth-cookie-name command in aaa-server host configuration mode. This is an SSO with HTTP Forms command.

auth-cookie-name

Syntax Description

Syntax DescriptionSyntax Description

name

The name of the authentication cookie. The maximum name size is 128 characters.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Aaa-server host configuration


Command History

Release
Modification

7.1(1)

This command was introduced.


Usage Guidelines

The WebVPN server of the ASA uses an HTTP POST request to submit a single sign-on authentication request to an SSO server. If authentication succeeds, the authenticating web server passes back an authentication cookie to the client browser. The client browser then authenticates to other web servers in the SSO domain by presenting the authentication cookie. The auth-cookie-name command configures name of the authentication cookie to be used for SSO by the ASA.

A typical authentication cookie format is Set-Cookie: <cookie name>=<cookie value> [;<cookie attributes>]. In the following authentication cookie example, SMSESSION is the name that would be configured with the auth-cookie-name command:

Set-Cookie:
SMSESSION=yN4Yp5hHVNDgs4FT8dn7+Rwev41hsE49XlKc+1twie0gqnjbhkTkUnR8XWP3hvDH6PZPbHIHtWLDKTa8
ngDB/lbYTjIxrbDx8WPWwaG3CxVa3adOxHFR8yjD55GevK3ZF4ujgU1lhO6fta0dSSOSepWvnsCb7IFxCw+MGiw0o8
8uHa2t4l+SillqfJvcpuXfiIAO06D/dapWriHjNoi4llJOgCst33wEhxFxcWy2UWxs4EZSjsI5GyBnefSQTPVfma5d
c/emWor9vWr0HnTQaHP5rg5dTNqunkDEdMIHfbeP3F90cZejVzihM6igiS6P/CEJAjE;Domain=.example.com;Pa
th=/

Examples

The following example specifies the authentication cookie name of SMSESSION for the authentication cookie received from a web server named example.com:

hostname(config)# aaa-server testgrp1 host example.com
hostname(config-aaa-server-host)# auth-cookie-name SMSESSION
hostname(config-aaa-server-host)# 

Related Commands

Command
Description

action-uri

Specifies a web server URI to receive a username and password for single sign-on authentication.

hidden-parameter

Creates hidden parameters for exchange with the authenticating web server.

password-parameter

Specifies the name of the HTTP POST request parameter in which a user password must be submitted for SSO authentication.

start-url

Specifies the URL at which to retrieve a prelogin cookie.

user-parameter

Specifies that a username parameter must be submitted as part of the HTTP POST request used for SSO authentication.


authenticated-session-username

To specify which authentication username to associate with the session when double authentication is enabled, use the authenticated-session-username command in tunnel-group general-attributes mode. To remove the attribute from the configuration, use the no form of this command.

authenticated-session-username {primary | secondary}

no authenticated-session-username

Syntax Description

clientless

Use the username from the secondary authentication server.

primary

(Default) Use the username from the primary authentication server.


Defaults

The default value is primary.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group general-attributes configuration


Command History

Release
Modification

8.2(1)

This command was introduced.


Usage Guidelines

This command is meaningful only when double authentication is enabled. The authenticated-session-username command selects the authentication server from which the ASA extracts the username to associate with the session.

Examples

The following example, entered in global configuration mode, creates an IPsec remote access tunnel group named remotegrp and specifies the use of the username from the secondary authentication server for the connection:

hostname(config)# tunnel-group remotegrp type ipsec_ra
hostname(config)# tunnel-group remotegrp general-attributes
hostname(config-tunnel-webvpn)# authenticated-session-username secondary
hostname(config-tunnel-webvpn)# 

Related Commands

Command
Description

pre-fill-username

Enables the pre-fill username feature.

show running-config tunnel-group

Shows the indicated tunnel group configuration.

tunnel-group general-attributes

Specifies the general attributes for the named tunnel group.

username-from-certificate

Specifies the field in a certificate to use as the username for authorization.


authentication-attr-from-server

To specify which authentication server authorization attributes to apply to the connection when double authentication is enabled, use the authentication-attr-from-server command in tunnel-group general-attributes mode. To remove the attribute from the configuration, use the no form of this command.

authentication-attr-from-server {primary | secondary}

no authentication-attr-from-server

Syntax Description

secondary

Use the secondary authentication server.

primary

(Default) Use the primary authentication server.


Defaults

The default value is primary.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group general-attributes configuration


Command History

Release
Modification

8.2(1)

This command was introduced.


Usage Guidelines

This command is meaningful only when double authentication is enabled. The authentication-attr-from-server command selects the authentication server from which the ASA extracts the authorization attributes to be applied to the connection.

Examples

The following example, entered in global configuration mode, creates an IPsec remote access tunnel group named remotegrp and specifies that the authorization attributes to be applied to the connection must come from the secondary authentication server:

hostname(config)# tunnel-group remotegrp type ipsec_ra
hostname(config)# tunnel-group remotegrp general-attributes
hostname(config-tunnel-webvpn)# authentication-attr-from-server secondary
hostname(config-tunnel-webvpn)# 

Related Commands

Command
Description

pre-fill-username

Enables the pre-fill username feature.

show running-config tunnel-group

Shows the indicated tunnel-group configuration.

tunnel-group general-attributes

Specifies the general attributes for the named tunnel-group.

username-from-certificate

Specifies the field in a certificate to use as the username for authorization.


authentication-certificate

To request a certificate from a WebVPN client establing a connection, use the authentication-certificate command in webvpn configuration mode. To cancel the requirement for a client certificate, use the no form of this command.

authentication-certificate interface-name

no authentication-certificate [interface-name]

Syntax Description

interface-name

The name of the interface used to establish the connection. Available interfaces names are:

inside Name of interface GigabitEthernet0/1

outside Name of interface GigabitEthernet0/0


Defaults

If you omit the authentication-certificate command, client certificate authentication is disabled.

If you do not specify an interface-name with the authentication-certificate command, the default interface-name is inside

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

For this command to take effect, WebVPN must already be enabled on the corresponding interface. An interface is configured and named with the interface, IP address, and nameif commands.

This command applies only to WebVPN client connections, however the ability to specify client certificate authentication for management connections with the http authentication-certificate command is available on all platforms, including the platforms that do not support WebVPN.

The ASA validates certificates against the PKI trustpoints. If a certificate does not pass validation, then one of the following actions occurs:

If:
Then:

The local CA embedded in the ASA is not enabled.

The ASA closes the SSL connection.

The local CA is enabled, and AAA authentication is not enabled.

The ASA redirects the client to the certificate enrollment page for the local CA to obtain a certificate.

Both the local CA and AAA authentication are enabled.

The client is redirected to a AAA authentication page. If configured, the client also is presented with a link to the enrollment page for the local CA.


Examples

The following example configures certificate authentication for WebVPN user connections on the outside interface:

hostname(config)# webvpn
hostname(config-webvpn)# authentication-certificate outside
hostname(config-webvpn)#

Related Commands

Command
Description

authentication (tunnel-group webvpn configuration mode)

Specifies that the members of a tunnel group must use a digital certificate for authentication.

http authentication-certificate

Specifies authentication by means of certificate for ASDM management connections to the ASA.

interface

Configures the interface used to establish the connection

show running-config ssl

Displays the current set of configured SSL commands.

ssl trust-point

Configures the ssl certificate trustpoint.


authentication-exclude

To enable end users to browse to configured links without logging in to clientless SSL VPN,, enter the authentication-exclude command in webvpn configuration mode. Use this command multiple times to permit acccess to multiple sites.

authentication-exclude url-fnmatch

Syntax Description

url-fnmatch

Identifies the link to exempt from the requirement to log in to clientless SSL VPN.


Command Default

Disabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

This feature is useful when you require that some internal resources be available for public use via SSL VPN.

You need to distribute information about the links to end users in an SSL VPN-mangled form, for example, by browsing to these resources using SSL VPN and copying the resulting URLS into the information about links that you distribute.

Examples

The following example shows how to exempt two sites from authentication requirements:

hostname(config)# webvpn
hostname(config-webvpn)# authentication-exclude http://www.example.com/public/*
hostname(config-webvpn)# authentication-exclude *example.html
hostname(config-webvpn)# hostname #

authentication

To configure the authentication method for WebVPN and e-mail proxies, use the authentication command in various modes. To restore the default method, use the no form of this command. The ASA authenticates users to verify their identity.

authentication {[aaa] [certificate] [mailhost] [piggyback]}

no authentication [aaa] [certificate] [mailhost] [piggyback]

Syntax Description

aaa

Provides a username and password that the ASA checks against a previously configured AAA server.

certificate

Provides a certificate during SSL negotiation.

mailhost

Authenticates via the remote mail server. For SMTPS only. For the IMAP4S and POP3S, mailhost authentication is mandatory and not displayed as a configurable option.

piggyback

Requires that an HTTPS WebVPN session already exists. Piggyback authentication is available for e-mail proxies only.


Defaults

The following table shows the default authentication methods for WebVPN and e-mail proxies:

Protocol
Default Authentication Method

IMAP4S

Mailhost (required)

POP3S

Mailhost (required)

SMTPS

AAA

WebVPN

AAA


Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Imap4s configuration

Pop3s configuration

SMTPS configuration

Webvpn configuration

 

   

Command History

Release
Modification

8.0(2)

This command was introduced.

7.1(1)

This command was deprecated in webvpn configuration mode and moved to tunnel-group webvpn-attributes configuration mode for WebVPN.

8.0(2)

This command was modified to reflect changes to certificate authentication requirements.


Usage Guidelines

At least one authentication method is required. For WebVPN, for example, you can specify AAA authentication, certificate authentication, or both. You can specify these in either order.

WebVPN certificate authentication requires that HTTPS user certificates be required for the respective interfaces. That is, for this selection to be operational, before you can specify certificate authentication, you must have specified the interface in an authentication-certificate command.

If you enter this command in webvpn configuration mode, it is transformed to the same command in tunnel-group webvpn-attributes configuration mode.

For WebVPN, you can require both AAA and certificate authentication, in which case users must provide both a certificate and a username and password. For e-mail proxy authentication, you can require more than one authentication method. Specifying the command again overwrites the current configuration.

Examples

The following example shows how to require that WebVPN users provide certificates for authentication:

hostname(config)# webvpn
hostname(config-webvpn)# authentication certificate

Related Commands

Command
Description

authentication-certificate

Requests a certificate from a WebVPN client establishing a connection.

show running-config

Displays the current tunnel-group configuration.

clear configure aaa

Removes/resets the configured AAA values.

show running-config aaa

Displays the AAA configuration.


authentication eap-proxy

For L2TP over IPsec connections, to enable EAP and permit the ASA to proxy the PPP authentication process to an external RADIUS authentication server, use the authentication eap-proxy command in tunnel-group ppp-attributes configuration mode. To return the command to its default setting (permit CHAP and MS-CHAP), use the no form of this command.

authentication eap-proxy

no authentication eap-proxy

Syntax Description

This command has no keywords or arguments.

Defaults

EAP is not a permitted authentication protocol.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group ppp-attributes configuration


Command History

Release
Modification

7.2(1)

This command was introduced.


Usage Guidelines

You can apply this attribute only to the L2TP/IPsec tunnel group type.

Examples

The following example entered in config-ppp configuration mode, permits EAP for PPP connections for the tunnel group named pppremotegrp:

hostname(config)# tunnel-group pppremotegrp type IPSec/IPSec
hostname(config)# tunnel-group pppremotegrp ppp-attributes
hostname(config-ppp)# authentication eap
hostname(config-ppp)# 

Related Commands

Command
Description

clear configure tunnel-group

Clears all configured tunnel groups.

show running-config tunnel-group

Shows the indicated certificate map entry.

tunnel-group-map default-group

Associates the certificate map entries created using the crypto ca certificate map command with tunnel groups.


authentication key eigrp

To enable authentication of EIGRP packets and specify the authentication key, use the authentication key eigrp command in interface configuration mode. To disable EIGRP authentication, use the no form of this command.

authentication key eigrp as-number key key-id key-id

no authentication key eigrp as-number

Syntax Description

as-number

The autonomous system number of the EIGRP process being authenticated. This must be the same values as configured for the EIGRP routing process.

key

Key to authenticate EIGRP updates. The key can contain up to 16 characters.

key-id key-id

Key identification value; valid values range from 1 to 255.


Defaults

EIGRP authentication is disabled.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Interface configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

You must configure both the authentication mode eigrp and the authentication key eigrp commands on an interface to enable EIGRP message authentication. Use the show running-config interface command to view the authentication commands configured on an interface.

Examples

The following examples shows EIGRP authentication configured on interface GigabitEthernet0/3:

hostname(config)# interface Gigabit0/3
hostname(config-if)# authentication mode eigrp md5
hostname(config-if)# authentication key eigrp 100 thisismykey key_id 5

Related Commands

Command
Description

authentication mode eigrp

Specifies the type of authentication used for EIGRP authentication.


authentication mode eigrp

To specify the type of authentication used for EIGRP authentication, use the authentication mode eigrp command in interface configuration mode. To restore the default authentication method, use the no form of this command.

authentication mode eigrp as-num md5

no authentication mode eigrp as-num md5

Syntax Description

as-num

The autonomous system number of the EIGRP routing process.

md5

Uses MD5 for EIGRP message authentication.


Defaults

No authentication is provided by default.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Interface configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

You must configure both the authentication mode eigrp and the authentication key eigrp commands on an interface to enable EIGRP message authentication. Use the show running-config interface command to view the authentication commands configured on an interface.

Examples

The following examples shows EIGRP authentication configured on interface GigabitEthernet0/3:

hostname(config)# interface GigabitEthernet0/3
hostname(config-if)# authentication mode eigrp 100 md5
hostname(config-if)# authentication key eigrp 100 thisismykey key_id 5

Related Commands

Command
Description

authentication key eigrp

Enables authentication of EIGRP packets and specifies the authentication key.


authentication ms-chap-v1

For L2TP over IPsec connections, to enable Microsoft CHAP, Version 1 authentication for PPP, use the authentication ms-chap-v1 command in tunnel-group ppp-attributes configuration mode. This protocol is 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. To return the command to its default setting (permit CHAP and MS-CHAP), use the no form of this command. To disable Microsoft CHAP, Version 1, use the no form of this command.

authentication ms-chap-v1

no authentication ms-chap-v1

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group ppp-attributes configuration


Command History

Release
Modification

7.2(1)

This command was introduced.


Usage Guidelines

You can apply this attribute only to the L2TP/IPsec tunnel group type.

Related Commands

Command
Description

clear configure tunnel-group

Clears the entire tunnel-group database or just the specified tunnel group.

show running-config tunnel-group

Displays the currently running tunnel-group configuration for a specified tunnel group or for all tunnel groups.

tunnel-group

Creates and manages the database of connection-specific records for IPsec and WebVPN tunnels.


authentication ms-chap-v2

For L2TP over IPsec connections, to enable Microsoft CHAP, Version 2 authentication for PPP, use the authentication ms-chap-v1 command in tunnel-group ppp-attributes configuration mode. To return the command to its default setting (permit CHAP and MS-CHAP), use the no form of this command.

authentication ms-chap-v2

no authentication ms-chap-v2

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group ppp-attributes configuration


Command History

Release
Modification

7.2(1)

This command was introduced.


Usage Guidelines

You can apply this attribute only to the L2TP/IPsec tunnel-group type.

This protocol is 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.

Related Commands

Command
Description

clear configure tunnel-group

Clears the entire tunnel-group database or just the specified tunnel group.

show running-config tunnel-group

Displays the currently running tunnel group configuration for a specified tunnel group or for all tunnel groups.

tunnel-group

Creates and manages the database of connection-specific records for IPsec and WebVPN tunnels.


authentication pap

For L2TP over IPsec connections, to permit PAP authentiation for PPP, use the authentication pap command in tunnel-group ppp-attributes configuration mode. To return the command to its default setting (permit CHAP and MS-CHAP), use the no form of this command.

authentication pap

no authentication pap

Syntax Description

This command has no keywords or arguments.

Defaults

PAP is not a permitted authentication protocol.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group ppp-attributes configuration


Command History

Release
Modification

7.2(1)

This command was introduced.


Usage Guidelines

You can apply this attribute only to the L2TP/IPsec tunnel group type.

This protocol passes a cleartext username and password during authentication and is not secure.

Examples

The following example entered in config-ppp configuration mode, permits PAP for PPP connections for a tunnel group named pppremotegrps:

hostname(config)# tunnel-group pppremotegrp type IPSec/IPSec
hostname(config)# tunnel-group pppremotegrp ppp-attributes
hostname(config-ppp)# authentication pap
hostname(config-ppp)# 

Related Commands

Command
Description

clear configure tunnel-group

Clears all configured tunnel groups.

show running-config tunnel-group

Shows the indicated certificate map entry.

tunnel-group-map default-group

Associates the certificate map entries created using the crypto ca certificate map command with tunnel groups.


authentication-certificate

To request a certificate from a WebVPN client establing a connection, use the authentication-certificate command in webvpn configuration mode. To cancel the requirement for a client certificate, use the no form of this command.

authentication-certificate interface-name

no authentication-certificate [interface-name]

Syntax Description

interface-name

The name of the interface used to establish the connection. Available interfaces names are:

inside Name of interface GigabitEthernet0/1

outside Name of interface GigabitEthernet0/0


Defaults

If you omit the authentication-certificate command, client certificate authentication is disabled.

If you do not specify an interface name with the authentication-certificate command, the default interface name is inside.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration


Command History

Release
Modification

8.0(2)

This command was introduced.


Usage Guidelines

For this command to take effect, WebVPN must already be enabled on the corresponding interface. An interface is configured and named with the interface, IP address, and nameif commands.

This command applies only to WebVPN client connections, however the ability to specify client certificate authentication for management connections with the http authentication-certificate command is available on all platforms, including the platforms that do not support WebVPN.

The ASA validates certificates against the PKI trustpoints. If a certificate does not pass validation, then one of the following actions occurs:

If:
Then:

The local CA embedded in the ASA is not enabled.

The ASA closes the SSL connection.

The local CA is enabled, and AAA authentication is not enabled.

The ASA redirects the client to the certificate enrollment page for the local CA to obtain a certificate.

Both the local CA and AAA authentication are enabled.

The client is redirected to a AAA authentication page. If configured, the client also is presented with a link to the enrollment page for the local CA.


Examples

The following example configures certificate authentication for WebVPN user connections on the outside interface:

hostname(config)# webvpn
hostname(config-webvpn)# authentication-certificate outside
hostname(config-webvpn)#

Related Commands

Command
Description

authentication (tunnel-group webvpn configuration mode)

Specifies that the members of a tunnel group must use a digital certificate for authentication.

http authentication-certificate

Specifies authentication by means of certificate for ASDM management connections to the ASA.

interface

Configures the interface used to establish the connection

show running-config ssl

Displays the current set of configured SSL commands.

ssl trust-point

Configures the ssl certificate trustpoint.


authentication-port

To specify the port number used for RADIUS authentication for this host, use the authentication-port command in aaa-server configuration host configuration mode. To remove the authentication port specification, use the no form of this command. This command specifies the destination TCP/UDP port number of the remote RADIUS server hosts to which you want to assign authentication functions:

authentication-port port

no authentication-port

Syntax Description

port

A port number, in the range 1-65535, for RADIUS authentication.


Defaults

By default, the device listens for RADIUS on port 1645 (in compliance with RFC 2058). If the port is not specified, the RADIUS authentication default port number (1645) is used.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Aaa-server host configuration


Command History

Release
Modification

7.0(1)

Semantic change to the command to support the specification of server ports on a per-host basis for server groups that contain RADIUS servers.


Usage Guidelines

If your RADIUS authentication server uses a port other than 1645, you must configure the ASA for the appropriate port prior to starting the RADIUS service with the aaa-server command.

This command is valid only for server groups that are configured for RADIUS.

Examples

The following example configures a RADIUS AAA server named "srvgrp1" on host "1.2.3.4", sets a timeout of 9 seconds, sets a retry-interval of 7 seconds, and configures authentication port 1650.

hostname(config)# aaa-server svrgrp1 protocol radius
hostname(config-aaa-server-group)# aaa-server svrgrp1 host 1.2.3.4
hostname(config-aaa-server-host)# timeout 9
hostname(config-aaa-server-host)# retry-interval 7
hostname(config-aaa-server-host)# authentication-port 1650
hostname(config-aaa-server-host)# exit
hostname(config)# 

Related Commands

Command
Description

aaa authentication

Enables or disables LOCAL, TACACS+, or RADIUS user authentication, on a server designated by the aaa-server command, or ASDM user authentication.

aaa-server host

Enters AAA server host configuration mode, so you can configure AAA server parameters that are host-specific.

clear configure aaa-server

Removes all AAA command statements from the configuration.

show running-config aaa-server

Displays AAA server statistics for all AAA servers, for a particular server group, for a particular server within a particular group, or for a particular protocol.


authentication-server-group (imap4s, pop3s, smtps)

To specify the set of authentication servers to use for e-mail proxies, use the authentication-server-group command in various modes. To remove authentication servers from the configuration, use the no form of this command.

authentication-server-group group_tag

no authentication-server-group

Syntax Description

group_tag

Identifies the previously configured authentication server or group of servers. Use the aaa-server command to configure authentication servers.


Defaults

No authentication servers are configured by default.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Imap4s configuration

Pop3s configuration

Smtps configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

The ASA authenticates users to verify their identity.

If you configure AAA authentication, you must configure this attribute as well. Otherwise, authentication always fails.

Examples

The next example shows how to configure IMAP4S e-mail proxy to use the set of authentication servers named "IMAP4SSVRS":

hostname(config)# imap4s
hostname(config-imap4s)# authentication-server-group IMAP4SSVRS

Related Commands

Command
Description

aaa-server host

Configures authentication, authorization, and accounting servers.


authentication-server-group (tunnel-group general-attributes)

To specify the AAA server group to use for user authentication for a tunnel group, use the authentication-server-group command in tunnel-group general-attributes configuration mode. To return this attribute to the default, use the no form of this command.

authentication-server-group [(interface_name)] server_group [LOCAL]

no authentication-server-group [(interface_name)] server_group

Syntax Description

interface_name

(Optional) Specifies the interface where the IPsec tunnel terminates.

LOCAL

(Optional) Requires authentication against the local user database if all of the servers in the server group have been deactivated due to communication failures.

server_group

Identifies the previously configured authentication server or group of servers.


Defaults

The default setting for the server-group in this command is LOCAL.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Tunnel-group general-attributes configuration


Command History

Release
Modification

7.0(1)

This command was introduced.

7.1(1)

This command was deprecated in webvpn configuration mode and moved to tunnel-group general-attributes configuration mode.

8.0(2)

This command was enhanced to allow per-interface authentication for IPsec connections.


Usage Guidelines

You can apply this attribute to all tunnel-group types.

Use the aaa-server command to configure authentication servers and the aaa-server-host command to add servers to a previously configured AAA server group.

Examples

The following example entered in config-general configuration mode, configures an authentication server group named aaa-server456 for an IPsec remote-access tunnel group named remotegrp:

hostname(config)# tunnel-group remotegrp type ipsec-ra
hostname(config)# tunnel-group remotegrp general-attributes
hostname(config-tunnel-general)# authentication-server-group aaa-server456
hostname(config-tunnel-general)# 

Related Commands

Command
Description

aaa-server

Creates a AAA server group and configures AAA server parameters that are group-specific and common to all group hosts.

aaa-server host

Adds servers to a previously configured AAA server group and configures host-specific AAA server parameters.

clear configure tunnel-group

Clears all configured tunnel groups.

show running-config tunnel-group

Shows the tunnel group configuration for all tunnel groups or for a particular tunnel group.


authorization-required

To require users to authorize successfully prior to connecting, use the authorization-required command in various modes. To remove the attribute from the configuration, use the no form of this command.

authorization-required

no authorization-required

Syntax Description

This command has no arguments or keywords.

Defaults

Authorization-required is disabled by default.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Imap4s configuration

Pop3s configuration

Smtps configuration

Tunnel-group general-attributes configuration


Command History

Release
Modification

7.0(1)

This command was introduced.

7.1(1)

This command was deprecated in webvpn configuration mode and moved to tunnel-group general-attributes configuration mode.

7.2(1)

Replaced webvpn configuration mode with imap4s, pop3s, and smtps configuration modes.


Examples

The following example, entered in global configuration mode, requires authorization based on the complete DN for users connecting through a remote-access tunnel group named remotegrp. The first command configures the tunnel-group type as ipsec_ra (IPsec remote access) for the remote group named remotegrp. The second command enters tunnel-group general-attributes configuration mode for the specified tunnel group, and the last command specifies that authorization is required for the named tunnel group.

hostname(config)# tunnel-group remotegrp type ipsec_ra
hostname(config)# tunnel-group remotegrp general-attributes
hostname(config-tunnel-general)# authorization-required
hostname(config-tunnel-general)# 

Related Commands

Command
Description

authorization-dn-attributes

Specifies the primary and secondary subject DN fields to use as the username for authorization.

clear configure tunnel-group

Clears all configured tunnel groups.

show running-config tunnel-group

Shows the indicated certificate map entry.

tunnel-group general-attributes

Specifies the general attributes for the named tunnel group.


authorization-server-group

To specify the set of authorization servers to use with WebVPN and e-mail proxies, use the authorization-server-group command in various modes. To remove authorization servers from the configuration, use the no form of this command.

authorization-server-group group_tag

no authorization-server-group

Syntax Description

group_tag

Identifies the previously configured authorization server or group of servers. Use the aaa-server command to configure authorization servers.


Defaults

No authorization servers are configured by default.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Imap4s configuration

Pop3s configuration

Smtps configuration

Tunnel-group general-attributes configuration


Command History

Release
Modification

7.0(1)

This command was introduced.

7.1(1)

This command was deprecated in webvpn configuration mode and moved to tunnel-group general-attributes configuration mode.


Usage Guidelines

The ASA uses authorization to verify the level of access to network resources that users are permitted.

If you enter this command in webvpn configuration mode, it is transformed to the same command in tunnel-group general-attributes mode.

When VPN Authorization is defined as LOCAL, the attributes configured in the default group policy DfltGrpPolicy are enforced.

Examples

The following example shows how to configure POP3S e-mail proxy to use the set of authorization servers named "POP3Spermit":

hostname(config)# pop3s
hostname(config-pop3s)# authorization-server-group POP3Spermit

The following example entered in config-general configuration mode, configures an authorization server group named "aaa-server78" for an IPsec remote-access tunnel group named "remotegrp":

hostname(config)# tunnel-group remotegrp type ipsec-ra
hostname(config)# tunnel-group remotegrp general-attributes
hostname(config-tunnel-general)# authorization-server-group aaa-server78
hostname(config-tunnel-general)# 

Related Commands

Command
Description

aaa-server host

Configures authentication, authorization, and accounting servers.

clear configure tunnel-group

Clears all configured tunnel groups.

show running-config tunnel-group

Shows the tunnel group configuration for all tunnel groups or for a particular tunnel group.

tunnel-group general-attributes

Specifies the general attributes for the named tunnel-group.


auth-prompt

To specify or change the AAA challenge text for through-the-ASA user sessions, use the auth-prompt command in global configuration mode. To remove the authentication challenge text, use the no form of this command.

auth-prompt prompt [prompt | accept | reject] string

no auth-prompt prompt [ prompt | accept | reject]

Syntax Description

accept

If a user authentication via Telnet is accepted, display the prompt string.

prompt

The AAA challenge prompt string follows this keyword.

reject

If a user authentication via Telnet is rejected, display the prompt string.

string

A string of up to 235 alphanumeric characters or 31 words, limited by whichever maximum is first reached. Special characters, spaces, and punctuation characters are permitted. Entering a question mark or pressing the Enter key ends the string. (The question mark appears in the string.)


Defaults

If you do not specify an authentication prompt:

FTP users see hostname(config)# ,

HTTP users see hostname(config-aaa-server-group)#

Telnet users see no challenge text.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

Minor semantic changes.


Usage Guidelines

The auth-prompt command lets you specify the AAA challenge text for HTTP, FTP, and Telnet access through the ASA when requiring user authentication from TACACS+ or RADIUS servers. This text is primarily for cosmetic purposes and displays above the username and password prompts that users view when logging in.

If the user authentication occurs from Telnet, you can use the accept and reject options to display different status prompts to indicate that the authentication attempt is accepted or rejected by the AAA server.

If the AAA server authenticates the user, the ASA displays the auth-prompt accept text, if specified, to the user; otherwise it displays the reject text, if specified. Authentication of HTTP and FTP sessions displays only the challenge text at the prompt. The accept and reject text are not displayed.


Note Microsoft Internet Explorer displays up to 37 characters in an authentication prompt. Telnet and FTP display up to 235 characters in an authentication prompt.


Examples

The following example sets the authentication prompt to the string "Please enter your username and password.":

hostname(config)# auth-prompt prompt Please enter your username and password

After this string is added to the configuration, users see the following:

Please enter your username and password
User Name:
Password:

For Telnet users, you can also provide separate messages to display when the ASA accepts or rejects the authentication attempt; for example:

hostname(config)# auth-prompt reject Authentication failed. Try again.
hostname(config)# auth-prompt accept Authentication succeeded.

The following example sets the authentication prompt for a successful authentication to the string, "You're OK."

hostname(config)# auth-prompt accept You're OK.

After successfully authenticating, the user sees the following message:

You're OK.

Related Commands

Command
Description

clear configure auth-prompt

Removes the previously specified authentication prompt challenge text and reverts to the default value, if any.

show running-config auth-prompt

Displays the current authentication prompt challenge text.


auto-signon

To configure the ASA to automatically pass user login credentials for Clientless SSL VPN connections on to internal servers, use the auto-signon command in any of three modes: webvpn configuration, webvpn group configuration, or webvpn username configuration mode. The authentication method can be NTLM (includes NTLMv1 and NTLMv2), HTTP Basic authentication, or both. To disable auto-signon to a particular server, use the no form of this command with the original ip, uri, and auth-type arguments. To disable auto-signon to all servers, use the no form of this command without arguments.

auto-signon allow {ip ip-address ip-mask | uri resource-mask} auth-type {basic | ftp | ntlm | all}

no auto-signon [allow {ip ip-address ip-mask | uri resource-mask} auth-type {basic | ftp | ntlm | all}]

Syntax Description

Syntax DescriptionSyntax Description

all

Specifies both the NTLM and HTTP Basic authentication methods.

allow

Enables authentication to a particular server.

auth-type

Enables selection of an authentication method.

basic

Specifies the HTTP Basic authentication method.

ftp

Ftp and cifs authentication type.

ip

Specifies that an IP address and mask identifies the servers to be authenticated to.

ip-address

In conjunction with ip-mask, identifies the IP address range of the servers to be authenticated to.

ip-mask

In conjunction with ip-address, identifies the IP address range of the servers to be authenticated to.

ntlm

Specifies the NTLMv1 authentication method.

resource-mask

Identifies the URI mask of the servers to be authenticated to.

uri

Specifies that a URI mask identifies the servers to be authenticated to.


Defaults

By default, this feature is disabled for all servers.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Webvpn configuration (global)

Webvpn group policy configuration

Webvpn username configuration


Command History

Release
Modification

7.1(1)

This command was introduced.

8.0(1)

NTLMv2 support was added. The ntlm keyword includes both NTLMv1 and NTLMv2.


Usage Guidelines

The auto-signon command is a single sign-on method for Clientless SSL VPN users. It passes the login credentials (username and password) to internal servers for authentication using NTLM authentication, HTTP Basic authentication, or both. Multiple auto-signon commands can be entered and are processed according to the input order (early commands take precedence).

You can use the auto-signon feature in three modes: webvpn configuration group-policy, webvpn configuration, or webvpn username configuration mode. The typical precedence behavior applies, where username supersedes group, and group supersedes global. The mode you choose depends upon the desired scope of authentication:

Mode
Scope

Webvpn configuration

All WebVPN users globally

Webvpn group configuration

A subset of WebVPN users defined by a group policy

Webvpn username configuration

An individual WebVPN user


Examples

The following example commands configure auto-signon for all Clientless users, using NTLM authentication, to servers with IP addresses ranging from 10.1.1.0 to 10.1.1.255:

hostname(config)# webvpn
hostname(config-webvpn)# auto-signon allow ip 10.1.1.0 255.255.255.0 auth-type ntlm 

The following example commands configure auto-signon for all Clientless users, using HTTP Basic authentication, to servers defined by the URI mask https://*.example.com/*:

hostname(config)# webvpn
hostname(config-webvpn)# auto-signon allow uri https://*.example.com/* auth-type basic
The following example commands configure auto-signon for Clientless users ExamplePolicy group 
policy, using either HTTP Basic or NTLM authentication, to servers defined by the URI mask 
https://*.example.com/*:
hostname(config)# group-policy ExamplePolicy attributes 
hostname(config-group-policy)# webvpn 
hostname(config-group-webvpn)# auto-signon allow uri https://*.example.com/* auth-type all

The following example commands configure auto-signon for a user named Anyuser, using HTTP Basic authentication, to servers with IP addresses ranging from 10.1.1.0 to 10.1.1.255:

hostname(config)# username Anyuser attributes
hostname(config-username)# webvpn
hostname(config-username-webvpn)# auto-signon allow ip 10.1.1.0 255.255.255.0 auth-type 
basic 

Related Commands

Command
Description

show running-config webvpn auto-signon

Displays auto-signon assignments of the running configuration.


auto-summary

To enable the automatic summarization of subnet routes into network-level routes, use the auto-summary command in router configuration mode. To disable route summarization, use the no form of this command.

auto-summary

no auto-summary

Syntax Description

This command has no arguments or keywords.

Defaults

Route summarization is enabled for RIP Version 1, RIP Version 2, and EIGRP.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Router configuration


Command History

Release
Modification

7.2(1)

This command was introduced.

8.0(2)

Support for EIGRP was added.


Usage Guidelines

Route summarization reduces the amount of routing information in the routing tables.

RIP Version 1 always uses automatic summarization. You cannot disable automatic summarization for RIP Version 1.

If you are using RIP Version 2, you can turn off automatic summarization by specifying the no auto-summary command. Disable automatic summarization if you must perform routing between disconnected subnets. When automatic summarization is disabled, subnets are advertised.

EIGRP summary routes are given an administrative distance value of 5. You cannot configure this value.

Only the no form of this command appears in the running configuration.

Examples

The following example disables RIP route summarization:

hostname(config)# router rip
hostname(config-router)# network 10.0.0.0
hostname(config-router)# version 2
hostname(config-router)# no auto-summary

The following example disables automatic EIGRP route summarization:

hostname(config)# router eigrp 100
hostname(config-router)# network 10.0.0.0
hostname(config-router)# no auto-summary

Related Commands

Command
Description

clear configure router

Clears all router commands and router configuration mode commands from the running configuration.

router eigrp

Enables the EIGRP routing process and enters EIGRP router configuration mode.

router rip

Enables the RIP routing process and enters RIP router configuration mode.

show running-config router

Displays the router commands and router configuration mode commands in the running configuration.


auto-update device-id

To configure the ASA device ID for use with an Auto Update Server, use the auto-update device-id command in global configuration mode. To remove the device ID, use the no form of this command.

auto-update device-id [hardware-serial | hostname | ipaddress [if_name] | mac-address [if_name] | string text]

no auto-update device-id [hardware-serial | hostname | ipaddress [if_name] | mac-address [if_name] | string text]

Syntax Description

hardware-serial

Uses the hardware serial number of the ASA to uniquely identify the device.

hostname

Uses the hostname of the ASA to uniquely identify the device.

ipaddress [if_name]

Uses the IP address of the ASA to uniquely identify the ASA. By default, the ASA uses the interface used to communicate with the Auto Update Server. If you want to use a different IP address, specify the if_name.

mac-address [if_name]

Uses the MAC address of the ASA to uniquely identify the ASA. By default, the ASA uses the MAC address of the interface used to communicate with the Auto Update Server. If you want to use a different MAC address, specify the if_name.

string text

Specifies the text string to uniquely identify the device to the Auto Update Server.


Defaults

The default ID is the hostname.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Examples

The following example sets the device ID to the serial number:

hostname(config)# auto-update device-id hardware-serial

Related Commands

auto-update poll-period

Sets how often the ASA checks for updates from an Auto Update Server.

auto-update server

Identifies the Auto Update Server.

auto-update timeout

Stops traffic from passing through the ASA if the Auto Update Server is not contacted within the timeout period.

clear configure auto-update

Clears the Auto Update Server configuration.

show running-config auto-update

Shows the Auto Update Server configuration.


auto-update poll-at

To schedule a specific time for the adaptive security appliance to poll the Auto Update Server, use the auto-update poll-at command from global configuration mode. To remove all specified scheduling times for the adaptive security appliance to poll the Auto Update Server, use the no form of this command.

auto-update poll-at days-of-the-week time [randomize minutes] [retry_count [retry_period]]

no auto-update poll-at days-of-the-week time [randomize minutes] [retry_count [retry_period]]

Syntax Description

days-of-the-week

Any single day or combination of days: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday. Other possible values are daily (Monday through Sunday), weekdays (Monday through Friday) and weekend (Saturday and Sunday).

randomize minutes

Specifies the period to randomize the poll time following the specified start time. from from 1 to 1439 minutes.

retry_count

Specifies how many times to try reconnecting to the Auto Update Server if the first attempt fails. The default is 0.

retry_period

Specifies how long to wait between connection attempts. The default is 5 minutes. The range is from 1 and 35791 minutes.

time

Specifies the time in the format HH:MM at which to start the poll. For example, 8:00 is 8:00 AM and 20:00 is 8:00 PM.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.2(1)

This command was introduced.


Usage Guidelines

The auto-update poll-at command specifys a time at which to poll for updates. If you enable the randomize option, the polling occurs at a random time within the range of the first time and the specified number of minutes. The auto-update poll-at and auto-update poll-period commands are mutually exclusive. Only one of them can be configured.

Examples

In the following example, the adaptive security appliance polls the Auto Update Server every Friday and Saturday night at a random time between 10:00 p.m. and 11:00 p.m. If the adaptive security appliance is unable to contact the server, it tries two more times every 10 minutes.

hostname(config)# auto-update poll-at Friday Saturday 22:00 randomize 60 2 10
hostname(config)# auto-update server http://192.168.1.114/aus/autoupdate.asp

Related Commands

auto-update device-id

Sets the ASA device ID for use with an Auto Update Server.

auto-update poll-period

Sets how often the ASA checks for updates from an Auto Update Server.

auto-update timeout

Stops traffic from passing through the ASA if the Auto Update Server is not contacted within the timeout period.

clear configure auto-update

Clears the Auto Update Server configuration.

management-access

Enables access to an internal management interface on the ASA.

show running-config auto-update

Shows the Auto Update Server configuration.


auto-update poll-period

To configure how often the ASA checks for updates from an Auto Update Server, use the auto-update poll-period command in global configuration mode. To reset the parameters to the defaults, use the no form of this command.

auto-update poll-period poll_period [retry_count [retry_period]]

no auto-update poll-period poll_period [retry_count [retry_period]]

Syntax Description

poll_period

Specifies how often, in minutes, to poll an Auto Update Server, between 1 and 35791. The default is 720 minutes (12 hours).

retry_count

Specifies how many times to try reconnecting to the Auto Update Server if the first attempt fails. The default is 0.

retry_period

Specifies how long to wait, in minutes, between connection attempts, between 1 and 35791. The default is 5 minutes.


Defaults

The default poll period is 720 minutes (12 hours).

The default number of times to try reconnecting to the Auto Update Server if the first attempt fails is 0.

The default period to wait between connection attempts is 5 minutes.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

The auto-update poll-at and auto-update poll-period commands are mutually exclusive. Only one of them can be configured.

Examples

The following example sets the poll period to 360 minutes, the retries to 1, and the retry period to 3 minutes:

hostname(config)# auto-update poll-period 360 1 3

Related Commands

auto-update device-id

Sets the ASA device ID for use with an Auto Update Server.

auto-update server

Identifies the Auto Update Server.

auto-update timeout

Stops traffic from passing through the ASA if the Auto Update Server is not contacted within the timeout period.

clear configure auto-update

Clears the Auto Update Server configuration.

show running-config auto-update

Shows the Auto Update Server configuration.


auto-update server

To identify the Auto Update Server, use the auto-update server command in global configuration mode. To remove the server, use the no form of this command.

auto-update server url [source interface] [verify-certificate]

no auto-update server url [source interface] [verify-certificate]

Syntax Description

interface

Specifies which interface to use when sending requests to the Auto Update Server.

url

Specifies the location of the Auto Update Server using the following syntax: http[s]:[[user:password@]location [:port ]] / pathname

verify_certificate

Verifies the certificate returned by the Auto Update Server.


Defaults

No default behavior or values.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.

7.2(1)

The command was modified to add support for multiple servers.


Usage Guidelines

The ASA periodically contacts the Auto Update Server for any configuration, operating system, and ASDM updates.

You can configure multiple servers to work with auto update. When checking for updates, a connection is made to the first server, but if that fails then the next server will be contacted. This will continue until all the servers have been tried. If all of them fail to connect, then a retry starting with the first server is attempted if the auto-update poll-period is configured to retry the connection.

For auto update functionality to work properly, you must use the boot system configuration command and ensure it specifies a valid boot image. Likewise, the asdm image command must be used with auto update to update the ASDM software image.

If the interface specified in the source interface argument is the same interface specified with the management-access command, requests to the Auto Update Server will be sent over the VPN tunnel.

Examples

The following example sets the Auto Update Server URL and specifies the interface outside:

hostname(config)# auto-update server http://10.1.1.1:1741/ source outside

Related Commands

auto-update device-id

Sets the ASA device ID for use with an Auto Update Server.

auto-update poll-period

Sets how often the ASA checks for updates from an Auto Update Server.

auto-update timeout

Stops traffic from passing through the ASA if the Auto Update Server is not contacted within the timeout period.

clear configure auto-update

Clears the Auto Update Server configuration.

management-access

Enables access to an internal management interface on the adaptive security appliance.

show running-config auto-update

Shows the Auto Update Server configuration.


auto-update timeout

To set a timeout period in which to contact the Auto Update Server, use the auto-update timeout command in global configuration mode. To remove the timeout, use the no form of this command.

auto-update timeout period

no auto-update timeout [period]

Syntax Description

period

Specifies the timeout period in minutes between 1 and 35791. The default is 0, which means there is no timeout. You cannot set the timeout to 0; use the no form of the command to reset it to 0.


Defaults

The default timeout is 0, which sets the ASA to never time out.

Command Modes

The following table shows the modes in which you can enter the command:

Command Mode
Firewall Mode
Security Context
Routed
Transparent
Single
Multiple
Context
System

Global configuration


Command History

Release
Modification

7.0(1)

This command was introduced.


Usage Guidelines

A timeout condition is reported with syslog message 201008.

If the Auto Update Server has not been contacted for the timeout period, the ASA stops all traffic through the ASA. Set a timeout to ensure that the ASA has the most recent image and configuration.

Examples

The following example sets the timeout to 24 hours:

hostname(config)# auto-update timeout 1440

Related Commands

auto-update device-id

Sets the ASA device ID for use with an Auto Update Server.

auto-update poll-period

Sets how often the ASA checks for updates from an Auto Update Server.

auto-update server

Identifies the Auto Update Server.

clear configure auto-update

Clears the Auto Update Server configuration.

show running-config auto-update

Shows the Auto Update Server configuration.