ar - az

area

To create an OSPF v2 or OSPFv3 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.

Command Default

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

  • Yes

  • Yes

IPv6 router configuration

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.0(1)

Support for OSPFv3 was added.

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:


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

area authentication

To enable authentication for an OSPFv2 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 for 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 for the area specified by the area_id .

Command Default

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

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.0(1)

Multiple context mode is supported.

Usage Guidelines

If the specified OSPFv2 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:


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

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 or IPv6 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 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

Command Default

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

  • Yes

  • Yes

  • Yes

IPv6 router configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.0(1)

Multiple context mode and OSPFv3 are supported.

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:


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

area filter-list prefix

To filter prefixes advertised in Type 3 LSAs between OSPFv2 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

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

Command Default

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

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.0(1)

Multiple context mode is supported.

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 has been configured in the private network, then it sends Type 5 LSAs (describing private networks) that 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:


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

area nssa

To configure an area as an NSSA, use the area nssa command in router configuration mode or IPv6 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

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

Command Default

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

  • Yes

  • Yes

  • Yes

IPv6 router configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.0(1)

Multiple content mode and OSPFv3 are supported.

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:


ciscoasa(config-rtr)# area 1 nssa no-redistribution
ciscoasa(config-rtr)# 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:


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

area-password

To configure the IS-IS area authentication password, use the area-password command in router isis configuration mode. To disable the password, use the no form of this command.

area-password password [ authenticate snp { validate | send-only } ]

no area password [ password ]

Syntax Description

password

Password you assign.

authenticate snp

(Optional) Causes the system to insert the password into sequence number PDUS (SNPs).

validate

Causes the system to insert the password into the SNPs and check the password in SNPs that it receives.

send-only

Causes the system to only insert the password into the SNPs, but not check the password in SNPs that it receives. Use this keyword during a software upgrade to ease the transition.

Command Default

No area password is defined and area password 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 isis configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.6(1)

This command was added.

Usage Guidelines

Using the area-password command on all routers in an area prevents unauthorized routers from injecting false routing information into the link-state database.

This password is exchanged as plain text and thus this feature provides only limited security.

This password is inserted in Level 1 (station router level) PDU link-state packets (LSPs), complete sequence number PDUs (CSNPs), and partial sequence number PDUs (PSNP).

If you do not specify the authenticate snp keyword along with either the validate or send-only keyword, then the IS-IS routing protocol does not insert the password into SNPs.

Examples

The following example assigns an area authentication password and specifies that the password be inserted in SNPs and checked in SNPs that the system receives:


ciscoasa(config-router)# router isis
ciscoasa(config-router)# area-password track authenticate snp validate

area range (ipv6 router ospf)

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

area area_id ipv6-prefix-/prefix-length [ advertise | not advertise ] [ cost cost ]

no area area_id ipv6-prefix-/prefix-length [ advertise | not advertise ] [ cost cost ]

Syntax Description

advertise

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

area_id

Specifies the identifier of the area for which routes are to be summarized. You can specify the identifier as either a decimal number or an IPv6 prefix.

cost cost

(Optional) Specifies the metric or cost for this summary route, which is used during OSPF SPF calculations to detemine the shortest paths to the destination. Valid values range from 0 to 16777215.

ipv6-prefix

Specifies the IPv6 prefix.

not-advertise

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

prefix-length

Specifies the IPv6 prefix length.

Command Default

The range status is set to advertise 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

Ipv6 router ospf configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.0(1)

This command was added.

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 IPv6 prefix and prefix length. This behavior is called route summarization . You can configure multiple area range commands for an area. In this way, OSPFv3 can summarize routes for many different sets of IPv6 prefixes and prefix lengths.

Examples

The following example specifies one summary route to be advertised by the ABR to other areas for IPv6 prefix 2000:0:0:4::2 with the prefix-length 2001::/64:


ciscoasa(config-router)# area 1 range 
2000:0:0:4::2/2001::/64
 
ciscoasa(config-router)# 

area range (router ospf)

To consolidate and summarize routes at an area boundary, use the area range command in router ospf 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

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

Command Default

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

Ipv6 router ospf configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.0(1)

Multiple context mode is supported.

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 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. In this way, 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:


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

area stub

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

area area_id stub [ no-summary ]

no area area_id stub [ no-summary ]

Syntax Description

area_id

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

Command Default

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

  • Yes

  • Yes

IPv6 router configuration

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.0(1)

Support for OSPFv3 was added.

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:


