-
Cisco ASA Series Command Reference
-
About this Guide
-
Using the Command Line Interface
- A through B Commands
-
C Commands
-
cache -- clear compression
-
clear configure -- clear configure http
-
clear configure flow-export-- clear configure zonelabs-integrity
-
clear conn -- clear isakmp sa
-
clear local-host -- clear xlate
-
client-access-rule -- crl-configure
-
crypto ca authenticate -- crypto ipsec ikev1 transform-set mode transport
-
crypto isakmp disconnect-notify -- cxsc auth-proxy port
-
-
D through F Commands
-
database path -- debug cxsc
-
debug dap -- debug http-map
-
debug icmp -- debug ospfv3
-
debug parser cache -- debug xml
-
default -- dhcp-server
-
dhcpd address -- distribute-list out
-
dns domain-lookup -- dynamic-filter whitelist
-
eigrp log-neighbor-changes -- export webvpn webcontent
-
failover -- fallback
-
file-bookmarks -- functions
-
- G through I Commands
- J through L Commands
- M through O Commands
- P through R Commands
-
S Commands
-
same-security-traffic -- shape
-
show aaa kerberos -- show asdm sessions
-
show asp cluster counter -- show asp table vpn-context
-
show blocks -- show cpu
-
show crashinfo -- show curpriv
-
show ddns update interface -- show environment
-
show failover -- show ipsec stats traffic
-
show ipv6 access-list -- show ipv6
-
show isakmp ipsec-over-tcp stats -- show ospf virtual-links
-
show nac-policy -- show ospf virtual-links
-
show pager -- show route
-
show running-config -- show running-config ctl-provider
-
show running-config ddns -- show running-config isakmp
-
show running-config ipv6 router -- show running-config router
-
show running-config same-security-traffic -- show running-config xlate
-
show scansafe -- show switch vlan
-
show tcpstat -- show traffic
-
show uauth -- show xlate
-
shun -- snmp-server user
-
software-version -- storage-objects
-
subject-name -- sysopt radius ignore-secret
-
- T through Z Commands
-
Cisco IOS Commands for the ASASM
-
Feedback
Table Of Contents
area through auto-update timeout Commands
authenticated-session-username
authentication-attr-from-server
authentication-server-group (imap4s, pop3s, smtps)
authentication-server-group (tunnel-group general-attributes)
area through auto-update timeout Commands
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.
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
—
—
IPv6 router configuration
•
—
•
—
—
Command History
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 1hostname(config-router)#Related Commands
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
Defaults
Area authentication is disabled.
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
•
—
Command History
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:
hostname(config-router)# area 1 authentication message-digesthostname(config-router)#Related Commands
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 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
Defaults
The default value of cost is 1.
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
•
—
IPv6 router configuration
•
—
•
•
—
Command History
7.0(1)
We introduced 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:
hostname(config-router)# area 1 default-cost 5hostname(config-router)#Related Commands
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
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
•
—
Command History
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:
hostname(config-router)# area 1 filter-list prefix-list AREA_1 inhostname(config-router)#Related Commands
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 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
Defaults
The defaults are as follows:
•
•
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
•
—
IPv6 router configuration
•
—
•
•
—
Command History
7.0(1)
We introduced 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:
hostname(config-rtr)# area 1 nssa no-redistributionhostname(config-rtr)# area area_id nssa default-information-originateExamples
The following example shows how setting two options separately results in a single command in the configuration:
hostname(config-rtr)# area 1 nssa no-redistributionhostname(config-rtr)# area 1 nssa default-information-originatehostname(config-rtr)# exithostname(config-rtr)# show running-config router ospf 1router ospf 1area 1 nssa no-redistribution default-information-originateRelated Commands
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 (OSPFv2)
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
Defaults
The address range status is set to advertise.
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
•
—
Command History
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:
hostname(config-router)# area 10.0.0.0 range 10.0.0.0 255.0.0.0hostname(config-router)# area 0 range 192.168.110.0 255.255.255.0hostname(config-router)#Related Commands
router ospf
Enters router configuration mode.
show running-config router
Displays the commands in the global router configuration.
area range (OSPFv3)
To consolidate and summarize OSPFv3 routes at an area boundary, use the area range command in IPv6 router configuration mode. To disable this function, use the no form of this command.
area area_id range ipv6-prefix/prefix-length [advertise | not-advertise] [cost cost]
no area area_id range ipv6-prefix/prefix-length [advertise | not-advertise] [cost cost]
Syntax Description
Defaults
The range status is set to advertise by default.
Command Modes
The following table shows the modes in which you can enter the command:
IPv6 router configuration
•
—
•
•
—
Command History
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:
hostname(config-router)# area 1 range 2000:0:0:4::2/2001::/64hostname(config-router)#Related Commands
ipv6 router ospf
Enters IPv6 router configuration mode for OSPFv3.
show running-config ipv6 router
Displays the IPv6 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 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
Defaults
The default behaviors are as follows:
•
•
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
—
—
IPv6 router configuration
•
—
•
—
—
Command History
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-rtr)# area 1 stubhostname(config-rtr)#Related Commands
area virtual-link (OSPFv2)
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
Note
Defaults
The defaults are as follows:
•
•
•
•
•
•
•
•
Command Modes
The following table shows the modes in which you can enter the command:
Router configuration
•
—
•
—
—
Command History
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
Examples
The following example establishes a virtual link with MD5 authentication:
hostname(config-rtr)# area 10.0.0.0 virtual-link 10.3.4.5 message-digest-key 3 md5 8 sa5721bk47Related Commands
area virtual-link (OSPFv3)
To define an OSPFv3 virtual link, use the area virtual-link command in IPv6 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 [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
Note
Defaults
The defaults are as follows:
•
•
•
•
•
•
Command Modes
The following table shows the modes in which you can enter the command:
IPv6 router configuration
•
—
•
—
—
Command History
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
Examples
The following example establishes a virtual link in OSPFv3:
hostname(config-if)# ipv6 router ospf 1hostname(config-rtr)# log-adjacency-changeshostname(config-rtr)# area 1 virtual-link 192.168.255.1 hello interval 5Related Commands
i
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
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Global configuration
•
•
•
•
—
Command History
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
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.2100Related Commands
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:
Global configuration
•
•
•
•
—
Command History
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:
•
•
Examples
The following example enables non-connected subnets:
hostname(config)# arp permit non-connectedRelated Commands
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
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:
Global configuration
—
•
•
•
—
Command History
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:
•
•
•
Note
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
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.2100hostname(config)# arp-inspection outside enable no-floodRelated Commands
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
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:
Global configuration
•
•
•
•
—
Command History
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 5000Related Commands
asdm disconnect
To terminate an active ASDM session, use the asdm disconnect command in privileged EXEC mode.
asdm disconnect session
Syntax Description
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Privileged EXEC
•
•
•
•
—
Command History
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 sessions0 192.168.1.11 192.168.1.2hostname# asdm disconnect 0hostname# show asdm sessions1 192.168.1.2Related Commands
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
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Privileged EXEC
•
•
•
•
—
Command History
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
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_sessions0 192.168.1.11 192.168.1.2hostname# asdm disconnect 0hostname# show asdm log_sessions1 192.168.1.2Related Commands
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:
Global configuration
•
•
•
•
•
Command History
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 enablehostname(config)#Related Commands
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
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:
Global configuration
•
•
•
—
•
Command History
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.binhostname(config)#Related Commands
show asdm image
Displays the current ASDM image file.
boot
Sets the software image and startup configuration files.
asdm location
Caution
asdm location ip_addr netmask if_name
asdm location ipv6_addr/prefix if_name
Syntax Description
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Global configuration
•
•
•
•
—
Command History
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 multicore ASAs, to change the load balancing behavior, 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
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. The default behavior is to allow only one core to receive packets from an interface receive ring at a time.
Command Modes
The following table shows the modes in which you can enter the command:
Global configuration
•
•
•
—
•
Command History
Usage Guidelines
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. 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 the show cpu command output is far less than 100%, then this command may help your throughput if the packets belong to many unrelated connections. The CPU usage is a good indicator of how many cores are effectively being used.
For example on the ASA 5580-40, which includes 8 cores, if two cores are used, then the show cpu command output will be 25%; four cores will be 50%; and six cores will be 75%.
Examples
The following example enables per-packet load balancing:
hostname(config)# asp load-balance per-packetRelated Commands
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
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Interface configuration
•
•
—
•
—
Command History
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
Examples
The following example assigns the selected interfaces to the asymmetric routing group 1.
Context ctx1 configuration:
hostname/ctx1(config)# interface Ethernet2hostname/ctx1(config-if)# nameif outsidehostname/ctx1(config-if)# ip address 192.168.1.11 255.255.255.0 standby 192.168.1.21hostname/ctx1(config-if)# asr-group 1Context ctx2 configuration:
hostname/ctx2(config)# interface Ethernet3hostname/ctx2(config-if)# nameif outsidehostname/ctx2(config-if)# ip address 192.168.1.31 255.255.255.0 standby 192.168.1.41hostname/ctx2(config-if)# asr-group 1Related Commands
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:
Webvpn configuration
•
—
•
—
—
Command History
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:
hostname(config-webvpn)# sso server myhostname type saml-v1.1-posthostname(config-webvpn-sso-saml# assertion-consumer-url https://saml-server/postconsumerhostname(config-webvpn-sso-saml#Related Commands
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
Command Default
No default value or behaviors.
Command Modes
The following table shows the modes in which you can enter the command:
DAP attributes configuration
•
•
•
—
—
Command History
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:
action = continue
action = continue
port-forward = enable hostlist1
url-list = links2
—
url-entry = enable
hostname #test dynamic-access-policy attributeshostname(config-dap-test-attr)#attribute aaa.ldap.memberof SAPhostname(config-dap-test-attr)#attribute endpoint.av.nav.exists truehostname(config-dap-test-attr)#exithostname #test dynamic-access-policy executePolicy Attributes:action = continueport-forward = enable hostlist1url-list = links2url-entry = enablehostname #Related Commands
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
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Aaa-server host configuration
•
—
•
—
—
Command History
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+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.comhostname(config-aaa-server-host)# auth-cookie-name SMSESSIONhostname(config-aaa-server-host)#Related Commands
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.
Defaults
The default value is primary.
Command Modes
The following table shows the modes in which you can enter the command:
Tunnel-group general-attributes configuration
•
—
•
—
—
Command History
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_rahostname(config)# tunnel-group remotegrp general-attributeshostname(config-tunnel-webvpn)# authenticated-session-username secondaryhostname(config-tunnel-webvpn)#Related Commands
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
Defaults
The default value is primary.
Command Modes
The following table shows the modes in which you can enter the command:
Tunnel-group general-attributes configuration
•
—
•
—
—
Command History
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_rahostname(config)# tunnel-group remotegrp general-attributeshostname(config-tunnel-webvpn)# authentication-attr-from-server secondaryhostname(config-tunnel-webvpn)#Related Commands
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:
•
•
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:
Webvpn configuration
•
—
•
—
—
Command History
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 those that do not support WebVPN.
The ASA validates certificates using the PKI trustpoints. If a certificate does not pass validation, then one of the following actions occurs:
Examples
The following example configures certificate authentication for WebVPN user connections on the outside interface:
hostname(config)# webvpnhostname(config-webvpn)# authentication-certificate outsidehostname(config-webvpn)#Related Commands
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
Command Default
Disabled.
Command Modes
The following table shows the modes in which you can enter the command:
Webvpn configuration
•
—
•
—
—
Command History
Usage Guidelines
This feature is useful when you require some internal resources to 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)#webvpnhostname(config-webvpn)#authentication-exclude http://www.example.com/public/*hostname(config-webvpn)#authentication-exclude *example.htmlhostname(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
Defaults
The following table shows the default authentication methods for WebVPN and e-mail proxies:
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 History
Usage Guidelines
At least one authentication method is required. For WebVPN, for example, you can specify AAA authentication, certificate authentication, or both. You can enter these commands 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 into the same command in tunnel-group webvpn-attributes configuration mode.
For WebVPN, you can require both AAA and certificate authentication. In this 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)# webvpnhostname(config-webvpn)# authentication certificateRelated Commands
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
By default, EAP is not a permitted authentication protocol.
Command Modes
The following table shows the modes in which you can enter the command:
Tunnel-group ppp-attributes configuration
•
—
•
—
—
Command History
Usage Guidelines
You can apply this attribute only to the L2TP or 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/IPSechostname(config)# tunnel-group pppremotegrp ppp-attributeshostname(config-ppp)# authentication eaphostname(config-ppp)#Related Commands
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
Defaults
EIGRP authentication is disabled.
Command Modes
The following table shows the modes in which you can enter the command:
Interface configuration
•
—
•
•
—
Command History
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/3hostname(config-if)# authentication mode eigrp md5hostname(config-if)# authentication key eigrp 100 thisismykey key_id 5Related Commands
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:
Interface configuration
•
—
•
•
—
Command History
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/3hostname(config-if)# authentication mode eigrp 100 md5hostname(config-if)# authentication key eigrp 100 thisismykey key_id 5Related Commands
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.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:
Tunnel-group ppp-attributes configuration
•
—
•
—
—
Command History
Usage Guidelines
You can apply this attribute only to the L2TP or 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
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:
Tunnel-group ppp-attributes configuration
•
—
•
—
—
Command History
Usage Guidelines
You can apply this attribute only to the L2TP or 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 clear text passwords as in CHAP. This protocol also generates a key for data encryption by MPPE.
Related Commands
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
By default, PAP is not a permitted authentication protocol.
Command Modes
The following table shows the modes in which you can enter the command:
Tunnel-group ppp-attributes configuration
•
—
•
—
—
Command History
Usage Guidelines
You can apply this attribute only to the L2TP or IPsec tunnel group type.
This protocol passes the clear text 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/IPSechostname(config)# tunnel-group pppremotegrp ppp-attributeshostname(config-ppp)# authentication paphostname(config-ppp)#Related Commands
authentication-certificate
To request a certificate from a WebVPN client establishing 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:
•
•
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:
Webvpn configuration
•
—
•
—
—
Command History
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 with the PKI trustpoints. If a certificate does not pass validation, then one of the following actions occurs:
Examples
The following example configures certificate authentication for WebVPN user connections on the outside interface:
hostname(config)# webvpnhostname(config-webvpn)# authentication-certificate outsidehostname(config-webvpn)#Related Commands
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.
authentication-port port
no authentication-port
Syntax Description
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:
Aaa-server host configuration
•
•
•
•
—
Command History
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
This command specifies the destination TCP/UDP port number of the remote RADIUS server hosts to which you want to assign authentication functions. If your RADIUS authentication server uses a port other than 1645, you must configure the ASA for the appropriate port before 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 radiushostname(config-aaa-server-group)#aaa-server svrgrp1 host 1.2.3.4hostname(config-aaa-server-host)#timeout 9hostname(config-aaa-server-host)#retry-interval 7hostname(config-aaa-server-host)#authentication-port 1650hostname(config-aaa-server-host)#exithostname(config)#Related Commands
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
Defaults
No authentication servers are configured by default.
Command Modes
The following table shows the modes in which you can enter the command:
Imap4s configuration
•
—
•
—
—
Pop3s configuration
•
—
•
—
—
Smtps configuration
•
—
•
—
—
Command History
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.
Use the aaa-server command to configure authentication servers.
Examples
The following example shows how to configure an IMAP4S e-mail proxy to use the set of authentication servers named "IMAP4SSVRS":
hostname(config)#imap4shostname(config-imap4s)# authentication-server-group IMAP4SSVRSRelated Commands
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
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:
Tunnel-group general-attributes configuration
•
—
•
—
—
Command History
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-rahostname(config)# tunnel-group remotegrp general-attributeshostname(config-tunnel-general)# authentication-server-group aaa-server456hostname(config-tunnel-general)#Related Commands
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
This command is disabled by default.
Command Modes
The following table shows the modes in which you can enter the command:
Command History
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_rahostname(config)# tunnel-group remotegrp general-attributeshostname(config-tunnel-general)# authorization-requiredhostname(config-tunnel-general)#Related Commands
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 History
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 into 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)#pop3shostname(config-pop3s)# authorization-server-group POP3SpermitThe following example entered in tunnel-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-rahostname(config)# tunnel-group remotegrp general-attributeshostname(config-tunnel-general)# authorization-server-group aaa-server78hostname(config-tunnel-general)#Related Commands
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
Defaults
If you do not specify an authentication prompt:
•
hostname #.•
hostname(config-dap-test-attr)#•
Command Modes
The following table shows the modes in which you can enter the command:
Global configuration
•
•
—
—
•
Command History
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 see when logging in.
If 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 do not appear.
Note
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 passwordAfter this string is added to the configuration, users see the following:
Please enter your username and passwordUser 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
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. 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
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 History
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 on the desired scope of authentication:
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 configures 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)# webvpnhostname(config-webvpn)# auto-signon allow ip 10.1.1.0 255.255.255.0 auth-type ntlmThe following example configures auto-signon for all clientless users, using HTTP Basic authentication, to servers defined by the URI mask https://*.example.com/*:
hostname(config)# webvpnhostname(config-webvpn)# auto-signon allow uri https://*.example.com/* auth-type basicThe following example configures 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 attributeshostname(config-group-policy)# webvpnhostname(config-group-webvpn)# auto-signon allow uri https://*.example.com/* auth-type allThe following example configures 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 attributeshostname(config-username)# webvpnhostname(config-username-webvpn)# auto-signon allow ip 10.1.1.0 255.255.255.0 auth-type basicRelated Commands
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:
Router configuration
•
—
•
•
—
Command History
7.2(1)
This command was introduced.
8.0(2)
Support for EIGRP was added.
9.0(1)
Multiple context mode is supported.
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 riphostname(config-router)# network 10.0.0.0hostname(config-router)# version 2hostname(config-router)# no auto-summaryThe following example disables automatic EIGRP route summarization:
hostname(config)# router eigrp 100hostname(config-router)# network 10.0.0.0hostname(config-router)# no auto-summaryRelated Commands
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
Defaults
The default ID is the hostname.
Command Modes
The following table shows the modes in which you can enter the command:
Global configuration
•
•
•
—
—
Command History
Examples
The following example sets the device ID to the serial number:
hostname(config)# auto-update device-id hardware-serialRelated Commands
auto-update poll-at
To schedule a specific time for the ASA to poll the Auto Update Server, use the auto-update poll-at command in global configuration mode. To remove all specified scheduling times for the ASA 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
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Global configuration
•
•
•
—
—
Command History
Usage Guidelines
The auto-update poll-at command specifies 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 option 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 ASA 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 ASA 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 10hostname(config)# auto-update server http://192.168.1.114/aus/autoupdate.aspRelated Commands
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
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:
Global configuration
•
•
•
—
—
Command History
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 3Related Commands
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
Defaults
No default behavior or values.
Command Modes
The following table shows the modes in which you can enter the command:
Global configuration
•
•
•
—
—
Command History
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 is contacted. This process continues 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 has been configured to retry the connection.
For auto-update functionality to work correctly, you must use the boot system configuration command and ensure that it specifies a valid boot image. In addition, you must use the asdm image command 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 are sent over the VPN tunnel.
Examples
The following example sets the Auto Update Server URL and specifies the interface as outside:
hostname(config)# auto-update server http://10.1.1.1:1741/ source outsideRelated Commands
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
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:
Global configuration
•
•
•
—
—
Command History
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 going through it. 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 1440Related Commands