ciscoasa(config-rtr)# area 1 stub
ciscoasa(config-rtr)#

area virtual-link (ipv6 router ospf)

To define an OSPFv3 virtual link, use the area virtual-link command in ipv6 router ospf 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 [ hello-interval seconds ] [ retransmit-interval seconds ] [ transmit-delay seconds ] [ dead-interval seconds ] [ ttl-security hops hop-count ]

no area area_id virtual-link router_id [ hello-interval seconds ] [ retransmit-interval seconds ] [ transmit-delay seconds ] [ dead-interval seconds ] [ ttl-security hops hop-count ]

Syntax Description

area_id

Specifies the area ID of the transit area for the virtual link. You can specify the identifier as either a decimal number or valid IPv6 prefix. Valid decimal values range from 0 to 4294967295.

hello-interval seconds

(Optional) Specifies the time in seconds between hello packets that the ASA sends on the interface. The hello interval is an unsigned integer value to be advertised in the hello packets. The value must be the same for all routers and access servers that are attached to a common network. Valid values range from 1 to 8192 seconds.

retransmit-interval seconds

(Optional) Specifies the time in seconds between LSA retransmissions for adjacent routers that belong to the interface. The retransmission interval is the expected round-trip delay between any two routers on the attached network. The value must be greater than the expected round-trip delay. Valid values range from 1 to 8192 seconds.

router_id

Specifies the router ID that is associated with the virtual link neighbor. The router ID appears in the show ipv6 ospf or show ipv6 display command.

transmit-delay seconds

(Optional) Specifies the estimated time in seconds that is required to send a link-state update packet on the interface. The integer value must be greater than zero. LSAs in the update packet have their age incremented by this amount before transmission. Valid values range from 1 to 8192 seconds.

dead-interval seconds

(Optional) Specifies the time in seconds that hello packets are not seen before a neighbor indicates that the router is down. The dead interval in an unsigned integer value. As with the hello interval, this value must be the same for all routers and access servers that are attached to a common network. Valid values range from 1 to 8192 seconds.

ttl-security hops hop-count

(Optional) Configures the time-to-live (TTL) security on a virtual link. Valid values for the hop count range from 1 to 254.


Note


Single-digit passwords and passwords starting with a digit followed by a white space are no longer supported.

Command Default

The defaults are as follows:

  • area_id : No area ID is predefined.

  • router_id : No router ID is predefined.

  • hello-interval : 10 seconds.

  • retransmit-interval : 5 seconds.

  • transmit-delay : 1 second.

  • dead-interval : 40 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

Ipv6 router ospf configuration

  • Yes

  • Yes

Command History

Release

Modification

9.0(1)

This command was added.

Usage Guidelines

In OSPFv3, 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 occurs.

The setting of the retransmission interval should be conservative, or unnecessary 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.


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 correctly configured. Use the show ipv6 ospf command to obtain the router ID.

Examples

The following example establishes a virtual link in OSPFv3:


ciscoasa(config-if)# ipv6 router ospf 1
ciscoasa(config-rtr)# log-adjacency-changes
ciscoasa(config-rtr)# area 1 virtual-link 192.168.255.1 hello interval 5

area virtual-link (router ospf)

To define an OSPF virtual link, use the area virtual-link command in router ospf 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 [ key-chain key-chain-name | message-digest | null ]] [ hello-interval seconds ] [ retransmit-interval 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 [ key-chain key-chain-name | message-digest | null ]] [ hello-interval seconds ] [ retransmit-interval 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.

key-chain

key-chain-name

(Optional) Specifies a key chain to use for authentication. The key-name argument can be a maximum of 63 alphanumeric characters.

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.

Command Default

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 ospf configuration

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

9.12(1)

Key chain feature was added to support rotating keys for OSPF authentication.

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.

Examples

The following example establishes a virtual link with MD5 authentication:


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

The following example establishes a virtual link with rotating keys authentication:


ciscoasa(config-rtr)# area 10.0.0.0 virtual-link 10.3.4.5 authentication key-chain CHAIN-RTR-OSPFKEY

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.

Command Default

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

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

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:


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

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 bridge group member 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.

Command Default

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

Gloabl configuration

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

This command was added.

9.7(1)

You can now configure this command in routed mode when using Integrated Routing and Bridging.

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 then 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, provided 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:


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

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

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

8.4(5), 9.0(1)

We added this command.

Usage Guidelines

The ASA ARP cache only contains entries from directly-connected subnets by default. When the no arp permit-nonconnected command is there (default behavior), the ASA rejects both incoming ARP requests and ARP responses in case the ARP packet received is in a different subnet than the connected interface.

Note that the first case (default behavior) causes a failure in case PAT is configured on the ASA and the virtual IP address (mapped) for PAT is in a different subnet than the connected interface.

Also, we do not recommend enabling this feature unless you know the security risks. This feature could facilitate denial of service (DoS) attacks 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:


ciscoasa(config)# arp permit non-connected

The default behavior can be seen in the output of the debug arp command on the ASA as:

For an incoming ARP request:


- larp-in: request at outside from 10.10.2.1 0013.8083.0bb1 for 10.10.2.2 0000.0000.0000 having smac 0013.8083.0bb1 dmac ffff.ffff.ffff\narp-in: Arp packet received from 10.10.2.1 which is in different subnet than the connected interface 10.10.1.2/255.255.255.0

For an incoming ARP response:

The following example enables non-connected subnets:


ciscoasa(config)# arp permit non-connected
 
- arp-in: response at outside from 10.10.2.1 0013.8083.0bb1 for 10.10.1.2 0016.4687.9f43 having smac 0013.8083.0bb1 dmac 0016.4687.9f43\narp-in: Arp packet received from 10.10.2.1 which is in different subnet than the connected interface 10.10.1.2/255.255.255.0 

arp rate-limit

To set the ARP rate limit to control the number of ARP packets per second, use the arp rate-limit command in global configuration mode. To restore the default, use the no form of this command.

arp rate-limit seconds

no arp rate-limit

Syntax Description

seconds

Specifies the number of seconds between 10 and 32768. The default value depends on your ASA model.

Command Default

The default value depends on your ASA model.

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

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.6(2)

We introduced this command.

Usage Guidelines

You can customize this value to prevent an ARP storm attack.

Examples

The following example sets the ARP rate to 10000 per second:


ciscoasa(config)# arp rate-limit 10000

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.

Command Default

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

Secuity Context

Routed

Transparent

Single

Multiple

Context

System

Gloabl configuration

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

We added this command.

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:


ciscoasa(config)# arp timeout 5000

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.

Command Default

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

  • Yes

  • Yes

  • Yes

  • Yes

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.


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

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.

Command Default

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

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

This command was added.

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.


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

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.

Command Default

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

  • Yes

  • Yes

  • Yes

  • Yes

  • Yes

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:


ciscoasa(config)# asdm history enable
ciscoasa(config)#

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, 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, this URL indicates the external Flash memory card.

  • flash:/ [path / ]filename

This URL indicates the internal Flash memory.

Command Default

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

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

This command was added.

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:


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

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 .

Command Default

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

  • Yes

  • Yes

  • Yes

  • Yes

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.

as-path access-list

To configure an autonomous system path filter using a regular expression, use the as-path access-list command in global configuration mode. To delete the autonomous system path filter and remove it from the running configuration file, use the no form of this command.

as-path access-list acl-name { permit | deny } regexp

no as-path access-list acl-name

Syntax Description

acl-name

Name that specifies the AS-path access-list.

permit

Permits advertisement based on matching conditions.

deny

Denies advertisement based on matching conditions

regexp

Regular expression that defines the AS-path filter. The autonomous system number is expressed in the range from 1 to 65535.

For more details about autonomous system number formats, see the router bgp command.

Note

 
See the "Regular Expressions" appendix in the Cisco IOS Terminal Services Configuration Guide for information about configuring regular expressions.

Command Default

No autonomous system path filter is created.

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

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.2(1)

We added this command.

Usage Guidelines

Use the as-path access-list command to configure an autonomous system path filter. You can apply autonomous system path filters to both inbound and outbound BGP paths. Each filter is defined by the regular expression. If the regular expression matches the representation of the autonomous system path of the route as an ASCII string, then the permit or deny condition applies. The autonomous system path should not contain the local autonomous system number.

The Cisco implementation of 4-byte autonomous system numbers uses asplain—65538 for example—as the default regular expression match and output display format for autonomous system numbers, but you can configure 4-byte autonomous system numbers in both the asplain format and the asdot format as described in RFC 5396. To change the default regular expression match and output display of 4-byte autonomous system numbers to asdot format, use the bgp asnotation dot command. When the asdot format is enabled as the default, any regular expressions to match 4-byte autonomous system numbers must be written using the asdot format, or the regular expression match will fail.

Examples

In the following example, an autonomous system path access list (number 500) is defined to configure the ASA to not advertise any path through or from autonomous system 65535 to the 10.20.2.2 neighbor:


ciscoasa(config)# as-path access-list as-path-acl deny _65535_
ciscoasa(config)# as-path access-list as-path-acl deny ^65535$
ciscoasa(config)# router bgp 5000
ciscoasa(config-router)# address-fmaily ipv4
ciscoasa(config-router-af)# neighbor 192.168.1.1 remote-as 65535
ciscoasa(config-router-af)# neighbor 10.20.2.2 remote-as 40000
ciscoasa(config-router-af)# neighbor 10.20.2.2 filter-list as-path-acl out

asp load-balance per-packet

For multi-core ASAs, to change the load balancing behavior to be per packet, use the asp load-balance per-packet command in global configuration mode. To restore the default load-balancing mechanism, use the no form of this command.

asp load-balance per-packet [ auto ]

no asp load-balance per-packet

Syntax Description

auto

Automatically enables and disables per-packet load-balancing on each interface receive ring according to network conditions.

Command Default

Per-packet load-balancing 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

Gloabl configuration

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

8.1(1)

We added this command.

9.3(1)

The auto option was added.

9.8(1)

The auto option is now available for the ASA virtual.

Usage Guidelines

The job of the load balancer is to distribute packets to CPU cores and to maintain packet order. By default, a connection can only be processed by one core at a time. Due to this behavior, the cores will be under-utilized if there are a small number of interfaces/RX rings in use when compared to the number of cores. For example if there are only two Gigabit Ethernet interfaces in use on an ASA, then only two cores will be used. (A Ten Gigabit Ethernet interface has 4 RX rings and a Gigabit Ethernet interface as 1 RX ring.) You may want to optimize the load balancer by enabling per-packet load balancing so you can use more cores.

The default load-balancing behavior optimizes overall system performance when you have many interfaces in use, while the per-packet load balancer optimizes the overall system performance when you have a smaller number of interfaces that are active.

If you enable per-packet load balancing, when one core processes packets from an interface, another core can receive and process the next packet from the same interface. Therefore, it is possible for all cores to process packets from the same interface simultaneously.

Per-packet load balancing will improve performance if:

  • The system drops packets

  • The show cpu command shows CPU usage far less than 100%—The CPU usage is a good indicator of how many cores are being used. For example, on an 8-core system, if two cores are used, show cpu shows 25%; four cores: 50%; six cores: 75%.

  • There are a small number of interfaces that are in use


Note


Typically if there are less than 64 concurrent flows on the ASA, then enabling per-packet load balancing will incur more overhead than its benefit.

The auto option enables the ASA to detect whether or not asymmetric traffic has been added. The one-to-one lock between interface receive rings and cores is released if load balancing is needed. Load balancing per packet is only enabled on the heavily-loaded interface receive rings, not on all the interface receive rings. This adaptive load balance mechanism helps avoid the following issues:

  • Overruns caused by sporadic traffic spikes on flows

  • Overruns caused by bulk flows oversubscribing specific interface receive rings

  • Overruns caused by relatively heavily overloaded interface receive rings, in which a single core cannot sustain the load.

The auto option is not available for the ASA virtual in 9.7 and earlier.

Examples

The following example shows how to change the default load-balancing behavior:


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

The following example enables the automatic switching on and off of per-packet load balancing:


ciscoasa(config)# asp load-balance per-packet auto

asp rule-engine compile-offload

Use the asp rule-engine compile-offload command to enable or disable the compile offload function for the rule engine.

asp rule-engine compile-offload [ threshold rule-threshold ]

no asp rule-engine compile-offload [ threshold rule-threshold ]

Syntax Description

thresholdrule-threshold

Rule update threshold count to offload the compilation, 1 – 1000000. Default is 100.

Command Default

This command 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

Global configuration

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.20(1)

This command was introduced.

Usage Guidelines

When enabled, tmatch compilation is offloaded to the data path from the control plane if the tmatch object rule update count is greater than the threshold value. This leaves more time for the control plane to perform other tasks. Offloaded compliation is for rule-based policies such as ACLs, NAT, and VPN.

Because there is a fixed overhead to offload the compilation, you can increase the default threshold of 100 to adjust performance. The default threshold should work well in most cases.

Examples

The following example increases the threshold to 1000.


ciscoasa(config)# asp rule-engine compile-offload threshold 1000

asp rule-engine transactional-commit

Use the asp rule-engine transactional-commit command to enable or disable the transactional commit model for the rule engine.

asp rule-engine transactional-commit option

no asp rule-engine transactional-commit option

Syntax Description

option

Enables the transactional commit model for the rule engine for the selected policies. Options include:

  • access-group —Access rules applied globally or to interfaces.

  • nat —Network address translation rules.

Command Default

By default, the transactional commit model 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

  • Yes

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.1(5)

We added this command.

9.3(1)

We added the nat keyword.

Usage Guidelines

By default, when you change a rule-based policy (such as access rules), the changes become effective immediately. However, this immediacy comes at a slight cost in performance. The performance cost is more noticeable for very large rule lists in a high connections-per-second environment, for example, when you change a policy with 25,000 rules while the ASA is handling 18,000 connections per second.

The performance is affected because the rule engine compiles rules to enable faster rule lookup. By default, the system will also search uncompiled rules when evaluating a connection attempt so that new rules can be applied; since the rules are not compiled, the search takes longer.

You can change this behavior so that the rule engine uses a transactional model when implementing rule changes, continuing to use the old rules until the new rules are compiled and ready for use. Using the transactional model, performance should not drop during the rule compilation. The following table clarifies the behavioral difference.

Model

Before Compilation

During Compilation

After Compilation

Default

Match old rules.

Match new rules.

(Connections per second rate will decrease.)

Match new rules.

Transactional

Match old rules.

Match old rules.

(Connections per second rate will be unaffected.)

Match new rules.

An additional benefit of the transactional model is that, when replacing an ACL on an interface, there is no gap between deleting the old ACL and applying the new one. This reduces the chances that acceptable connections will be dropped during the operation.


Tip


If you enable the transactional model for a rule type, there are syslog messages to mark the beginning and the end of the compilation. These messages are numbered 780001 and following.


Examples

The following example enables the transactional commit model for access groups:


ciscoasa(config)# asp rule-engine transactional-commit access-group

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.

Command Default

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

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

7.0(1)

This command was added.

Usage Guidelines

When Active/Active failover is enabled, you may encounter situations where load balancing causes the return traffic for outbound connections to be routed through an active context on the peer unit, in which 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:


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

Context ctx2 configuration:


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

assertion-consumer-url (Deprecated)


Note


The last supported release for this command was Version 9.5(1).

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.

Command Default

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

  • Yes

  • Yes

Command History

Release

Modification

8.0(2)

This command was added.

9.5(2)

This command was deprecated, with the introduction of support for SAML 2.0.

Usage Guidelines

Single sign-on (SSO) 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.

Examples

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


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

attribute bind

To change the IP-to-attribute binding for an attribute-based network object, use the attribute bind command in EXEC mode.

attribute bind agent-name binding ip-address type attribute-type value attribute-value

Syntax Description

agent-name

Specifies the name of the VM attribute agent monitoring the attribute.

ip-address

Specifies the IP address of the attribute-based network object being managed.

attribute-type

Specifies the string identifying the attribute type to be updated.

attribute-value

Specifies the string identifying the new value to be assigned to the attribute type.

Command Default

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 mode

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.7(1)

This command was added.

Examples

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


ciscoasa(config)# attribute bind VMAgent binding 10.10.1.19 type custom.location value global

attribute source-group

To configure a VM attribute agent to communicate with VMware vCenter or a single ESXi host, use the attribute source-group command in EXEC mode. To delete an agent, use the no form of this command.

attribute source-group agent-name type agent-type

no attribute source-group agent-name

Syntax Description

agent-name

Specifies the name of the VM attribute agent name.

agent-type

Specifies the the type of attribute agent. Currently ESXi is the only supported agent type.

Command Default

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 mode

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.7(1)

This command was added.

Examples

The following example shows how to configure a VM attribute agent:


ciscoasa(config)# attribute source-group VMAgent type esxi

attribute source-group host

To configure VMware vCenter host credentials that allow a VM attribute agent to communicate with vCenter or a single ESXi host, use the attribute source-group host command in attribute agent configuration mode. To delete host credentials, use the no form of this command.

host ip-address username ESXi-username password ESXi-password

no host ip-address

Syntax Description

ip-address

Specifies the name of the VM attribute agent.

ESXi-username

Specifies the vCenter host username.

ESXi-password

Specifies the vCenter host password.

Command Default

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

Attribute agent configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.7(1)

This command was added.

Usage Guidelines

Use this command after you configure or modify an attribute agent.

Examples

The following example shows how to configure host credentials for an attribute agent:


ciscoasa(config)# attribute source-group VMAgent
ciscoasa(config-attr)# host 10.122.202.217 user admin password Cisco123

attribute source-group keepalive

To configure keepalive settings for VMware vCenter communication, use the attribute source-group keepalive command in attribute agent configuration mode. To restore the default values, use the no form of this command.

keepalive retry-interval interval retry-count count

no keepalive

Syntax Description

interval

Specifies the interval between keepalive messages from the attribute agent to vCenter. Each time a keepalive message receives a response from the source, the agent is considered to be in contact with the source, and the keepalive timer for that agent is restarted. The default is 30 seconds.

count

Specifies the retry count when a keepalive message is not received. Each time the timer expires without receiving a keepalive, the retry count for that agent is incremented. If the retry count reaches the configured threshold value, the agent declares that it has lost contact with the source. The default is 3.

Command Default

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

Attribute agent configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.7(1)

This command was added.

Usage Guidelines

Use this command after you configure or modify an attribute agent.

Examples

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


ciscoasa(config)# attribute source-group VMAgent
ciscoasa(config-attr)# keepalive retry-timer 100 retry-count 5

attributes

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

attributes 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, antivirus, antispyware, 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

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

8.0(2)

This command was added.

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 selection 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 antivirus software installed on the endpoint system. The endpoint ID for the antivirus 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


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

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

name

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

Command Default

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

  • Yes

  • Yes

Command History

Release

Modification

7.1(1)

This command was added.

Usage Guidelines

The WebVPN server of the ASA uses an HTTP POST request to submit a single sign-on (SSO) 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 configuresthe 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+1twie0gqnjbhkTkUnR8XWP3hvDH6PZPbHIHtWLDKTa8ngDB/lbYTjIxrbDx8WPWwaG3CxVa3adOxHFR8yjD55GevK3ZF4ujgU1lhO6fta0dSSOSepWvnsCb7IFxCw+MGiw0o88uHa2t4l+SillqfJvcpuXfiIAO06D/dapWriHjNoi4llJOgCst33wEhxFxcWy2UWxs4EZSjsI5GyBnefSQTPVfma5dc/emWor9vWr0HnTQaHP5rg5dTNqunkDEdMIHfbeP3F90cZejVzihM6igiS6P/CEJAjE;Domain=.example.com;Path=/

Examples

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


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

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

primary

Uses the username from the primary authentication server.

secondary

Uses the username from the secondary authentication server.

Command Default

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

  • Yes

  • Yes

Command History

Release

Modification

8.2(1)

This command was added.

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:


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

authentication (bfd-template)

To configure authentication in a BFD template for single-hop and multi-hop sessions, use the authentication command in BFD configuration mode. To disable authentication in the BFD template for single-hop or multi-hop sessions, use the no form of this command.

authentication authentication-type [ 0|8 ] key-string key-id id

Syntax Description

authentication-type

Specifies the authentication type. Valid values are md5 , meticulous-md5 , meticulous-sha-1 , and sha-1 .

0|8

0 specifies that an UNENCRYPTED password will follow. 8 specifies that an ENCRYPTED password will follow.

key-string

Specifies the authentication string that must be sent and received in the packets using the routing protocol being authenticated. The valid range is 1 to 17 uppercase and lowercase alphanumeric characters, except that the first character CANNOT be a number.

id

Specifies the shared key ID that matches the key string.

Command Default

This command has 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

BFD configuration

  • Yes

  • Yes

  • Yes

Command History

Release

Modification

9.6(2)

This command was added.

Usage Guidelines

Use this command to configure authentication in a BFD single-hop and multi-hop templates. We recommend that you configure authentication to enhance security.

Authentication must be configured on each BFD source-destination pair, and authentication parameters must match on both devices.

Examples

The following example configures authentication in a single-hop BFD template.


ciscoasa(config)# bfd single-hop sh-template
ciscoasa(config-bfd)# authentication sha-1 0 cisco key-id 10

The following example configures authentication in a multi-hop BFD template.


ciscoasa(config)# bfd multi-hop mh-template
ciscoasa(config-bfd)# authentication shat-1 0 cisco key-id 10

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 ] [ multiple certificate ] [ saml ] [ mailhost ] [ piggyback ] }

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

Syntax Description

aaa

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

certificate

Provides a certificate during SSL negotiation.

mailhost

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

multiple certificate

Provides a multiple certificate option during SSL negotiation.

piggyback

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

saml

SAML authentication method is mutually exclusive.

Command Default

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